Class WalletLocked

Readonlyaddress

provider

• get provider(): Provider

• The provider used to interact with the network.

  Returns Provider

  A Provider instance.

  Throws

  FuelError if the provider is not set.

• set provider(provider): void

• Sets the provider for the account.

  Parameters

  • provider: Provider

    A Provider instance.

  Returns void

addBatchTransfer

• addBatchTransfer(request, transferParams): ScriptTransactionRequest

• Adds multiple transfers to a script transaction request.

  Parameters

  • request: ScriptTransactionRequest

    The script transaction request to add transfers to.
  • transferParams: TransferParams[]

    An array of TransferParams objects representing the transfers to be made.

  Returns ScriptTransactionRequest

  The updated script transaction request.

addTransfer

• addTransfer(request, transferParams): ScriptTransactionRequest

• Adds a transfer to the given transaction request.

  Parameters

  • request: ScriptTransactionRequest

    The script transaction request to add transfers to.
  • transferParams: TransferParams

    The object representing the transfer to be made.

  Returns ScriptTransactionRequest

  The updated transaction request with the added transfer.

batchTransfer

• batchTransfer(transferParams, txParams?): Promise<TransactionResponse>

• Transfers multiple amounts of a token to multiple recipients.

  Parameters

  • transferParams: TransferParams[]

    An array of TransferParams objects representing the transfers to be made.
  • txParams: TxParamsType = {}

    Optional transaction parameters.

  Returns Promise<TransactionResponse>

  A promise that resolves to a TransactionResponse object representing the transaction result.

batchTransferToContracts

• batchTransferToContracts(contractTransferParams, txParams?): Promise<TransactionResponse>

• Parameters

  • contractTransferParams: ContractTransferParams[]
  • txParams: TxParamsType = {}

  Returns Promise<TransactionResponse>

connect

• connect(provider): Provider

• Changes the provider connection for the account.

  Parameters

  • provider: Provider

    A Provider instance.

  Returns Provider

  The updated Provider instance.

createTransfer

• createTransfer(destination, amount, assetId?, txParams?): Promise<ScriptTransactionRequest>

• A helper that creates a transfer transaction request and returns it.

  Parameters

  • destination: string | Address

    The address of the destination.
  • amount: BigNumberish

    The amount of coins to transfer.
  • OptionalassetId: BytesLike

    The asset ID of the coins to transfer (optional).
  • txParams: TxParamsType = {}

    The transaction parameters (optional).

  Returns Promise<ScriptTransactionRequest>

  A promise that resolves to the prepared transaction request.

fund

• fund<T>(request, params): Promise<T>

• Funds a transaction request by adding the necessary resources.

  Type Parameters

  • T extends TransactionRequest

    The type of the TransactionRequest.

  Parameters

  • request: T

    The transaction request to fund.
  • params: EstimatedTxParams

    The estimated transaction parameters.

  Returns Promise<T>

  A promise that resolves to the funded transaction request.

generateFakeResources

• generateFakeResources(coins): Resource[]

• Generates an array of fake resources based on the provided coins.

  Parameters

  • coins: FakeResources[]

    An array of FakeResources objects representing the coins.

  Returns Resource[]

  An array of Resource objects with generated properties.

getBalance

• getBalance(assetId?): Promise<BN>

• Retrieves the balance of the account for the given asset.

  Parameters

  • OptionalassetId: BytesLike

    The asset ID to check the balance for (optional).

  Returns Promise<BN>

  A promise that resolves to the balance amount.

getBalances

• getBalances(): Promise<GetBalancesResponse>

• Retrieves all the balances for the account.

  Returns Promise<GetBalancesResponse>

  A promise that resolves to an array of Coins and their quantities.

getCoins

• getCoins(assetId?, paginationArgs?): Promise<GetCoinsResponse>

• Retrieves coins owned by the account.

  Parameters

  • OptionalassetId: BytesLike

    The asset ID of the coins to retrieve (optional).
  • OptionalpaginationArgs: CursorPaginationArgs

  Returns Promise<GetCoinsResponse>

  A promise that resolves to an array of Coins.

getMessages

• getMessages(paginationArgs?): Promise<GetMessagesResponse>

• Retrieves messages owned by the account.

  Parameters

  • OptionalpaginationArgs: CursorPaginationArgs

  Returns Promise<GetMessagesResponse>

  A promise that resolves to an array of Messages.

getResourcesToSpend

• getResourcesToSpend(quantities, excludedIds?): Promise<Resource[]>

• Retrieves resources satisfying the spend query for the account.

  Parameters

  • quantities: CoinQuantityLike[]

    Quantities of resources to be obtained.
  • OptionalexcludedIds: ExcludeResourcesOption

    IDs of resources to be excluded from the query (optional).

  Returns Promise<Resource[]>

  A promise that resolves to an array of Resources.

getTransactionCost

• getTransactionCost(transactionRequestLike, transactionCostParams?): Promise<TransactionCost>

• Returns a transaction cost to enable user to set gasLimit and also reserve balance amounts on the transaction.

  Parameters

  • transactionRequestLike: TransactionRequestLike

    The transaction request object.
  • transactionCostParams: TransactionCostParams = {}

    The transaction cost parameters (optional).

  Returns Promise<TransactionCost>

  A promise that resolves to the transaction cost object.

sendTransaction

• sendTransaction(transactionRequestLike, sendTransactionParams?): Promise<TransactionResponse>

• Sends a transaction to the network.

  Parameters

  • transactionRequestLike: TransactionRequestLike

    The transaction request to be sent.
  • sendTransactionParams: AccountSendTxParams = {}

    The provider send transaction parameters (optional).

  Returns Promise<TransactionResponse>

  A promise that resolves to the transaction response.

signTransaction

• signTransaction(transactionRequestLike): Promise<string>

• Signs a transaction from the account via the connector..

  Parameters

  • transactionRequestLike: TransactionRequestLike

    The transaction request to sign.

  Returns Promise<string>

  A promise that resolves to the signature of the transaction.

simulateTransaction

• simulateTransaction(transactionRequestLike, estimateTxParams?): Promise<CallResult>

• Simulates a transaction.

  Parameters

  • transactionRequestLike: TransactionRequestLike

    The transaction request to be simulated.
  • estimateTxParams: EstimateTransactionParams = {}

    The estimate transaction params (optional).

  Returns Promise<CallResult>

  A promise that resolves to the call result.

transfer

• transfer(destination, amount, assetId?, txParams?): Promise<TransactionResponse>

• Transfers coins to a destination address.

  Parameters

  • destination: string | Address

    The address of the destination.
  • amount: BigNumberish

    The amount of coins to transfer.
  • OptionalassetId: BytesLike

    The asset ID of the coins to transfer (optional).
  • txParams: TxParamsType = {}

    The transaction parameters (optional).

  Returns Promise<TransactionResponse>

  A promise that resolves to the transaction response.

transferToContract

• transferToContract(contractId, amount, assetId, txParams?): Promise<TransactionResponse>

• Transfers coins to a contract address.

  Parameters

  • contractId: string | Address

    The address of the contract.
  • amount: BigNumberish

    The amount of coins to transfer.
  • assetId: BytesLike

    The asset ID of the coins to transfer (optional).
  • txParams: TxParamsType = {}

    The transaction parameters (optional).

  Returns Promise<TransactionResponse>

  A promise that resolves to the transaction response.

withdrawToBaseLayer

• withdrawToBaseLayer(recipient, amount, txParams?): Promise<TransactionResponse>

• Withdraws an amount of the base asset to the base chain.

  Parameters

  • recipient: string | Address

    Address of the recipient on the base chain.
  • amount: BigNumberish

    Amount of base asset.
  • txParams: TxParamsType = {}

    The transaction parameters (optional).

  Returns Promise<TransactionResponse>

  A promise that resolves to the transaction response.