Struct Bip32PrivateKey

pub struct Bip32PrivateKey(/* private fields */);

Implementations

impl Bip32PrivateKey

pub fn derive(&self, index: u32) -> Bip32PrivateKey

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).

pub fn from_128_xprv(bytes: &[u8]) -> Result<Bip32PrivateKey, JsError>

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)

pub fn to_128_xprv(&self) -> Vec<u8>

see from_128_xprv

pub fn generate_ed25519_bip32() -> Result<Bip32PrivateKey, JsError>

pub fn to_raw_key(&self) -> PrivateKey

pub fn to_public(&self) -> Bip32PublicKey

pub fn from_bytes(bytes: &[u8]) -> Result<Bip32PrivateKey, JsError>

pub fn as_bytes(&self) -> Vec<u8>

pub fn from_bech32(bech32_str: &str) -> Result<Bip32PrivateKey, JsError>

pub fn to_bech32(&self) -> String

pub fn from_bip39_entropy(entropy: &[u8], password: &[u8]) -> Bip32PrivateKey

pub fn chaincode(&self) -> Vec<u8>

pub fn to_hex(&self) -> String

pub fn from_hex(hex_str: &str) -> Result<Bip32PrivateKey, JsError>