sp1-core-executor 6.1.0

RISC-V executor for SP1
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

use serde::{Deserialize, Serialize};

use crate::SyscallCode;

/// Allowed presets for collections of events that may be retained instead of deferred.
#[derive(Clone, Copy, Debug, PartialEq, Eq, PartialOrd, Ord, Hash, Serialize, Deserialize)]
#[non_exhaustive]
pub enum RetainedEventsPreset {
    /// Retain events for BLS12-381 base field arithmetic operations.
    Bls12381Field,
    /// Retain events for BN254 base field arithmetic operations.
    Bn254Field,
    /// Retain events for SHA-256 operations.
    Sha256,
    /// Retain events for Poseidon2 operations.
    Poseidon2,
    /// Retain events for ``U256Ops`` operations.
    U256Ops,
    /// Retain events for Secp256k1 operations.
    Secp256k1,
}

impl RetainedEventsPreset {
    /// The codes of syscalls that generate events that are retained by this preset.
    #[must_use]
    pub const fn syscall_codes(&self) -> &'static [SyscallCode] {
        #[allow(clippy::enum_glob_use)]
        use SyscallCode::*;
        match self {
            RetainedEventsPreset::Bls12381Field => {
                &[BLS12381_FP_ADD, BLS12381_FP_MUL, BLS12381_FP_SUB]
            }
            RetainedEventsPreset::Bn254Field => &[BN254_FP_ADD, BN254_FP_MUL, BN254_FP_SUB],
            RetainedEventsPreset::Sha256 => &[SHA_COMPRESS, SHA_EXTEND],
            RetainedEventsPreset::Poseidon2 => &[POSEIDON2],
            RetainedEventsPreset::U256Ops => &[UINT256_ADD_CARRY, UINT256_MUL_CARRY],
            RetainedEventsPreset::Secp256k1 => &[SECP256K1_ADD, SECP256K1_DOUBLE],
        }
    }
}