Skip to main content

DerivationPath

aptos_sdk::account

Struct DerivationPath

pub struct DerivationPath { /* private fields */ }

Available on crate feature mnemonic only.

Expand description

A parsed BIP-32 / BIP-44 derivation path.

Use Self::aptos_ed25519 / Self::aptos_secp256k1 for the canonical Aptos paths, or Self::from_str to parse a custom path of the form m/44'/637'/0'/0'/0'.

Implementations§

impl DerivationPath

pub fn components(&self) -> &[PathComponent]

Returns the path components in order.

pub fn is_fully_hardened(&self) -> bool

Returns true iff every component in the path is hardened.

Ed25519 derivation rejects paths that are not fully hardened.

pub fn aptos_ed25519(address_index: u32) -> AptosResult<Self>

Builds the canonical Aptos Ed25519 derivation path m/44'/637'/0'/0'/{address_index}'.

The address_index is placed in the final (address) BIP-44 component for backward compatibility with the pre-existing Mnemonic::derive_ed25519_key(index) behavior. Callers needing to vary the BIP-44 account index (the Petra/TS-SDK convention) should construct the path explicitly via Self::from_str and pass it to Mnemonic::derive_ed25519_key_at_path.

All five components are hardened, matching the TypeScript SDK’s APTOS_HARDENED_REGEX.

§Errors

Returns AptosError::KeyDerivation if address_index >= 2^31 (the top bit is reserved as the BIP-32 hardened flag).

pub fn aptos_secp256k1(address_index: u32) -> AptosResult<Self>

Builds the canonical Aptos Secp256k1 derivation path m/44'/637'/0'/0/{address_index}.

The address_index is placed in the final (address) BIP-44 component for symmetry with Self::aptos_ed25519. The last two indices are non-hardened, matching the TypeScript SDK’s APTOS_BIP44_REGEX. Callers needing to vary the BIP-44 account index should construct the path explicitly via Self::from_str.

§Errors

Returns AptosError::KeyDerivation if address_index >= 2^31.

pub fn from_str(path: &str) -> AptosResult<Self>

Parses a derivation path of the form m/44'/637'/0'/0'/0'.

Apostrophes (') and lowercase h are accepted as hardened markers. The leading m/ (or M/) prefix is required.

This is a convenience wrapper around the std::str::FromStr implementation; both produce identical results.

§Errors

Returns AptosError::KeyDerivation if the path is malformed, a component is missing, the numeric value exceeds 2^31 - 1, or the path is empty.

Trait Implementations§

impl Clone for DerivationPath

fn clone(&self) -> DerivationPath

Returns a duplicate of the value. Read more

1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more

impl Debug for DerivationPath

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

Formats the value using the given formatter. Read more

impl Display for DerivationPath

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

Formats the value using the given formatter. Read more

impl Eq for DerivationPath

impl FromStr for DerivationPath

type Err = AptosError

The associated error which can be returned from parsing.

fn from_str(path: &str) -> AptosResult<Self>

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

impl PartialEq for DerivationPath

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

Equality operator ==. Read more

1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more

impl StructuralPartialEq for DerivationPath

Auto Trait Implementations§

impl Freeze for DerivationPath

impl RefUnwindSafe for DerivationPath

impl Send for DerivationPath

impl Sync for DerivationPath

impl Unpin for DerivationPath

impl UnsafeUnpin for DerivationPath

impl UnwindSafe for DerivationPath

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

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

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

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

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

fn into(self) -> U

Calls U::from(self).

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

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

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] only if self and other return Action::Follow. Read more

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] if either self or other returns Action::Follow. Read more

impl<T> Same for T

type Output = T

Should always be Self

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

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

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

fn to_string(&self) -> String

Converts the given value to a String. Read more

impl<T> ToStringFallible for T
where T: Display,

fn try_to_string(&self) -> Result<String, TryReserveError>

ToString::to_string, but without panic on OOM.

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more