Struct cml_crypto_wasm::Bip32PrivateKey

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

Implementations

impl Bip32PrivateKey

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

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() -> Bip32PrivateKey

pub fn to_raw_key(&self) -> PrivateKey

pub fn to_public(&self) -> Bip32PublicKey

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

pub fn to_raw_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]) -> Self

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

Trait Implementations

impl AsRef<Bip32PrivateKey> for Bip32PrivateKey

fn as_ref(&self) -> &Bip32PrivateKey

Converts this type into a shared reference of the (usually inferred) input type.

impl From<Bip32PrivateKey> for Bip32PrivateKey

fn from(wrapper: Bip32PrivateKey) -> Self

Converts to this type from the input type.

impl From<Bip32PrivateKey> for Bip32PrivateKey

fn from(inner: Bip32PrivateKey) -> Self

Converts to this type from the input type.

impl From<Bip32PrivateKey> for JsValue

fn from(value: Bip32PrivateKey) -> Self

Converts to this type from the input type.

impl FromWasmAbi for Bip32PrivateKey

type Abi = u32

The wasm ABI type that this converts from when coming back out from the ABI boundary.

unsafe fn from_abi(js: u32) -> Self

Recover a Self from Self::Abi.

impl IntoWasmAbi for Bip32PrivateKey

type Abi = u32

The wasm ABI type that this converts into when crossing the ABI boundary.

fn into_abi(self) -> u32

Convert self into Self::Abi so that it can be sent across the wasm ABI boundary.

impl OptionFromWasmAbi for Bip32PrivateKey

fn is_none(abi: &Self::Abi) -> bool

Tests whether the argument is a “none” instance. If so it will be deserialized as None, and otherwise it will be passed to FromWasmAbi.

impl OptionIntoWasmAbi for Bip32PrivateKey

fn none() -> Self::Abi

Returns an ABI instance indicating “none”, which JS will interpret as the None branch of this option.

impl RefFromWasmAbi for Bip32PrivateKey

type Abi = u32

The wasm ABI type references to Self are recovered from.

type Anchor = Ref<'static, Bip32PrivateKey>

The type that holds the reference to Self for the duration of the invocation of the function that has an &Self parameter. This is required to ensure that the lifetimes don’t persist beyond one function call, and so that they remain anonymous.

unsafe fn ref_from_abi(js: Self::Abi) -> Self::Anchor

Recover a Self::Anchor from Self::Abi.

impl RefMutFromWasmAbi for Bip32PrivateKey

type Abi = u32

Same as RefFromWasmAbi::Abi

type Anchor = RefMut<'static, Bip32PrivateKey>

Same as RefFromWasmAbi::Anchor

unsafe fn ref_mut_from_abi(js: Self::Abi) -> Self::Anchor

Same as RefFromWasmAbi::ref_from_abi

impl WasmDescribe for Bip32PrivateKey

fn describe()