Class TonClient4

Constructors

constructor

Properties

#private

Methods

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

Constructors

constructor

Properties

Private #private

#private: any

Methods

getAccount

  • getAccount(seqno, address): Promise<{
        account: {
            balance: {
                coins: string;
            };
            last: null | {
                hash: string;
                lt: string;
            };
            state: {
                type: "uninit";
            } | {
                code: null | string;
                data: null | string;
                type: "active";
            } | {
                stateHash: string;
                type: "frozen";
            };
            storageStat: null | {
                duePayment: null | string;
                lastPaid: number;
                used: {
                    bits: number;
                    cells: number;
                    publicCells: number;
                };
            };
        };
        block: {
            fileHash: string;
            rootHash: string;
            seqno: number;
            shard: string;
            workchain: number;
        };
    }>

  • Get block info by unix timestamp

    Parameters

    • seqno: number

      block sequence number

    • address: Address

      account address

    Returns Promise<{
        account: {
            balance: {
                coins: string;
            };
            last: null | {
                hash: string;
                lt: string;
            };
            state: {
                type: "uninit";
            } | {
                code: null | string;
                data: null | string;
                type: "active";
            } | {
                stateHash: string;
                type: "frozen";
            };
            storageStat: null | {
                duePayment: null | string;
                lastPaid: number;
                used: {
                    bits: number;
                    cells: number;
                    publicCells: number;
                };
            };
        };
        block: {
            fileHash: string;
            rootHash: string;
            seqno: number;
            shard: string;
            workchain: number;
        };
    }>

    account info

getAccountLite

  • getAccountLite(seqno, address): Promise<{
        account: {
            balance: {
                coins: string;
            };
            last: null | {
                hash: string;
                lt: string;
            };
            state: {
                type: "uninit";
            } | {
                codeHash: string;
                dataHash: string;
                type: "active";
            } | {
                stateHash: string;
                type: "frozen";
            };
            storageStat: null | {
                duePayment: null | string;
                lastPaid: number;
                used: {
                    bits: number;
                    cells: number;
                    publicCells: number;
                };
            };
        };
    }>

  • Get account lite info (without code and data)

    Parameters

    • seqno: number

      block sequence number

    • address: Address

      account address

    Returns Promise<{
        account: {
            balance: {
                coins: string;
            };
            last: null | {
                hash: string;
                lt: string;
            };
            state: {
                type: "uninit";
            } | {
                codeHash: string;
                dataHash: string;
                type: "active";
            } | {
                stateHash: string;
                type: "frozen";
            };
            storageStat: null | {
                duePayment: null | string;
                lastPaid: number;
                used: {
                    bits: number;
                    cells: number;
                    publicCells: number;
                };
            };
        };
    }>

    account lite info

getAccountTransactions

  • getAccountTransactions(address, lt, hash): Promise<{
        block: {
            fileHash: string;
            rootHash: string;
            seqno: number;
            shard: string;
            workchain: number;
        };
        tx: Transaction;
    }[]>

  • Load unparsed account 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;
    }[]>

    unparsed transactions

getAccountTransactionsParsed

  • getAccountTransactionsParsed(address, lt, hash, count?): Promise<ParsedTransactions>

  • Load parsed account transactions

    Parameters

    • address: Address

      address

    • lt: bigint

      last transaction lt

    • hash: Buffer

      last transaction hash

    • Optional count: number

      number of transactions to load

    Returns Promise<ParsedTransactions>

    parsed transactions

getBlock

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

  • Get block info

    Parameters

    • seqno: number

      block sequence number

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

    block info

getBlockByUtime

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

  • Get block info by unix timestamp

    Parameters

    • ts: number

      unix timestamp

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

    block info

getConfig

  • getConfig(seqno, ids?): Promise<{
        config: {
            address: string;
            cell: string;
            globalBalance: {
                coins: string;
            };
        };
    }>

  • Get network config

    Parameters

    • seqno: number

      block sequence number

    • Optional ids: number[]

      optional config ids

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

    network config

getLastBlock

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

  • Get Last Block

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

    last block info

isAccountChanged

  • isAccountChanged(seqno, address, lt): Promise<{
        block: {
            fileHash: string;
            rootHash: string;
            seqno: number;
            shard: string;
            workchain: number;
        };
        changed: boolean;
    }>

  • Check if account was updated since

    Parameters

    • seqno: number

      block sequence number

    • address: Address

      account address

    • lt: bigint

      account last transaction lt

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

    account change info

isContractDeployed

  • isContractDeployed(seqno, address): Promise<boolean>

  • Check if contract is deployed

    Parameters

    • seqno: number
    • address: Address

      addres to check

    Returns Promise<boolean>

    true if contract is in active state

open

  • open<T>(contract): OpenedContract<T>

  • Open smart contract

    Type Parameters

    • T extends Contract

    Parameters

    • contract: T

      contract

    Returns OpenedContract<T>

    opened contract

openAt

  • openAt<T>(block, contract): OpenedContract<T>

  • Open smart contract

    Type Parameters

    • T extends Contract

    Parameters

    • block: number

      block number

    • contract: T

      contract

    Returns OpenedContract<T>

    opened contract

provider

  • provider(address, init?): ContractProvider

  • Create provider

    Parameters

    • address: Address

      address

    • Optional init: null | StateInit

      optional init data

    Returns ContractProvider

    provider

providerAt

  • providerAt(block, address, init?): ContractProvider

  • Create provider at specified block number

    Parameters

    • block: number

      block number

    • address: Address

      address

    • Optional init: null | StateInit

      optional init data

    Returns ContractProvider

    provider

runMethod

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

  • Execute run method

    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;
        reader: TupleReader;
        result: TupleItem[];
        resultRaw: null | string;
        shardBlock: {
            fileHash: string;
            rootHash: string;
            seqno: number;
            shard: string;
            workchain: number;
        };
    }>

    method result

sendMessage

  • sendMessage(message): Promise<{
        status: any;
    }>

  • Send external message

    Parameters

    • message: Buffer

      message boc

    Returns Promise<{
        status: any;
    }>

    message status

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc