Class TonClient4

Hierarchy

TonClient4

Index

Constructors

Properties

Methods

getAccount getAccountLite getAccountTransactions getBlock getBlockByUtime getConfig getLastBlock getTransaction isAccountChanged open openAt provider providerAt runMethod sendMessage

Constructors

constructor

new TonClient4(args: TonClient4Parameters): TonClient4
Parameters
- args: TonClient4Parameters
Returns TonClient4
- Defined in src/client/TonClient4.ts:31

Properties

`Private` `Optional` #adapter

#adapter?: AxiosAdapter

`Private` #endpoint

#endpoint: string

`Private` #timeout

#timeout: number

Methods

getAccount

getAccount(seqno: number, address: Address): Promise<{
account: { state: { type: "uninit"; } | { type: "active"; code: string | null; data: string | null; } | { type: "frozen"; stateHash: string; }; balance: { coins: string; }; last: { lt: string; hash: string; } | null; storageStat: { ...; } | null; };
block: { workchain: number; seqno: number; shard: string; rootHash: string; fileHash: string; };
}>
Get block info by unix timestamp

Returns
account info
Parameters
- seqno: number
  
  block sequence number
- address: Address
  
  account address
Returns Promise<{
account: { state: { type: "uninit"; } | { type: "active"; code: string | null; data: string | null; } | { type: "frozen"; stateHash: string; }; balance: { coins: string; }; last: { lt: string; hash: string; } | null; storageStat: { ...; } | null; };
block: { workchain: number; seqno: number; shard: string; rootHash: string; fileHash: string; };
}>
- Defined in src/client/TonClient4.ts:87

getAccountLite

getAccountLite(seqno: number, address: Address): Promise<{
account: { state: { type: "uninit"; } | { type: "active"; codeHash: string; dataHash: string; } | { type: "frozen"; stateHash: string; }; balance: { coins: string; }; last: { lt: string; hash: string; } | null; storageStat: { ...; } | null; };
}>
Get account lite info (without code and data)

Returns
account lite info
Parameters
- seqno: number
  
  block sequence number
- address: Address
  
  account address
Returns Promise<{
account: { state: { type: "uninit"; } | { type: "active"; codeHash: string; dataHash: string; } | { type: "frozen"; stateHash: string; }; balance: { coins: string; }; last: { lt: string; hash: string; } | null; storageStat: { ...; } | null; };
}>
- Defined in src/client/TonClient4.ts:101

getAccountTransactions

getAccountTransactions(address: Address, lt: bigint, hash: Buffer): Promise<{
    block: {
        fileHash: string;
        rootHash: string;
        seqno: number;
        shard: string;
        workchain: number;
    };
    tx: Transaction;
}[]>
Load unparsed account transactions

Returns
unparsed transactions
Parameters
- address: Address
  
  address
- lt: bigint
  
  last transaction lt
- hash: Buffer
  
  last transaction hash
Returns Promise<{
    block: {
        fileHash: string;
        rootHash: string;
        seqno: number;
        shard: string;
        workchain: number;
    };
    tx: Transaction;
}[]>
- Defined in src/client/TonClient4.ts:154

getBlock

getBlock(seqno: number): Promise<{
shards: ({ workchain: number; seqno: number; shard: string; rootHash: string; fileHash: string; transactions: { account: string; hash: string; lt: string; }[]; })[];
}>
Get block info

Returns
block info
Parameters
- seqno: number
  
  block sequence number
Returns Promise<{
shards: ({ workchain: number; seqno: number; shard: string; rootHash: string; fileHash: string; transactions: { account: string; hash: string; lt: string; }[]; })[];
}>
- Defined in src/client/TonClient4.ts:54

getBlockByUtime

getBlockByUtime(ts: number): Promise<{
shards: ({ workchain: number; seqno: number; shard: string; rootHash: string; fileHash: string; transactions: { account: string; hash: string; lt: string; }[]; })[];
}>
Get block info by unix timestamp

Returns
block info
Parameters
- ts: number
  
  unix timestamp
Returns Promise<{
shards: ({ workchain: number; seqno: number; shard: string; rootHash: string; fileHash: string; transactions: { account: string; hash: string; lt: string; }[]; })[];
}>
- Defined in src/client/TonClient4.ts:70

getConfig

getConfig(seqno: number, ids?: number[]): Promise<{
config: { cell: string; address: string; globalBalance: { coins: string; }; };
}>
Get network config

Returns
network config
Parameters
- seqno: number
  
  block sequence number
- Optional ids: number[]
  
  optional config ids
Returns Promise<{
config: { cell: string; address: string; globalBalance: { coins: string; }; };
}>
- Defined in src/client/TonClient4.ts:186

getLastBlock

getLastBlock(): Promise<{
    init: { fileHash: string; rootHash: string; };
    last: { seqno: number; shard: string; workchain: number; fileHash: string; rootHash: string; };
    now: number;
    stateRootHash: string;
}>
Get Last Block

Returns
last block info

Returns Promise<{
    init: { fileHash: string; rootHash: string; };
    last: { seqno: number; shard: string; workchain: number; fileHash: string; rootHash: string; };
    now: number;
    stateRootHash: string;
}>
- Defined in src/client/TonClient4.ts:41

getTransaction

getTransaction(seqno: number, address: Address, lt: bigint): Promise<{
    block: {
        rootHash: string;
        seqno: number;
        shard: string;
        workchain: number;
    };
    boc: string;
    proof: string;
    tx: {
        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;
    };
}>
Load one unparsed account transaction

Returns
one unparsed transaction
Parameters
- seqno: number
  
  block sequence number
- address: Address
  
  account address
- lt: bigint
  
  account last transaction lt
Returns Promise<{
    block: {
        rootHash: string;
        seqno: number;
        shard: string;
        workchain: number;
    };
    boc: string;
    proof: string;
    tx: {
        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/TonClient4.ts:131

isAccountChanged

isAccountChanged(seqno: number, address: Address, lt: bigint): Promise<{
block: { workchain: number; seqno: number; shard: string; rootHash: string; fileHash: string; };
changed: boolean;
}>
Check if account was updated since

Returns
account change info
Parameters
- seqno: number
  
  block sequence number
- address: Address
  
  account address
- lt: bigint
  
  account last transaction lt
Returns Promise<{
block: { workchain: number; seqno: number; shard: string; rootHash: string; fileHash: string; };
changed: boolean;
}>
- Defined in src/client/TonClient4.ts:116

open

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

Returns
opened contract
Type Parameters
- T extends Contract
Parameters
- contract: T
  
  contract
Returns OpenedContract<T>
- Defined in src/client/TonClient4.ts:240

openAt

openAt<T>(block: number, contract: T): OpenedContract<T>
Open smart contract

Returns
opened contract
Type Parameters
- T extends Contract
Parameters
- block: number
  
  block number
- contract: T
  
  contract
Returns OpenedContract<T>
- Defined in src/client/TonClient4.ts:250

provider

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

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

providerAt

providerAt(block: number, address: Address, init?: null | {
code: Cell;
data: Cell;
}): ContractProvider
Create provider at specified block number

Returns
provider
Parameters
- block: number
  
  block number
- address: Address
  
  address
- Optional init: null | {
  code: Cell;
  data: Cell;
  }
  
  optional init data
Returns ContractProvider
- Defined in src/client/TonClient4.ts:271

runMethod

runMethod(seqno: number, address: Address, name: string, args?: TupleItem[]): Promise<{
    block: {
        fileHash: string;
        rootHash: string;
        seqno: number;
        shard: string;
        workchain: number;
    };
    exitCode: number;
    result: TupleItem[];
    resultRaw: null | string;
    shardBlock: {
        fileHash: string;
        rootHash: string;
        seqno: number;
        shard: string;
        workchain: number;
    };
}>
Execute run method

Returns
method result
Parameters
- seqno: number
  
  block sequence number
- address: Address
  
  account address
- name: string
  
  method name
- Optional args: TupleItem[]
  
  method arguments
Returns Promise<{
    block: {
        fileHash: string;
        rootHash: string;
        seqno: number;
        shard: string;
        workchain: number;
    };
    exitCode: number;
    result: TupleItem[];
    resultRaw: null | string;
    shardBlock: {
        fileHash: string;
        rootHash: string;
        seqno: number;
        shard: string;
        workchain: number;
    };
}>
- Defined in src/client/TonClient4.ts:206

sendMessage

sendMessage(message: Buffer): Promise<{
status: number;
}>
Send external message

Returns
message status
Parameters
- message: Buffer
  
  message boc
Returns Promise<{
status: number;
}>
- Defined in src/client/TonClient4.ts:227

Class TonClient4

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

args: TonClient4Parameters

Returns TonClient4

Properties

Private Optional #adapter

Private #endpoint

Private #timeout

Methods

getAccount

Returns

Parameters

seqno: number

address: Address

getAccountLite

Returns

Parameters

seqno: number

address: Address

Returns Promise<{ account: { state: { type: "uninit"; } | { type: "active"; codeHash: string; dataHash: string; } | { type: "frozen"; stateHash: string; }; balance: { coins: string; }; last: { lt: string; hash: string; } | null; storageStat: { ...; } | null; }; }>

getAccountTransactions

Returns

Parameters

address: Address

lt: bigint

hash: Buffer

Returns Promise<{ block: { fileHash: string; rootHash: string; seqno: number; shard: string; workchain: number; }; tx: Transaction; }[]>

getBlock

Returns

Parameters

seqno: number

Returns Promise<{ shards: ({ workchain: number; seqno: number; shard: string; rootHash: string; fileHash: string; transactions: { account: string; hash: string; lt: string; }[]; })[]; }>

getBlockByUtime

Returns

Parameters

ts: number

Returns Promise<{ shards: ({ workchain: number; seqno: number; shard: string; rootHash: string; fileHash: string; transactions: { account: string; hash: string; lt: string; }[]; })[]; }>

getConfig

Returns

Parameters

seqno: number

Optional ids: number[]

Returns Promise<{ config: { cell: string; address: string; globalBalance: { coins: string; }; }; }>

getLastBlock

Returns

Returns Promise<{ init: { fileHash: string; rootHash: string; }; last: { seqno: number; shard: string; workchain: number; fileHash: string; rootHash: string; }; now: number; stateRootHash: string; }>

getTransaction

Returns

Parameters

seqno: number

address: Address

lt: bigint

isAccountChanged

Returns

Parameters

seqno: number

address: Address

lt: bigint

Returns Promise<{ block: { workchain: number; seqno: number; shard: string; rootHash: string; fileHash: string; }; changed: boolean; }>

open

Returns

Type Parameters

T extends Contract

Parameters

contract: T

Returns OpenedContract<T>

openAt

Returns

Type Parameters

T extends Contract

Parameters

block: number

contract: T

`Private` `Optional` #adapter

`Private` #endpoint

`Private` #timeout

Returns Promise<{
account: { state: { type: "uninit"; } | { type: "active"; codeHash: string; dataHash: string; } | { type: "frozen"; stateHash: string; }; balance: { coins: string; }; last: { lt: string; hash: string; } | null; storageStat: { ...; } | null; };
}>

Returns Promise<{
block: {
fileHash: string;
rootHash: string;
seqno: number;
shard: string;
workchain: number;
};
tx: Transaction;
}[]>

Returns Promise<{
shards: ({ workchain: number; seqno: number; shard: string; rootHash: string; fileHash: string; transactions: { account: string; hash: string; lt: string; }[]; })[];
}>

Returns Promise<{
shards: ({ workchain: number; seqno: number; shard: string; rootHash: string; fileHash: string; transactions: { account: string; hash: string; lt: string; }[]; })[];
}>

`Optional` ids: number[]

Returns Promise<{
config: { cell: string; address: string; globalBalance: { coins: string; }; };
}>

Returns Promise<{
init: { fileHash: string; rootHash: string; };
last: { seqno: number; shard: string; workchain: number; fileHash: string; rootHash: string; };
now: number;
stateRootHash: string;
}>

Returns Promise<{
block: { workchain: number; seqno: number; shard: string; rootHash: string; fileHash: string; };
changed: boolean;
}>

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

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

`Optional` args: TupleItem[]

Returns Promise<{
block: {
fileHash: string;
rootHash: string;
seqno: number;
shard: string;
workchain: number;
};
exitCode: number;
result: TupleItem[];
resultRaw: null | string;
shardBlock: {
fileHash: string;
rootHash: string;
seqno: number;
shard: string;
workchain: number;
};
}>

Returns Promise<{
status: number;
}>