Struct Nullifier

pub struct Nullifier(/* private fields */);

A note’s nullifier.

A note’s nullifier is computed as:

hash(serial_num, script_root, input_commitment, asset_commitment).

This achieves the following properties:

• Every note can be reduced to a single unique nullifier.
• We cannot derive a note’s commitment from its nullifier, or a note’s nullifier from its hash.
• To compute the nullifier we must know all components of the note: serial_num, script_root, input_commitment and asset_commitment.

Implementations

impl Nullifier

pub fn new( script_root: Digest, inputs_commitment: Digest, asset_commitment: Digest, serial_num: Word, ) -> Self

Returns a new note Nullifier instantiated from the provided digest.

pub fn as_elements(&self) -> &[Felt]

Returns the elements of this nullifier.

pub fn most_significant_felt(&self) -> Felt

Returns the most significant felt (the last element in array)

pub fn inner(&self) -> Digest

Returns the digest defining this nullifier.

pub fn prefix(&self) -> u16

Returns the prefix of this nullifier.

Nullifier prefix is defined as the 16 most significant bits of the nullifier value.

pub fn from_hex(hex_value: &str) -> Result<Self, HexParseError>

Creates a Nullifier from a hex string. Assumes that the string starts with “0x” and that the hexadecimal characters are big-endian encoded.

pub fn to_hex(&self) -> String

Returns a big-endian, hex-encoded string.

Trait Implementations

impl Clone for Nullifier

fn clone(&self) -> Nullifier

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Nullifier

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

Formats the value using the given formatter.

impl Deserializable for Nullifier

fn read_from<R: ByteReader>( source: &mut R, ) -> Result<Self, DeserializationError>

Reads a sequence of bytes from the provided source, attempts to deserialize these bytes into Self, and returns the result.

fn read_from_bytes(bytes: &[u8]) -> Result<Self, DeserializationError>

Attempts to deserialize the provided bytes into Self and returns the result.

impl Display for Nullifier

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

Formats the value using the given formatter.

impl From<&NoteDetails> for Nullifier

fn from(note: &NoteDetails) -> Self

Converts to this type from the input type.

impl From<&Nullifier> for Word

fn from(nullifier: &Nullifier) -> Self

Converts to this type from the input type.

impl From<&Nullifier> for [u8; 32]

fn from(nullifier: &Nullifier) -> Self

Converts to this type from the input type.

impl From<[BaseElement; 4]> for Nullifier

fn from(value: Word) -> Self

Converts to this type from the input type.

impl From<RpoDigest> for Nullifier

fn from(value: Digest) -> Self

Converts to this type from the input type.

impl From<Nullifier> for Word

fn from(nullifier: Nullifier) -> Self

Converts to this type from the input type.

impl From<Nullifier> for [u8; 32]

fn from(nullifier: Nullifier) -> Self

Converts to this type from the input type.

impl From<Nullifier> for InputNoteCommitment

fn from(nullifier: Nullifier) -> Self

Converts to this type from the input type.

impl Hash for Nullifier

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 Nullifier

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

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

fn partial_cmp(&self, other: &Nullifier) -> 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 Serializable for Nullifier

fn write_into<W: ByteWriter>(&self, target: &mut W)

Serializes self into bytes and writes these bytes into the target.

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

Serializes self into a vector of bytes.

fn get_size_hint(&self) -> usize

Returns an estimate of how many bytes are needed to represent self.

impl Copy for Nullifier

impl Eq for Nullifier

impl StructuralPartialEq for Nullifier