Class: Account
@fuel-ts/account.Account
Account provides an abstraction for interacting with accounts or wallets on the network.
Hierarchy
↳
Account↳↳
WalletLocked↳↳
Predicate
Constructors
constructor
• new Account(address, provider?, connector?): Account
Creates a new Account instance.
Parameters
| Name | Type | Description |
|---|---|---|
address | string | AbstractAddress | The address of the account. |
provider? | Provider | A Provider instance (optional). |
connector? | FuelConnector | A FuelConnector instance (optional). |
Returns
Overrides
Defined in
packages/account/src/account.ts:92
Properties
_connector
• Protected Optional _connector: FuelConnector
The connector for use with external wallets
Defined in
packages/account/src/account.ts:83
_provider
• Protected Optional _provider: Provider
The provider used to interact with the network.
Defined in
packages/account/src/account.ts:78
address
• Readonly address: AbstractAddress
The address associated with the account.
Overrides
Defined in
packages/account/src/account.ts:73
Accessors
provider
• get provider(): Provider
The provider used to interact with the network.
Throws
FuelError if the provider is not set.
Returns
A Provider instance.
Overrides
AbstractAccount.provider
Defined in
packages/account/src/account.ts:106
• set provider(provider): void
Sets the provider for the account.
Parameters
| Name | Type | Description |
|---|---|---|
provider | Provider | A Provider instance. |
Returns
void
Overrides
AbstractAccount.provider
Defined in
packages/account/src/account.ts:119
Methods
addBatchTransfer
▸ addBatchTransfer(request, transferParams): ScriptTransactionRequest
Adds multiple transfers to a script transaction request.
Parameters
| Name | Type | Description |
|---|---|---|
request | ScriptTransactionRequest | The script transaction request to add transfers to. |
transferParams | TransferParams[] | An array of TransferParams objects representing the transfers to be made. |
Returns
The updated script transaction request.
Defined in
packages/account/src/account.ts:389
addTransfer
▸ addTransfer(request, transferParams): ScriptTransactionRequest
Adds a transfer to the given transaction request.
Parameters
| Name | Type | Description |
|---|---|---|
request | ScriptTransactionRequest | The script transaction request to add transfers to. |
transferParams | TransferParams | The object representing the transfer to be made. |
Returns
The updated transaction request with the added transfer.
Defined in
packages/account/src/account.ts:371
batchTransfer
▸ batchTransfer(transferParams, txParams?): Promise<TransactionResponse>
Transfers multiple amounts of a token to multiple recipients.
Parameters
| Name | Type | Description |
|---|---|---|
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.
Defined in
packages/account/src/account.ts:354
connect
▸ connect(provider): Provider
Changes the provider connection for the account.
Parameters
| Name | Type | Description |
|---|---|---|
provider | Provider | A Provider instance. |
Returns
The updated Provider instance.
Defined in
packages/account/src/account.ts:129
createTransfer
▸ createTransfer(destination, amount, assetId?, txParams?): Promise<TransactionRequest>
A helper that creates a transfer transaction request and returns it.
Parameters
| Name | Type | Description |
|---|---|---|
destination | string | AbstractAddress | The address of the destination. |
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<TransactionRequest>
A promise that resolves to the prepared transaction request.
Defined in
packages/account/src/account.ts:316
fund
▸ fund<T>(request, params): Promise<T>
Funds a transaction request by adding the necessary resources.
Type parameters
| Name | Type | Description |
|---|---|---|
T | extends TransactionRequest | The type of the TransactionRequest. |
Parameters
| Name | Type | Description |
|---|---|---|
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.
Overrides
Defined in
packages/account/src/account.ts:199
generateFakeResources
▸ generateFakeResources(coins): Resource[]
Generates an array of fake resources based on the provided coins.
Parameters
| Name | Type | Description |
|---|---|---|
coins | FakeResources[] | An array of FakeResources objects representing the coins. |
Returns
Resource[]
An array of Resource objects with generated properties.
Defined in
packages/account/src/account.ts:584
getBalance
▸ getBalance(assetId?): Promise<BN>
Retrieves the balance of the account for the given asset.
Parameters
| Name | Type | Description |
|---|---|---|
assetId? | BytesLike | The asset ID to check the balance for (optional). |
Returns
Promise<BN>
A promise that resolves to the balance amount.
Defined in
packages/account/src/account.ts:176
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.
Defined in
packages/account/src/account.ts:187
getCoins
▸ getCoins(assetId?, paginationArgs?): Promise<GetCoinsResponse>
Retrieves coins owned by the account.
Parameters
| Name | Type | Description |
|---|---|---|
assetId? | BytesLike | The asset ID of the coins to retrieve (optional). |
paginationArgs? | CursorPaginationArgs | - |
Returns
Promise<GetCoinsResponse>
A promise that resolves to an array of Coins.
Defined in
packages/account/src/account.ts:154
getMessages
▸ getMessages(paginationArgs?): Promise<GetMessagesResponse>
Retrieves messages owned by the account.
Parameters
| Name | Type |
|---|---|
paginationArgs? | CursorPaginationArgs |
Returns
Promise<GetMessagesResponse>
A promise that resolves to an array of Messages.
Defined in
packages/account/src/account.ts:166
getResourcesToSpend
▸ getResourcesToSpend(quantities, excludedIds?): Promise<Resource[]>
Retrieves resources satisfying the spend query for the account.
Parameters
| Name | Type | Description |
|---|---|---|
quantities | CoinQuantityLike[] | Quantities of resources to be obtained. |
excludedIds? | ExcludeResourcesOption | IDs of resources to be excluded from the query (optional). |
Returns
Promise<Resource[]>
A promise that resolves to an array of Resources.
Overrides
AbstractAccount.getResourcesToSpend
Defined in
packages/account/src/account.ts:141
sendTransaction
▸ sendTransaction(transactionRequestLike, sendTransactionParams?): Promise<TransactionResponse>
Sends a transaction to the network.
Parameters
| Name | Type | Description |
|---|---|---|
transactionRequestLike | TransactionRequestLike | The transaction request to be sent. |
sendTransactionParams | ProviderSendTxParams | The provider send transaction parameters (optional). |
Returns
Promise<TransactionResponse>
A promise that resolves to the transaction response.
Overrides
AbstractAccount.sendTransaction
Defined in
packages/account/src/account.ts:541
signTransaction
▸ signTransaction(transactionRequestLike): Promise<string>
Signs a transaction from the account via the connector..
Parameters
| Name | Type | Description |
|---|---|---|
transactionRequestLike | TransactionRequestLike | The transaction request to sign. |
Returns
Promise<string>
A promise that resolves to the signature of the transaction.
Defined in
packages/account/src/account.ts:524
simulateTransaction
▸ simulateTransaction(transactionRequestLike, estimateTxParams?): Promise<CallResult>
Simulates a transaction.
Parameters
| Name | Type | Description |
|---|---|---|
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.
Overrides
AbstractAccount.simulateTransaction
Defined in
packages/account/src/account.ts:567
transfer
▸ transfer(destination, amount, assetId?, txParams?): Promise<TransactionResponse>
Transfers coins to a destination address.
Parameters
| Name | Type | Description |
|---|---|---|
destination | string | AbstractAddress | The address of the destination. |
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.
Defined in
packages/account/src/account.ts:337
transferToContract
▸ transferToContract(contractId, amount, assetId?, txParams?): Promise<TransactionResponse>
Transfers coins to a contract address.
Parameters
| Name | Type | Description |
|---|---|---|
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.
Defined in
packages/account/src/account.ts:410
withdrawToBaseLayer
▸ withdrawToBaseLayer(recipient, amount, txParams?): Promise<TransactionResponse>
Withdraws an amount of the base asset to the base chain.
Parameters
| Name | Type | Description |
|---|---|---|
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.
Defined in
packages/account/src/account.ts:464