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 = 25;
166
167    /// The anchor height, defined as the expected number of blocks to reach the coinbase target.
168    /// Note: The anchor height used exclusively by `coinbase_reward_v1`.
169    const ANCHOR_HEIGHT: u32 = Self::REWARD_ANCHOR_TIME as u32 / Self::BLOCK_TIME as u32;
170    /// The anchor time used specifically for calculating the coinbase reward.
171    /// We ensure that the reward anchor time matches the original ConsensusVersion::V1 anchor time
172    /// to maintain the original coinbase reward schedule.
173    const REWARD_ANCHOR_TIME: u16 = 25;
174    /// A list of (consensus_version, anchor_time_in_seconds) pairs (sparse).
175    /// Each entry takes effect at the specified version and remains active until the next entry.
176    /// The anchor time, defined as the expected time in seconds to reach the coinbase target.
177    const ANCHOR_TIMES: [(ConsensusVersion, u16); 2] =
178        [(ConsensusVersion::V1, Self::REWARD_ANCHOR_TIME), (ConsensusVersion::V15, 35)];
179    /// The expected time per block in seconds.
180    const BLOCK_TIME: u16 = 10;
181    /// The number of blocks per epoch.
182    #[cfg(not(feature = "test"))]
183    const NUM_BLOCKS_PER_EPOCH: u32 = 3600 / Self::BLOCK_TIME as u32; // 360 blocks == ~1 hour
184    /// The number of blocks per epoch.
185    /// This is deliberately set to a low value for testing purposes only.
186    #[cfg(feature = "test")]
187    const NUM_BLOCKS_PER_EPOCH: u32 = 10;
188
189    /// The maximum number of entries in data.
190    const MAX_DATA_ENTRIES: usize = 32;
191    /// The maximum recursive depth of an entry.
192    /// Note: This value must be strictly less than u8::MAX.
193    const MAX_DATA_DEPTH: usize = 32;
194    /// The maximum number of fields in data (must not exceed u16::MAX).
195    #[allow(clippy::cast_possible_truncation)]
196    const MAX_DATA_SIZE_IN_FIELDS: u32 = ((128 * 1024 * 8) / Field::<Self>::SIZE_IN_DATA_BITS) as u32;
197
198    /// The minimum number of entries in a struct.
199    const MIN_STRUCT_ENTRIES: usize = 1; // This ensures the struct is not empty.
200    /// The maximum number of entries in a struct.
201    const MAX_STRUCT_ENTRIES: usize = Self::MAX_DATA_ENTRIES;
202
203    /// The minimum number of elements in an array.
204    const MIN_ARRAY_ELEMENTS: usize = 1; // This ensures the array is not empty.
205    ///  A list of (consensus_version, size) pairs indicating the maximum number of elements in an array.
206    const MAX_ARRAY_ELEMENTS: [(ConsensusVersion, usize); 3] =
207        [(ConsensusVersion::V1, 32), (ConsensusVersion::V11, 512), (ConsensusVersion::V14, 2048)];
208
209    /// The minimum number of entries in a record.
210    const MIN_RECORD_ENTRIES: usize = 1; // This accounts for 'record.owner'.
211    /// The maximum number of entries in a record.
212    const MAX_RECORD_ENTRIES: usize = Self::MIN_RECORD_ENTRIES.saturating_add(Self::MAX_DATA_ENTRIES);
213
214    /// The maximum program size by number of characters.
215    const MAX_PROGRAM_SIZE: [(ConsensusVersion, usize); 2] = [
216        (ConsensusVersion::V1, 100_000),  // 100 kB
217        (ConsensusVersion::V14, 512_000), // 512 kB
218    ];
219    /// The maximum number of mappings in a program.
220    const MAX_MAPPINGS: usize = 31;
221    /// The maximum number of functions in a program.
222    const MAX_FUNCTIONS: usize = 31;
223    /// The maximum number of structs in a program.
224    const MAX_STRUCTS: usize = 10 * Self::MAX_FUNCTIONS;
225    /// The maximum number of records in a program.
226    const MAX_RECORDS: usize = 10 * Self::MAX_FUNCTIONS;
227    /// The maximum number of closures in a program.
228    const MAX_CLOSURES: usize = 2 * Self::MAX_FUNCTIONS;
229    /// The maximum number of view functions in a program.
230    const MAX_VIEWS: usize = 2 * Self::MAX_FUNCTIONS;
231    /// The maximum number of operands in an instruction.
232    const MAX_OPERANDS: usize = Self::MAX_INPUTS;
233    /// The maximum number of instructions in a closure or function.
234    const MAX_INSTRUCTIONS: usize = u16::MAX as usize;
235    /// The maximum number of commands in finalize.
236    const MAX_COMMANDS: usize = u16::MAX as usize;
237    /// The maximum number of `call` commands in a finalize body. Matched to
238    /// `Transaction::MAX_TRANSITIONS` so view-call arity in a finalize is bounded analogously
239    /// to the static-call bound on transition graphs.
240    const MAX_CALLS: usize = 32;
241    /// The maximum number of write commands in finalize.
242    const MAX_WRITES: [(ConsensusVersion, u16); 2] = [(ConsensusVersion::V1, 16), (ConsensusVersion::V14, 32)];
243    /// The maximum number of `position` commands in finalize.
244    const MAX_POSITIONS: usize = u8::MAX as usize;
245
246    /// The maximum number of inputs per transition.
247    const MAX_INPUTS: usize = 16;
248    /// The maximum number of outputs per transition.
249    const MAX_OUTPUTS: usize = 16;
250
251    /// The maximum number of imports.
252    const MAX_IMPORTS: usize = 64;
253
254    /// A list of consensus versions and their corresponding maximum transaction sizes in bytes.
255    ///
256    /// A transaction consists of fixed identifiers, deployment data, and fees.
257    /// Fixed components include identifiers, ownership, checksums, and fees.
258    /// Variable components include the program bytecode and verifying-key entries.
259    /// Verifying-key entries scale with the number of functions and records.
260    ///
261    /// MAX_TRANSACTION_SIZE = C + MAX_PROGRAM_SIZE + (673 + 58) * (MAX_FUNCTIONS + MAX_RECORDS)
262    /// C = fixed size components (Up to 2367 bytes)
263    // Note: This value must **not** decrease without considering the impact on transaction validity.
264    const MAX_TRANSACTION_SIZE: [(ConsensusVersion, usize); 2] = [
265        (ConsensusVersion::V1, 128_000),  // 128 kB
266        (ConsensusVersion::V14, 768_000), // 768 kB
267    ];
268
269    /// The state root type.
270    type StateRoot: Bech32ID<Field<Self>>;
271    /// The block hash type.
272    type BlockHash: Bech32ID<Field<Self>>;
273    /// The ratification ID type.
274    type RatificationID: Bech32ID<Field<Self>>;
275    /// The transaction ID type.
276    type TransactionID: Bech32ID<Field<Self>>;
277    /// The transition ID type.
278    type TransitionID: Bech32ID<Field<Self>>;
279    /// The transmission checksum type.
280    type TransmissionChecksum: IntegerType;
281
282    /// A list of (consensus_version, block_height) pairs indicating when each consensus version takes effect.
283    /// Documentation for what is changed at each version can be found in `N::CONSENSUS_VERSION`
284    /// Do not read this directly outside of tests, use `N::CONSENSUS_VERSION_HEIGHTS()` instead.
285    const _CONSENSUS_VERSION_HEIGHTS: [(ConsensusVersion, u32); NUM_CONSENSUS_VERSIONS];
286
287    ///  A list of (consensus_version, size) pairs indicating the maximum number of validators in a committee.
288    //  Note: This value must **not** decrease without considering the impact on serialization.
289    //  Decreasing this value will break backwards compatibility of serialization without explicit
290    //  declaration of migration based on round number rather than block height.
291    //  Increasing this value will require a migration to prevent forking during network upgrades.
292    const MAX_CERTIFICATES: [(ConsensusVersion, u16); 5];
293
294    /// Returns the list of consensus versions.
295    #[allow(non_snake_case)]
296    #[cfg(not(any(test, feature = "test", feature = "test_consensus_heights")))]
297    fn CONSENSUS_VERSION_HEIGHTS() -> &'static [(ConsensusVersion, u32); NUM_CONSENSUS_VERSIONS] {
298        // Initialize the consensus version heights directly from the constant.
299        CONSENSUS_VERSION_HEIGHTS.get_or_init(|| Self::_CONSENSUS_VERSION_HEIGHTS)
300    }
301    /// Returns the list of test consensus versions.
302    #[allow(non_snake_case)]
303    #[cfg(any(test, feature = "test", feature = "test_consensus_heights"))]
304    fn CONSENSUS_VERSION_HEIGHTS() -> &'static [(ConsensusVersion, u32); NUM_CONSENSUS_VERSIONS] {
305        CONSENSUS_VERSION_HEIGHTS.get_or_init(load_test_consensus_heights)
306    }
307
308    /// A set of incrementing consensus version heights used for tests.
309    #[allow(non_snake_case)]
310    #[cfg(any(test, feature = "test", feature = "test_consensus_heights"))]
311    const TEST_CONSENSUS_VERSION_HEIGHTS: [(ConsensusVersion, u32); NUM_CONSENSUS_VERSIONS] =
312        TEST_CONSENSUS_VERSION_HEIGHTS;
313    /// Returns the consensus version which is active at the given height.
314    #[allow(non_snake_case)]
315    fn CONSENSUS_VERSION(seek_height: u32) -> anyhow::Result<ConsensusVersion> {
316        match Self::CONSENSUS_VERSION_HEIGHTS().binary_search_by(|(_, height)| height.cmp(&seek_height)) {
317            // If a consensus version was found at this height, return it.
318            Ok(index) => Ok(Self::CONSENSUS_VERSION_HEIGHTS()[index].0),
319            // If the specified height was not found, determine whether to return an appropriate version.
320            Err(index) => {
321                if index == 0 {
322                    Err(anyhow!("Expected consensus version 1 to exist at height 0."))
323                } else {
324                    // Return the appropriate version belonging to the height *lower* than the sought height.
325                    Ok(Self::CONSENSUS_VERSION_HEIGHTS()[index - 1].0)
326                }
327            }
328        }
329    }
330    /// Returns the height at which a specified consensus version becomes active.
331    #[allow(non_snake_case)]
332    fn CONSENSUS_HEIGHT(version: ConsensusVersion) -> Result<u32> {
333        Ok(Self::CONSENSUS_VERSION_HEIGHTS().get(version as usize - 1).ok_or(anyhow!("Invalid consensus version"))?.1)
334    }
335    /// Returns the last `MAX_ARRAY_ELEMENTS` value.
336    #[allow(non_snake_case)]
337    fn LATEST_MAX_ARRAY_ELEMENTS() -> usize {
338        Self::MAX_ARRAY_ELEMENTS.last().expect("MAX_ARRAY_ELEMENTS must have at least one entry").1
339    }
340    /// Returns the last `MAX_CERTIFICATES` value.
341    #[allow(non_snake_case)]
342    fn LATEST_MAX_CERTIFICATES() -> u16 {
343        Self::MAX_CERTIFICATES.last().expect("MAX_CERTIFICATES must have at least one entry").1
344    }
345
346    /// Returns the last `MAX_PROGRAM_SIZE` value.
347    #[allow(non_snake_case)]
348    fn LATEST_MAX_PROGRAM_SIZE() -> usize {
349        Self::MAX_PROGRAM_SIZE.last().expect("MAX_PROGRAM_SIZE must have at least one entry").1
350    }
351
352    /// Returns the last `MAX_WRITES` value.
353    #[allow(non_snake_case)]
354    fn LATEST_MAX_WRITES() -> u16 {
355        Self::MAX_WRITES.last().expect("MAX_WRITES must have at least one entry").1
356    }
357
358    /// Returns the last `MAX_TRANSACTION_SIZE` value.
359    #[allow(non_snake_case)]
360    fn LATEST_MAX_TRANSACTION_SIZE() -> usize {
361        Self::MAX_TRANSACTION_SIZE.last().expect("MAX_TRANSACTION_SIZE must have at least one entry").1
362    }
363
364    /// Returns the block height where the the inclusion proof will be updated.
365    #[allow(non_snake_case)]
366    fn INCLUSION_UPGRADE_HEIGHT() -> Result<u32>;
367
368    /// Returns the genesis block bytes.
369    fn genesis_bytes() -> &'static [u8];
370
371    /// Returns the restrictions list as a JSON-compatible string.
372    fn restrictions_list_as_str() -> &'static str;
373
374    /// Returns the proving key for the given function name in the v0 version of `credits.aleo`.
375    fn get_credits_v0_proving_key(function_name: String) -> Result<&'static Arc<VarunaProvingKey<Self>>>;
376
377    /// Returns the verifying key for the given function name in the v0 version of `credits.aleo`.
378    fn get_credits_v0_verifying_key(function_name: String) -> Result<&'static Arc<VarunaVerifyingKey<Self>>>;
379
380    /// Returns the proving key for the given function name in `credits.aleo`.
381    fn get_credits_proving_key(function_name: String) -> Result<&'static Arc<VarunaProvingKey<Self>>>;
382
383    /// Returns the verifying key for the given function name in `credits.aleo`.
384    fn get_credits_verifying_key(function_name: String) -> Result<&'static Arc<VarunaVerifyingKey<Self>>>;
385
386    #[cfg(not(feature = "wasm"))]
387    /// Returns the `proving key` for the inclusion_v0 circuit.
388    fn inclusion_v0_proving_key() -> &'static Arc<VarunaProvingKey<Self>>;
389
390    #[cfg(feature = "wasm")]
391    /// Returns the `proving key` for the inclusion_v0 circuit.
392    fn inclusion_v0_proving_key(bytes: Option<Vec<u8>>) -> &'static Arc<VarunaProvingKey<Self>>;
393
394    /// Returns the `verifying key` for the inclusion_v0 circuit.
395    fn inclusion_v0_verifying_key() -> &'static Arc<VarunaVerifyingKey<Self>>;
396
397    #[cfg(not(feature = "wasm"))]
398    /// Returns the `proving key` for the inclusion circuit.
399    fn inclusion_proving_key() -> &'static Arc<VarunaProvingKey<Self>>;
400
401    #[cfg(feature = "wasm")]
402    fn inclusion_proving_key(bytes: Option<Vec<u8>>) -> &'static Arc<VarunaProvingKey<Self>>;
403
404    /// Returns the `verifying key` for the inclusion circuit.
405    fn inclusion_verifying_key() -> &'static Arc<VarunaVerifyingKey<Self>>;
406
407    #[cfg(not(feature = "wasm"))]
408    /// Returns the `proving key` for the translation circuit.
409    fn translation_credits_proving_key() -> &'static Arc<VarunaProvingKey<Self>>;
410
411    #[cfg(feature = "wasm")]
412    /// Returns the `proving key` for the translation circuit.
413    fn translation_credits_proving_key(bytes: Option<Vec<u8>>) -> &'static Arc<VarunaProvingKey<Self>>;
414
415    /// Returns the `verifying key` for the translation circuit.
416    fn translation_credits_verifying_key() -> &'static Arc<VarunaVerifyingKey<Self>>;
417
418    /// Returns the powers of `G`.
419    fn g_powers() -> &'static Vec<Group<Self>>;
420
421    /// Returns the scalar multiplication on the generator `G`.
422    fn g_scalar_multiply(scalar: &Scalar<Self>) -> Group<Self>;
423
424    /// Returns the Varuna universal prover.
425    fn varuna_universal_prover() -> &'static UniversalProver<Self::PairingCurve>;
426
427    /// Returns the Varuna universal verifier.
428    fn varuna_universal_verifier() -> &'static UniversalVerifier<Self::PairingCurve>;
429
430    /// Returns the sponge parameters for Varuna.
431    fn varuna_fs_parameters() -> &'static FiatShamirParameters<Self>;
432
433    /// Returns the commitment domain as a constant field element.
434    fn commitment_domain() -> Field<Self>;
435
436    /// Returns the encryption domain as a constant field element.
437    fn encryption_domain() -> Field<Self>;
438
439    /// Returns the graph key domain as a constant field element.
440    fn graph_key_domain() -> Field<Self>;
441
442    /// Returns the serial number domain as a constant field element.
443    fn serial_number_domain() -> Field<Self>;
444
445    /// Returns a BHP commitment with an input hasher of 256-bits and randomizer.
446    fn commit_bhp256(input: &[bool], randomizer: &Scalar<Self>) -> Result<Field<Self>>;
447
448    /// Returns a BHP commitment with an input hasher of 512-bits and randomizer.
449    fn commit_bhp512(input: &[bool], randomizer: &Scalar<Self>) -> Result<Field<Self>>;
450
451    /// Returns a BHP commitment with an input hasher of 768-bits and randomizer.
452    fn commit_bhp768(input: &[bool], randomizer: &Scalar<Self>) -> Result<Field<Self>>;
453
454    /// Returns a BHP commitment with an input hasher of 1024-bits and randomizer.
455    fn commit_bhp1024(input: &[bool], randomizer: &Scalar<Self>) -> Result<Field<Self>>;
456
457    /// Returns a Pedersen commitment for the given (up to) 64-bit input and randomizer.
458    fn commit_ped64(input: &[bool], randomizer: &Scalar<Self>) -> Result<Field<Self>>;
459
460    /// Returns a Pedersen commitment for the given (up to) 128-bit input and randomizer.
461    fn commit_ped128(input: &[bool], randomizer: &Scalar<Self>) -> Result<Field<Self>>;
462
463    /// Returns a BHP commitment with an input hasher of 256-bits and randomizer.
464    fn commit_to_group_bhp256(input: &[bool], randomizer: &Scalar<Self>) -> Result<Group<Self>>;
465
466    /// Returns a BHP commitment with an input hasher of 512-bits and randomizer.
467    fn commit_to_group_bhp512(input: &[bool], randomizer: &Scalar<Self>) -> Result<Group<Self>>;
468
469    /// Returns a BHP commitment with an input hasher of 768-bits and randomizer.
470    fn commit_to_group_bhp768(input: &[bool], randomizer: &Scalar<Self>) -> Result<Group<Self>>;
471
472    /// Returns a BHP commitment with an input hasher of 1024-bits and randomizer.
473    fn commit_to_group_bhp1024(input: &[bool], randomizer: &Scalar<Self>) -> Result<Group<Self>>;
474
475    /// Returns a Pedersen commitment for the given (up to) 64-bit input and randomizer.
476    fn commit_to_group_ped64(input: &[bool], randomizer: &Scalar<Self>) -> Result<Group<Self>>;
477
478    /// Returns a Pedersen commitment for the given (up to) 128-bit input and randomizer.
479    fn commit_to_group_ped128(input: &[bool], randomizer: &Scalar<Self>) -> Result<Group<Self>>;
480
481    /// Returns the BHP hash with an input hasher of 256-bits.
482    fn hash_bhp256(input: &[bool]) -> Result<Field<Self>>;
483
484    /// Returns the BHP hash with an input hasher of 512-bits.
485    fn hash_bhp512(input: &[bool]) -> Result<Field<Self>>;
486
487    /// Returns the BHP hash with an input hasher of 768-bits.
488    fn hash_bhp768(input: &[bool]) -> Result<Field<Self>>;
489
490    /// Returns the BHP hash with an input hasher of 1024-bits.
491    fn hash_bhp1024(input: &[bool]) -> Result<Field<Self>>;
492
493    /// Returns the Keccak hash with a 256-bit output.
494    fn hash_keccak256(input: &[bool]) -> Result<Vec<bool>>;
495
496    /// Returns the Keccak hash with a 384-bit output.
497    fn hash_keccak384(input: &[bool]) -> Result<Vec<bool>>;
498
499    /// Returns the Keccak hash with a 512-bit output.
500    fn hash_keccak512(input: &[bool]) -> Result<Vec<bool>>;
501
502    /// Returns the Pedersen hash for a given (up to) 64-bit input.
503    fn hash_ped64(input: &[bool]) -> Result<Field<Self>>;
504
505    /// Returns the Pedersen hash for a given (up to) 128-bit input.
506    fn hash_ped128(input: &[bool]) -> Result<Field<Self>>;
507
508    /// Returns the Poseidon hash with an input rate of 2.
509    fn hash_psd2(input: &[Field<Self>]) -> Result<Field<Self>>;
510
511    /// Returns the Poseidon hash with an input rate of 4.
512    fn hash_psd4(input: &[Field<Self>]) -> Result<Field<Self>>;
513
514    /// Returns the Poseidon hash with an input rate of 8.
515    fn hash_psd8(input: &[Field<Self>]) -> Result<Field<Self>>;
516
517    /// Returns the SHA-3 hash with a 256-bit output.
518    fn hash_sha3_256(input: &[bool]) -> Result<Vec<bool>>;
519
520    /// Returns the SHA-3 hash with a 384-bit output.
521    fn hash_sha3_384(input: &[bool]) -> Result<Vec<bool>>;
522
523    /// Returns the SHA-3 hash with a 512-bit output.
524    fn hash_sha3_512(input: &[bool]) -> Result<Vec<bool>>;
525
526    /// Returns the extended Poseidon hash with an input rate of 2.
527    fn hash_many_psd2(input: &[Field<Self>], num_outputs: u16) -> Vec<Field<Self>>;
528
529    /// Returns the extended Poseidon hash with an input rate of 4.
530    fn hash_many_psd4(input: &[Field<Self>], num_outputs: u16) -> Vec<Field<Self>>;
531
532    /// Returns the extended Poseidon hash with an input rate of 8.
533    fn hash_many_psd8(input: &[Field<Self>], num_outputs: u16) -> Vec<Field<Self>>;
534
535    /// Returns the BHP hash with an input hasher of 256-bits.
536    fn hash_to_group_bhp256(input: &[bool]) -> Result<Group<Self>>;
537
538    /// Returns the BHP hash with an input hasher of 512-bits.
539    fn hash_to_group_bhp512(input: &[bool]) -> Result<Group<Self>>;
540
541    /// Returns the BHP hash with an input hasher of 768-bits.
542    fn hash_to_group_bhp768(input: &[bool]) -> Result<Group<Self>>;
543
544    /// Returns the BHP hash with an input hasher of 1024-bits.
545    fn hash_to_group_bhp1024(input: &[bool]) -> Result<Group<Self>>;
546
547    /// Returns the Pedersen hash for a given (up to) 64-bit input.
548    fn hash_to_group_ped64(input: &[bool]) -> Result<Group<Self>>;
549
550    /// Returns the Pedersen hash for a given (up to) 128-bit input.
551    fn hash_to_group_ped128(input: &[bool]) -> Result<Group<Self>>;
552
553    /// Returns the Poseidon hash with an input rate of 2 on the affine curve.
554    fn hash_to_group_psd2(input: &[Field<Self>]) -> Result<Group<Self>>;
555
556    /// Returns the Poseidon hash with an input rate of 4 on the affine curve.
557    fn hash_to_group_psd4(input: &[Field<Self>]) -> Result<Group<Self>>;
558
559    /// Returns the Poseidon hash with an input rate of 8 on the affine curve.
560    fn hash_to_group_psd8(input: &[Field<Self>]) -> Result<Group<Self>>;
561
562    /// Returns the Poseidon hash with an input rate of 2 on the scalar field.
563    fn hash_to_scalar_psd2(input: &[Field<Self>]) -> Result<Scalar<Self>>;
564
565    /// Returns the Poseidon hash with an input rate of 4 on the scalar field.
566    fn hash_to_scalar_psd4(input: &[Field<Self>]) -> Result<Scalar<Self>>;
567
568    /// Returns the Poseidon hash with an input rate of 8 on the scalar field.
569    fn hash_to_scalar_psd8(input: &[Field<Self>]) -> Result<Scalar<Self>>;
570
571    /// Returns a Merkle tree with a BHP leaf hasher of 1024-bits and a BHP path hasher of 512-bits.
572    fn merkle_tree_bhp<const DEPTH: u8>(leaves: &[Vec<bool>]) -> Result<BHPMerkleTree<Self, DEPTH>>;
573
574    /// Returns a Merkle tree with a Poseidon leaf hasher with input rate of 4 and a Poseidon path hasher with input rate of 2.
575    fn merkle_tree_psd<const DEPTH: u8>(leaves: &[Vec<Field<Self>>]) -> Result<PoseidonMerkleTree<Self, DEPTH>>;
576
577    /// Returns `true` if the given Merkle path is valid for the given root and leaf.
578    #[allow(clippy::ptr_arg)]
579    fn verify_merkle_path_bhp<const DEPTH: u8>(
580        path: &MerklePath<Self, DEPTH>,
581        root: &Field<Self>,
582        leaf: &Vec<bool>,
583    ) -> bool;
584
585    /// Returns `true` if the given Merkle path is valid for the given root and leaf.
586    #[allow(clippy::ptr_arg)]
587    fn verify_merkle_path_psd<const DEPTH: u8>(
588        path: &MerklePath<Self, DEPTH>,
589        root: &Field<Self>,
590        leaf: &Vec<Field<Self>>,
591    ) -> bool;
592
593    /// Returns the Poseidon leaf hasher for dynamic records (rate 8).
594    fn dynamic_record_leaf_hasher() -> &'static Poseidon8<Self>;
595
596    /// Returns the Poseidon path hasher for dynamic records (rate 2).
597    fn dynamic_record_path_hasher() -> &'static Poseidon2<Self>;
598}
599
600/// Returns the consensus version heights, initializing them if necessary.
601///
602/// If a `heights` string is provided, it must be a comma-separated list of ascending block heights
603/// starting from zero (e.g., `"0,2,3,4,..."`) with a number of heights exactly equal to the value
604/// of the Network trait's `NUM_CONSENSUS_VERSIONS` constant. These heights correspond to the
605/// activation block of each `ConsensusVersion`.
606///
607/// If `heights` is `None`, the function will use SnarkVM's default test consensus heights.
608///
609/// This function caches the initialized heights, and can be set only once. Further calls will
610/// return the cached heights.
611///
612/// This method should be called by `wasm` users who need to set test values for consensus heights
613/// for purposes such as testing on a local devnet. If this method needs to be used, it should be
614/// called immediately after the wasm module is initialized.
615#[cfg(feature = "wasm")]
616pub fn get_or_init_consensus_version_heights(
617    heights: Option<String>,
618) -> [(ConsensusVersion, u32); NUM_CONSENSUS_VERSIONS] {
619    let heights = load_test_consensus_heights_inner(heights);
620    *CONSENSUS_VERSION_HEIGHTS.get_or_init(|| heights)
621}