-
Notifications
You must be signed in to change notification settings - Fork 58
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
wallet-core: ensure the pick notes code will works on FFI too
- Change custom vectors with `owned::List` instead - Change the module structure: avoid clippy pedantic while keeping the same lib's root symbols
- Loading branch information
Showing
7 changed files
with
291 additions
and
242 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,73 @@ | ||
| // This Source Code Form is subject to the terms of the Mozilla Public | ||
| // License, v. 2.0. If a copy of the MPL was not distributed with this | ||
| // file, You can obtain one at http://mozilla.org/MPL/2.0/. | ||
| // | ||
| // Copyright (c) DUSK NETWORK. All rights reserved. | ||
|
|
||
| //! Provides functions and types for calculate notes' balance. | ||
| use alloc::vec::Vec; | ||
|
|
||
| use dusk_bytes::{DeserializableSlice, Serializable, Write}; | ||
| use execution_core::transfer::phoenix::{Note, ViewKey as PhoenixViewKey}; | ||
|
|
||
| use crate::notes::MAX_INPUT_NOTES; | ||
|
|
||
| /// Calculate the sum for all the given [`Note`]s that belong to the given | ||
| /// [`PhoenixViewKey`]. | ||
| pub fn calculate<T>( | ||
| vk: &PhoenixViewKey, | ||
| notes: impl Iterator<Item = T>, | ||
| ) -> TotalAmount | ||
| where | ||
| T: AsRef<Note>, | ||
| { | ||
| let mut values: Vec<u64> = notes | ||
| .filter_map(|note| note.as_ref().value(Some(vk)).ok()) | ||
| .collect(); | ||
|
|
||
| values.sort_by(|a, b| b.cmp(a)); | ||
|
|
||
| let spendable = values.iter().take(MAX_INPUT_NOTES).sum(); | ||
| let value = spendable + values.iter().skip(MAX_INPUT_NOTES).sum::<u64>(); | ||
|
|
||
| TotalAmount { value, spendable } | ||
| } | ||
|
|
||
| /// Information about the balance of a particular key. | ||
| #[derive(Debug, Default, Hash, Clone, Copy, PartialEq, Eq)] | ||
| pub struct TotalAmount { | ||
| /// The total value of the balance. | ||
| pub value: u64, | ||
| /// The maximum _spendable_ value in a single transaction. This is | ||
| /// different from `value` since there is a maximum number of notes one can | ||
| /// spend. | ||
| pub spendable: u64, | ||
| } | ||
|
|
||
| impl Serializable<{ 2 * u64::SIZE }> for TotalAmount { | ||
| type Error = dusk_bytes::Error; | ||
|
|
||
| fn from_bytes(buf: &[u8; Self::SIZE]) -> Result<Self, Self::Error> | ||
| where | ||
| Self: Sized, | ||
| { | ||
| let mut reader = &buf[..]; | ||
|
|
||
| let value = u64::from_reader(&mut reader)?; | ||
| let spendable = u64::from_reader(&mut reader)?; | ||
|
|
||
| Ok(Self { value, spendable }) | ||
| } | ||
|
|
||
| #[allow(unused_must_use)] | ||
| fn to_bytes(&self) -> [u8; Self::SIZE] { | ||
| let mut buf = [0u8; Self::SIZE]; | ||
| let mut writer = &mut buf[..]; | ||
|
|
||
| writer.write(&self.value.to_bytes()); | ||
| writer.write(&self.spendable.to_bytes()); | ||
|
|
||
| buf | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,110 @@ | ||
| // This Source Code Form is subject to the terms of the Mozilla Public | ||
| // License, v. 2.0. If a copy of the MPL was not distributed with this | ||
| // file, You can obtain one at http://mozilla.org/MPL/2.0/. | ||
| // | ||
| // Copyright (c) DUSK NETWORK. All rights reserved. | ||
|
|
||
| //! Provides functions and types to handle notes' ownership. | ||
| use alloc::vec::Vec; | ||
|
|
||
| use core::ops::Index; | ||
| use core::slice::Iter; | ||
| use execution_core::{ | ||
| transfer::phoenix::{NoteLeaf, SecretKey as PhoenixSecretKey}, | ||
| BlsScalar, | ||
| }; | ||
| use rkyv::{Archive, Deserialize, Serialize}; | ||
|
|
||
| /// A collection of notes stored as key-value pairs. | ||
| /// The key is a `BlsScalar` and the value is a `NoteLeaf`. | ||
| /// Duplicates are allowed. | ||
| #[derive(Default, Archive, Serialize, Deserialize, Debug, PartialEq, Clone)] | ||
| pub struct List { | ||
| /// The underlying storage of key-value pairs where | ||
| /// `BlsScalar` is the key and `NoteLeaf` is the value. | ||
| entries: Vec<(BlsScalar, NoteLeaf)>, | ||
| } | ||
|
|
||
| impl List { | ||
| /// Inserts a new key-value pair into the collection. | ||
| pub fn insert(&mut self, key: BlsScalar, value: NoteLeaf) { | ||
| self.entries.push((key, value)); | ||
| } | ||
|
|
||
| /// Returns the number of entries (key-value pairs) in the collection. | ||
| #[must_use] | ||
| pub fn len(&self) -> usize { | ||
| self.entries.len() | ||
| } | ||
|
|
||
| /// Checks if the collection is empty. | ||
| #[must_use] | ||
| pub fn is_empty(&self) -> bool { | ||
| self.entries.is_empty() | ||
| } | ||
|
|
||
| /// Retrieves the value (`NoteLeaf`) associated with a given key | ||
| #[must_use] | ||
| pub fn get(&self, key: &BlsScalar) -> Option<&NoteLeaf> { | ||
| self.entries.iter().find(|(k, _)| k == key).map(|(_, v)| v) | ||
| } | ||
|
|
||
| /// Retrieves all keys in the collection. | ||
| #[must_use] | ||
| pub fn keys(&self) -> Vec<BlsScalar> { | ||
| self.entries.iter().map(|(k, _)| *k).collect() | ||
| } | ||
|
|
||
| /// Returns an iterator over the key-value pairs. | ||
| pub fn iter(&self) -> Iter<'_, (BlsScalar, NoteLeaf)> { | ||
| self.entries.iter() | ||
| } | ||
| } | ||
|
|
||
| impl Index<&BlsScalar> for List { | ||
| type Output = NoteLeaf; | ||
|
|
||
| /// Retrieves the value (`NoteLeaf`) associated with a given key | ||
| /// (`BlsScalar`). | ||
| /// | ||
| /// Panics if the key is not found in the collection. | ||
| fn index(&self, index: &BlsScalar) -> &Self::Output { | ||
| self.get(index).expect("key not found") | ||
| } | ||
| } | ||
|
|
||
| impl<'a> IntoIterator for &'a List { | ||
| type IntoIter = core::slice::Iter<'a, (BlsScalar, NoteLeaf)>; | ||
| type Item = &'a (BlsScalar, NoteLeaf); | ||
| fn into_iter(self) -> Self::IntoIter { | ||
| self.iter() | ||
| } | ||
| } | ||
|
|
||
| impl From<Vec<(BlsScalar, NoteLeaf)>> for List { | ||
| fn from(entries: Vec<(BlsScalar, NoteLeaf)>) -> Self { | ||
| List { entries } | ||
| } | ||
| } | ||
|
|
||
| /// Filter all notes and their block height that are owned by the given keys, | ||
| /// mapped to their nullifiers. | ||
| pub fn map( | ||
| keys: impl AsRef<[PhoenixSecretKey]>, | ||
| notes: impl AsRef<[NoteLeaf]>, | ||
| ) -> List { | ||
| notes | ||
| .as_ref() | ||
| .iter() | ||
| .fold(List::default(), |mut notes_map, note_leaf| { | ||
| for sk in keys.as_ref() { | ||
| if sk.owns(note_leaf.note.stealth_address()) { | ||
| let nullifier = note_leaf.note.gen_nullifier(sk); | ||
| notes_map.insert(nullifier, note_leaf.clone()); | ||
| break; | ||
| } | ||
| } | ||
| notes_map | ||
| }) | ||
| } |
Oops, something went wrong.