@fuel-ts/account v0.94.1 • Docs
Class: Wallet
Wallet
provides methods to create locked and unlocked wallet instances.
Constructors
new Wallet()
new Wallet():
Wallet
Returns
Properties
Property | Modifier | Type | Default value | Description | Defined in |
---|---|---|---|---|---|
fromEncryptedJson | static | (jsonWallet : string , password : string , provider ?: Provider ) => Promise <WalletUnlocked > | WalletUnlocked.fromEncryptedJson | Create a Wallet Unlocked from an encrypted JSON. Param The encrypted JSON keystore. Param The password to decrypt the JSON. Param A Provider instance (optional). | packages/account/src/wallet/wallet.ts:79 |
fromExtendedKey | static | (extendedKey : string , provider ?: Provider ) => WalletUnlocked | WalletUnlocked.fromExtendedKey | Create a Wallet Unlocked from an extended key. Param The extended key. Param A Provider instance (optional). | packages/account/src/wallet/wallet.ts:69 |
fromMnemonic | static | (mnemonic : string , path ?: string , passphrase ?: BytesLike , provider ?: Provider ) => WalletUnlocked | WalletUnlocked.fromMnemonic | Create a Wallet Unlocked from a mnemonic phrase. Param The mnemonic phrase. Param A Provider instance (optional). Param The derivation path (optional). Param The passphrase for the mnemonic (optional). | packages/account/src/wallet/wallet.ts:60 |
fromSeed | static | (seed : string , path ?: string , provider ?: Provider ) => WalletUnlocked | WalletUnlocked.fromSeed | Create a Wallet Unlocked from a seed. Param The seed phrase. Param A Provider instance (optional). Param The derivation path (optional). | packages/account/src/wallet/wallet.ts:49 |
generate | static | (generateOptions ?: GenerateOptions ) => WalletUnlocked | WalletUnlocked.generate | Generate a new Wallet Unlocked with a random key pair. Param Options to customize the generation process (optional). | packages/account/src/wallet/wallet.ts:39 |
Methods
fromAddress()
static
fromAddress(address
,provider
?):WalletLocked
Creates a locked wallet instance from an address and a provider.
Parameters
Parameter | Type | Description |
---|---|---|
address | string | AbstractAddress | The address of the wallet. |
provider ? | Provider | A Provider instance (optional). |
Returns
A locked wallet instance.
Defined in
packages/account/src/wallet/wallet.ts:18
fromPrivateKey()
static
fromPrivateKey(privateKey
,provider
?):WalletUnlocked
Creates an unlocked wallet instance from a private key and a provider.
Parameters
Parameter | Type | Description |
---|---|---|
privateKey | BytesLike | The private key of the wallet. |
provider ? | Provider | A Provider instance (optional). |
Returns
An unlocked wallet instance.
Defined in
packages/account/src/wallet/wallet.ts:29