Struct Note

pub struct Note { /* private fields */ }

A plaintext Penumbra note.

Implementations

impl Note

pub fn controlled_by(&self, fvk: &FullViewingKey) -> bool

pub fn from_allocation(allocation: Allocation) -> Result<Note>

Obtain a note corresponding to this allocation.

Note: to ensure determinism, this uses a zero rseed when creating the note.

pub fn from_parts( address: Address, value: Value, rseed: Rseed, ) -> Result<Self, Error>

pub fn payload(&self) -> NotePayload

pub fn generate( rng: &mut (impl Rng + CryptoRng), address: &Address, value: Value, ) -> Self

Generate a fresh note representing the given value for the given destination address, with a random blinding factor.

pub fn address(&self) -> Address

pub fn diversified_generator(&self) -> Element

pub fn transmission_key(&self) -> &Public

pub fn transmission_key_s(&self) -> Fq

pub fn clue_key(&self) -> &ClueKey

pub fn diversifier(&self) -> &Diversifier

pub fn ephemeral_secret_key(&self) -> Secret

pub fn ephemeral_public_key(&self) -> Public

pub fn note_blinding(&self) -> Fq

pub fn value(&self) -> Value

pub fn asset_id(&self) -> Id

pub fn amount(&self) -> Amount

pub fn rseed(&self) -> Rseed

pub fn encrypt(&self) -> NoteCiphertext

Encrypt a note, returning its ciphertext.

pub fn encrypt_key( &self, ovk: &OutgoingViewingKey, cv: Commitment, ) -> OvkWrappedKey

Generate encrypted outgoing cipher key for use with this note.

pub fn decrypt_key( wrapped_ovk: OvkWrappedKey, cm: StateCommitment, cv: Commitment, ovk: &OutgoingViewingKey, epk: &Public, ) -> Result<SharedSecret, Error>

Decrypt wrapped OVK to generate the transmission key and ephemeral secret

pub fn decrypt_outgoing( ciphertext: &NoteCiphertext, wrapped_ovk: OvkWrappedKey, cm: StateCommitment, cv: Commitment, ovk: &OutgoingViewingKey, epk: &Public, ) -> Result<Note, Error>

Decrypt a note ciphertext using the wrapped OVK to generate a plaintext Note.

pub fn decrypt( ciphertext: &NoteCiphertext, ivk: &IncomingViewingKey, epk: &Public, ) -> Result<Note, Error>

Decrypt a note ciphertext using the IVK and ephemeral public key to generate a plaintext Note.

pub fn decrypt_with_payload_key( ciphertext: &NoteCiphertext, payload_key: &PayloadKey, epk: &Public, ) -> Result<Note, Error>

Decrypt a note ciphertext using the PayloadKey.

pub fn commit(&self) -> StateCommitment

Create the note commitment for this note.

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

Trait Implementations

impl AllocVar<Note, Fq> for NoteVar

fn new_variable<T: Borrow<Note>>( 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 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<'de> Deserialize<'de> for Note

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&Note> for [u8; 160]

fn from(note: &Note) -> [u8; 160]

Converts to this type from the input type.

impl From<&Note> for Vec<u8>

fn from(note: &Note) -> Vec<u8>

Converts to this type from the input type.

impl From<Note> for [u8; 160]

fn from(note: Note) -> [u8; 160]

Converts to this type from the input type.

impl From<Note> for Note

fn from(msg: Note) -> Self

Converts to this type from the input type.

impl PartialEq for Note

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

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 Note

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

impl TryFrom<&[u8]> for Note

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<[u8; 160]> for Note

type Error = Error

The type returned in the event of a conversion error.

fn try_from(bytes: [u8; 160]) -> Result<Note, Self::Error>

Performs the conversion.

impl TryFrom<Note> for Note

type Error = Error

The type returned in the event of a conversion error.

fn try_from(msg: Note) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<NoteView> for Note

type Error = Error

The type returned in the event of a conversion error.

fn try_from(view: NoteView) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for Note

impl StructuralPartialEq for Note