Enum elements::confidential::Nonce

pub enum Nonce {
    Null,
    Explicit([u8; 32]),
    Confidential(PublicKey),
}

A CT commitment to an output nonce (i.e. a public key)

Variants

Null

No value

Explicit([u8; 32])

There should be no such thing as an “explicit nonce”, but Elements will deserialize such a thing (and insists that its size be 32 bytes). So we stick a 32-byte type here that implements all the traits we need.

Confidential(PublicKey)

Nonce is committed

Implementations

impl Nonce

pub fn new_confidential<R: RngCore + CryptoRng, C: Signing>( rng: &mut R, secp: &Secp256k1<C>, receiver_blinding_pk: &PublicKey ) -> (Self, SecretKey)

Create nonce commitment.

pub fn with_ephemeral_sk<C: Signing>( secp: &Secp256k1<C>, ephemeral_sk: SecretKey, receiver_blinding_pk: &PublicKey ) -> (Self, SecretKey)

Similar to Nonce::new_confidential, but with a given ephemeral_sk instead of sampling it from rng.

pub fn shared_secret( &self, receiver_blinding_sk: &SecretKey ) -> Option<SecretKey>

Calculate the shared secret.

pub fn encoded_length(&self) -> usize

Serialized length, in bytes

pub fn from_commitment(bytes: &[u8]) -> Result<Self, Error>

Create from commitment.

pub fn is_null(&self) -> bool

Check if the object is null.

pub fn is_explicit(&self) -> bool

Check if the object is explicit.

pub fn is_confidential(&self) -> bool

Check if the object is confidential.

pub fn explicit(&self) -> Option<[u8; 32]>

Returns the explicit inner value. Returns None if Nonce::is_explicit returns false.

pub fn commitment(&self) -> Option<PublicKey>

Returns the confidential commitment in case of a confidential value. Returns None if Nonce::is_confidential returns false.

Trait Implementations

impl Clone for Nonce

fn clone(&self) -> Nonce

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Nonce

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

Formats the value using the given formatter.

impl Decodable for Nonce

fn consensus_decode<D: Read>(d: D) -> Result<Self, Error>

Decode an object with a well-defined format

impl Default for Nonce

fn default() -> Self

Returns the “default value” for a type.

impl Display for Nonce

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

Formats the value using the given formatter.

impl Encodable for Nonce

fn consensus_encode<S: Write>(&self, s: S) -> Result<usize, Error>

Encode an object with a well-defined format, should only ever error if the underlying Write errors. Returns the number of bytes written on success

impl From<PublicKey> for Nonce

fn from(from: PublicKey) -> Self

Converts to this type from the input type.

impl Hash for Nonce

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 Nonce

fn cmp(&self, other: &Nonce) -> 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 + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for Nonce

fn eq(&self, other: &Nonce) -> 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 PartialOrd for Nonce

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl Copy for Nonce

impl Eq for Nonce

impl StructuralPartialEq for Nonce