metadata.rs

use super::{AccountId, Felt, Word};

/// Represents metadata associated with a note. This includes the sender, tag, and number of assets.
/// - sender is the account which created the note.
/// - tag is a tag which can be used to identify the target account for the note.
/// - num_assets is the number of assets in the note.
#[derive(Debug, Eq, PartialEq)]
pub struct NoteMetadata {
    sender: AccountId,
    tag: Felt,
    num_assets: Felt,
}

impl NoteMetadata {
    /// Returns a new note metadata object created with the specified parameters.
    pub fn new(sender: AccountId, tag: Felt, num_assets: Felt) -> Self {
        Self {
            sender,
            tag,
            num_assets,
        }
    }

    /// Returns the account which created the note.
    pub fn sender(&self) -> AccountId {
        self.sender
    }

    /// Returns the tag associated with the note.
    pub fn tag(&self) -> Felt {
        self.tag
    }

    /// Returns the number of assets in the note.
    pub fn num_assets(&self) -> Felt {
        self.num_assets
    }
}

impl From<&NoteMetadata> for Word {
    fn from(metadata: &NoteMetadata) -> Self {
        let mut elements = Word::default();
        elements[0] = metadata.num_assets;
        elements[1] = metadata.tag;
        elements[2] = metadata.sender.into();
        elements
    }
}