Skip to main content

snarkvm_console_network/
lib.rs

1// Copyright (c) 2019-2026 Provable Inc.
2// This file is part of the snarkVM library.
3
4// Licensed under the Apache License, Version 2.0 (the "License");
5// you may not use this file except in compliance with the License.
6// You may obtain a copy of the License at:
7
8// http://www.apache.org/licenses/LICENSE-2.0
9
10// Unless required by applicable law or agreed to in writing, software
11// distributed under the License is distributed on an "AS IS" BASIS,
12// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13// See the License for the specific language governing permissions and
14// limitations under the License.
15
16#![forbid(unsafe_code)]
17#![allow(clippy::too_many_arguments)]
18#![warn(clippy::cast_possible_truncation)]
19
20#[macro_use]
21extern crate lazy_static;
22
23pub use snarkvm_console_network_environment as environment;
24pub use snarkvm_console_network_environment::*;
25
26mod helpers;
27pub use helpers::*;
28
29mod canary_v0;
30pub use canary_v0::*;
31
32mod consensus_heights;
33pub use consensus_heights::*;
34
35mod mainnet_v0;
36pub use mainnet_v0::*;
37
38mod testnet_v0;
39
40pub use testnet_v0::*;
41
42pub mod prelude {
43    #[cfg(feature = "wasm")]
44    pub use crate::get_or_init_consensus_version_heights;
45    pub use crate::{
46        CANARY_V0_CONSENSUS_VERSION_HEIGHTS,
47        CanaryV0,
48        ConsensusVersion,
49        MAINNET_V0_CONSENSUS_VERSION_HEIGHTS,
50        MainnetV0,
51        Network,
52        TEST_CONSENSUS_VERSION_HEIGHTS,
53        TESTNET_V0_CONSENSUS_VERSION_HEIGHTS,
54        TestnetV0,
55        consensus_config_value,
56        consensus_config_value_by_version,
57        environment::prelude::*,
58    };
59}
60
61pub use crate::environment::prelude::*;
62
63use snarkvm_algorithms::{
64    AlgebraicSponge,
65    crypto_hash::PoseidonSponge,
66    snark::varuna::{CircuitProvingKey, CircuitVerifyingKey, VarunaHidingMode},
67    srs::{UniversalProver, UniversalVerifier},
68};
69use snarkvm_console_algorithms::{BHP512, BHP1024, Poseidon2, Poseidon4, Poseidon8};
70use snarkvm_console_collections::merkle_tree::{MerklePath, MerkleTree};
71use snarkvm_console_types::{Field, Group, Scalar};
72use snarkvm_curves::PairingEngine;
73
74use indexmap::IndexMap;
75use std::sync::{Arc, OnceLock};
76
77/// A helper type for the BHP Merkle tree.
78pub type BHPMerkleTree<N, const DEPTH: u8> = MerkleTree<N, BHP1024<N>, BHP512<N>, DEPTH>;
79/// A helper type for the Poseidon Merkle tree.
80pub type PoseidonMerkleTree<N, const DEPTH: u8> = MerkleTree<N, Poseidon4<N>, Poseidon2<N>, DEPTH>;
81
82/// Helper types for the Varuna parameters.
83type Fq<N> = <<N as Environment>::PairingCurve as PairingEngine>::Fq;
84pub type FiatShamir<N> = PoseidonSponge<Fq<N>, 2, 1>;
85pub type FiatShamirParameters<N> = <FiatShamir<N> as AlgebraicSponge<Fq<N>, 2>>::Parameters;
86
87/// Helper types for the Varuna proving and verifying key.
88pub(crate) type VarunaProvingKey<N> = CircuitProvingKey<<N as Environment>::PairingCurve, VarunaHidingMode>;
89pub(crate) type VarunaVerifyingKey<N> = CircuitVerifyingKey<<N as Environment>::PairingCurve>;
90
91/// A list of consensus versions and their corresponding block heights.
92static CONSENSUS_VERSION_HEIGHTS: OnceLock<[(ConsensusVersion, u32); NUM_CONSENSUS_VERSIONS]> = OnceLock::new();
93
94pub trait Network:
95    'static
96    + Environment
97    + Copy
98    + Clone
99    + Debug
100    + Eq
101    + PartialEq
102    + core::hash::Hash
103    + Serialize
104    + DeserializeOwned
105    + for<'a> Deserialize<'a>
106    + Send
107    + Sync
108{
109    /// The network ID.
110    const ID: u16;
111    /// The (long) network name.
112    const NAME: &'static str;
113    /// The short network name (used, for example, in query URLs).
114    const SHORT_NAME: &'static str;
115
116    /// The function name for the inclusion circuit.
117    const INCLUSION_FUNCTION_NAME: &'static str;
118
119    /// The fixed timestamp of the genesis block.
120    const GENESIS_TIMESTAMP: i64;
121    /// The genesis block coinbase target.
122    const GENESIS_COINBASE_TARGET: u64;
123    /// The genesis block proof target.
124    const GENESIS_PROOF_TARGET: u64;
125    /// The maximum number of solutions that can be included per block as a power of 2.
126    const MAX_SOLUTIONS_AS_POWER_OF_TWO: u8 = 2; // 4 solutions
127    /// The maximum number of solutions that can be included per block.
128    const MAX_SOLUTIONS: usize = 1 << Self::MAX_SOLUTIONS_AS_POWER_OF_TWO; // 4 solutions
129
130    /// The starting supply of Aleo credits.
131    const STARTING_SUPPLY: u64 = 1_500_000_000_000_000; // 1.5B credits
132    /// The maximum supply of Aleo credits.
133    /// This value represents the absolute upper bound on all ALEO created over the lifetime of the network.
134    const MAX_SUPPLY: u64 = 5_000_000_000_000_000; // 5B credits
135    /// The block height that upper bounds the total supply of Aleo credits to 5 billion.
136    #[cfg(not(feature = "test"))]
137    const MAX_SUPPLY_LIMIT_HEIGHT: u32 = 263_527_685;
138    /// The block height that upper bounds the total supply of Aleo credits to 5 billion.
139    /// This is deliberately set to a low value for testing purposes only.
140    #[cfg(feature = "test")]
141    const MAX_SUPPLY_LIMIT_HEIGHT: u32 = 5;
142    /// The cost in microcredits per byte for the deployment transaction.
143    const DEPLOYMENT_FEE_MULTIPLIER: u64 = 1_000; // 1 millicredit per byte
144    /// The multiplier in microcredits for each command in the constructor.
145    const CONSTRUCTOR_FEE_MULTIPLIER: u64 = 100; // 100x per command
146    /// The constant that divides the storage polynomial.
147    const EXECUTION_STORAGE_FEE_SCALING_FACTOR: u64 = 5000;
148    /// The maximum size execution transactions can be before a quadratic storage penalty applies.
149    const EXECUTION_STORAGE_PENALTY_THRESHOLD: u64 = 5000;
150    /// The cost in microcredits per constraint for the deployment transaction.
151    const SYNTHESIS_FEE_MULTIPLIER: u64 = 25; // 25 microcredits per constraint
152    /// The maximum number of variables in a deployment.
153    const MAX_DEPLOYMENT_VARIABLES: u64 = 1 << 21; // 2,097,152 variables
154    /// The maximum number of constraints in a deployment.
155    const MAX_DEPLOYMENT_CONSTRAINTS: u64 = 1 << 21; // 2,097,152 constraints
156    /// The maximum number of instances to verify in a batch proof.
157    const MAX_BATCH_PROOF_INSTANCES: usize = 128;
158    /// The maximum number of microcredits that can be spent as a fee.
159    const MAX_FEE: u64 = 1_000_000_000_000_000;
160    /// A list of consensus versions and their corresponding transaction spend limits in microcredits.
161    //  Note: This value must **not** decrease without considering the impact on transaction validity.
162    const TRANSACTION_SPEND_LIMIT: [(ConsensusVersion, u64); 2] =
163        [(ConsensusVersion::V1, 100_000_000), (ConsensusVersion::V10, 4_000_000)];
164    /// The compute discount approved by ARC 0005.
165    const ARC_0005_COMPUTE_DISCOUNT: u64 =
166        Self::CREDITS_PER_SECOND_OF_RUNTIME[0].1 / Self::CREDITS_PER_SECOND_OF_RUNTIME[1].1;
167    /// The number of microcredits representing a second of runtime.
168    const CREDITS_PER_SECOND_OF_RUNTIME: [(ConsensusVersion, u64); 2] =
169        [(ConsensusVersion::V1, 100_000_000), (ConsensusVersion::V10, 4_000_000)];
170
171    /// The anchor height, defined as the expected number of blocks to reach the coinbase target.
172    /// Note: The anchor height used exclusively by `coinbase_reward_v1`.
173    const ANCHOR_HEIGHT: u32 = Self::REWARD_ANCHOR_TIME as u32 / Self::BLOCK_TIME as u32;
174    /// The anchor time used specifically for calculating the coinbase reward.
175    /// We ensure that the reward anchor time matches the original ConsensusVersion::V1 anchor time
176    /// to maintain the original coinbase reward schedule.
177    const REWARD_ANCHOR_TIME: u16 = 25;
178    /// A list of (consensus_version, anchor_time_in_seconds) pairs (sparse).
179    /// Each entry takes effect at the specified version and remains active until the next entry.
180    /// The anchor time, defined as the expected time in seconds to reach the coinbase target.
181    const ANCHOR_TIMES: [(ConsensusVersion, u16); 3] = [
182        (ConsensusVersion::V1, Self::REWARD_ANCHOR_TIME),
183        (ConsensusVersion::V15, 35),
184        (ConsensusVersion::V17, Self::REWARD_ANCHOR_TIME),
185    ];
186    /// The expected time per block in seconds.
187    const BLOCK_TIME: u16 = 10;
188    /// The number of blocks per epoch.
189    #[cfg(not(feature = "test"))]
190    const NUM_BLOCKS_PER_EPOCH: u32 = 3600 / Self::BLOCK_TIME as u32; // 360 blocks == ~1 hour
191    /// The number of blocks per epoch.
192    /// This is deliberately set to a low value for testing purposes only.
193    #[cfg(feature = "test")]
194    const NUM_BLOCKS_PER_EPOCH: u32 = 10;
195
196    /// The maximum number of entries in data.
197    const MAX_DATA_ENTRIES: usize = 32;
198    /// The maximum recursive depth of an entry.
199    /// Note: This value must be strictly less than u8::MAX.
200    const MAX_DATA_DEPTH: usize = 32;
201    /// The maximum number of fields in data (must not exceed u16::MAX).
202    #[allow(clippy::cast_possible_truncation)]
203    const MAX_DATA_SIZE_IN_FIELDS: u32 = ((128 * 1024 * 8) / Field::<Self>::SIZE_IN_DATA_BITS) as u32;
204
205    /// The minimum number of entries in a struct.
206    const MIN_STRUCT_ENTRIES: usize = 1; // This ensures the struct is not empty.
207    /// The maximum number of entries in a struct.
208    const MAX_STRUCT_ENTRIES: usize = Self::MAX_DATA_ENTRIES;
209
210    /// The minimum number of elements in an array.
211    const MIN_ARRAY_ELEMENTS: usize = 1; // This ensures the array is not empty.
212    ///  A list of (consensus_version, size) pairs indicating the maximum number of elements in an array.
213    const MAX_ARRAY_ELEMENTS: [(ConsensusVersion, usize); 3] =
214        [(ConsensusVersion::V1, 32), (ConsensusVersion::V11, 512), (ConsensusVersion::V14, 2048)];
215
216    /// The minimum number of entries in a record.
217    const MIN_RECORD_ENTRIES: usize = 1; // This accounts for 'record.owner'.
218    /// The maximum number of entries in a record.
219    const MAX_RECORD_ENTRIES: usize = Self::MIN_RECORD_ENTRIES.saturating_add(Self::MAX_DATA_ENTRIES);
220
221    /// The maximum program size by number of characters.
222    const MAX_PROGRAM_SIZE: [(ConsensusVersion, usize); 3] = [
223        (ConsensusVersion::V1, 100_000),    // 100 kB
224        (ConsensusVersion::V14, 512_000),   // 512 kB
225        (ConsensusVersion::V16, 2_048_000), // 2048 kB
226    ];
227    /// The maximum number of mappings in a program.
228    const MAX_MAPPINGS: usize = 31;
229    /// The maximum number of functions in a program.
230    const MAX_FUNCTIONS: usize = 31;
231    /// The maximum number of structs in a program.
232    const MAX_STRUCTS: usize = 10 * Self::MAX_FUNCTIONS;
233    /// The maximum number of records in a program.
234    const MAX_RECORDS: usize = 10 * Self::MAX_FUNCTIONS;
235    /// The maximum number of closures in a program.
236    const MAX_CLOSURES: usize = 2 * Self::MAX_FUNCTIONS;
237    /// The maximum number of view functions in a program.
238    const MAX_VIEWS: usize = 2 * Self::MAX_FUNCTIONS;
239    /// The maximum number of operands in an instruction.
240    const MAX_OPERANDS: usize = Self::MAX_INPUTS;
241    /// The maximum number of instructions in a closure or function.
242    const MAX_INSTRUCTIONS: usize = u16::MAX as usize;
243    /// The maximum number of commands in finalize.
244    const MAX_COMMANDS: usize = u16::MAX as usize;
245    /// The maximum number of `call` commands in a finalize body. Matched to
246    /// `Transaction::MAX_TRANSITIONS` so view-call arity in a finalize is bounded analogously
247    /// to the static-call bound on transition graphs.
248    const MAX_CALLS: usize = 32;
249    /// The maximum number of write commands in finalize.
250    const MAX_WRITES: [(ConsensusVersion, u16); 2] = [(ConsensusVersion::V1, 16), (ConsensusVersion::V14, 32)];
251    /// The maximum number of `position` commands in finalize.
252    const MAX_POSITIONS: usize = u8::MAX as usize;
253
254    /// The maximum number of inputs per transition.
255    const MAX_INPUTS: usize = 16;
256    /// The maximum number of outputs per transition.
257    const MAX_OUTPUTS: usize = 16;
258
259    /// The maximum number of imports.
260    const MAX_IMPORTS: usize = 64;
261
262    /// A list of consensus versions and their corresponding maximum transaction sizes in bytes.
263    ///
264    /// A transaction consists of fixed identifiers, deployment data, and fees.
265    /// Fixed components include identifiers, ownership, checksums, and fees.
266    /// Variable components include the program bytecode and verifying-key entries.
267    /// Verifying-key entries scale with the number of functions and records.
268    ///
269    /// MAX_TRANSACTION_SIZE = C + MAX_PROGRAM_SIZE + (673 + 58) * (MAX_FUNCTIONS + MAX_RECORDS)
270    /// C = fixed size components (Up to 2367 bytes)
271    // Note: This value must **not** decrease without considering the impact on transaction validity.
272    const MAX_TRANSACTION_SIZE: [(ConsensusVersion, usize); 3] = [
273        (ConsensusVersion::V1, 128_000),    // 128 kB
274        (ConsensusVersion::V14, 768_000),   // 768 kB
275        (ConsensusVersion::V16, 2_304_000), // 2304 kB
276    ];
277
278    /// The state root type.
279    type StateRoot: Bech32ID<Field<Self>>;
280    /// The block hash type.
281    type BlockHash: Bech32ID<Field<Self>>;
282    /// The ratification ID type.
283    type RatificationID: Bech32ID<Field<Self>>;
284    /// The transaction ID type.
285    type TransactionID: Bech32ID<Field<Self>>;
286    /// The transition ID type.
287    type TransitionID: Bech32ID<Field<Self>>;
288    /// The transmission checksum type.
289    type TransmissionChecksum: IntegerType;
290
291    /// A list of (consensus_version, block_height) pairs indicating when each consensus version takes effect.
292    /// Documentation for what is changed at each version can be found in `N::CONSENSUS_VERSION`
293    /// Do not read this directly outside of tests, use `N::CONSENSUS_VERSION_HEIGHTS()` instead.
294    const _CONSENSUS_VERSION_HEIGHTS: [(ConsensusVersion, u32); NUM_CONSENSUS_VERSIONS];
295
296    ///  A list of (consensus_version, size) pairs indicating the maximum number of validators in a committee.
297    //  Note: This value must **not** decrease without considering the impact on serialization.
298    //  Decreasing this value will break backwards compatibility of serialization without explicit
299    //  declaration of migration based on round number rather than block height.
300    //  Increasing this value will require a migration to prevent forking during network upgrades.
301    const MAX_CERTIFICATES: [(ConsensusVersion, u16); 5];
302
303    /// Returns the list of consensus versions.
304    #[allow(non_snake_case)]
305    #[cfg(not(any(test, feature = "test", feature = "test_consensus_heights")))]
306    fn CONSENSUS_VERSION_HEIGHTS() -> &'static [(ConsensusVersion, u32); NUM_CONSENSUS_VERSIONS] {
307        // Initialize the consensus version heights directly from the constant.
308        CONSENSUS_VERSION_HEIGHTS.get_or_init(|| Self::_CONSENSUS_VERSION_HEIGHTS)
309    }
310    /// Returns the list of test consensus versions.
311    #[allow(non_snake_case)]
312    #[cfg(any(test, feature = "test", feature = "test_consensus_heights"))]
313    fn CONSENSUS_VERSION_HEIGHTS() -> &'static [(ConsensusVersion, u32); NUM_CONSENSUS_VERSIONS] {
314        CONSENSUS_VERSION_HEIGHTS.get_or_init(load_test_consensus_heights)
315    }
316
317    /// A set of incrementing consensus version heights used for tests.
318    #[allow(non_snake_case)]
319    #[cfg(any(test, feature = "test", feature = "test_consensus_heights"))]
320    const TEST_CONSENSUS_VERSION_HEIGHTS: [(ConsensusVersion, u32); NUM_CONSENSUS_VERSIONS] =
321        TEST_CONSENSUS_VERSION_HEIGHTS;
322    /// Returns the consensus version which is active at the given height.
323    #[allow(non_snake_case)]
324    fn CONSENSUS_VERSION(seek_height: u32) -> anyhow::Result<ConsensusVersion> {
325        match Self::CONSENSUS_VERSION_HEIGHTS().binary_search_by(|(_, height)| height.cmp(&seek_height)) {
326            // If a consensus version was found at this height, return it.
327            Ok(index) => Ok(Self::CONSENSUS_VERSION_HEIGHTS()[index].0),
328            // If the specified height was not found, determine whether to return an appropriate version.
329            Err(index) => {
330                if index == 0 {
331                    Err(anyhow!("Expected consensus version 1 to exist at height 0."))
332                } else {
333                    // Return the appropriate version belonging to the height *lower* than the sought height.
334                    Ok(Self::CONSENSUS_VERSION_HEIGHTS()[index - 1].0)
335                }
336            }
337        }
338    }
339    /// Returns the height at which a specified consensus version becomes active.
340    #[allow(non_snake_case)]
341    fn CONSENSUS_HEIGHT(version: ConsensusVersion) -> Result<u32> {
342        Ok(Self::CONSENSUS_VERSION_HEIGHTS().get(version as usize - 1).ok_or(anyhow!("Invalid consensus version"))?.1)
343    }
344    /// Returns the last `MAX_ARRAY_ELEMENTS` value.
345    #[allow(non_snake_case)]
346    fn LATEST_MAX_ARRAY_ELEMENTS() -> usize {
347        Self::MAX_ARRAY_ELEMENTS.last().expect("MAX_ARRAY_ELEMENTS must have at least one entry").1
348    }
349    /// Returns the last `MAX_CERTIFICATES` value.
350    #[allow(non_snake_case)]
351    fn LATEST_MAX_CERTIFICATES() -> u16 {
352        Self::MAX_CERTIFICATES.last().expect("MAX_CERTIFICATES must have at least one entry").1
353    }
354
355    /// Returns the last `MAX_PROGRAM_SIZE` value.
356    #[allow(non_snake_case)]
357    fn LATEST_MAX_PROGRAM_SIZE() -> usize {
358        Self::MAX_PROGRAM_SIZE.last().expect("MAX_PROGRAM_SIZE must have at least one entry").1
359    }
360
361    /// Returns the last `MAX_WRITES` value.
362    #[allow(non_snake_case)]
363    fn LATEST_MAX_WRITES() -> u16 {
364        Self::MAX_WRITES.last().expect("MAX_WRITES must have at least one entry").1
365    }
366
367    /// Returns the last `MAX_TRANSACTION_SIZE` value.
368    #[allow(non_snake_case)]
369    fn LATEST_MAX_TRANSACTION_SIZE() -> usize {
370        Self::MAX_TRANSACTION_SIZE.last().expect("MAX_TRANSACTION_SIZE must have at least one entry").1
371    }
372
373    /// Returns the block height where the the inclusion proof will be updated.
374    #[allow(non_snake_case)]
375    fn INCLUSION_UPGRADE_HEIGHT() -> Result<u32>;
376
377    /// Returns the genesis block bytes.
378    fn genesis_bytes() -> &'static [u8];
379
380    /// Returns the restrictions list as a JSON-compatible string.
381    fn restrictions_list_as_str() -> &'static str;
382
383    /// Returns the proving key for the given function name in the v0 version of `credits.aleo`.
384    fn get_credits_v0_proving_key(function_name: String) -> Result<&'static Arc<VarunaProvingKey<Self>>>;
385
386    /// Returns the verifying key for the given function name in the v0 version of `credits.aleo`.
387    fn get_credits_v0_verifying_key(function_name: String) -> Result<&'static Arc<VarunaVerifyingKey<Self>>>;
388
389    /// Returns the proving key for the given function name in `credits.aleo`.
390    fn get_credits_proving_key(function_name: String) -> Result<&'static Arc<VarunaProvingKey<Self>>>;
391
392    /// Returns the verifying key for the given function name in `credits.aleo`.
393    fn get_credits_verifying_key(function_name: String) -> Result<&'static Arc<VarunaVerifyingKey<Self>>>;
394
395    #[cfg(not(feature = "wasm"))]
396    /// Returns the `proving key` for the inclusion_v0 circuit.
397    fn inclusion_v0_proving_key() -> &'static Arc<VarunaProvingKey<Self>>;
398
399    #[cfg(feature = "wasm")]
400    /// Returns the `proving key` for the inclusion_v0 circuit.
401    fn inclusion_v0_proving_key(bytes: Option<Vec<u8>>) -> &'static Arc<VarunaProvingKey<Self>>;
402
403    /// Returns the `verifying key` for the inclusion_v0 circuit.
404    fn inclusion_v0_verifying_key() -> &'static Arc<VarunaVerifyingKey<Self>>;
405
406    #[cfg(not(feature = "wasm"))]
407    /// Returns the `proving key` for the inclusion circuit.
408    fn inclusion_proving_key() -> &'static Arc<VarunaProvingKey<Self>>;
409
410    #[cfg(feature = "wasm")]
411    fn inclusion_proving_key(bytes: Option<Vec<u8>>) -> &'static Arc<VarunaProvingKey<Self>>;
412
413    /// Returns the `verifying key` for the inclusion circuit.
414    fn inclusion_verifying_key() -> &'static Arc<VarunaVerifyingKey<Self>>;
415
416    #[cfg(not(feature = "wasm"))]
417    /// Returns the `proving key` for the translation circuit.
418    fn translation_credits_proving_key() -> &'static Arc<VarunaProvingKey<Self>>;
419
420    #[cfg(feature = "wasm")]
421    /// Returns the `proving key` for the translation circuit.
422    fn translation_credits_proving_key(bytes: Option<Vec<u8>>) -> &'static Arc<VarunaProvingKey<Self>>;
423
424    /// Returns the `verifying key` for the translation circuit.
425    fn translation_credits_verifying_key() -> &'static Arc<VarunaVerifyingKey<Self>>;
426
427    /// Returns the powers of `G`.
428    fn g_powers() -> &'static Vec<Group<Self>>;
429
430    /// Returns the scalar multiplication on the generator `G`.
431    fn g_scalar_multiply(scalar: &Scalar<Self>) -> Group<Self>;
432
433    /// Returns the Varuna universal prover.
434    fn varuna_universal_prover() -> &'static UniversalProver<Self::PairingCurve>;
435
436    /// Returns the Varuna universal verifier.
437    fn varuna_universal_verifier() -> &'static UniversalVerifier<Self::PairingCurve>;
438
439    /// Returns the sponge parameters for Varuna.
440    fn varuna_fs_parameters() -> &'static FiatShamirParameters<Self>;
441
442    /// Returns the commitment domain as a constant field element.
443    fn commitment_domain() -> Field<Self>;
444
445    /// Returns the encryption domain as a constant field element.
446    fn encryption_domain() -> Field<Self>;
447
448    /// Returns the graph key domain as a constant field element.
449    fn graph_key_domain() -> Field<Self>;
450
451    /// Returns the serial number domain as a constant field element.
452    fn serial_number_domain() -> Field<Self>;
453
454    /// Returns a BHP commitment with an input hasher of 256-bits and randomizer.
455    fn commit_bhp256(input: &[bool], randomizer: &Scalar<Self>) -> Result<Field<Self>>;
456
457    /// Returns a BHP commitment with an input hasher of 512-bits and randomizer.
458    fn commit_bhp512(input: &[bool], randomizer: &Scalar<Self>) -> Result<Field<Self>>;
459
460    /// Returns a BHP commitment with an input hasher of 768-bits and randomizer.
461    fn commit_bhp768(input: &[bool], randomizer: &Scalar<Self>) -> Result<Field<Self>>;
462
463    /// Returns a BHP commitment with an input hasher of 1024-bits and randomizer.
464    fn commit_bhp1024(input: &[bool], randomizer: &Scalar<Self>) -> Result<Field<Self>>;
465
466    /// Returns a Pedersen commitment for the given (up to) 64-bit input and randomizer.
467    fn commit_ped64(input: &[bool], randomizer: &Scalar<Self>) -> Result<Field<Self>>;
468
469    /// Returns a Pedersen commitment for the given (up to) 128-bit input and randomizer.
470    fn commit_ped128(input: &[bool], randomizer: &Scalar<Self>) -> Result<Field<Self>>;
471
472    /// Returns a BHP commitment with an input hasher of 256-bits and randomizer.
473    fn commit_to_group_bhp256(input: &[bool], randomizer: &Scalar<Self>) -> Result<Group<Self>>;
474
475    /// Returns a BHP commitment with an input hasher of 512-bits and randomizer.
476    fn commit_to_group_bhp512(input: &[bool], randomizer: &Scalar<Self>) -> Result<Group<Self>>;
477
478    /// Returns a BHP commitment with an input hasher of 768-bits and randomizer.
479    fn commit_to_group_bhp768(input: &[bool], randomizer: &Scalar<Self>) -> Result<Group<Self>>;
480
481    /// Returns a BHP commitment with an input hasher of 1024-bits and randomizer.
482    fn commit_to_group_bhp1024(input: &[bool], randomizer: &Scalar<Self>) -> Result<Group<Self>>;
483
484    /// Returns a Pedersen commitment for the given (up to) 64-bit input and randomizer.
485    fn commit_to_group_ped64(input: &[bool], randomizer: &Scalar<Self>) -> Result<Group<Self>>;
486
487    /// Returns a Pedersen commitment for the given (up to) 128-bit input and randomizer.
488    fn commit_to_group_ped128(input: &[bool], randomizer: &Scalar<Self>) -> Result<Group<Self>>;
489
490    /// Returns the BHP hash with an input hasher of 256-bits.
491    fn hash_bhp256(input: &[bool]) -> Result<Field<Self>>;
492
493    /// Returns the BHP hash with an input hasher of 512-bits.
494    fn hash_bhp512(input: &[bool]) -> Result<Field<Self>>;
495
496    /// Returns the BHP hash with an input hasher of 768-bits.
497    fn hash_bhp768(input: &[bool]) -> Result<Field<Self>>;
498
499    /// Returns the BHP hash with an input hasher of 1024-bits.
500    fn hash_bhp1024(input: &[bool]) -> Result<Field<Self>>;
501
502    /// Returns the Keccak hash with a 256-bit output.
503    fn hash_keccak256(input: &[bool]) -> Result<Vec<bool>>;
504
505    /// Returns the Keccak hash with a 384-bit output.
506    fn hash_keccak384(input: &[bool]) -> Result<Vec<bool>>;
507
508    /// Returns the Keccak hash with a 512-bit output.
509    fn hash_keccak512(input: &[bool]) -> Result<Vec<bool>>;
510
511    /// Returns the Pedersen hash for a given (up to) 64-bit input.
512    fn hash_ped64(input: &[bool]) -> Result<Field<Self>>;
513
514    /// Returns the Pedersen hash for a given (up to) 128-bit input.
515    fn hash_ped128(input: &[bool]) -> Result<Field<Self>>;
516
517    /// Returns the Poseidon hash with an input rate of 2.
518    fn hash_psd2(input: &[Field<Self>]) -> Result<Field<Self>>;
519
520    /// Returns the Poseidon hash with an input rate of 4.
521    fn hash_psd4(input: &[Field<Self>]) -> Result<Field<Self>>;
522
523    /// Returns the Poseidon hash with an input rate of 8.
524    fn hash_psd8(input: &[Field<Self>]) -> Result<Field<Self>>;
525
526    /// Returns the SHA-3 hash with a 256-bit output.
527    fn hash_sha3_256(input: &[bool]) -> Result<Vec<bool>>;
528
529    /// Returns the SHA-3 hash with a 384-bit output.
530    fn hash_sha3_384(input: &[bool]) -> Result<Vec<bool>>;
531
532    /// Returns the SHA-3 hash with a 512-bit output.
533    fn hash_sha3_512(input: &[bool]) -> Result<Vec<bool>>;
534
535    /// Returns the extended Poseidon hash with an input rate of 2.
536    fn hash_many_psd2(input: &[Field<Self>], num_outputs: u16) -> Vec<Field<Self>>;
537
538    /// Returns the extended Poseidon hash with an input rate of 4.
539    fn hash_many_psd4(input: &[Field<Self>], num_outputs: u16) -> Vec<Field<Self>>;
540
541    /// Returns the extended Poseidon hash with an input rate of 8.
542    fn hash_many_psd8(input: &[Field<Self>], num_outputs: u16) -> Vec<Field<Self>>;
543
544    /// Returns the BHP hash with an input hasher of 256-bits.
545    fn hash_to_group_bhp256(input: &[bool]) -> Result<Group<Self>>;
546
547    /// Returns the BHP hash with an input hasher of 512-bits.
548    fn hash_to_group_bhp512(input: &[bool]) -> Result<Group<Self>>;
549
550    /// Returns the BHP hash with an input hasher of 768-bits.
551    fn hash_to_group_bhp768(input: &[bool]) -> Result<Group<Self>>;
552
553    /// Returns the BHP hash with an input hasher of 1024-bits.
554    fn hash_to_group_bhp1024(input: &[bool]) -> Result<Group<Self>>;
555
556    /// Returns the Pedersen hash for a given (up to) 64-bit input.
557    fn hash_to_group_ped64(input: &[bool]) -> Result<Group<Self>>;
558
559    /// Returns the Pedersen hash for a given (up to) 128-bit input.
560    fn hash_to_group_ped128(input: &[bool]) -> Result<Group<Self>>;
561
562    /// Returns the Poseidon hash with an input rate of 2 on the affine curve.
563    fn hash_to_group_psd2(input: &[Field<Self>]) -> Result<Group<Self>>;
564
565    /// Returns the Poseidon hash with an input rate of 4 on the affine curve.
566    fn hash_to_group_psd4(input: &[Field<Self>]) -> Result<Group<Self>>;
567
568    /// Returns the Poseidon hash with an input rate of 8 on the affine curve.
569    fn hash_to_group_psd8(input: &[Field<Self>]) -> Result<Group<Self>>;
570
571    /// Returns the Poseidon hash with an input rate of 2 on the scalar field.
572    fn hash_to_scalar_psd2(input: &[Field<Self>]) -> Result<Scalar<Self>>;
573
574    /// Returns the Poseidon hash with an input rate of 4 on the scalar field.
575    fn hash_to_scalar_psd4(input: &[Field<Self>]) -> Result<Scalar<Self>>;
576
577    /// Returns the Poseidon hash with an input rate of 8 on the scalar field.
578    fn hash_to_scalar_psd8(input: &[Field<Self>]) -> Result<Scalar<Self>>;
579
580    /// Returns a Merkle tree with a BHP leaf hasher of 1024-bits and a BHP path hasher of 512-bits.
581    fn merkle_tree_bhp<const DEPTH: u8>(leaves: &[Vec<bool>]) -> Result<BHPMerkleTree<Self, DEPTH>>;
582
583    /// Returns a Merkle tree with a Poseidon leaf hasher with input rate of 4 and a Poseidon path hasher with input rate of 2.
584    fn merkle_tree_psd<const DEPTH: u8>(leaves: &[Vec<Field<Self>>]) -> Result<PoseidonMerkleTree<Self, DEPTH>>;
585
586    /// Returns `true` if the given Merkle path is valid for the given root and leaf.
587    #[allow(clippy::ptr_arg)]
588    fn verify_merkle_path_bhp<const DEPTH: u8>(
589        path: &MerklePath<Self, DEPTH>,
590        root: &Field<Self>,
591        leaf: &Vec<bool>,
592    ) -> bool;
593
594    /// Returns `true` if the given Merkle path is valid for the given root and leaf.
595    #[allow(clippy::ptr_arg)]
596    fn verify_merkle_path_psd<const DEPTH: u8>(
597        path: &MerklePath<Self, DEPTH>,
598        root: &Field<Self>,
599        leaf: &Vec<Field<Self>>,
600    ) -> bool;
601
602    /// Returns the Poseidon leaf hasher for dynamic records (rate 8).
603    fn dynamic_record_leaf_hasher() -> &'static Poseidon8<Self>;
604
605    /// Returns the Poseidon path hasher for dynamic records (rate 2).
606    fn dynamic_record_path_hasher() -> &'static Poseidon2<Self>;
607}
608
609/// Returns the consensus version heights, initializing them if necessary.
610///
611/// If a `heights` string is provided, it must be a comma-separated list of ascending block heights
612/// starting from zero (e.g., `"0,2,3,4,..."`) with a number of heights exactly equal to the value
613/// of the Network trait's `NUM_CONSENSUS_VERSIONS` constant. These heights correspond to the
614/// activation block of each `ConsensusVersion`.
615///
616/// If `heights` is `None`, the function will use SnarkVM's default test consensus heights.
617///
618/// This function caches the initialized heights, and can be set only once. Further calls will
619/// return the cached heights.
620///
621/// This method should be called by `wasm` users who need to set test values for consensus heights
622/// for purposes such as testing on a local devnet. If this method needs to be used, it should be
623/// called immediately after the wasm module is initialized.
624#[cfg(feature = "wasm")]
625pub fn get_or_init_consensus_version_heights(
626    heights: Option<String>,
627) -> [(ConsensusVersion, u32); NUM_CONSENSUS_VERSIONS] {
628    let heights = load_test_consensus_heights_inner(heights);
629    *CONSENSUS_VERSION_HEIGHTS.get_or_init(|| heights)
630}