@fuel-ts/account v0.94.8 • Docs
Class: WalletUnlocked
WalletUnlocked provides the functionalities for an unlocked wallet.
Extends
Constructors
new WalletUnlocked()
new WalletUnlocked(
privateKey,provider?):WalletUnlocked
Creates a new BaseWalletUnlocked instance.
Parameters
• privateKey: BytesLike
The private key of the wallet.
• provider?: Provider
A Provider instance (optional).
Returns
Inherited from
BaseWalletUnlocked.constructor
Defined in
packages/account/src/wallet/base-wallet-unlocked.ts:40
Properties
_connector?
protectedoptional_connector:FuelConnector
The connector for use with external wallets
Inherited from
Defined in
packages/account/src/account.ts:87
_provider?
protectedoptional_provider:Provider
The provider used to interact with the network.
Inherited from
Defined in
packages/account/src/account.ts:82
address
readonlyaddress:AbstractAddress
The address associated with the account.
Inherited from
Defined in
packages/account/src/account.ts:77
signer()
signer: () =>
Signer
A function that returns the wallet's signer.
Returns
Inherited from
Defined in
packages/account/src/wallet/base-wallet-unlocked.ts:32
defaultPath
staticdefaultPath:string="m/44'/117999342./0"
Default HDWallet path.
Inherited from
BaseWalletUnlocked.defaultPath
Defined in
packages/account/src/wallet/base-wallet-unlocked.ts:27
Accessors
privateKey
getprivateKey():string
Gets the private key of the wallet.
Returns
string
The private key of the wallet.
Inherited from
Defined in
packages/account/src/wallet/base-wallet-unlocked.ts:51
provider
getprovider():Provider
The provider used to interact with the network.
Throws
FuelError if the provider is not set.
setprovider(provider):void
Sets the provider for the account.
Parameters
• provider: Provider
A Provider instance.
Returns
A Provider instance.
Inherited from
Defined in
packages/account/src/account.ts:110
publicKey
getpublicKey():string
Gets the public key of the wallet.
Returns
string
Inherited from
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
The updated script transaction request.
Inherited from
BaseWalletUnlocked.addBatchTransfer
Defined in
packages/account/src/account.ts:407
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
The updated transaction request with the added transfer.
Inherited from
BaseWalletUnlocked.addTransfer
Defined in
packages/account/src/account.ts:389
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
BaseWalletUnlocked.batchTransfer
Defined in
packages/account/src/account.ts:372
connect()
connect(
provider):Provider
Changes the provider connection for the account.
Parameters
• provider: Provider
A Provider instance.
Returns
The updated Provider instance.
Inherited from
Defined in
packages/account/src/account.ts:133
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.
• 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
BaseWalletUnlocked.createTransfer
Defined in
packages/account/src/account.ts:334
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.
Inherited from
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
Defined in
packages/account/src/account.ts:203
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
BaseWalletUnlocked.generateFakeResources
Defined in
packages/account/src/account.ts:671
getBalance()
getBalance(
assetId?):Promise<BN>
Retrieves the balance of the account for the given asset.
Parameters
• 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:180
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
BaseWalletUnlocked.getBalances
Defined in
packages/account/src/account.ts:191
getCoins()
getCoins(
assetId?,paginationArgs?):Promise<GetCoinsResponse>
Retrieves coins owned by the account.
Parameters
• 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:158
getMessages()
getMessages(
paginationArgs?):Promise<GetMessagesResponse>
Retrieves messages owned by the account.
Parameters
• paginationArgs?: CursorPaginationArgs
Returns
Promise<GetMessagesResponse>
A promise that resolves to an array of Messages.
Inherited from
BaseWalletUnlocked.getMessages
Defined in
packages/account/src/account.ts:170
getResourcesToSpend()
getResourcesToSpend(
quantities,excludedIds?):Promise<Resource[]>
Retrieves resources satisfying the spend query for the account.
Parameters
• 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
BaseWalletUnlocked.getResourcesToSpend
Defined in
packages/account/src/account.ts:145
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
BaseWalletUnlocked.getTransactionCost
Defined in
packages/account/src/account.ts:530
lock()
lock():
WalletLocked
Locks the wallet and returns an instance of WalletLocked.
Returns
An instance of WalletLocked.
Defined in
packages/account/src/wallet/wallets.ts:48
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.
Inherited from
BaseWalletUnlocked.populateTransactionWitnessesSignature
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.
Inherited from
BaseWalletUnlocked.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.
Inherited from
BaseWalletUnlocked.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.
Inherited from
BaseWalletUnlocked.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.
Inherited from
BaseWalletUnlocked.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.
• 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:355
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
BaseWalletUnlocked.transferToContract
Defined in
packages/account/src/account.ts:428
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
BaseWalletUnlocked.withdrawToBaseLayer
Defined in
packages/account/src/account.ts:481
fromEncryptedJson()
staticfromEncryptedJson(jsonWallet,password,provider?):Promise<WalletUnlocked>
Create a Wallet Unlocked from an encrypted JSON.
Parameters
• jsonWallet: string
The encrypted JSON keystore.
• password: string
The password to decrypt the JSON.
• provider?: Provider
A Provider instance (optional).
Returns
Promise<WalletUnlocked>
An unlocked wallet instance.
Defined in
packages/account/src/wallet/wallets.ts:123
fromExtendedKey()
staticfromExtendedKey(extendedKey,provider?):WalletUnlocked
Create a Wallet Unlocked from an extended key.
Parameters
• extendedKey: string
The extended key.
• provider?: Provider
A Provider instance (optional).
Returns
An instance of WalletUnlocked.
Defined in
packages/account/src/wallet/wallets.ts:109
fromMnemonic()
staticfromMnemonic(mnemonic,path?,passphrase?,provider?):WalletUnlocked
Create a Wallet Unlocked from a mnemonic phrase.
Parameters
• 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).
Returns
An instance of WalletUnlocked.
Defined in
packages/account/src/wallet/wallets.ts:89
fromSeed()
staticfromSeed(seed,path?,provider?):WalletUnlocked
Create a Wallet Unlocked from a seed.
Parameters
• seed: string
The seed phrase.
• path?: string
The derivation path (optional).
• provider?: Provider
A Provider instance (optional).
Returns
An instance of WalletUnlocked.
Defined in
packages/account/src/wallet/wallets.ts:73
generate()
staticgenerate(generateOptions?):WalletUnlocked
Generate a new Wallet Unlocked with a random key pair.
Parameters
• generateOptions?: GenerateOptions
Options to customize the generation process (optional).
Returns
An instance of WalletUnlocked.
Defined in
packages/account/src/wallet/wallets.ts:59