@fuel-ts/account v0.97.0 • Docs
WalletUnlocked provides the functionalities for an unlocked wallet.
new WalletUnlocked(
privateKey,provider?):WalletUnlocked
Creates a new BaseWalletUnlocked instance.
• privateKey: BytesLike
The private key of the wallet.
• provider?: Provider
A Provider instance (optional).
BaseWalletUnlocked .constructor
packages/account/src/wallet/base-wallet-unlocked.ts:40
protectedoptional_connector:FuelConnector
The connector for use with external wallets
BaseWalletUnlocked ._connector
packages/account/src/account.ts:93
protectedoptional_provider:Provider
The provider used to interact with the network.
packages/account/src/account.ts:88
readonlyaddress:AbstractAddress
The address associated with the account.
packages/account/src/account.ts:83
signer: () =>
Signer
A function that returns the wallet's signer.
packages/account/src/wallet/base-wallet-unlocked.ts:32
staticdefaultPath:string="m/44'/117999342./0"
Default HDWallet path.
BaseWalletUnlocked .defaultPath
packages/account/src/wallet/base-wallet-unlocked.ts:27
getprivateKey():string
Gets the private key of the wallet.
string
The private key of the wallet.
BaseWalletUnlocked .privateKey
packages/account/src/wallet/base-wallet-unlocked.ts:51
getprovider():Provider
The provider used to interact with the network.
FuelError if the provider is not set.
setprovider(provider):void
Sets the provider for the account.
• provider: Provider
A Provider instance.
A Provider instance.
packages/account/src/account.ts:116
getpublicKey():string
Gets the public key of the wallet.
string
packages/account/src/wallet/base-wallet-unlocked.ts:60
addBatchTransfer(
request,transferParams):ScriptTransactionRequest
Adds multiple transfers to a script transaction request.
• request: ScriptTransactionRequest
The script transaction request to add transfers to.
• transferParams: TransferParams []
An array of TransferParams objects representing the transfers to be made.
The updated script transaction request.
BaseWalletUnlocked .addBatchTransfer
packages/account/src/account.ts:415
addTransfer(
request,transferParams):ScriptTransactionRequest
Adds a transfer to the given transaction request.
• request: ScriptTransactionRequest
The script transaction request to add transfers to.
• transferParams: TransferParams
The object representing the transfer to be made.
The updated transaction request with the added transfer.
BaseWalletUnlocked .addTransfer
packages/account/src/account.ts:397
batchTransfer(
transferParams,txParams):Promise<TransactionResponse>
Transfers multiple amounts of a token to multiple recipients.
• transferParams: TransferParams []
An array of TransferParams objects representing the transfers to be made.
• txParams: TxParamsType = {}
Optional transaction parameters.
Promise<TransactionResponse >
A promise that resolves to a TransactionResponse object representing the transaction result.
BaseWalletUnlocked .batchTransfer
packages/account/src/account.ts:380
batchTransferToContracts(
contractTransferParams,txParams):Promise<TransactionResponse>
• contractTransferParams: ContractTransferParams []
• txParams: TxParamsType = {}
Promise<TransactionResponse >
BaseWalletUnlocked .batchTransferToContracts
packages/account/src/account.ts:445
connect(
provider):Provider
Changes the provider connection for the account.
• provider: Provider
A Provider instance.
The updated Provider instance.
packages/account/src/account.ts:139
createTransfer(
destination,amount,assetId?,txParams?):Promise<ScriptTransactionRequest>
A helper that creates a transfer transaction request and returns it.
• 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).
Promise<ScriptTransactionRequest >
A promise that resolves to the prepared transaction request.
BaseWalletUnlocked .createTransfer
packages/account/src/account.ts:342
encrypt(
password):Promise<string>
Encrypts an unlocked wallet with a password.
• password: string
the password to encrypt the wallet with.
Promise<string>
packages/account/src/wallet/base-wallet-unlocked.ts:156
fund<
T>(request,params):Promise<T>
Funds a transaction request by adding the necessary resources.
• T extends TransactionRequest
The type of the TransactionRequest.
• request: T
The transaction request to fund.
• params: EstimatedTxParams
The estimated transaction parameters.
Promise<T>
A promise that resolves to the funded transaction request.
packages/account/src/account.ts:209
generateFakeResources(
coins):Resource[]
Generates an array of fake resources based on the provided coins.
• coins: FakeResources []
An array of FakeResources objects representing the coins.
Resource []
An array of Resource objects with generated properties.
BaseWalletUnlocked .generateFakeResources
packages/account/src/account.ts:688
getBalance(
assetId?):Promise<BN>
Retrieves the balance of the account for the given asset.
• assetId?: BytesLike
The asset ID to check the balance for (optional).
Promise<BN>
A promise that resolves to the balance amount.
BaseWalletUnlocked .getBalance
packages/account/src/account.ts:186
getBalances():
Promise<GetBalancesResponse>
Retrieves all the balances for the account.
Promise<GetBalancesResponse >
A promise that resolves to an array of Coins and their quantities.
BaseWalletUnlocked .getBalances
packages/account/src/account.ts:197
getCoins(
assetId?,paginationArgs?):Promise<GetCoinsResponse>
Retrieves coins owned by the account.
• assetId?: BytesLike
The asset ID of the coins to retrieve (optional).
• paginationArgs?: CursorPaginationArgs
Promise<GetCoinsResponse >
A promise that resolves to an array of Coins.
packages/account/src/account.ts:164
getMessages(
paginationArgs?):Promise<GetMessagesResponse>
Retrieves messages owned by the account.
• paginationArgs?: CursorPaginationArgs
Promise<GetMessagesResponse >
A promise that resolves to an array of Messages.
BaseWalletUnlocked .getMessages
packages/account/src/account.ts:176
getResourcesToSpend(
quantities,excludedIds?):Promise<Resource[]>
Retrieves resources satisfying the spend query for the account.
• quantities: CoinQuantityLike []
Quantities of resources to be obtained.
• excludedIds?: ExcludeResourcesOption
IDs of resources to be excluded from the query (optional).
Promise<Resource []>
A promise that resolves to an array of Resources.
BaseWalletUnlocked .getResourcesToSpend
packages/account/src/account.ts:151
getTransactionCost(
transactionRequestLike,transactionCostParams):Promise<TransactionCost>
Returns a transaction cost to enable user to set gasLimit and also reserve balance amounts on the transaction.
• transactionRequestLike: TransactionRequestLike
The transaction request object.
• transactionCostParams: TransactionCostParams = {}
The transaction cost parameters (optional).
Promise<TransactionCost >
A promise that resolves to the transaction cost object.
BaseWalletUnlocked .getTransactionCost
packages/account/src/account.ts:547
lock():
WalletLocked
Locks the wallet and returns an instance of WalletLocked.
An instance of WalletLocked.
packages/account/src/wallet/wallets.ts:48
populateTransactionWitnessesSignature<
T>(transactionRequestLike):Promise<T>
Populates a transaction with the witnesses signature.
• T extends TransactionRequest
• transactionRequestLike: TransactionRequestLike
The transaction request to populate.
Promise<T>
The populated transaction request.
BaseWalletUnlocked .populateTransactionWitnessesSignature
packages/account/src/wallet/base-wallet-unlocked.ts:95
sendTransaction(
transactionRequestLike,estimateTxDependencies):Promise<TransactionResponse>
Populates the witness signature for a transaction and sends it to the network using provider.sendTransaction.
• transactionRequestLike: TransactionRequestLike
The transaction request to send.
• estimateTxDependencies: EstimateTransactionParams = {}
Whether to estimate the transaction dependencies.
Promise<TransactionResponse >
A promise that resolves to the TransactionResponse object.
BaseWalletUnlocked .sendTransaction
packages/account/src/wallet/base-wallet-unlocked.ts:113
signMessage(
message):Promise<string>
Signs a message with the wallet's private key.
• message: string
The message to sign.
Promise<string>
A promise that resolves to the signature as a ECDSA 64 bytes string.
BaseWalletUnlocked .signMessage
packages/account/src/wallet/base-wallet-unlocked.ts:70
signTransaction(
transactionRequestLike):Promise<string>
Signs a transaction with the wallet's private key.
• transactionRequestLike: TransactionRequestLike
The transaction request to sign.
Promise<string>
A promise that resolves to the signature as a ECDSA 64 bytes string.
BaseWalletUnlocked .signTransaction
packages/account/src/wallet/base-wallet-unlocked.ts:81
simulateTransaction(
transactionRequestLike,__namedParameters):Promise<CallResult>
Populates the witness signature for a transaction and sends a call to the network using provider.dryRun.
• transactionRequestLike: TransactionRequestLike
The transaction request to simulate.
• __namedParameters: EstimateTransactionParams = {}
Promise<CallResult >
A promise that resolves to the CallResult object.
BaseWalletUnlocked .simulateTransaction
packages/account/src/wallet/base-wallet-unlocked.ts:133
transfer(
destination,amount,assetId?,txParams?):Promise<TransactionResponse>
Transfers coins to a destination address.
• 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).
Promise<TransactionResponse >
A promise that resolves to the transaction response.
packages/account/src/account.ts:363
transferToContract(
contractId,amount,assetId?,txParams?):Promise<TransactionResponse>
Transfers coins to a contract address.
• 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).
Promise<TransactionResponse >
A promise that resolves to the transaction response.
BaseWalletUnlocked .transferToContract
packages/account/src/account.ts:436
withdrawToBaseLayer(
recipient,amount,txParams):Promise<TransactionResponse>
Withdraws an amount of the base asset to the base chain.
• recipient: string | AbstractAddress
Address of the recipient on the base chain.
• amount: BigNumberish
Amount of base asset.
• txParams: TxParamsType = {}
The transaction parameters (optional).
Promise<TransactionResponse >
A promise that resolves to the transaction response.
BaseWalletUnlocked .withdrawToBaseLayer
packages/account/src/account.ts:498
staticfromEncryptedJson(jsonWallet,password,provider?):Promise<WalletUnlocked>
Create a Wallet Unlocked from an encrypted JSON.
• jsonWallet: string
The encrypted JSON keystore.
• password: string
The password to decrypt the JSON.
• provider?: Provider
A Provider instance (optional).
Promise<WalletUnlocked >
An unlocked wallet instance.
packages/account/src/wallet/wallets.ts:123
staticfromExtendedKey(extendedKey,provider?):WalletUnlocked
Create a Wallet Unlocked from an extended key.
• extendedKey: string
The extended key.
• provider?: Provider
A Provider instance (optional).
An instance of WalletUnlocked.
packages/account/src/wallet/wallets.ts:109
staticfromMnemonic(mnemonic,path?,passphrase?,provider?):WalletUnlocked
Create a Wallet Unlocked from a mnemonic phrase.
• 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.
packages/account/src/wallet/wallets.ts:89
staticfromSeed(seed,path?,provider?):WalletUnlocked
Create a Wallet Unlocked from a seed.
• seed: string
The seed phrase.
• path?: string
The derivation path (optional).
• provider?: Provider
A Provider instance (optional).
An instance of WalletUnlocked.
packages/account/src/wallet/wallets.ts:73
staticgenerate(generateOptions?):WalletUnlocked
Generate a new Wallet Unlocked with a random key pair.
• generateOptions?: GenerateOptions
Options to customize the generation process (optional).
An instance of WalletUnlocked.