Skip to content

Simplify compute_asset_desc_hash function #161

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ConstanceBeguier merged 6 commits into from
May 6, 2025
Merged

Simplify compute_asset_desc_hash function #161

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
784dd06
Simplify compute_asset_desc_hash function
ConstanceBeguier Apr 25, 2025
ec8496d
Take into account review
ConstanceBeguier May 5, 2025
0306120
Update compute_asset_desc_hash to panic when asset_desc is not UTF8 e…
ConstanceBeguier May 5, 2025
48c39db
Change visibility of get_burn_tuple function to private
ConstanceBeguier May 5, 2025
7c14e13
Update panic message
ConstanceBeguier May 6, 2025
3d4d7da
Merge branch 'zsa1' into clean_asset_desc
ConstanceBeguier May 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
67 changes: 49 additions & 18 deletions src/bundle/burn_validation.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,43 +67,50 @@ impl fmt::Display for BurnError {
mod tests {
use crate::issuance::compute_asset_desc_hash;
use crate::value::NoteValue;
use nonempty::NonEmpty;

use super::*;

/// Creates an item of bundle burn list for a given asset description and value.
/// Creates an item of bundle burn list for a given asset description hash and value.
///
/// This function is deterministic and guarantees that each call with the same parameters
/// will return the same result. It achieves determinism by using a static `IssuanceAuthorizingKey`.
///
/// # Arguments
///
/// * `asset_desc` - The asset description string.
/// * `asset_desc_hash` - The asset description hash.
/// * `value` - The value for the burn.
///
/// # Returns
///
/// A tuple `(AssetBase, Amount)` representing the burn list item.
///
pub fn get_burn_tuple(asset_desc: &[u8], value: u64) -> (AssetBase, NoteValue) {
fn get_burn_tuple(asset_desc_hash: &[u8; 32], value: u64) -> (AssetBase, NoteValue) {
use crate::keys::{IssuanceAuthorizingKey, IssuanceValidatingKey};

let isk = IssuanceAuthorizingKey::from_bytes([1u8; 32]).unwrap();

(
AssetBase::derive(
&IssuanceValidatingKey::from(&isk),
&compute_asset_desc_hash(asset_desc).unwrap(),
),
AssetBase::derive(&IssuanceValidatingKey::from(&isk), asset_desc_hash),
NoteValue::from_raw(value),
)
}

#[test]
fn validate_bundle_burn_success() {
let bundle_burn = vec![
get_burn_tuple(b"Asset 1", 10),
get_burn_tuple(b"Asset 2", 20),
get_burn_tuple(b"Asset 3", 10),
get_burn_tuple(
&compute_asset_desc_hash(&NonEmpty::from_slice(b"Asset 1").unwrap()),
10,
),
get_burn_tuple(
&compute_asset_desc_hash(&NonEmpty::from_slice(b"Asset 2").unwrap()),
20,
),
get_burn_tuple(
&compute_asset_desc_hash(&NonEmpty::from_slice(b"Asset 3").unwrap()),
10,
),
];

let result = validate_bundle_burn(&bundle_burn);
Expand All @@ -114,9 +121,18 @@ mod tests {
#[test]
fn validate_bundle_burn_duplicate_asset() {
let bundle_burn = vec![
get_burn_tuple(b"Asset 1", 10),
get_burn_tuple(b"Asset 1", 20),
get_burn_tuple(b"Asset 3", 10),
get_burn_tuple(
&compute_asset_desc_hash(&NonEmpty::from_slice(b"Asset 1").unwrap()),
Copy link
Collaborator

@PaulLaux PaulLaux May 5, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can we add a From<> trait for NonEmpty in our code so we can do b"Asset 1".into() ?

Copy link
Collaborator Author

@ConstanceBeguier ConstanceBeguier May 6, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it is not possible because neither From nor NonEmpty are defined in the current crate.

10,
),
get_burn_tuple(
&compute_asset_desc_hash(&NonEmpty::from_slice(b"Asset 1").unwrap()),
20,
),
get_burn_tuple(
&compute_asset_desc_hash(&NonEmpty::from_slice(b"Asset 3").unwrap()),
10,
),
];

let result = validate_bundle_burn(&bundle_burn);
Expand All @@ -127,9 +143,15 @@ mod tests {
#[test]
fn validate_bundle_burn_native_asset() {
let bundle_burn = vec![
get_burn_tuple(b"Asset 1", 10),
get_burn_tuple(
&compute_asset_desc_hash(&NonEmpty::from_slice(b"Asset 1").unwrap()),
10,
),
(AssetBase::native(), NoteValue::from_raw(20)),
get_burn_tuple(b"Asset 3", 10),
get_burn_tuple(
&compute_asset_desc_hash(&NonEmpty::from_slice(b"Asset 3").unwrap()),
10,
),
];

let result = validate_bundle_burn(&bundle_burn);
Expand All @@ -140,9 +162,18 @@ mod tests {
#[test]
fn validate_bundle_burn_zero_value() {
let bundle_burn = vec![
get_burn_tuple(b"Asset 1", 10),
get_burn_tuple(b"Asset 2", 0),
get_burn_tuple(b"Asset 3", 10),
get_burn_tuple(
&compute_asset_desc_hash(&NonEmpty::from_slice(b"Asset 1").unwrap()),
10,
),
get_burn_tuple(
&compute_asset_desc_hash(&NonEmpty::from_slice(b"Asset 2").unwrap()),
0,
),
get_burn_tuple(
&compute_asset_desc_hash(&NonEmpty::from_slice(b"Asset 3").unwrap()),
10,
),
];

let result = validate_bundle_burn(&bundle_burn);
Expand Down
Loading
Loading