miden-standards 0.17.0

Standards of the Miden protocol
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33

use miden_protocol::note::NoteAttachmentScheme;

/// The [`NoteAttachmentScheme`]s of standard note attachments.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
#[non_exhaustive]
pub enum StandardNoteAttachment {
    /// See [`NetworkAccountTarget`](crate::note::NetworkAccountTarget) for details.
    NetworkAccountTarget,
    /// The attachment scheme used by both PSWAP output notes (payback P2ID + remainder PSWAP).
    /// Carries the word `[amount, order_id, depth, 0]`. See
    /// [`PswapNote`](crate::note::PswapNote) for details.
    PswapAttachment,
    /// The USDCx mint attachment carrying the attestation and deposit intent.
    UsdcxMint,
    /// The USDCx burn attachment carrying the withdrawal destination.
    UsdcxBurn,
    /// See [`AccountCodeUpgradeAttachment`](crate::note::AccountCodeUpgradeAttachment) for
    /// details.
    AccountCodeUpgrade,
}

impl StandardNoteAttachment {
    /// Returns the [`NoteAttachmentScheme`] of the standard attachment.
    pub const fn attachment_scheme(&self) -> NoteAttachmentScheme {
        match self {
            StandardNoteAttachment::NetworkAccountTarget => NoteAttachmentScheme::new_const(2u16),
            StandardNoteAttachment::PswapAttachment => NoteAttachmentScheme::new_const(3u16),
            StandardNoteAttachment::UsdcxMint => NoteAttachmentScheme::new_const(4u16),
            StandardNoteAttachment::UsdcxBurn => NoteAttachmentScheme::new_const(5u16),
            StandardNoteAttachment::AccountCodeUpgrade => NoteAttachmentScheme::new_const(7u16),
        }
    }
}