Struct ChainCode 

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

A 32-byte chain code used in BIP32 hierarchical deterministic key derivation.

Chain codes provide additional entropy for deriving child keys. Every extended key (both private and public) has an associated chain code that is used in the HMAC-SHA512 operation during child key derivation.

Security

Chain codes must be kept secret, similar to private keys. Exposing a chain code along with an extended public key can compromise the privacy of all child keys.

Memory Safety: This type implements ZeroizeOnDrop, which automatically overwrites the chain code bytes with zeros when the value is dropped, preventing sensitive data from lingering in memory.

Size

Chain codes are always exactly 32 bytes (256 bits) in length.

Examples

use khodpay_bip32::ChainCode;

// Create from a 32-byte array
let bytes = [0u8; 32];
let chain_code = ChainCode::from_bytes(&bytes)?;

// Access the underlying bytes
let bytes_ref: &[u8; 32] = chain_code.as_bytes();
assert_eq!(bytes_ref.len(), 32);

Implementations

impl ChainCode

pub const LENGTH: usize = 32usize

The length of a chain code in bytes.

pub fn new(bytes: [u8; 32]) -> Self

Creates a new ChainCode from a 32-byte array.

Arguments

• bytes - A 32-byte array containing the chain code data

Examples

use khodpay_bip32::ChainCode;

let bytes = [0u8; 32];
let chain_code = ChainCode::new(bytes);
assert_eq!(chain_code.as_bytes(), &bytes);

pub fn from_bytes(bytes: &[u8]) -> Result<Self>

Creates a ChainCode from a byte slice.

Arguments

• bytes - A byte slice that must be exactly 32 bytes long

Errors

Returns Error::InvalidPrivateKey if the slice is not exactly 32 bytes.

Examples

use khodpay_bip32::ChainCode;

// Valid 32-byte slice
let bytes = vec![0u8; 32];
let chain_code = ChainCode::from_bytes(&bytes)?;

// Invalid length
let invalid = vec![0u8; 16];
assert!(ChainCode::from_bytes(&invalid).is_err());

pub fn as_bytes(&self) -> &[u8; 32]

Returns a reference to the chain code bytes as a 32-byte array.

Examples

use khodpay_bip32::ChainCode;

let bytes = [42u8; 32];
let chain_code = ChainCode::new(bytes);

let bytes_ref: &[u8; 32] = chain_code.as_bytes();
assert_eq!(bytes_ref, &bytes);

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

Converts the chain code to a Vec<u8>.

Examples

use khodpay_bip32::ChainCode;

let bytes = [1u8; 32];
let chain_code = ChainCode::new(bytes);

let vec = chain_code.to_vec();
assert_eq!(vec.len(), 32);
assert_eq!(vec, bytes.to_vec());

pub fn len(&self) -> usize

Returns the length of the chain code (always 32).

Examples

use khodpay_bip32::ChainCode;

let chain_code = ChainCode::new([0u8; 32]);
assert_eq!(chain_code.len(), 32);

pub fn is_empty(&self) -> bool

Always returns false since chain codes have a fixed non-zero length.

This method exists for consistency with collection-like types.

Examples

use khodpay_bip32::ChainCode;

let chain_code = ChainCode::new([0u8; 32]);
assert!(!chain_code.is_empty());

Trait Implementations

impl AsRef<[u8]> for ChainCode

fn as_ref(&self) -> &[u8]

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

impl Clone for ChainCode

fn clone(&self) -> ChainCode

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ChainCode

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Drop for ChainCode

fn drop(&mut self)

Executes the destructor for this type.

impl From<[u8; 32]> for ChainCode

fn from(bytes: [u8; 32]) -> Self

Converts to this type from the input type.

impl PartialEq for ChainCode

fn eq(&self, other: &ChainCode) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl TryFrom<&[u8]> for ChainCode

type Error = Error

The type returned in the event of a conversion error.

fn try_from(bytes: &[u8]) -> Result<Self>

Performs the conversion.

impl TryFrom<Vec<u8>> for ChainCode

type Error = Error

The type returned in the event of a conversion error.

fn try_from(bytes: Vec<u8>) -> Result<Self>

Performs the conversion.

impl Eq for ChainCode

impl StructuralPartialEq for ChainCode