Class Wallet

Hierarchy

Wallet

Index

Constructors

Methods

account setRoot fromPhrase fromPrivateKey fromSeed randomMnemonic

Constructors

constructor

new Wallet(clientProvider: ClientProvider): Wallet
Parameters
- clientProvider: ClientProvider
Returns Wallet
- Defined in lib/Wallet.ts:25

Methods

account

account(index?: bigint): Promise<Account>
Return a Account object from this wallet, given the account index
Parameters
- index: bigint = ...
Returns Promise<Account>
- Defined in lib/Wallet.ts:86

setRoot

setRoot(xPrv: string): void
Set xPrv of the wallet, you don't have to explicitly call this, as it's used by factory methods
Parameters
- xPrv: string
Returns void
- Defined in lib/Wallet.ts:79

`Static` fromPhrase

fromPhrase(clientProvider: ClientProvider, phrase: string): Wallet
Initialize a Wallet object from mnemonic pharse
Parameters
- clientProvider: ClientProvider
- phrase: string
Returns Wallet
- Defined in lib/Wallet.ts:34

`Static` fromPrivateKey

fromPrivateKey(clientProvider: ClientProvider, xPrv: string): Wallet
Initialize a Wallet object from private key string
Parameters
- clientProvider: ClientProvider
- xPrv: string
Returns Wallet
- Defined in lib/Wallet.ts:54

`Static` fromSeed

fromSeed(clientProvider: ClientProvider, seed: string): Wallet
Initialize a Wallet object from seed (without password)
Parameters
- clientProvider: ClientProvider
- seed: string
Returns Wallet
- Defined in lib/Wallet.ts:44

`Static` randomMnemonic

randomMnemonic(): {
entropy: string;
phrase: string;
}
Return a random mnemonic phrase that can be used to initialize a wallet

Returns {
entropy: string;
phrase: string;
}
- entropy: string
- phrase: string
- Defined in lib/Wallet.ts:67

Generated using TypeDoc