Struct hdpath::AccountHDPath

pub struct AccountHDPath { /* private fields */ }

Account-only HD Path for BIP-44, BIP-49, BIP-84 and similar.

It’s not supposed to be used to derive actual addresses, but only to build other path based on this

Represents m/purpose'/coin_type'/account'/x/x, like m/44'/0'/0'/x/x.

Create new

use hdpath::{AccountHDPath, Purpose};

//creates path m/84'/0'/0'
let hd_account = AccountHDPath::new(Purpose::Witness, 0, 0);

Parse string

use hdpath::{AccountHDPath};

//creates path m/84'/0'/0'
let hd_account = AccountHDPath::from_str("m/84'/0'/0'").unwrap();

Internal type and index can be explicitly market as unused (which is the default format for converting it into a string).

use hdpath::{AccountHDPath};

//creates path m/84'/0'/0'
let hd_account = AccountHDPath::from_str("m/84'/0'/0'/x/x").unwrap();

Create actial path

use hdpath::{AccountHDPath, Purpose, StandardHDPath};

let hd_account = AccountHDPath::from_str("m/84'/0'/0'").unwrap();
// gives hd path m/84'/0'/0'/0/4
let hd_path: StandardHDPath = hd_account.address_at(0, 4).unwrap();

Implementations

impl AccountHDPath

pub fn new(purpose: Purpose, coin_type: u32, account: u32) -> AccountHDPath

pub fn try_new(
    purpose: Purpose,
    coin_type: u32,
    account: u32
) -> Result<AccountHDPath, (String, u32)>

pub fn address_at(
    &self,
    change: u32,
    index: u32
) -> Result<StandardHDPath, (String, u32)>

Derive path to an address withing this account path

let hd_account = AccountHDPath::try_from("m/84'/0'/0'").unwrap();
// gives hd path m/84'/0'/0'/0/4
let hd_path: StandardHDPath = hd_account.address_at(0, 4).unwrap();

Return error (field_name, invalid_value) if the field has an incorrect value. It may happed if change or index are in hardened space.

pub fn purpose(&self) -> &Purpose

pub fn coin_type(&self) -> u32

pub fn account(&self) -> u32

Trait Implementations

impl Clone for AccountHDPath

fn clone(&self) -> AccountHDPath

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AccountHDPath

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

Formats the value using the given formatter.

impl Display for AccountHDPath

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

Formats the value using the given formatter.

impl From<&'_ StandardHDPath> for AccountHDPath

fn from(value: &StandardHDPath) -> Self

Converts to this type from the input type.

impl From<StandardHDPath> for AccountHDPath

fn from(value: StandardHDPath) -> Self

Converts to this type from the input type.

impl FromStr for AccountHDPath

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl HDPath for AccountHDPath

fn len(&self) -> u8

Size of the HD Path

fn get(&self, pos: u8) -> Option<PathValue>

Get element as the specified position. The implementation must return Some<PathValue> for all values up to len(). And return None if the position if out of bounds.

fn to_bytes(&self) -> Vec<u8>

Encode as bytes, where first byte is number of elements in path (always 5 for StandardHDPath) following by 4-byte BE values

fn parent(&self) -> Option<CustomHDPath>

Get parent HD Path. Return None if the current path is empty (i.e. already at the top)

fn as_custom(&self) -> CustomHDPath

Convert current to CustomHDPath structure

impl PartialEq<AccountHDPath> for AccountHDPath

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl TryFrom<&'_ str> for AccountHDPath

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: &str) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<CustomHDPath> for AccountHDPath

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: CustomHDPath) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for AccountHDPath

impl StructuralEq for AccountHDPath

impl StructuralPartialEq for AccountHDPath