Class BaseWalletUnlocked

BaseWalletUnlocked provides the base functionalities for an unlocked wallet.

Hierarchy (view full)

Account
- BaseWalletUnlocked
  - WalletUnlocked

Constructors

constructor

new BaseWalletUnlocked(privateKey, provider?): BaseWalletUnlocked
Creates a new BaseWalletUnlocked instance.
Parameters
- privateKey: BytesLike
  The private key of the wallet.
- Optionalprovider: Provider
  A Provider instance (optional).
Returns BaseWalletUnlocked
Overrides Account.constructor
- Defined in packages/account/src/wallet/base-wallet-unlocked.ts:40

Properties

`Protected` `Optional`_connector

_connector?: FuelConnector

The connector for use with external wallets

`Protected` `Optional`_provider

_provider?: Provider

The provider used to interact with the network.

`Readonly`address

address: AbstractAddress

The address associated with the account.

signer

signer: (() => Signer)

A function that returns the wallet's signer.

`Static`defaultPath

defaultPath: string = "m/44'/1179993420'/0'/0/0"

Default HDWallet path.

Accessors

privateKey

get privateKey(): string
Gets the private key of the wallet.

Returns string
The private key of the wallet.
- Defined in packages/account/src/wallet/base-wallet-unlocked.ts:51

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.
Inherited from Account.provider
- Defined in packages/account/src/account.ts:116
set provider(provider): void
Sets the provider for the account.
Parameters
- provider: Provider
  A Provider instance.
Returns void
Inherited from Account.provider
- Defined in packages/account/src/account.ts:129

publicKey

get publicKey(): string
Gets the public key of the wallet.

Returns string
- Defined in packages/account/src/wallet/base-wallet-unlocked.ts:60

Methods

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.
Inherited from Account.addBatchTransfer
- Defined in packages/account/src/account.ts:419

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.
Inherited from Account.addTransfer
- Defined in packages/account/src/account.ts:405

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.
Inherited from Account.batchTransfer
- Defined in packages/account/src/account.ts:388

batchTransferToContracts

batchTransferToContracts(contractTransferParams, txParams?): Promise<TransactionResponse>
Parameters
- contractTransferParams: ContractTransferParams[]
- txParams: TxParamsType = {}
Returns Promise<TransactionResponse>
Inherited from Account.batchTransferToContracts
- Defined in packages/account/src/account.ts:448

connect

connect(provider): Provider
Changes the provider connection for the account.
Parameters
- provider: Provider
  A Provider instance.
Returns Provider
The updated Provider instance.
Inherited from Account.connect
- Defined in packages/account/src/account.ts:139

createTransfer

createTransfer(destination, amount, assetId?, txParams?): Promise<ScriptTransactionRequest>
A helper that creates a transfer transaction request and returns it.
Parameters
- destination: string | AbstractAddress
  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.
Inherited from Account.createTransfer
- Defined in packages/account/src/account.ts:343

encrypt

encrypt(password): Promise<string>
Encrypts an unlocked wallet with a password.
Parameters
- password: string
  the password to encrypt the wallet with.
Returns Promise<string>
- the encrypted wallet.
- Defined in packages/account/src/wallet/base-wallet-unlocked.ts:156

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.
Inherited from Account.fund
- Defined in packages/account/src/account.ts:209

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.
Inherited from Account.generateFakeResources
- Defined in packages/account/src/account.ts:691

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.
Inherited from Account.getBalance
- Defined in packages/account/src/account.ts:186

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.
Inherited from Account.getBalances
- Defined in packages/account/src/account.ts:197

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.
Inherited from Account.getCoins
- Defined in packages/account/src/account.ts:164

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.
Inherited from Account.getMessages
- Defined in packages/account/src/account.ts:176

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.
Inherited from Account.getResourcesToSpend
- Defined in packages/account/src/account.ts:151

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.
Inherited from Account.getTransactionCost
- Defined in packages/account/src/account.ts:550

populateTransactionWitnessesSignature

populateTransactionWitnessesSignature<T>(transactionRequestLike): Promise<T>
Populates a transaction with the witnesses signature.
Type Parameters
- T extends TransactionRequest
Parameters
- transactionRequestLike: TransactionRequestLike
  The transaction request to populate.
Returns Promise<T>
The populated transaction request.
- Defined in packages/account/src/wallet/base-wallet-unlocked.ts:95

sendTransaction

sendTransaction(transactionRequestLike, estimateTxDependencies?): Promise<TransactionResponse>
Populates the witness signature for a transaction and sends it to the network using provider.sendTransaction.
Parameters
- transactionRequestLike: TransactionRequestLike
  The transaction request to send.
- estimateTxDependencies: EstimateTransactionParams = {}
  Whether to estimate the transaction dependencies.
Returns Promise<TransactionResponse>
A promise that resolves to the TransactionResponse object.
Overrides Account.sendTransaction
- Defined in packages/account/src/wallet/base-wallet-unlocked.ts:113

signMessage

signMessage(message): Promise<string>
Signs a message with the wallet's private key.
Parameters
- message: string
  The message to sign.
Returns Promise<string>
A promise that resolves to the signature as a ECDSA 64 bytes string.
Overrides Account.signMessage
- Defined in packages/account/src/wallet/base-wallet-unlocked.ts:70

signTransaction

signTransaction(transactionRequestLike): Promise<string>
Signs a transaction with the wallet's private key.
Parameters
- transactionRequestLike: TransactionRequestLike
  The transaction request to sign.
Returns Promise<string>
A promise that resolves to the signature as a ECDSA 64 bytes string.
Overrides Account.signTransaction
- Defined in packages/account/src/wallet/base-wallet-unlocked.ts:81

simulateTransaction

simulateTransaction(transactionRequestLike, __namedParameters?): Promise<CallResult>
Populates the witness signature for a transaction and sends a call to the network using provider.dryRun.
Parameters
- transactionRequestLike: TransactionRequestLike
  The transaction request to simulate.
- __namedParameters: EstimateTransactionParams = {}
Returns Promise<CallResult>
A promise that resolves to the CallResult object.
Overrides Account.simulateTransaction
- Defined in packages/account/src/wallet/base-wallet-unlocked.ts:133

transfer

transfer(destination, amount, assetId?, txParams?): Promise<TransactionResponse>
Transfers coins to a destination address.
Parameters
- destination: string | AbstractAddress
  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.
Inherited from Account.transfer
- Defined in packages/account/src/account.ts:371

transferToContract

transferToContract(contractId, amount, assetId, txParams?): Promise<TransactionResponse>
Transfers coins to a contract address.
Parameters
- contractId: string | AbstractAddress
  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.
Inherited from Account.transferToContract
- Defined in packages/account/src/account.ts:439

withdrawToBaseLayer

withdrawToBaseLayer(recipient, amount, txParams?): Promise<TransactionResponse>
Withdraws an amount of the base asset to the base chain.
Parameters
- recipient: string | AbstractAddress
  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.
Inherited from Account.withdrawToBaseLayer
- Defined in packages/account/src/account.ts:501

Class BaseWalletUnlocked

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns BaseWalletUnlocked

Properties

Protected Optional_connector

Protected Optional_provider

Readonlyaddress

signer

StaticdefaultPath

Accessors

privateKey

Returns string

provider

Returns Provider

Throws

Parameters

Returns void

publicKey

Returns string

Methods

addBatchTransfer

Parameters

Returns ScriptTransactionRequest

addTransfer

Parameters

Returns ScriptTransactionRequest

batchTransfer

Parameters

Returns Promise<TransactionResponse>

batchTransferToContracts

Parameters

Returns Promise<TransactionResponse>

connect

Parameters

Returns Provider

createTransfer

Parameters

Returns Promise<ScriptTransactionRequest>

encrypt

Parameters

Returns Promise<string>

fund

Type Parameters

Parameters

Returns Promise<T>

generateFakeResources

Parameters

Returns Resource[]

getBalance

Parameters

Returns Promise<BN>

getBalances

Returns Promise<GetBalancesResponse>

getCoins

Parameters

Returns Promise<GetCoinsResponse>

getMessages

Parameters

Returns Promise<GetMessagesResponse>

getResourcesToSpend

Parameters

Returns Promise<Resource[]>

getTransactionCost

Parameters

Returns Promise<TransactionCost>

populateTransactionWitnessesSignature

Type Parameters

Parameters

Returns Promise<T>

sendTransaction

Parameters

Returns Promise<TransactionResponse>

`Protected` `Optional`_connector

`Protected` `Optional`_provider

`Readonly`address

`Static`defaultPath