Struct AccountHDPath

Source
pub struct AccountHDPath { /* private fields */ }
Expand description

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§

Source§

impl AccountHDPath

Source

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

Source

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

Source

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.

Source

pub fn purpose(&self) -> &Purpose

Source

pub fn coin_type(&self) -> u32

Source

pub fn account(&self) -> u32

Trait Implementations§

Source§

impl Clone for AccountHDPath

Source§

fn clone(&self) -> AccountHDPath

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for AccountHDPath

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Display for AccountHDPath

Source§

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

Formats the value using the given formatter. Read more
Source§

impl From<&StandardHDPath> for AccountHDPath

Source§

fn from(value: &StandardHDPath) -> Self

Converts to this type from the input type.
Source§

impl From<StandardHDPath> for AccountHDPath

Source§

fn from(value: StandardHDPath) -> Self

Converts to this type from the input type.
Source§

impl FromStr for AccountHDPath

Source§

type Err = Error

The associated error which can be returned from parsing.
Source§

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

Parses a string s to return a value of this type. Read more
Source§

impl HDPath for AccountHDPath

Source§

fn len(&self) -> u8

Size of the HD Path
Source§

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. Read more
Source§

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
Source§

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

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

fn as_custom(&self) -> CustomHDPath

Convert current to CustomHDPath structure
Source§

impl Hash for AccountHDPath

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for AccountHDPath

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl TryFrom<&str> for AccountHDPath

Source§

type Error = Error

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

impl TryFrom<CustomHDPath> for AccountHDPath

Source§

type Error = Error

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

impl Eq for AccountHDPath

Source§

impl StructuralPartialEq for AccountHDPath

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.