Struct phoenix_core::Note
source · pub struct Note { /* private fields */ }
Expand description
A note that does not encrypt its value
Implementations§
source§impl Note
impl Note
sourcepub 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
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
sourcepub fn transparent<R: RngCore + CryptoRng>(
rng: &mut R,
sender_pk: &PublicKey,
receiver_pk: &PublicKey,
value: u64,
sender_blinder: [JubJubScalar; 2],
) -> Self
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.
sourcepub fn transparent_stealth(
stealth_address: StealthAddress,
value: u64,
sender: impl Into<Sender>,
) -> Self
pub fn transparent_stealth( stealth_address: StealthAddress, value: u64, sender: impl Into<Sender>, ) -> 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.
sourcepub fn obfuscated<R: RngCore + CryptoRng>(
rng: &mut R,
sender_pk: &PublicKey,
receiver_pk: &PublicKey,
value: u64,
value_blinder: JubJubScalar,
sender_blinder: [JubJubScalar; 2],
) -> Self
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.
sourcepub fn gen_nullifier(&self, sk: &SecretKey) -> BlsScalar
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)
sourcepub fn hash_inputs(&self) -> [BlsScalar; 6]
pub fn hash_inputs(&self) -> [BlsScalar; 6]
Return the internal representation of scalars to be hashed
sourcepub fn hash(&self) -> BlsScalar
pub fn hash(&self) -> BlsScalar
Return a hash represented by `H(note_type, value_commitment, H(StealthAddress), pos, encrypted_data)
sourcepub const fn stealth_address(&self) -> &StealthAddress
pub const fn stealth_address(&self) -> &StealthAddress
Returns the the stealth address associated with the note.
sourcepub fn set_pos(&mut self, pos: u64)
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
sourcepub const fn value_commitment(&self) -> &JubJubAffine
pub const fn value_commitment(&self) -> &JubJubAffine
Return the value commitment H(value, value_blinder)
sourcepub const fn sender(&self) -> &Sender
pub const fn sender(&self) -> &Sender
Returns elgamal encryption of the sender’s PublicKey
encrypted using
the StealthAddress::note_pk
so only the receiver of the Note
can decrypt.
sourcepub fn value(&self, vk: Option<&ViewKey>) -> Result<u64, Error>
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.
sourcepub fn value_blinder(&self, vk: Option<&ViewKey>) -> Result<JubJubScalar, Error>
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
Trait Implementations§
source§impl Serializable<SIZE> for Note
impl Serializable<SIZE> for Note
impl Eq for Note
Auto Trait Implementations§
impl Freeze for Note
impl RefUnwindSafe for Note
impl Send for Note
impl Sync for Note
impl Unpin for Note
impl UnwindSafe for Note
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§default unsafe fn clone_to_uninit(&self, dst: *mut T)
default unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)source§impl<T, const N: usize> DeserializableSlice<N> for Twhere
T: Serializable<N>,
impl<T, const N: usize> DeserializableSlice<N> for Twhere
T: Serializable<N>,
source§impl<T> FmtForward for T
impl<T> FmtForward for T
source§fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
self
to use its Binary
implementation when Debug
-formatted.source§fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
self
to use its Display
implementation when
Debug
-formatted.source§fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
self
to use its LowerExp
implementation when
Debug
-formatted.source§fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
self
to use its LowerHex
implementation when
Debug
-formatted.source§fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
self
to use its Octal
implementation when Debug
-formatted.source§fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
self
to use its Pointer
implementation when
Debug
-formatted.source§fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
self
to use its UpperExp
implementation when
Debug
-formatted.source§fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
self
to use its UpperHex
implementation when
Debug
-formatted.source§impl<T, const N: usize> ParseHexStr<N> for Twhere
T: Serializable<N>,
impl<T, const N: usize> ParseHexStr<N> for Twhere
T: Serializable<N>,
source§impl<T> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere
T: ?Sized,
source§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
source§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
self
and passes that borrow into the pipe function. Read moresource§fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
self
and passes that borrow into the pipe function. Read moresource§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
source§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R,
) -> R
fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
source§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
self
, then passes self.as_ref()
into the pipe function.source§fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
self
, then passes self.as_mut()
into the pipe
function.source§fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
self
, then passes self.deref()
into the pipe function.source§impl<T> Tap for T
impl<T> Tap for T
source§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
Borrow<B>
of a value. Read moresource§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
BorrowMut<B>
of a value. Read moresource§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
AsRef<R>
view of a value. Read moresource§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
AsMut<R>
view of a value. Read moresource§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
Deref::Target
of a value. Read moresource§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
Deref::Target
of a value. Read moresource§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
.tap()
only in debug builds, and is erased in release builds.source§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
.tap_mut()
only in debug builds, and is erased in release
builds.source§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
.tap_borrow()
only in debug builds, and is erased in release
builds.source§fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
.tap_borrow_mut()
only in debug builds, and is erased in release
builds.source§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
.tap_ref()
only in debug builds, and is erased in release
builds.source§fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
.tap_ref_mut()
only in debug builds, and is erased in release
builds.source§fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
.tap_deref()
only in debug builds, and is erased in release
builds.