Class TON

constructor

• new TON(rpc_url): xmcore.TON

• Parameters

  • rpc_url: string

  Returns xmcore.TON

provider

signer

wallet

cellsToSendableFile

• cellsToSendableFile(cells): Promise<Buffer<ArrayBufferLike>[]>

• Prepare a cell to be sent to the network.

  Parameters

  • cells: Cell[]

  Returns Promise<Buffer<ArrayBufferLike>[]>

  The cell as a sendable file

connect

• connect(): Promise<boolean>

• Connects to the RPC provider

  Returns Promise<boolean>

  A boolean indicating if the connection was successful

connectWallet

• connectWallet(mnemonics): Promise<WalletContractV4>

• Connects to a wallet using a private key

  Parameters

  • mnemonics: string

  Returns Promise<WalletContractV4>

  The wallet object

getAddress

• getAddress(): string

• Returns the address of the connected wallet

  Returns string

getBalance

• getBalance(address): Promise<string>

• Gets the balance of a wallet

  Parameters

  • address: string

    The wallet address

  Returns Promise<string>

  The balance of the wallet as a string

getEmptyTransaction

• getEmptyTransaction(): Promise<Builder>

• Creates a skeleton transaction

  Returns Promise<Builder>

preparePay

• preparePay(receiver, amount, options?): Promise<Buffer<ArrayBufferLike>>
• Alias

  Creates a signed transaction to transfer default chain currency

  Parameters

  • receiver: string

    The receiver's address
  • amount: string

    The amount to transfer
  • Optionaloptions: {
        privateKey: string;
    }

    Options

    • privateKey: string

      A private key mnemonic to use for signing the transaction(s) instead of the connected wallet

  Returns Promise<Buffer<ArrayBufferLike>>

  The signed transaction

  prepareTransfer

preparePays

• preparePays(payments, options?): Promise<Buffer<ArrayBufferLike>[]>

• Creates a list of signed transactions to transfer default chain currency

  Parameters

  • payments: IPayOptions[]

    A list of transfers to prepare
  • Optionaloptions: {
        privateKey: string;
    }

    Options

    • privateKey: string

      A private key mnemonic to use for signing the transaction(s) instead of the connected wallet

  Returns Promise<Buffer<ArrayBufferLike>[]>

  An ordered list of signed transactions

setRpc

• setRpc(rpc_url): void

• Sets the RPC URL only. Use await instance.connect() to connect to the rpc provider

  Parameters

  • rpc_url: string

  Returns void

signMessage

• signMessage(message, options?): Promise<string>

• Signs a message using the connected wallet

  Parameters

  • message: string

    The message to sign
  • Optionaloptions: {
        privateKey?: string;
    }

    Options

    • OptionalprivateKey?: string

  Returns Promise<string>

  The signed message

signTransaction

• signTransaction(tx): Promise<Cell>

• Signs a transaction using the connected wallet

  Parameters

  • tx: Cell

    The transaction to sign

  Returns Promise<Cell>

  The signed transaction

signTransactions

• signTransactions(txs): Promise<Cell[]>

• Signs a list of transactions using the connected wallet. The transaction nonce is incremented for each transaction in order of appearance.

  Parameters

  • txs: Cell[]

  Returns Promise<Cell[]>

verifyMessage

• verifyMessage(message, signature, publicKey): Promise<boolean>

• Verifies a message using the connected wallet

  Parameters

  • message: string

    The message to verify
  • signature: string

    The signature to verify
  • publicKey: string

  Returns Promise<boolean>

  A boolean indicating if the message was verified