Skip to main content

KeyDeriver

Struct KeyDeriver 

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

Key derivation for BRC-42/BRC-43 protocols. KeyDeriver derives various types of keys using a root private key.

Supports deriving public and private keys, symmetric keys, and revealing key linkages, all using BRC-42 Type-42 derivation.

Implementations§

Source§

impl KeyDeriver

Source

pub fn new(private_key: PrivateKey) -> KeyDeriver

Create a new KeyDeriver from a root private key.

Source

pub fn new_anyone() -> KeyDeriver

Create a KeyDeriver using the special “anyone” key (PrivateKey(1)).

Source

pub fn root_key(&self) -> &PrivateKey

Returns a reference to the root private key.

Source

pub fn identity_key(&self) -> PublicKey

Returns the public key corresponding to the root private key.

Source

pub fn identity_key_hex(&self) -> String

Returns the identity key as a compressed DER hex string.

Source

pub fn derive_private_key( &self, protocol: &Protocol, key_id: &str, counterparty: &Counterparty, ) -> Result<PrivateKey, WalletError>

Derive a private key for the given protocol, key ID, and counterparty.

Source

pub fn derive_public_key( &self, protocol: &Protocol, key_id: &str, counterparty: &Counterparty, for_self: bool, ) -> Result<PublicKey, WalletError>

Derive a public key for the given protocol, key ID, and counterparty.

If for_self is true, derives the private child key first and returns its public key. If false, derives directly on the counterparty’s public key.

Source

pub fn derive_symmetric_key( &self, protocol: &Protocol, key_id: &str, counterparty: &Counterparty, ) -> Result<SymmetricKey, WalletError>

Derive a symmetric key from the ECDH shared secret of the derived private and public keys.

The symmetric key is the x-coordinate of the shared secret point.

Source

pub fn reveal_counterparty_secret( &self, counterparty: &Counterparty, ) -> Result<PublicKey, WalletError>

Reveal the counterparty shared secret as a public key point.

Cannot be used for counterparty type “self”.

Source

pub fn reveal_specific_secret( &self, counterparty: &Counterparty, protocol: &Protocol, key_id: &str, ) -> Result<Vec<u8>, WalletError>

Reveal a specific secret for the given protocol and key ID.

Computes HMAC-SHA256 of the shared secret (compressed) and the invoice number string.

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

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

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

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

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: 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
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: 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
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.
Source§

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

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

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

fn with_current_subscriber(self) -> WithDispatch<Self>

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