Struct Address

pub struct Address { /* private fields */ }

A valid payment address.

Implementations

impl Address

pub fn from_components( d: Diversifier, pk_d: Public, ck_d: ClueKey, ) -> Option<Self>

Constructs a payment address from its components.

Returns None if the bytes in pk_d are a non-canonical representation of an Fq s value.

pub fn diversifier(&self) -> &Diversifier

Returns a reference to the address diversifier.

pub fn diversified_generator(&self) -> &Element

Returns a reference to the diversified base.

This method computes the diversified base if it has not been computed yet. This value is cached after it has been computed once.

pub fn transmission_key(&self) -> &Public

Returns a reference to the transmission key.

pub fn clue_key(&self) -> &ClueKey

Returns a reference to the clue key.

pub fn transmission_key_s(&self) -> &Fq

Returns a reference to the transmission key s value.

pub fn to_vec(&self) -> Vec<u8>

Converts this address to a vector of bytes.

pub fn dummy<R: CryptoRng + Rng>(rng: &mut R) -> Self

Generates a randomized dummy address.

pub fn display_short_form(&self) -> String

Short form suitable for displaying in a UI.

pub fn compat_encoding(&self) -> String

Compat (bech32 non-m) address format

pub fn noble_forwarding_address(&self, channel: &str) -> NobleForwardingAddress

Generate a Noble forwarding address.

pub fn encode_as_transparent_address(&self) -> Option<String>

Encodes the address as a transparent address if it has zero diversifier and clue key. Returns None if the address doesn’t meet the requirements for a transparent address.

Trait Implementations

impl AllocVar<Address, Fq> for AddressVar

fn new_variable<T: Borrow<Address>>( cs: impl Into<Namespace<Fq>>, f: impl FnOnce() -> Result<T, SynthesisError>, mode: AllocationMode, ) -> Result<Self, SynthesisError>

Allocates a new variable of type Self in the ConstraintSystem cs. The mode of allocation is decided by mode.

fn new_constant( cs: impl Into<Namespace<F>>, t: impl Borrow<V>, ) -> Result<Self, SynthesisError>

Allocates a new constant of type Self in the ConstraintSystem cs.

fn new_input<T>( cs: impl Into<Namespace<F>>, f: impl FnOnce() -> Result<T, SynthesisError>, ) -> Result<Self, SynthesisError>

where T: Borrow<V>,

Allocates a new public input of type Self in the ConstraintSystem cs.

fn new_witness<T>( cs: impl Into<Namespace<F>>, f: impl FnOnce() -> Result<T, SynthesisError>, ) -> Result<Self, SynthesisError>

where T: Borrow<V>,

Allocates a new private witness of type Self in the ConstraintSystem cs.

impl Clone for Address

fn clone(&self) -> Address

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Address

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Address

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Address

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

Formats the value using the given formatter.

impl DomainType for Address

type Proto = Address

fn encode_to_vec(&self) -> Vec<u8>

Encode this domain type to a byte vector, via proto type P.

fn to_proto(&self) -> Self::Proto

Convert this domain type to the associated proto type.

fn decode<B>(buf: B) -> Result<Self, Error>

where B: Buf,

Decode this domain type from a byte buffer, via proto type P.

impl From<&Address> for Address

fn from(a: &Address) -> Self

Converts to this type from the input type.

impl From<Address> for Address

fn from(a: Address) -> Self

Converts to this type from the input type.

impl FromStr for Address

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

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

impl Hash for Address

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Address

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Address

fn eq(&self, rhs: &Self) -> 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 PartialOrd for Address

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for Address

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl ToConstraintField<Fq> for Address

fn to_field_elements(&self) -> Option<Vec<Fq>>

impl TryFrom<&[u8]> for Address

type Error = Error

The type returned in the event of a conversion error.

fn try_from(jumbled_bytes: &[u8]) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&Vec<u8>> for Address

type Error = Error

The type returned in the event of a conversion error.

fn try_from(jumbled_vec: &Vec<u8>) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Address> for Address

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Address) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Vec<u8>> for Address

type Error = Error

The type returned in the event of a conversion error.

fn try_from(jumbled_vec: Vec<u8>) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for Address