mirror of https://github.com/zcash/orchard.git
Publicize diversifier method of Address, fix comments, etc
This commit is contained in:
parent
22e7ba14a2
commit
0800d23fe7
12
CHANGELOG.md
12
CHANGELOG.md
|
@ -6,12 +6,12 @@ and this project adheres to Rust's notion of
|
|||
[Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
||||
|
||||
## [Unreleased]
|
||||
### Changed
|
||||
- `note`:
|
||||
- `RandomSeed` and its functions `from_bytes` and `as_bytes` now public
|
||||
- `Note::from_parts` now public
|
||||
- added pub fn `random_seed`
|
||||
- `keys::Diversifier::from_bytes` now public
|
||||
### Added
|
||||
- `orchard::address::Address::diversifier`
|
||||
- `orchard::keys::Diversifier::from_bytes`
|
||||
- `orchard::note`:
|
||||
- `RandomSeed`
|
||||
- `Note::{from_parts, rseed}`
|
||||
|
||||
## [0.2.0] - 2022-06-24
|
||||
### Added
|
||||
|
|
|
@ -30,7 +30,8 @@ impl Address {
|
|||
Address { d, pk_d }
|
||||
}
|
||||
|
||||
pub(crate) fn diversifier(&self) -> Diversifier {
|
||||
/// Returns the [`Diversifier`] for this `Address`.
|
||||
pub fn diversifier(&self) -> Diversifier {
|
||||
self.d
|
||||
}
|
||||
|
||||
|
|
|
@ -552,7 +552,7 @@ impl DiversifierKey {
|
|||
pub struct Diversifier([u8; 11]);
|
||||
|
||||
impl Diversifier {
|
||||
///Read a diversifier from a byte array.
|
||||
/// Reads a diversifier from a byte array.
|
||||
pub fn from_bytes(d: [u8; 11]) -> Self {
|
||||
Diversifier(d)
|
||||
}
|
||||
|
@ -1050,7 +1050,8 @@ mod tests {
|
|||
NoteValue::from_raw(tv.note_v),
|
||||
rho,
|
||||
RandomSeed::from_bytes(tv.note_rseed, &rho).unwrap(),
|
||||
);
|
||||
)
|
||||
.unwrap();
|
||||
|
||||
let cmx: ExtractedNoteCommitment = note.commitment().into();
|
||||
assert_eq!(cmx.to_bytes(), tv.note_cmx);
|
||||
|
|
45
src/note.rs
45
src/note.rs
|
@ -35,8 +35,9 @@ impl RandomSeed {
|
|||
}
|
||||
}
|
||||
|
||||
///Read a note's random seed from bytes, given the note's nullifier.
|
||||
///Returns None if the nullifier is not for the same note as the seed.
|
||||
/// Reads a note's random seed from bytes, given the note's nullifier.
|
||||
///
|
||||
/// Returns `None` if the nullifier is not for the same note as the seed.
|
||||
pub fn from_bytes(rseed: [u8; 32], rho: &Nullifier) -> CtOption<Self> {
|
||||
let rseed = RandomSeed(rseed);
|
||||
let esk = rseed.esk_inner(rho);
|
||||
|
@ -111,24 +112,33 @@ impl PartialEq for Note {
|
|||
impl Eq for Note {}
|
||||
|
||||
impl Note {
|
||||
///Create a Note from its component parts.
|
||||
/// Creates a `Note` from its component parts.
|
||||
///
|
||||
/// Returns `None` if a valid [`NoteCommitment`] cannot be derived from the note.
|
||||
///
|
||||
/// # Caveats
|
||||
///
|
||||
/// This low-level constructor enforces that the provided arguments produce an
|
||||
/// internally valid `Note`. However, it allows notes to be constructed in a way that
|
||||
/// violates required security checks for note decryption, as specified in
|
||||
/// [Section 4.19] of the Zcash Protocol Specification. Users of this constructor
|
||||
/// should only call it with note components that have been fully validated by
|
||||
/// decrypting a received note according to [Section 4.19].
|
||||
///
|
||||
/// [Section 4.19]: https://zips.z.cash/protocol/protocol.pdf#saplingandorchardinband
|
||||
pub fn from_parts(
|
||||
recipient: Address,
|
||||
value: NoteValue,
|
||||
rho: Nullifier,
|
||||
rseed: RandomSeed,
|
||||
) -> Self {
|
||||
Note {
|
||||
) -> CtOption<Self> {
|
||||
let note = Note {
|
||||
recipient,
|
||||
value,
|
||||
rho,
|
||||
rseed,
|
||||
}
|
||||
}
|
||||
|
||||
///Get the seed randomness used by the note
|
||||
pub fn random_seed(&self) -> &RandomSeed {
|
||||
&self.rseed
|
||||
};
|
||||
CtOption::new(note, note.commitment_inner().is_some())
|
||||
}
|
||||
|
||||
/// Generates a new note.
|
||||
|
@ -143,14 +153,9 @@ impl Note {
|
|||
mut rng: impl RngCore,
|
||||
) -> Self {
|
||||
loop {
|
||||
let note = Note {
|
||||
recipient,
|
||||
value,
|
||||
rho,
|
||||
rseed: RandomSeed::random(&mut rng, &rho),
|
||||
};
|
||||
if note.commitment_inner().is_some().into() {
|
||||
break note;
|
||||
let note = Note::from_parts(recipient, value, rho, RandomSeed::random(&mut rng, &rho));
|
||||
if note.is_some().into() {
|
||||
break note.unwrap();
|
||||
}
|
||||
}
|
||||
}
|
||||
|
@ -189,7 +194,7 @@ impl Note {
|
|||
}
|
||||
|
||||
/// Returns the rseed value of this note.
|
||||
pub(crate) fn rseed(&self) -> &RandomSeed {
|
||||
pub fn rseed(&self) -> &RandomSeed {
|
||||
&self.rseed
|
||||
}
|
||||
|
||||
|
|
|
@ -75,7 +75,7 @@ where
|
|||
let pk_d = get_validated_pk_d(&diversifier)?;
|
||||
|
||||
let recipient = Address::from_parts(diversifier, pk_d);
|
||||
let note = Note::from_parts(recipient, value, domain.rho, rseed);
|
||||
let note = Option::from(Note::from_parts(recipient, value, domain.rho, rseed))?;
|
||||
Some((note, recipient))
|
||||
}
|
||||
|
||||
|
@ -396,7 +396,7 @@ mod tests {
|
|||
assert_eq!(ock.as_ref(), tv.ock);
|
||||
|
||||
let recipient = Address::from_parts(d, pk_d);
|
||||
let note = Note::from_parts(recipient, value, rho, rseed);
|
||||
let note = Note::from_parts(recipient, value, rho, rseed).unwrap();
|
||||
assert_eq!(ExtractedNoteCommitment::from(note.commitment()), cmx);
|
||||
|
||||
let action = Action::from_parts(
|
||||
|
|
Loading…
Reference in New Issue