Class TonClient

Hierarchy

TonClient

Index

Constructors

Properties

Methods

callGetMethod callGetMethodWithError estimateExternalMessageFee getBalance getContractState getMasterchainInfo getShardTransactions getTransaction getTransactions getWorkchainShards isContractDeployed open provider sendExternalMessage sendFile sendMessage

Constructors

constructor

new TonClient(parameters: TonClientParameters): TonClient
Parameters
- parameters: TonClientParameters
Returns TonClient
- Defined in src/client/TonClient.ts:33

Properties

`Private` #api

#api: HttpApi

`Readonly` parameters

parameters: TonClientParameters

Methods

callGetMethod

callGetMethod(address: Address, name: string, stack?: TupleItem[]): Promise<{
gas_used: number;
stack: TupleReader;
}>
Invoke get method

Returns
stack and gas_used field
Parameters
- address: Address
  
  contract address
- name: string
  
  name of method
- stack: TupleItem[] = []
Returns Promise<{
gas_used: number;
stack: TupleReader;
}>
- Defined in src/client/TonClient.ts:60

callGetMethodWithError

callGetMethodWithError(address: Address, name: string, params?: any[]): Promise<{
    exit_code: number;
    gas_used: number;
    stack: TupleReader;
}>
Invoke get method that returns error code instead of throwing error

Returns
stack and gas_used field
Parameters
- address: Address
  
  contract address
- name: string
  
  name of method
- params: any[] = []
  
  optional parameters
Returns Promise<{
    exit_code: number;
    gas_used: number;
    stack: TupleReader;
}>
- Defined in src/client/TonClient.ts:75

estimateExternalMessageFee

estimateExternalMessageFee(address: Address, args: {
    body: Cell;
    ignoreSignature: boolean;
    initCode: null | Cell;
    initData: null | Cell;
}): Promise<{
    @type: "query.fees";
    source_fees: { '@type': "fees"; in_fwd_fee: number; storage_fee: number; gas_fee: number; fwd_fee: number; };
}>
Estimate fees for external message

Returns
Parameters
- address: Address
  
  target address
- args: {
      body: Cell;
      ignoreSignature: boolean;
      initCode: null | Cell;
      initData: null | Cell;
  }
  - body: Cell
  - ignoreSignature: boolean
  - initCode: null | Cell
  - initData: null | Cell
Returns Promise<{
@type: "query.fees";
source_fees: { '@type': "fees"; in_fwd_fee: number; storage_fee: number; gas_fee: number; fwd_fee: number; };
}>
- Defined in src/client/TonClient.ts:180

getBalance

getBalance(address: Address): Promise<bigint>
Get Address Balance

Returns
balance
Parameters
- address: Address
  
  address for balance check
Returns Promise<bigint>
- Defined in src/client/TonClient.ts:49

getContractState

getContractState(address: Address): Promise<{
    balance: bigint;
    blockId: {
        seqno: number;
        shard: string;
        workchain: number;
    };
    code: null | Buffer;
    data: null | Buffer;
    lastTransaction: null | {
        hash: string;
        lt: string;
    };
    state: "active" | "uninitialized" | "frozen";
    timestampt: number;
}>
Resolves contract state
Parameters
- address: Address
  
  contract address
Returns Promise<{
    balance: bigint;
    blockId: {
        seqno: number;
        shard: string;
        workchain: number;
    };
    code: null | Buffer;
    data: null | Buffer;
    lastTransaction: null | {
        hash: string;
        lt: string;
    };
    state: "active" | "uninitialized" | "frozen";
    timestampt: number;
}>
- Defined in src/client/TonClient.ts:224

getMasterchainInfo

getMasterchainInfo(): Promise<{
    initSeqno: number;
    latestSeqno: number;
    shard: string;
    workchain: number;
}>
Fetch latest masterchain info

Returns
masterchain info

Returns Promise<{
    initSeqno: number;
    latestSeqno: number;
    shard: string;
    workchain: number;
}>
- Defined in src/client/TonClient.ts:114

getShardTransactions

getShardTransactions(workchain: number, seqno: number, shard: string): Promise<{
    account: Address;
    hash: string;
    lt: string;
}[]>
Fetch transactions inf shards
Parameters
- workchain: number
- seqno: number
- shard: string
Returns Promise<{
    account: Address;
    hash: string;
    lt: string;
}[]>
- Defined in src/client/TonClient.ts:143

getTransaction

getTransaction(address: Address, lt: string, hash: string): Promise<null | {
    address: bigint;
    description: TransactionDescription;
    endStatus: AccountStatus;
    inMessage: undefined | Message;
    lt: bigint;
    now: number;
    oldStatus: AccountStatus;
    outMessages: Dictionary<number, Message>;
    outMessagesCount: number;
    prevTransactionHash: bigint;
    prevTransactionLt: bigint;
    stateUpdate: HashUpdate;
    totalFees: CurrencyCollection;
}>
Get transaction by it's id

Returns
transaction or null if not exist
Parameters
- address: Address
  
  address
- lt: string
  
  logical time
- hash: string
  
  transaction hash
Returns Promise<null | {
    address: bigint;
    description: TransactionDescription;
    endStatus: AccountStatus;
    inMessage: undefined | Message;
    lt: bigint;
    now: number;
    oldStatus: AccountStatus;
    outMessages: Dictionary<number, Message>;
    outMessagesCount: number;
    prevTransactionHash: bigint;
    prevTransactionLt: bigint;
    stateUpdate: HashUpdate;
    totalFees: CurrencyCollection;
}>
- Defined in src/client/TonClient.ts:101

getTransactions

getTransactions(address: Address, opts: {
    hash?: string;
    inclusive?: boolean;
    limit: number;
    lt?: string;
    to_lt?: string;
}): Promise<Transaction[]>
Get transactions
Parameters
- address: Address
  
  address
- opts: {
      hash?: string;
      inclusive?: boolean;
      limit: number;
      lt?: string;
      to_lt?: string;
  }
  - Optional hash?: string
  - Optional inclusive?: boolean
  - limit: number
  - Optional lt?: string
  - Optional to_lt?: string
Returns Promise<Transaction[]>
- Defined in src/client/TonClient.ts:84

getWorkchainShards

getWorkchainShards(seqno: number): Promise<{
    seqno: number;
    shard: string;
    workchain: number;
}[]>
Fetch latest workchain shards
Parameters
- seqno: number
  
  masterchain seqno
Returns Promise<{
    seqno: number;
    shard: string;
    workchain: number;
}[]>
- Defined in src/client/TonClient.ts:128

isContractDeployed

isContractDeployed(address: Address): Promise<boolean>
Check if contract is deployed

Returns
true if contract is in active state
Parameters
- address: Address
  
  addres to check
Returns Promise<boolean>
- Defined in src/client/TonClient.ts:216

open

open<T>(src: T): OpenedContract<T>
Open contract

Returns
contract
Type Parameters
- T extends Contract
Parameters
- src: T
  
  source contract
Returns OpenedContract<T>
- Defined in src/client/TonClient.ts:251

provider

provider(address: Address, init: null | {
code: null | Cell;
data: null | Cell;
}): ContractProvider
Create a provider

Returns
provider
Parameters
- address: Address
  
  address
- init: null | {
  code: null | Cell;
  data: null | Cell;
  }
  
  optional init
Returns ContractProvider
- Defined in src/client/TonClient.ts:261

sendExternalMessage

sendExternalMessage(contract: Contract, src: Cell): Promise<void>
Send external message to contract
Parameters
- contract: Contract
  
  contract to send message
- src: Cell
  
  message body
Returns Promise<void>
- Defined in src/client/TonClient.ts:194

sendFile

sendFile(src: Buffer): Promise<void>
Send file to a network
Parameters
- src: Buffer
  
  source file
Returns Promise<void>
- Defined in src/client/TonClient.ts:171

sendMessage

sendMessage(src: Message): Promise<void>
Send message to a network
Parameters
- src: Message
  
  source message
Returns Promise<void>
- Defined in src/client/TonClient.ts:159

Class TonClient

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

parameters: TonClientParameters

Returns TonClient

Properties

Private #api

Readonly parameters

Methods

callGetMethod

Returns

Parameters

address: Address

name: string

stack: TupleItem[] = []

Returns Promise<{ gas_used: number; stack: TupleReader; }>

callGetMethodWithError

Returns

Parameters

address: Address

name: string

params: any[] = []

Returns Promise<{ exit_code: number; gas_used: number; stack: TupleReader; }>

estimateExternalMessageFee

Returns

Parameters

address: Address

args: { body: Cell; ignoreSignature: boolean; initCode: null | Cell; initData: null | Cell; }

body: Cell

ignoreSignature: boolean

initCode: null | Cell

initData: null | Cell

Returns Promise<{ @type: "query.fees"; source_fees: { '@type': "fees"; in_fwd_fee: number; storage_fee: number; gas_fee: number; fwd_fee: number; }; }>

getBalance

Returns

Parameters

address: Address

Returns Promise<bigint>

getContractState

Parameters

address: Address

Returns Promise<{ balance: bigint; blockId: { seqno: number; shard: string; workchain: number; }; code: null | Buffer; data: null | Buffer; lastTransaction: null | { hash: string; lt: string; }; state: "active" | "uninitialized" | "frozen"; timestampt: number; }>

getMasterchainInfo

Returns

Returns Promise<{ initSeqno: number; latestSeqno: number; shard: string; workchain: number; }>

getShardTransactions

Parameters

workchain: number

seqno: number

shard: string

Returns Promise<{ account: Address; hash: string; lt: string; }[]>

getTransaction

Returns

Parameters

address: Address

lt: string

hash: string

getTransactions

Parameters

address: Address

opts: { hash?: string; inclusive?: boolean; limit: number; lt?: string; to_lt?: string; }

Optional hash?: string

Optional inclusive?: boolean

limit: number

Optional lt?: string

Optional to_lt?: string

Returns Promise<Transaction[]>

getWorkchainShards

Parameters

seqno: number

Returns Promise<{ seqno: number; shard: string; workchain: number; }[]>

isContractDeployed

Returns

Parameters

`Private` #api

`Readonly` parameters

Returns Promise<{
gas_used: number;
stack: TupleReader;
}>

Returns Promise<{
exit_code: number;
gas_used: number;
stack: TupleReader;
}>

args: {
body: Cell;
ignoreSignature: boolean;
initCode: null | Cell;
initData: null | Cell;
}

Returns Promise<{
@type: "query.fees";
source_fees: { '@type': "fees"; in_fwd_fee: number; storage_fee: number; gas_fee: number; fwd_fee: number; };
}>

Returns Promise<{
balance: bigint;
blockId: {
seqno: number;
shard: string;
workchain: number;
};
code: null | Buffer;
data: null | Buffer;
lastTransaction: null | {
hash: string;
lt: string;
};
state: "active" | "uninitialized" | "frozen";
timestampt: number;
}>

Returns Promise<{
initSeqno: number;
latestSeqno: number;
shard: string;
workchain: number;
}>

Returns Promise<{
account: Address;
hash: string;
lt: string;
}[]>

opts: {
hash?: string;
inclusive?: boolean;
limit: number;
lt?: string;
to_lt?: string;
}

`Optional` hash?: string

`Optional` inclusive?: boolean

`Optional` lt?: string

`Optional` to_lt?: string

Returns Promise<{
seqno: number;
shard: string;
workchain: number;
}[]>

init: null | {
code: null | Cell;
data: null | Cell;
}