cardano-web3-js / CML / Bip32PrivateKey

Class: Bip32PrivateKey

Defined in: node_modules/cardano-wasm-libs/src/libs/cardano-multiplatform-lib/nodejs/cardano_multiplatform_lib.d.ts:998

Methods

chaincode()

chaincode(): Uint8Array

Defined in: node_modules/cardano-wasm-libs/src/libs/cardano-multiplatform-lib/nodejs/cardano_multiplatform_lib.d.ts:1045

Returns

Uint8Array

---

derive()

derive(index): Bip32PrivateKey

Defined in: node_modules/cardano-wasm-libs/src/libs/cardano-multiplatform-lib/nodejs/cardano_multiplatform_lib.d.ts:1021

derive this private key with the given index.

Security considerations

• hard derivation index cannot be soft derived with the public key

Hard derivation vs Soft derivation

If you pass an index below 0x80000000 then it is a soft derivation. The advantage of soft derivation is that it is possible to derive the public key too. I.e. derivation the private key with a soft derivation index and then retrieving the associated public key is equivalent to deriving the public key associated to the parent private key.

Hard derivation index does not allow public key derivation.

This is why deriving the private key should not fail while deriving the public key may fail (if the derivation index is invalid).

Parameters

index

number

Returns

Bip32PrivateKey

---

free()

free(): void

Defined in: node_modules/cardano-wasm-libs/src/libs/cardano-multiplatform-lib/nodejs/cardano_multiplatform_lib.d.ts:1000

Returns

void

---

to_128_xprv()

to_128_xprv(): Uint8Array

Defined in: node_modules/cardano-wasm-libs/src/libs/cardano-multiplatform-lib/nodejs/cardano_multiplatform_lib.d.ts:1036

see from_128_xprv

Returns

Uint8Array

---

to_bech32()

to_bech32(): string

Defined in: node_modules/cardano-wasm-libs/src/libs/cardano-multiplatform-lib/nodejs/cardano_multiplatform_lib.d.ts:1043

Returns

string

---

to_public()

to_public(): Bip32PublicKey

Defined in: node_modules/cardano-wasm-libs/src/libs/cardano-multiplatform-lib/nodejs/cardano_multiplatform_lib.d.ts:1039

Returns

Bip32PublicKey

---

to_raw_bytes()

to_raw_bytes(): Uint8Array

Defined in: node_modules/cardano-wasm-libs/src/libs/cardano-multiplatform-lib/nodejs/cardano_multiplatform_lib.d.ts:1041

Returns

Uint8Array

---

to_raw_key()

to_raw_key(): PrivateKey

Defined in: node_modules/cardano-wasm-libs/src/libs/cardano-multiplatform-lib/nodejs/cardano_multiplatform_lib.d.ts:1038

Returns

PrivateKey

---

from_128_xprv()

static from_128_xprv(bytes): Bip32PrivateKey

Defined in: node_modules/cardano-wasm-libs/src/libs/cardano-multiplatform-lib/nodejs/cardano_multiplatform_lib.d.ts:1032

128-byte xprv a key format in Cardano that some software still uses or requires the traditional 96-byte xprv is simply encoded as prv | chaincode however, because some software may not know how to compute a public key from a private key, the 128-byte inlines the public key in the following format prv | pub | chaincode so be careful if you see the term "xprv" as it could refer to either one our library does not require the pub (instead we compute the pub key when needed)

Parameters

bytes

Uint8Array

Returns

Bip32PrivateKey

---

from_bech32()

static from_bech32(bech32_str): Bip32PrivateKey

Defined in: node_modules/cardano-wasm-libs/src/libs/cardano-multiplatform-lib/nodejs/cardano_multiplatform_lib.d.ts:1042

Parameters

bech32_str

string

Returns

Bip32PrivateKey

---

from_bip39_entropy()

static from_bip39_entropy(entropy, password): Bip32PrivateKey

Defined in: node_modules/cardano-wasm-libs/src/libs/cardano-multiplatform-lib/nodejs/cardano_multiplatform_lib.d.ts:1044

Parameters

entropy

Uint8Array

password

Uint8Array

Returns

Bip32PrivateKey

---

from_raw_bytes()

static from_raw_bytes(bytes): Bip32PrivateKey

Defined in: node_modules/cardano-wasm-libs/src/libs/cardano-multiplatform-lib/nodejs/cardano_multiplatform_lib.d.ts:1040

Parameters

bytes

Uint8Array

Returns

Bip32PrivateKey

---

generate_ed25519_bip32()

static generate_ed25519_bip32(): Bip32PrivateKey

Defined in: node_modules/cardano-wasm-libs/src/libs/cardano-multiplatform-lib/nodejs/cardano_multiplatform_lib.d.ts:1037

Returns

Bip32PrivateKey