Struct SpDescriptor 

pub struct SpDescriptor { /* private fields */ }

A BIP 392 Silent Payments descriptor.

Contains an SpAddress (scan + spend public keys) plus optional BIP 393 annotations for wallet configuration.

Construction

use silent_payments_core::address::SpAddress;
use silent_payments_core::keys::{ScanPublicKey, SpendPublicKey};
use bitcoin::Network;
use bitcoin::secp256k1::{Secp256k1, SecretKey};
use silent_payments_descriptor::SpDescriptor;

let secp = Secp256k1::new();
let sk = SecretKey::from_slice(&[0x01; 32]).unwrap();
let pk = sk.public_key(&secp);
let addr = SpAddress::new(ScanPublicKey::from(pk), SpendPublicKey::from(pk), Network::Bitcoin);
let desc = SpDescriptor::from(addr).with_birthday_height(850000);
assert_eq!(desc.birthday_height(), Some(850000));

Implementations

impl SpDescriptor

pub fn address(&self) -> &SpAddress

Returns a reference to the wrapped SpAddress.

pub fn birthday_height(&self) -> Option<u32>

Returns the wallet birthday height annotation, if set.

pub fn gap_limit(&self) -> Option<u32>

Returns the gap limit annotation, if set.

pub fn max_labels(&self) -> Option<u32>

Returns the max labels annotation, if set.

pub fn with_birthday_height(self, height: u32) -> SpDescriptor

Returns a new descriptor with the birthday height annotation set.

Does not mutate self; returns a new value (immutable builder pattern).

pub fn with_gap_limit(self, limit: u32) -> SpDescriptor

Returns a new descriptor with the gap limit annotation set.

Does not mutate self; returns a new value (immutable builder pattern).

pub fn with_max_labels(self, max: u32) -> SpDescriptor

Returns a new descriptor with the max labels annotation set.

Does not mutate self; returns a new value (immutable builder pattern).

Trait Implementations

impl Clone for SpDescriptor

fn clone(&self) -> SpDescriptor

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SpDescriptor

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

Formats the value using the given formatter.

impl Display for SpDescriptor

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

Formats the value using the given formatter.

impl From<SpAddress> for SpDescriptor

fn from(address: SpAddress) -> SpDescriptor

Converts to this type from the input type.

impl FromStr for SpDescriptor

type Err = DescriptorError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<SpDescriptor, <SpDescriptor as FromStr>::Err>

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

impl PartialEq for SpDescriptor

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Eq for SpDescriptor

impl StructuralPartialEq for SpDescriptor