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