snarkvm-console-program 4.6.1

Program operations for a decentralized virtual machine
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
98
99

// Copyright (c) 2019-2026 Provable Inc.
// This file is part of the snarkVM library.

// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at:

// http://www.apache.org/licenses/LICENSE-2.0

// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

use snarkvm_console_collections::merkle_tree::MerklePath;
use snarkvm_console_network::BHPMerkleTree;

/// The depth of the Merkle tree for the blocks.
pub const BLOCKS_DEPTH: u8 = 32;
/// The depth of the Merkle tree for the block header.
pub const HEADER_DEPTH: u8 = 3;
/// The depth of the Merkle tree for finalize operations in a transaction.
/// A transaction can include at most `2^FINALIZE_ID_DEPTH` finalize operations total (across *all* transitions).
/// Note that `MAX_WRITES * MAX_TRANSITIONS` can exceed that Merkle-tree capacity.
pub const FINALIZE_ID_DEPTH: u8 = TRANSACTION_DEPTH + 4; // '+ 4' is to support an average of 16 finalize operations per transition.
/// The depth of the Merkle tree for finalize operations in a block.
pub const FINALIZE_OPERATIONS_DEPTH: u8 = TRANSACTIONS_DEPTH;
/// The depth of the Merkle tree for the ratifications in a block.
pub const RATIFICATIONS_DEPTH: u8 = 16;
/// The depth the Merkle tree for the subdag certificates in a block.
pub const SUBDAG_CERTIFICATES_DEPTH: u8 = 16;
/// The depth of the Merkle tree for transactions in a block.
/// Note: The technical limit is 2^20 - 1 transactions, to allow compatibility with the
/// finalize operations tree, which requires 1 leaf for the ratified finalize ID.
pub const TRANSACTIONS_DEPTH: u8 = 20;
/// The depth of the Merkle tree for the transaction.
pub const TRANSACTION_DEPTH: u8 = 5;
/// The depth of the Merkle tree for the transition.
pub const TRANSITION_DEPTH: u8 = 5;

/// The Merkle tree for the block state.
pub type BlockTree<N> = BHPMerkleTree<N, BLOCKS_DEPTH>;
/// The Merkle path for the state tree blocks.
pub type BlockPath<N> = MerklePath<N, BLOCKS_DEPTH>;

/// The Merkle tree for the block header.
pub type HeaderTree<N> = BHPMerkleTree<N, HEADER_DEPTH>;
/// The Merkle path for the block header.
pub type HeaderPath<N> = MerklePath<N, HEADER_DEPTH>;

/// The Merkle tree for ratifications in a block.
pub type RatificationsTree<N> = BHPMerkleTree<N, RATIFICATIONS_DEPTH>;
/// The Merkle path for a ratification in a block.
pub type RatificationsPath<N> = MerklePath<N, RATIFICATIONS_DEPTH>;

/// The Merkle tree for transactions in a block.
pub type TransactionsTree<N> = BHPMerkleTree<N, TRANSACTIONS_DEPTH>;
/// The Merkle path for a transaction in a block.
pub type TransactionsPath<N> = MerklePath<N, TRANSACTIONS_DEPTH>;

/// The Merkle tree for the transaction.
pub type TransactionTree<N> = BHPMerkleTree<N, TRANSACTION_DEPTH>;
/// The Merkle path for a function or transition in the transaction.
pub type TransactionPath<N> = MerklePath<N, TRANSACTION_DEPTH>;

/// The Merkle tree for the execution.
pub type ExecutionTree<N> = BHPMerkleTree<N, TRANSACTION_DEPTH>;
/// The Merkle tree for the deployment.
pub type DeploymentTree<N> = BHPMerkleTree<N, TRANSACTION_DEPTH>;

/// The Merkle tree for the transition.
pub type TransitionTree<N> = BHPMerkleTree<N, TRANSITION_DEPTH>;
/// The Merkle path for an input or output ID in the transition.
pub type TransitionPath<N> = MerklePath<N, TRANSITION_DEPTH>;

#[cfg(test)]
mod tests {
    use super::*;
    use snarkvm_console_network::Network;

    type CurrentNetwork = snarkvm_console_network::MainnetV0;

    #[test]
    fn test_transaction_depth_is_correct() {
        // We ensure 2^TRANSACTION_DEPTH - 1 == MAX_FUNCTIONS.
        // The "- 1" is for the fee transition.
        assert_eq!((2u32.checked_pow(TRANSACTION_DEPTH as u32).unwrap() - 1) as usize, CurrentNetwork::MAX_FUNCTIONS);
    }

    #[test]
    fn test_transition_depth_is_correct() {
        // We ensure 2^TRANSITION_DEPTH == (MAX_INPUTS + MAX_OUTPUTS).
        assert_eq!(
            2u32.checked_pow(TRANSITION_DEPTH as u32).unwrap() as usize,
            CurrentNetwork::MAX_INPUTS + CurrentNetwork::MAX_OUTPUTS
        );
    }
}