solana_sdk/
precompiles.rs

1//! Safecoin precompiled programs
2
3#![cfg(feature = "full")]
4
5use {
6    crate::{
7        decode_error::DecodeError,
8        feature_set::{prevent_calling_precompiles_as_programs, FeatureSet},
9        instruction::CompiledInstruction,
10        pubkey::Pubkey,
11    },
12    lazy_static::lazy_static,
13    std::sync::Arc,
14    thiserror::Error,
15};
16
17/// Precompile errors
18#[derive(Error, Debug, Clone, PartialEq, Eq)]
19pub enum PrecompileError {
20    #[error("public key is not valid")]
21    InvalidPublicKey,
22    #[error("id is not valid")]
23    InvalidRecoveryId,
24    #[error("signature is not valid")]
25    InvalidSignature,
26    #[error("offset not valid")]
27    InvalidDataOffsets,
28    #[error("instruction is incorrect size")]
29    InvalidInstructionDataSize,
30}
31impl<T> DecodeError<T> for PrecompileError {
32    fn type_of() -> &'static str {
33        "PrecompileError"
34    }
35}
36
37/// All precompiled programs must implement the `Verify` function
38pub type Verify = fn(&[u8], &[&[u8]], &Arc<FeatureSet>) -> std::result::Result<(), PrecompileError>;
39
40/// Information on a precompiled program
41pub struct Precompile {
42    /// Program id
43    pub program_id: Pubkey,
44    /// Feature to enable on, `None` indicates always enabled
45    pub feature: Option<Pubkey>,
46    /// Verification function
47    pub verify_fn: Verify,
48}
49impl Precompile {
50    /// Creates a new `Precompile`
51    pub fn new(program_id: Pubkey, feature: Option<Pubkey>, verify_fn: Verify) -> Self {
52        Precompile {
53            program_id,
54            feature,
55            verify_fn,
56        }
57    }
58    /// Check if a program id is this precompiled program
59    pub fn check_id<F>(&self, program_id: &Pubkey, is_enabled: F) -> bool
60    where
61        F: Fn(&Pubkey) -> bool,
62    {
63        #![allow(clippy::redundant_closure)]
64        self.feature
65            .map_or(true, |ref feature_id| is_enabled(feature_id))
66            && self.program_id == *program_id
67    }
68    /// Verify this precompiled program
69    pub fn verify(
70        &self,
71        data: &[u8],
72        instruction_datas: &[&[u8]],
73        feature_set: &Arc<FeatureSet>,
74    ) -> std::result::Result<(), PrecompileError> {
75        (self.verify_fn)(data, instruction_datas, feature_set)
76    }
77}
78
79lazy_static! {
80    /// The list of all precompiled programs
81    static ref PRECOMPILES: Vec<Precompile> = vec![
82        Precompile::new(
83            crate::secp256k1_program::id(),
84            Some(prevent_calling_precompiles_as_programs::id()),
85            crate::secp256k1_instruction::verify,
86        ),
87        Precompile::new(
88            crate::ed25519_program::id(),
89            Some(prevent_calling_precompiles_as_programs::id()),
90            crate::ed25519_instruction::verify,
91        ),
92    ];
93}
94
95/// Check if a program is a precompiled program
96pub fn is_precompile<F>(program_id: &Pubkey, is_enabled: F) -> bool
97where
98    F: Fn(&Pubkey) -> bool,
99{
100    PRECOMPILES
101        .iter()
102        .any(|precompile| precompile.check_id(program_id, |feature_id| is_enabled(feature_id)))
103}
104
105pub fn get_precompiles<'a>() -> &'a [Precompile] {
106    &PRECOMPILES
107}
108
109/// Check that a program is precompiled and if so verify it
110pub fn verify_if_precompile(
111    program_id: &Pubkey,
112    precompile_instruction: &CompiledInstruction,
113    all_instructions: &[CompiledInstruction],
114    feature_set: &Arc<FeatureSet>,
115) -> Result<(), PrecompileError> {
116    for precompile in PRECOMPILES.iter() {
117        if precompile.check_id(program_id, |feature_id| feature_set.is_active(feature_id)) {
118            let instruction_datas: Vec<_> = all_instructions
119                .iter()
120                .map(|instruction| instruction.data.as_ref())
121                .collect();
122            return precompile.verify(
123                &precompile_instruction.data,
124                &instruction_datas,
125                feature_set,
126            );
127        }
128    }
129    Ok(())
130}
solana_sdk/precompiles.rs

solana_sdk/
precompiles.rs
