Edit

Hierarchical Deterministic wallet

Installation

npm install @erebos/wallet-hd

Usage

import { HDWallet } from '@erebos/wallet-hd'

const wallet = HDWallet.createRandom()
const sameWallet = new HDWallet(wallet.mnemonic)

Interfaces and types

Arrayish

Exported by the ethers.js library.

TransactionParams

interface TransactionParams {
  from: string
  to?: string
  value?: string
  data?: string
  gasLimit: string
  gasPrice: string
  chainId?: string
}

Wallet

Wallet instance as exported by the ethers.js library.

HDWallet class

Arguments

1. mnemonic: string
2. activeIndexes?: Array<number> = [0]

HDWallet.createRandom()

Static function on the HDWallet class returning an instance with a randomly generated mnemonic.

Returns HDWallet

.mnemonic

Returns string

.wallets

Returns Array<Wallet>

.accounts

Returns Array<string> the list of wallet addresses.

.getAccountWallet()

Arguments

1. address: string

Returns Wallet if found for the given address

.addAccount()

Arguments

1. index: number

Returns Wallet

.discardAccount()

Arguments

1. index: number

.signTransaction()

Arguments

1. params: TransactionParams

Returns Promise<string>

.signMessage()

Arguments

1. address: string
2. message: string | Arrayish

Returns Promise<string>

.signBytes()

Arguments

1. address: string
2. bytes: Array<number>

Returns Array<number>