@fuel-ts/account v0.94.1 • Docs
Class: BaseWalletUnlocked
BaseWalletUnlocked
provides the base functionalities for an unlocked wallet.
Extends
Extended by
Constructors
new BaseWalletUnlocked()
new BaseWalletUnlocked(
privateKey
,provider
?):BaseWalletUnlocked
Creates a new BaseWalletUnlocked instance.
Parameters
Parameter | Type | Description |
---|---|---|
privateKey | BytesLike | The private key of the wallet. |
provider ? | Provider | A Provider instance (optional). |
Returns
Overrides
Defined in
packages/account/src/wallet/base-wallet-unlocked.ts:40
Properties
Property | Modifier | Type | Default value | Description | Inherited from | Defined in |
---|---|---|---|---|---|---|
_connector? | protected | FuelConnector | undefined | The connector for use with external wallets | Account ._connector | packages/account/src/account.ts:85 |
_provider? | protected | Provider | undefined | The provider used to interact with the network. | Account ._provider | packages/account/src/account.ts:80 |
address | readonly | AbstractAddress | undefined | The address associated with the account. | Account .address | packages/account/src/account.ts:75 |
signer | public | () => Signer | undefined | A function that returns the wallet's signer. | - | packages/account/src/wallet/base-wallet-unlocked.ts:32 |
defaultPath | static | string | "m/44'/117999342./0" | Default HDWallet path. | - | packages/account/src/wallet/base-wallet-unlocked.ts:27 |
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.
Throws
FuelError
if the provider is not set.
set
provider(provider
):void
Sets the provider for the account.
Parameters
Parameter | Type | Description |
---|---|---|
provider | Provider | A Provider instance. |
Returns
A Provider instance.
Inherited from
Defined in
packages/account/src/account.ts:108
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
Parameter | 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.
Inherited from
Defined in
packages/account/src/account.ts:405
addTransfer()
addTransfer(
request
,transferParams
):ScriptTransactionRequest
Adds a transfer to the given transaction request.
Parameters
Parameter | 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.
Inherited from
Defined in
packages/account/src/account.ts:387
batchTransfer()
batchTransfer(
transferParams
,txParams
):Promise
<TransactionResponse
>
Transfers multiple amounts of a token to multiple recipients.
Parameters
Parameter | 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.
Inherited from
Defined in
packages/account/src/account.ts:370
connect()
connect(
provider
):Provider
Changes the provider connection for the account.
Parameters
Parameter | Type | Description |
---|---|---|
provider | Provider | A Provider instance. |
Returns
The updated Provider instance.
Inherited from
Defined in
packages/account/src/account.ts:131
createTransfer()
createTransfer(
destination
,amount
,assetId
?,txParams
?):Promise
<ScriptTransactionRequest
>
A helper that creates a transfer transaction request and returns it.
Parameters
Parameter | 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
<ScriptTransactionRequest
>
A promise that resolves to the prepared transaction request.
Inherited from
Defined in
packages/account/src/account.ts:332
encrypt()
encrypt(
password
):Promise
<string
>
Encrypts an unlocked wallet with a password.
Parameters
Parameter | Type | Description |
---|---|---|
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
Type Parameter | Description |
---|---|
T extends TransactionRequest | The type of the TransactionRequest. |
Parameters
Parameter | 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.
Inherited from
Defined in
packages/account/src/account.ts:201
generateFakeResources()
generateFakeResources(
coins
):Resource
[]
Generates an array of fake resources based on the provided coins.
Parameters
Parameter | Type | Description |
---|---|---|
coins | FakeResources [] | An array of FakeResources objects representing the coins. |
Returns
Resource
[]
An array of Resource
objects with generated properties.
Inherited from
Defined in
packages/account/src/account.ts:667
getBalance()
getBalance(
assetId
?):Promise
<BN
>
Retrieves the balance of the account for the given asset.
Parameters
Parameter | Type | Description |
---|---|---|
assetId ? | BytesLike | The asset ID to check the balance for (optional). |
Returns
Promise
<BN
>
A promise that resolves to the balance amount.
Inherited from
Defined in
packages/account/src/account.ts:178
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
Defined in
packages/account/src/account.ts:189
getCoins()
getCoins(
assetId
?,paginationArgs
?):Promise
<GetCoinsResponse
>
Retrieves coins owned by the account.
Parameters
Parameter | 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.
Inherited from
Defined in
packages/account/src/account.ts:156
getMessages()
getMessages(
paginationArgs
?):Promise
<GetMessagesResponse
>
Retrieves messages owned by the account.
Parameters
Parameter | Type |
---|---|
paginationArgs ? | CursorPaginationArgs |
Returns
Promise
<GetMessagesResponse
>
A promise that resolves to an array of Messages.
Inherited from
Defined in
packages/account/src/account.ts:168
getResourcesToSpend()
getResourcesToSpend(
quantities
,excludedIds
?):Promise
<Resource
[]>
Retrieves resources satisfying the spend query for the account.
Parameters
Parameter | 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.
Inherited from
Defined in
packages/account/src/account.ts:143
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
Parameter | Type | Description |
---|---|---|
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
Defined in
packages/account/src/account.ts:528
populateTransactionWitnessesSignature()
populateTransactionWitnessesSignature<
T
>(transactionRequestLike
):Promise
<T
>
Populates a transaction with the witnesses signature.
Type Parameters
Type Parameter |
---|
T extends TransactionRequest |
Parameters
Parameter | Type | Description |
---|---|---|
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
Parameter | Type | Description |
---|---|---|
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
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
Parameter | Type | Description |
---|---|---|
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
Parameter | Type | Description |
---|---|---|
transactionRequestLike | TransactionRequestLike | The transaction request to sign. |
Returns
Promise
<string
>
A promise that resolves to the signature as a ECDSA 64 bytes string.
Overrides
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
Parameter | Type | Description |
---|---|---|
transactionRequestLike | TransactionRequestLike | The transaction request to simulate. |
__namedParameters | EstimateTransactionParams | - |
Returns
Promise
<CallResult
>
A promise that resolves to the CallResult object.
Overrides
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
Parameter | 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.
Inherited from
Defined in
packages/account/src/account.ts:353
transferToContract()
transferToContract(
contractId
,amount
,assetId
?,txParams
?):Promise
<TransactionResponse
>
Transfers coins to a contract address.
Parameters
Parameter | 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.
Inherited from
Defined in
packages/account/src/account.ts:426
withdrawToBaseLayer()
withdrawToBaseLayer(
recipient
,amount
,txParams
):Promise
<TransactionResponse
>
Withdraws an amount of the base asset to the base chain.
Parameters
Parameter | 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.
Inherited from
Defined in
packages/account/src/account.ts:479