Struct phoenix_core::Note

pub struct Note { /* private fields */ }

A note that does not encrypt its value

Implementations

impl Note

pub fn new<R: RngCore + CryptoRng>( rng: &mut R, note_type: NoteType, sender_pk: &PublicKey, receiver_pk: &PublicKey, value: u64, value_blinder: JubJubScalar, sender_blinder: [JubJubScalar; 2], ) -> Self

Creates a new phoenix output note

pub fn transparent<R: RngCore + CryptoRng>( rng: &mut R, sender_pk: &PublicKey, receiver_pk: &PublicKey, value: u64, sender_blinder: [JubJubScalar; 2], ) -> Self

Creates a new transparent note

The blinding factor will be constant zero since the value commitment exists only to shield the value. The value is not hidden for transparent notes, so this can be trivially treated as a constant.

pub fn transparent_stealth( stealth_address: StealthAddress, value: u64, sender_enc: [(JubJubAffine, JubJubAffine); 2], ) -> Self

Creates a new transparent note

This is equivalent to [transparent] but taking only a stealth address and a value. This is done to be able to generate a note directly for a stealth address, as opposed to a public key.

pub fn obfuscated<R: RngCore + CryptoRng>( rng: &mut R, sender_pk: &PublicKey, receiver_pk: &PublicKey, value: u64, value_blinder: JubJubScalar, sender_blinder: [JubJubScalar; 2], ) -> Self

Creates a new obfuscated note

The provided blinding factor will be used to calculate the value commitment of the note. The tuple (value, value_blinder), known by the caller of this function, must be later used to prove the knowledge of the value commitment of this note.

pub fn empty() -> Self

Creates a new empty Note

pub fn gen_nullifier(&self, sk: &SecretKey) -> BlsScalar

Create a unique nullifier for the note

This nullifier is represeted as H(note_sk · G', pos)

pub fn hash_inputs(&self) -> [BlsScalar; 6]

Return the internal representation of scalars to be hashed

pub fn hash(&self) -> BlsScalar

Return a hash represented by `H(note_type, value_commitment, H(StealthAddress), pos, encrypted_data)

pub const fn note_type(&self) -> NoteType

Return the type of the note

pub const fn pos(&self) -> &u64

Return the position of the note on the tree.

pub const fn stealth_address(&self) -> &StealthAddress

Returns the the stealth address associated with the note.

pub fn set_pos(&mut self, pos: u64)

Set the position of the note on the tree. This, naturally, won’t reflect immediatelly on the data storage

pub const fn value_commitment(&self) -> &JubJubAffine

Return the value commitment H(value, value_blinder)

pub const fn value_enc(&self) -> &[u8; 68]

Returns the cipher of the encrypted data

pub const fn sender_enc(&self) -> &[(JubJubAffine, JubJubAffine); 2]

Returns elgamal encryption of the sender’s PublicKey encrypted using the StealthAddress::note_pk so only the receiver of the Note can decrypt.

pub fn value(&self, vk: Option<&ViewKey>) -> Result<u64, Error>

Attempt to decrypt the note value provided a ViewKey. Always succeeds for transparent notes, might fails or return random values for obfuscated notes if the provided view key is wrong.

pub fn value_blinder(&self, vk: Option<&ViewKey>) -> Result<JubJubScalar, Error>

Decrypt the blinding factor with the provided ViewKey

If the decrypt fails, a random value is returned

pub fn decrypt_sender(&self, note_sk: &NoteSecretKey) -> PublicKey

Decrypts the PublicKey of the sender of the Note, using the NoteSecretKey generated by the receiver’s SecretKey and the StealthAddress of the Note.

Note: Decryption with an incorrect NoteSecretKey will still yield a PublicKey, but it will a random one that has nothing to do with the sender’s PublicKey.

Trait Implementations

impl Clone for Note

fn clone(&self) -> Note

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Note

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

Formats the value using the given formatter.

impl PartialEq for Note

fn eq(&self, other: &Self) -> 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 Serializable<SIZE> for Note

fn to_bytes(&self) -> [u8; 301]

Converts a Note into a byte representation

fn from_bytes(bytes: &[u8; 301]) -> Result<Self, Self::Error>

Attempts to convert a byte representation of a note into a Note, failing if the input is invalid

type Error = Error

The type returned in the event of a conversion error.

const SIZE: usize = N

The size of

impl Eq for Note