Class Secp256k1HdWallet

Hierarchy

Secp256k1HdWallet

Implements

OfflineAminoSigner

Index

Constructors

`Protected` constructor

new Secp256k1HdWallet(mnemonic: EnglishMnemonic, options: Secp256k1HdWalletConstructorOptions): Secp256k1HdWallet
Parameters
- mnemonic: EnglishMnemonic
- options: Secp256k1HdWalletConstructorOptions
Returns Secp256k1HdWallet
- Defined in secp256k1hdwallet.ts:248

Accessors

mnemonic

get mnemonic(): string
Returns string
- Defined in secp256k1hdwallet.ts:259

Methods

getAccounts

getAccounts(): Promise<readonly AccountData[]>
Get AccountData array from wallet. Rejects if not enabled.

Returns Promise<readonly AccountData[]>
Implementation of OfflineAminoSigner.getAccounts
- Defined in secp256k1hdwallet.ts:263

serialize

serialize(password: string): Promise<string>
Generates an encrypted serialization of this wallet.
Parameters
- password: string
  
  The user provided password used to generate an encryption key via a KDF. This is not normalized internally (see "Unicode normalization" to learn more).
Returns Promise<string>
- Defined in secp256k1hdwallet.ts:294

serializeWithEncryptionKey

serializeWithEncryptionKey(encryptionKey: Uint8Array, kdfConfiguration: KdfConfiguration): Promise<string>
Generates an encrypted serialization of this wallet.

This is an advanced alternative to calling serialize(password) directly, which allows you to offload the KDF execution to a non-UI thread (e.g. in a WebWorker).

The caller is responsible for ensuring the key was derived with the given KDF options. If this is not the case, the wallet cannot be restored with the original password.
Parameters
- encryptionKey: Uint8Array
- kdfConfiguration: KdfConfiguration
Returns Promise<string>
- Defined in secp256k1hdwallet.ts:309

signAmino

signAmino(signerAddress: string, signDoc: StdSignDoc): Promise<AminoSignResponse>
Request signature from whichever key corresponds to provided bech32-encoded address. Rejects if not enabled.

The signer implementation may offer the user the ability to override parts of the signDoc. It must return the doc that was signed in the response.
Parameters
- signerAddress: string
  
  The address of the account that should sign the transaction
- signDoc: StdSignDoc
  
  The content that should be signed
Returns Promise<AminoSignResponse>
Implementation of OfflineAminoSigner.signAmino
- Defined in secp256k1hdwallet.ts:272

`Static` deserialize

deserialize(serialization: string, password: string): Promise<Secp256k1HdWallet>
Restores a wallet from an encrypted serialization.
Parameters
- serialization: string
- password: string
  
  The user provided password used to generate an encryption key via a KDF. This is not normalized internally (see "Unicode normalization" to learn more).
Returns Promise<Secp256k1HdWallet>
- Defined in secp256k1hdwallet.ts:175

`Static` deserializeWithEncryptionKey

deserializeWithEncryptionKey(serialization: string, encryptionKey: Uint8Array): Promise<Secp256k1HdWallet>
Restores a wallet from an encrypted serialization.

This is an advanced alternative to calling deserialize(serialization, password) directly, which allows you to offload the KDF execution to a non-UI thread (e.g. in a WebWorker).

The caller is responsible for ensuring the key was derived with the given KDF configuration. This can be done using extractKdfConfiguration(serialization) and executeKdf(password, kdfConfiguration) from this package.
Parameters
- serialization: string
- encryptionKey: Uint8Array
Returns Promise<Secp256k1HdWallet>
- Defined in secp256k1hdwallet.ts:195

`Static` fromMnemonic

fromMnemonic(mnemonic: string, options?: Partial<Secp256k1HdWalletOptions>): Promise<Secp256k1HdWallet>
Restores a wallet from the given BIP39 mnemonic.
Parameters
- mnemonic: string
  
  Any valid English mnemonic.
- options: Partial<Secp256k1HdWalletOptions> = {}
  
  An optional Secp256k1HdWalletOptions object optionally containing a bip39Password, hdPaths, and prefix.
Returns Promise<Secp256k1HdWallet>
- Defined in secp256k1hdwallet.ts:141

`Static` generate

generate(length?: 12 | 15 | 18 | 21 | 24, options?: Partial<Secp256k1HdWalletOptions>): Promise<Secp256k1HdWallet>
Generates a new wallet with a BIP39 mnemonic of the given length.
Parameters
- length: 12 | 15 | 18 | 21 | 24 = 12
  
  The number of words in the mnemonic (12, 15, 18, 21 or 24).
- options: Partial<Secp256k1HdWalletOptions> = {}
  
  An optional Secp256k1HdWalletOptions object optionally containing a bip39Password, hdPaths, and prefix.
Returns Promise<Secp256k1HdWallet>
- Defined in secp256k1hdwallet.ts:159

Class Secp256k1HdWallet

Hierarchy

Implements

Index

Constructors

Accessors

Methods

Constructors

Protected constructor

Parameters

mnemonic: EnglishMnemonic

options: Secp256k1HdWalletConstructorOptions

Returns Secp256k1HdWallet

Accessors

mnemonic

Returns string

Methods

getAccounts

Returns Promise<readonly AccountData[]>

serialize

Parameters

password: string

Returns Promise<string>

serializeWithEncryptionKey

Parameters

encryptionKey: Uint8Array

kdfConfiguration: KdfConfiguration

Returns Promise<string>

signAmino

Parameters

signerAddress: string

signDoc: StdSignDoc

Returns Promise<AminoSignResponse>

Static deserialize

Parameters

serialization: string

password: string

Returns Promise<Secp256k1HdWallet>

Static deserializeWithEncryptionKey

Parameters

serialization: string

encryptionKey: Uint8Array

Returns Promise<Secp256k1HdWallet>

Static fromMnemonic

Parameters

mnemonic: string

options: Partial<Secp256k1HdWalletOptions> = {}

Returns Promise<Secp256k1HdWallet>

Static generate

Parameters

length: 12 | 15 | 18 | 21 | 24 = 12

options: Partial<Secp256k1HdWalletOptions> = {}

Returns Promise<Secp256k1HdWallet>

Settings

Member Visibility

Theme

`Protected` constructor

`Static` deserialize

`Static` deserializeWithEncryptionKey

`Static` fromMnemonic

`Static` generate