miden-protocol 0.14.5

Core components 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

use miden::protocol::account_id
use miden::protocol::util::asset

# RE-EXPORTS
# =================================================================================================

pub use miden::protocol::util::asset::FUNGIBLE_ASSET_MAX_AMOUNT
pub use miden::protocol::util::asset::ASSET_SIZE
pub use miden::protocol::util::asset::ASSET_VALUE_MEMORY_OFFSET
pub use miden::protocol::util::asset::key_to_faucet_id
pub use miden::protocol::util::asset::key_into_faucet_id
pub use miden::protocol::util::asset::key_to_asset_id
pub use miden::protocol::util::asset::key_into_asset_id
pub use miden::protocol::util::asset::key_to_callbacks_enabled
pub use miden::protocol::util::asset::store
pub use miden::protocol::util::asset::load
pub use miden::protocol::util::asset::fungible_value_into_amount
pub use miden::protocol::util::asset::fungible_to_amount
pub use miden::protocol::util::asset::create_fungible_key

# ERRORS
# =================================================================================================

const ERR_FUNGIBLE_ASSET_AMOUNT_EXCEEDS_MAX_ALLOWED_AMOUNT="fungible asset build operation called with amount that exceeds the maximum allowed asset amount"

const ERR_FUNGIBLE_ASSET_PROVIDED_FAUCET_ID_IS_INVALID="failed to build the fungible asset because the provided faucet id is not from a fungible faucet"

const ERR_NON_FUNGIBLE_ASSET_PROVIDED_FAUCET_ID_IS_INVALID="failed to build the non-fungible asset because the provided faucet id is not from a non-fungible faucet"

# PROCEDURES
# =================================================================================================

#! Creates a fungible asset for the specified fungible faucet and amount.
#!
#! Inputs:  [enable_callbacks, faucet_id_suffix, faucet_id_prefix, amount]
#! Outputs: [ASSET_KEY, ASSET_VALUE]
#!
#! Where:
#! - enable_callbacks is a flag (0 or 1) indicating whether asset callbacks are enabled.
#! - faucet_id_{suffix,prefix} are the suffix and prefix felts of the faucet to create the asset
#!   for.
#! - amount is the amount of the asset to create.
#! - ASSET_KEY is the vault key of the created fungible asset.
#! - ASSET_VALUE is the value of the created fungible asset.
#!
#! Panics if:
#! - the provided faucet ID is not a fungible faucet.
#! - the provided amount exceeds FUNGIBLE_ASSET_MAX_AMOUNT.
#! - enable_callbacks is not 0 or 1.
#!
#! Invocation: exec
pub proc create_fungible_asset
    # assert the faucet is a fungible faucet
    dup.2 exec.account_id::is_fungible_faucet assert.err=ERR_FUNGIBLE_ASSET_PROVIDED_FAUCET_ID_IS_INVALID
    # => [enable_callbacks, faucet_id_suffix, faucet_id_prefix, amount]

    # assert the amount is valid
    dup.3 lte.FUNGIBLE_ASSET_MAX_AMOUNT
    assert.err=ERR_FUNGIBLE_ASSET_AMOUNT_EXCEEDS_MAX_ALLOWED_AMOUNT
    # => [enable_callbacks, faucet_id_suffix, faucet_id_prefix, amount]

    # SAFETY: faucet ID and amount were validated
    exec.asset::create_fungible_asset_unchecked
    # => [ASSET_KEY, ASSET_VALUE]
end

#! Creates a non fungible asset for the specified non-fungible faucet.
#!
#! Inputs:  [enable_callbacks, faucet_id_suffix, faucet_id_prefix, DATA_HASH]
#! Outputs: [ASSET_KEY, ASSET_VALUE]
#!
#! Where:
#! - enable_callbacks is a flag (0 or 1) indicating whether asset callbacks are enabled.
#! - faucet_id_{suffix,prefix} are the suffix and prefix felts of the faucet to create the asset
#!   for.
#! - DATA_HASH is the data hash of the non-fungible asset to create.
#! - ASSET_KEY is the vault key of the created non-fungible asset.
#! - ASSET_VALUE is the value of the created non-fungible asset, which is identical to DATA_HASH.
#!
#! Panics if:
#! - the provided faucet ID is not a non-fungible faucet.
#! - enable_callbacks is not 0 or 1.
#!
#! Invocation: exec
pub proc create_non_fungible_asset
    # assert the faucet is a non-fungible faucet
    dup.2 exec.account_id::is_non_fungible_faucet
    assert.err=ERR_NON_FUNGIBLE_ASSET_PROVIDED_FAUCET_ID_IS_INVALID
    # => [enable_callbacks, faucet_id_suffix, faucet_id_prefix, DATA_HASH]

    # SAFETY: faucet ID was validated
    exec.::miden::protocol::util::asset::create_non_fungible_asset_unchecked
    # => [ASSET_KEY, ASSET_VALUE]
end