@fuel-ts/account .WalletUnlocked
WalletUnlocked provides the functionalities for an unlocked wallet.
•
new WalletUnlocked(
privateKey,
provider?):
WalletUnlocked Creates a new BaseWalletUnlocked instance.
| Name | Type | Description |
|---|
privateKey | BytesLike | The private key of the wallet. |
provider? | Provider | A Provider instance (optional). |
•
Protected Optional _connector:
FuelConnector
•
Protected Optional _provider:
Provider The provider used to interact with the network.
•
Readonly address:
AbstractAddress The address associated with the account.
A function that returns the wallet's signer.
▪ Static defaultPath: string = "m/44'/1179993420'/0'/0/0"
Default HDWallet path.
• get privateKey(): string
Gets the private key of the wallet.
string
The private key of the wallet.
BaseWalletUnlocked.privateKey
•
get provider():
Provider The provider used to interact with the network.
Throws
FuelError if the provider is not set.
A Provider instance.
BaseWalletUnlocked.provider
• set provider(provider): void
Sets the provider for the account.
| Name | Type | Description |
|---|
provider | Provider | A Provider instance. |
void
BaseWalletUnlocked.provider
• get publicKey(): string
Gets the public key of the wallet.
string
BaseWalletUnlocked.publicKey
▸
connect(
provider):
Provider Changes the provider connection for the account.
| Name | Type | Description |
|---|
provider | Provider | A Provider instance. |
The updated Provider instance.
▸
createTransfer(
destination,
amount,
assetId?,
txParams?):
Promise<
TransactionRequest >
A helper that creates a transfer transaction request and returns it.
| Name | Type | Default value | Description |
|---|
destination | string | AbstractAddress | undefined | The address of the destination. |
amount | BigNumberish | undefined | The amount of coins to transfer. |
assetId | BytesLike | BaseAssetId | The asset ID of the coins to transfer. |
txParams | TxParamsType | {} | The transaction parameters (gasLimit, gasPrice, maturity). |
A promise that resolves to the prepared transaction request.
▸ encrypt(password): Promise<string>
Promise<string>
Icon Linkfund
▸ fund<T>(request, coinQuantities, fee): Promise<void>
Adds resources to the transaction enough to fund it.
| Name | Type | Description |
|---|
request | T | The transaction request. |
coinQuantities | CoinQuantity [] | The coin quantities required to execute the transaction. |
fee | BN | The estimated transaction fee. |
Promise<void>
A promise that resolves when the resources are added to the transaction.
▸ getBalance(assetId?): Promise<BN>
Retrieves the balance of the account for the given asset.
| Name | Type | Default value | Description |
|---|
assetId | BytesLike | BaseAssetId | The asset ID to check the balance for. |
Promise<BN>
A promise that resolves to the balance amount.
▸
getBalances():
Promise<
CoinQuantity []>
Retrieves all the balances for the account.
A promise that resolves to an array of Coins and their quantities.
▸
getCoins(
assetId?):
Promise<
Coin []>
Retrieves coins owned by the account.
| Name | Type | Description |
|---|
assetId? | BytesLike | The asset ID of the coins to retrieve. |
A promise that resolves to an array of Coins.
▸
getMessages():
Promise<
Message []>
Retrieves messages owned by the account.
A promise that resolves to an array of Messages.
▸
getResourcesToSpend(
quantities,
excludedIds?):
Promise<
Resource []>
Retrieves resources satisfying the spend query for the account.
| Name | Type | Description |
|---|
quantities | CoinQuantityLike [] | IDs of coins to exclude. |
excludedIds? | ExcludeResourcesOption | IDs of resources to be excluded from the query. |
A promise that resolves to an array of Resources.
Icon Linklock
Locks the wallet and returns an instance of WalletLocked.
An instance of WalletLocked.
▸
populateTransactionWitnessesSignature(
transactionRequestLike):
Promise<
TransactionRequest >
Populates a transaction with the witnesses signature.
The populated transaction request.
▸
sendTransaction(
transactionRequestLike,
«destructured»?):
Promise<
TransactionResponse >
Populates the witness signature for a transaction and sends it to the network using provider.sendTransaction.
A promise that resolves to the TransactionResponse object.
▸ signMessage(message): Promise<string>
Signs a message with the wallet's private key.
| Name | Type | Description |
|---|
message | string | The message to sign. |
Promise<string>
A promise that resolves to the signature as a ECDSA 64 bytes string.
▸ signTransaction(transactionRequestLike): Promise<string>
Signs a transaction with the wallet's private key.
Promise<string>
A promise that resolves to the signature as a ECDSA 64 bytes string.
▸
simulateTransaction(
transactionRequestLike,
«destructured»?):
Promise<
CallResult >
Populates the witness signature for a transaction and sends a call to the network using provider.call.
A promise that resolves to the CallResult object.
▸
transfer(
destination,
amount,
assetId?,
txParams?):
Promise<
TransactionResponse >
Transfers coins to a destination address.
| Name | Type | Default value | Description |
|---|
destination | string | AbstractAddress | undefined | The address of the destination. |
amount | BigNumberish | undefined | The amount of coins to transfer. |
assetId | BytesLike | BaseAssetId | The asset ID of the coins to transfer. |
txParams | TxParamsType | {} | The transaction parameters (gasLimit, gasPrice, maturity). |
A promise that resolves to the transaction response.
▸
transferToContract(
contractId,
amount,
assetId?,
txParams?):
Promise<
TransactionResponse >
Transfers coins to a contract address.
| Name | Type | Default value | Description |
|---|
contractId | string | AbstractAddress | undefined | The address of the contract. |
amount | BigNumberish | undefined | The amount of coins to transfer. |
assetId | BytesLike | BaseAssetId | The asset ID of the coins to transfer. |
txParams | TxParamsType | {} | The optional transaction parameters. |
A promise that resolves to the transaction response.
▸
withdrawToBaseLayer(
recipient,
amount,
txParams?):
Promise<
TransactionResponse >
Withdraws an amount of the base asset to the base chain.
| Name | Type | Description |
|---|
recipient | string | AbstractAddress | Address of the recipient on the base chain. |
amount | BigNumberish | Amount of base asset. |
txParams | TxParamsType | The optional transaction parameters. |
A promise that resolves to the transaction response.
▸
fromEncryptedJson(
jsonWallet,
password,
provider?):
Promise<
WalletUnlocked >
Create a Wallet Unlocked from an encrypted JSON.
| Name | Type | Description |
|---|
jsonWallet | string | The encrypted JSON keystore. |
password | string | The password to decrypt the JSON. |
provider? | Provider | A Provider instance (optional). |
An unlocked wallet instance.
▸
fromExtendedKey(
extendedKey,
provider?):
WalletUnlocked Create a Wallet Unlocked from an extended key.
| Name | Type | Description |
|---|
extendedKey | string | The extended key. |
provider? | Provider | A Provider instance (optional). |
An instance of WalletUnlocked.
▸
fromMnemonic(
mnemonic,
path?,
passphrase?,
provider?):
WalletUnlocked Create a Wallet Unlocked from a mnemonic phrase.
| Name | Type | Description |
|---|
mnemonic | string | The mnemonic phrase. |
path? | string | The derivation path (optional). |
passphrase? | BytesLike | The passphrase for the mnemonic (optional). |
provider? | Provider | A Provider instance (optional). |
An instance of WalletUnlocked.
▸
fromSeed(
seed,
path?,
provider?):
WalletUnlocked Create a Wallet Unlocked from a seed.
| Name | Type | Description |
|---|
seed | string | The seed phrase. |
path? | string | The derivation path (optional). |
provider? | Provider | A Provider instance (optional). |
An instance of WalletUnlocked.
▸
generate(
generateOptions?):
WalletUnlocked Generate a new Wallet Unlocked with a random key pair.
| Name | Type | Description |
|---|
generateOptions? | GenerateOptions | Options to customize the generation process (optional). |
An instance of WalletUnlocked.