miden-standards 0.16.0-alpha.3

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
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97

use miden_protocol::account::StorageSlotName;
use miden_protocol::errors::{AccountError, TokenSymbolError};
use thiserror::Error;

use crate::account::access::Ownable2StepError;
use crate::utils::FixedWidthStringError;

mod fungible;
mod non_fungible;
mod token_metadata;

pub use fungible::{
    FungibleFaucet,
    FungibleFaucetBuilder,
    create_guarded_user_fungible_faucet,
    create_multisig_user_fungible_faucet,
    create_network_fungible_faucet,
    create_singlesig_user_fungible_faucet,
};
pub use non_fungible::{
    AssetStatus,
    NonFungibleFaucet,
    NonFungibleFaucetBuilder,
    create_network_non_fungible_faucet,
    create_user_non_fungible_faucet,
};
pub use token_metadata::{Description, ExternalLink, LogoURI, TokenMetadata, TokenName};

// TOKEN METADATA ERROR
// ================================================================================================

/// Errors raised when parsing token metadata from storage.
#[derive(Debug, Error)]
pub enum TokenMetadataError {
    #[error("failed to retrieve storage slot with name {slot_name}")]
    StorageLookupFailed {
        slot_name: StorageSlotName,
        source: AccountError,
    },
    #[error("invalid string data in field '{field}'")]
    InvalidStringField {
        field: &'static str,
        #[source]
        source: FixedWidthStringError,
    },
    #[error("mutability flag at index {index} has invalid value {value}: must be 0 or 1")]
    InvalidMutabilityFlag { index: usize, value: u64 },
    #[error("storage slot name mismatch: expected {expected}, got {actual}")]
    SlotNameMismatch {
        expected: StorageSlotName,
        actual: StorageSlotName,
    },
    #[error("invalid token symbol")]
    InvalidTokenSymbol(#[source] TokenSymbolError),
}

// FUNGIBLE FAUCET ERROR
// ================================================================================================

/// Basic fungible faucet related errors.
#[derive(Debug, Error)]
pub enum FungibleFaucetError {
    #[error("faucet metadata decimals is {actual} which exceeds max value of {max}")]
    TooManyDecimals { actual: u64, max: u8 },
    #[error("faucet metadata max supply is {actual} which exceeds max value of {max}")]
    MaxSupplyTooLarge { actual: u64, max: u64 },
    #[error("token supply {token_supply} exceeds max_supply {max_supply}")]
    TokenSupplyExceedsMaxSupply { token_supply: u64, max_supply: u64 },
    #[error(
        "account interface does not have the procedures of the basic fungible faucet component"
    )]
    MissingFungibleFaucetInterface,
    #[error("account creation failed")]
    AccountError(#[source] AccountError),
    #[error("account is not a fungible faucet account")]
    NotAFungibleFaucetAccount,
    #[error("failed to read ownership data from storage")]
    OwnershipError(#[source] Ownable2StepError),
    #[error(transparent)]
    TokenMetadata(#[from] TokenMetadataError),
}

// NON-FUNGIBLE FAUCET ERROR
// ================================================================================================

/// Non-fungible (NFT) faucet related errors.
#[derive(Debug, Error)]
pub enum NonFungibleFaucetError {
    #[error("account creation failed")]
    AccountCreationFailed(#[source] AccountError),
    #[error("account is not a non-fungible faucet account")]
    NotANonFungibleFaucetAccount,
    #[error("asset status registry holds invalid status code {status}: must be 0, 1 or 2")]
    InvalidAssetStatus { status: u64 },
    #[error(transparent)]
    TokenMetadata(#[from] TokenMetadataError),
}