Skip to main content

Deriver

Struct Deriver 

Source
pub struct Deriver<'a> { /* private fields */ }
Expand description

Casper address deriver from a unified wallet seed.

Default algorithm is KeyAlgo::Secp256k1 (Ledger path). Switch with with_algo or per-call derive_with.

Implementations§

Source§

impl<'a> Deriver<'a>

Source

pub const fn new(wallet: &'a Wallet) -> Self

Create a deriver with the default algorithm (KeyAlgo::Secp256k1).

Source

pub const fn with_algo(wallet: &'a Wallet, algo: KeyAlgo) -> Self

Create a deriver locked to algo for Derive::derive / Derive::derive_path.

Source

pub const fn algo(&self) -> KeyAlgo

Algorithm used by Derive::derive and Derive::derive_path.

Source

pub fn derive(&self, index: u32) -> Result<CasperAccount, DeriveError>

Derive at the default path for the deriver’s algorithm.

§Errors

Returns an error if key derivation or AccountHash hashing fails.

Source

pub fn derive_with( &self, algo: KeyAlgo, index: u32, ) -> Result<CasperAccount, DeriveError>

Derive at the default path for an explicit algorithm.

§Errors

Returns an error if key derivation or AccountHash hashing fails.

Source

pub fn derive_at(&self, path: &str) -> Result<CasperAccount, DeriveError>

Derive at an arbitrary path using the deriver’s stored algorithm for tagging / AccountHash.

Prefer derive_at_with when the path and algorithm must be specified together.

§Errors

Returns an error if key derivation or AccountHash hashing fails.

Source

pub fn derive_at_with( &self, path: &str, algo: KeyAlgo, ) -> Result<CasperAccount, DeriveError>

Derive at an arbitrary path with an explicit algorithm (encoding).

The path must be valid for the curve of algo (BIP-32 for secp, fully hardened SLIP-10 for Ed25519).

§Errors

Returns an error if key derivation or AccountHash hashing fails.

Trait Implementations§

Source§

impl<'a> Debug for Deriver<'a>

Source§

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

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

impl Derive for Deriver<'_>

Source§

type Account = CasperAccount

The (possibly newtype) account returned by this deriver. Read more
Source§

type Error = DeriveError

The error type returned by derivation operations.
Source§

fn derive(&self, index: u32) -> Result<CasperAccount, DeriveError>

Derive an account at the given index using the chain’s default path. Read more
Source§

fn derive_path(&self, path: &str) -> Result<CasperAccount, DeriveError>

Derive an account at a custom path string. Read more

Auto Trait Implementations§

§

impl<'a> Freeze for Deriver<'a>

§

impl<'a> RefUnwindSafe for Deriver<'a>

§

impl<'a> Send for Deriver<'a>

§

impl<'a> Sync for Deriver<'a>

§

impl<'a> Unpin for Deriver<'a>

§

impl<'a> UnsafeUnpin for Deriver<'a>

§

impl<'a> UnwindSafe for Deriver<'a>

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> DeriveExt for T
where T: Derive,

Source§

fn derive_many( &self, start: u32, count: u32, ) -> Result<Vec<Self::Account>, Self::Error>

Derive count accounts starting at index start. 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> Same for T

Source§

type Output = T

Should always be Self
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.