Class Bip32PrivateKey

An ed25519-bip32 extended private key, 96 bytes: kL ‖ kR ‖ chain code, derived as CIP-3 specifies for Cardano.

Index

Constructors

Methods

derive deriveHardened derivePath toBip32PublicKey toBytes toPrivateKey fromBytes fromEntropy

Constructors

constructor

new Bip32PrivateKey(xprv: Uint8Array): Bip32PrivateKey
Parameters
- xprv: Uint8Array
  kL ‖ kR ‖ chain code, 96 bytes, copied
Returns Bip32PrivateKey

Methods

derive

derive(index: number): Bip32PrivateKey
The child at index, an integer below 2^32: hardened at 2^31 and above, soft below.
Parameters
- index: number
Returns Bip32PrivateKey

deriveHardened

deriveHardened(index: number): Bip32PrivateKey
The hardened child at index + 2^31, for an integer index below 2^31.
Parameters
- index: number
Returns Bip32PrivateKey

derivePath

derivePath(path: string): Bip32PrivateKey
The key at a path such as "m/1852'/1815'/0'/0/0": an optional m, then indices separated by /, each marked hardened by ', h or H, or not.
Parameters
- path: string
Returns Bip32PrivateKey

toBip32PublicKey

toBip32PublicKey(): Bip32PublicKey

Returns Bip32PublicKey

toBytes

toBytes(): Uint8Array

A copy of the key's 96 bytes.

Returns Uint8Array

toPrivateKey

toPrivateKey(): PrivateKey

The signing key, kL ‖ kR.

Returns PrivateKey

`Static`fromBytes

fromBytes(xprv: Uint8Array): Bip32PrivateKey
Parameters
- xprv: Uint8Array
  kL ‖ kR ‖ chain code, 96 bytes, copied
Returns Bip32PrivateKey

`Static`fromEntropy

fromEntropy(
entropy: Uint8Array,
passphrase?: string | Uint8Array<ArrayBufferLike>,
): Promise<Bip32PrivateKey>
The CIP-3 Icarus master key for BIP-39 entropy: the bytes a mnemonic encodes, of any length, not the mnemonic itself.
Parameters
- entropy: Uint8Array
- passphrase: string | Uint8Array<ArrayBufferLike> = ...
  the optional second factor, as UTF-8 text or bytes; none by default
Returns Promise<Bip32PrivateKey>