//! Orchard notes

#![allow(clippy::unit_arg)]
#![allow(dead_code)]

use halo2::pasta::pallas;

mod ciphertexts;
mod nullifiers;

#[cfg(any(test, feature = "proptest-impl"))]
mod arbitrary;

use crate::amount::{Amount, NonNegative};

use super::{
    commitment::CommitmentRandomness,
    keys::{Diversifier, TransmissionKey},
};

pub use ciphertexts::EncryptedNote;

pub use nullifiers::Nullifier;

/// A Note represents that a value is spendable by the recipient who
/// holds the spending key corresponding to a given shielded payment
/// address.
#[derive(Clone, Debug)]
pub struct Note {
    /// The diversifer of the recipient’s shielded payment address.
    pub diversifier: Diversifier,
    /// The diversified transmission key of the recipient’s shielded
    /// payment address.
    pub transmission_key: TransmissionKey,
    /// An integer representing the value of the note in zatoshi.
    pub value: Amount<NonNegative>,
    /// Used as input to PRF^nf as part of deriving the nullier of the note.
    pub rho: pallas::Base, // TODO: refine type
    /// Sender-controlled randomness.
    pub psi: pallas::Base, // TODO: refine type
    /// A random commitment trapdoor used to produce the associated
    /// note commitment.
    pub rcm: CommitmentRandomness,
}