Struct bip351::Sender

pub struct Sender(_);

A struct that a sender of funds uses in combination with a recipient’s PaymentCode in order to send notifications and calculate payment addresses. This is invariant with regard to recipient and needs to be constructed only once per account (unique per BIP32 seed + account).

Implementations

impl Sender

pub fn from_seed<C: Signing>(
    secp: &Secp256k1<C>,
    seed: &[u8],
    network: Network,
    account: u32
) -> Result<Self, Error>

Construct a sender side from a BIP32 seed.

pub fn from_master_xprv<C: Signing>(
    secp: &Secp256k1<C>,
    master: ExtendedPrivKey,
    account: u32
) -> Result<Self, Error>

Construct a sender side from a master extended private key. Not supplying a master key here produces an error.

pub fn notify(
    &self,
    secp: &Secp256k1<All>,
    payment_code: &PaymentCode,
    recipient_index: u32,
    address_type: AddressType
) -> Result<(TxOut, SenderCommitment), Error>

Construct a notification for a payment code. The txout is an OP_RETURN consuming 0 sats. The returned SenderCommitment is used for subsequent interaction with the payment code.

recipient_index must be unique for each recipient as it uniquely defines the relationship between a sender and a recipient.

pub fn address(
    &self,
    secp: &Secp256k1<All>,
    commitment: &SenderCommitment,
    addr_index: u64
) -> Result<Address, Error>

Generate an address for a recipient that has already been notified.

pub fn network(&self) -> Network

Get the network used by this sender.

Trait Implementations

impl Clone for Sender

fn clone(&self) -> Sender

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Sender

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

Formats the value using the given formatter.

impl PartialEq<Sender> for Sender

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Sender

impl StructuralEq for Sender

impl StructuralPartialEq for Sender