2021-09-02 21:29:11 -07:00
|
|
|
#[cfg(RUSTC_WITH_SPECIALIZATION)]
|
|
|
|
use solana_frozen_abi::abi_example::AbiExample;
|
2021-12-03 09:00:31 -08:00
|
|
|
use {
|
|
|
|
crate::system_instruction_processor,
|
2022-05-25 16:27:00 -07:00
|
|
|
solana_program_runtime::invoke_context::{InvokeContext, ProcessInstructionWithContext},
|
2021-12-03 09:00:31 -08:00
|
|
|
solana_sdk::{
|
|
|
|
feature_set, instruction::InstructionError, pubkey::Pubkey, stake, system_program,
|
|
|
|
},
|
|
|
|
std::fmt,
|
|
|
|
};
|
2020-11-12 12:44:37 -08:00
|
|
|
|
2021-09-02 21:29:11 -07:00
|
|
|
#[derive(Clone)]
|
|
|
|
pub struct Builtin {
|
|
|
|
pub name: String,
|
|
|
|
pub id: Pubkey,
|
|
|
|
pub process_instruction_with_context: ProcessInstructionWithContext,
|
|
|
|
}
|
|
|
|
|
|
|
|
impl Builtin {
|
|
|
|
pub fn new(
|
|
|
|
name: &str,
|
|
|
|
id: Pubkey,
|
|
|
|
process_instruction_with_context: ProcessInstructionWithContext,
|
|
|
|
) -> Self {
|
|
|
|
Self {
|
|
|
|
name: name.to_string(),
|
|
|
|
id,
|
|
|
|
process_instruction_with_context,
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
impl fmt::Debug for Builtin {
|
|
|
|
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
|
|
|
|
write!(f, "Builtin [name={}, id={}]", self.name, self.id)
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
#[cfg(RUSTC_WITH_SPECIALIZATION)]
|
|
|
|
impl AbiExample for Builtin {
|
|
|
|
fn example() -> Self {
|
|
|
|
Self {
|
|
|
|
name: String::default(),
|
|
|
|
id: Pubkey::default(),
|
2022-04-01 06:48:05 -07:00
|
|
|
process_instruction_with_context: |_, _| Ok(()),
|
2021-09-02 21:29:11 -07:00
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
#[derive(Clone, Debug)]
|
|
|
|
pub struct Builtins {
|
|
|
|
/// Builtin programs that are always available
|
|
|
|
pub genesis_builtins: Vec<Builtin>,
|
|
|
|
|
2022-02-18 18:36:59 -08:00
|
|
|
/// Dynamic feature transitions for builtin programs
|
|
|
|
pub feature_transitions: Vec<BuiltinFeatureTransition>,
|
|
|
|
}
|
|
|
|
|
|
|
|
/// Actions taken by a bank when managing the list of active builtin programs.
|
|
|
|
#[derive(Debug, Clone)]
|
|
|
|
pub enum BuiltinAction {
|
|
|
|
Add(Builtin),
|
|
|
|
Remove(Pubkey),
|
|
|
|
}
|
|
|
|
|
|
|
|
/// State transition enum used for adding and removing builtin programs through
|
|
|
|
/// feature activations.
|
|
|
|
#[derive(Debug, Clone, AbiExample)]
|
2022-06-23 05:22:30 -07:00
|
|
|
pub enum BuiltinFeatureTransition {
|
2022-02-18 18:36:59 -08:00
|
|
|
/// Add a builtin program if a feature is activated.
|
|
|
|
Add {
|
|
|
|
builtin: Builtin,
|
|
|
|
feature_id: Pubkey,
|
|
|
|
},
|
|
|
|
/// Remove a builtin program if a feature is activated or
|
|
|
|
/// retain a previously added builtin.
|
|
|
|
RemoveOrRetain {
|
2022-02-22 04:54:08 -08:00
|
|
|
previously_added_builtin: Builtin,
|
|
|
|
addition_feature_id: Pubkey,
|
2022-02-18 18:36:59 -08:00
|
|
|
removal_feature_id: Pubkey,
|
|
|
|
},
|
|
|
|
}
|
|
|
|
|
|
|
|
impl BuiltinFeatureTransition {
|
|
|
|
pub fn to_action(
|
|
|
|
&self,
|
|
|
|
should_apply_action_for_feature: &impl Fn(&Pubkey) -> bool,
|
|
|
|
) -> Option<BuiltinAction> {
|
2022-06-23 05:22:30 -07:00
|
|
|
match self {
|
|
|
|
Self::Add {
|
2022-02-18 18:36:59 -08:00
|
|
|
builtin,
|
2022-06-23 05:22:30 -07:00
|
|
|
feature_id,
|
2022-02-18 18:36:59 -08:00
|
|
|
} => {
|
|
|
|
if should_apply_action_for_feature(feature_id) {
|
|
|
|
Some(BuiltinAction::Add(builtin.clone()))
|
|
|
|
} else {
|
|
|
|
None
|
|
|
|
}
|
|
|
|
}
|
2022-06-23 05:22:30 -07:00
|
|
|
Self::RemoveOrRetain {
|
2022-02-22 04:54:08 -08:00
|
|
|
previously_added_builtin,
|
2022-06-23 05:22:30 -07:00
|
|
|
addition_feature_id,
|
|
|
|
removal_feature_id,
|
2022-02-18 18:36:59 -08:00
|
|
|
} => {
|
|
|
|
if should_apply_action_for_feature(removal_feature_id) {
|
2022-02-22 04:54:08 -08:00
|
|
|
Some(BuiltinAction::Remove(previously_added_builtin.id))
|
|
|
|
} else if should_apply_action_for_feature(addition_feature_id) {
|
2022-02-18 18:36:59 -08:00
|
|
|
// Retaining is no different from adding a new builtin.
|
2022-02-22 04:54:08 -08:00
|
|
|
Some(BuiltinAction::Add(previously_added_builtin.clone()))
|
|
|
|
} else {
|
|
|
|
None
|
2022-02-18 18:36:59 -08:00
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
2021-09-02 21:29:11 -07:00
|
|
|
}
|
|
|
|
|
2020-09-24 12:23:09 -07:00
|
|
|
/// Builtin programs that are always available
|
|
|
|
fn genesis_builtins() -> Vec<Builtin> {
|
|
|
|
vec![
|
|
|
|
Builtin::new(
|
|
|
|
"system_program",
|
|
|
|
system_program::id(),
|
2022-05-25 16:27:00 -07:00
|
|
|
system_instruction_processor::process_instruction,
|
2020-09-24 12:23:09 -07:00
|
|
|
),
|
|
|
|
Builtin::new(
|
|
|
|
"vote_program",
|
|
|
|
solana_vote_program::id(),
|
2022-05-25 16:27:00 -07:00
|
|
|
solana_vote_program::vote_processor::process_instruction,
|
2020-09-24 12:23:09 -07:00
|
|
|
),
|
|
|
|
Builtin::new(
|
|
|
|
"stake_program",
|
2021-06-15 09:04:00 -07:00
|
|
|
stake::program::id(),
|
2022-05-25 16:27:00 -07:00
|
|
|
solana_stake_program::stake_instruction::process_instruction,
|
2020-09-24 12:23:09 -07:00
|
|
|
),
|
|
|
|
Builtin::new(
|
|
|
|
"config_program",
|
|
|
|
solana_config_program::id(),
|
2022-05-25 16:27:00 -07:00
|
|
|
solana_config_program::config_processor::process_instruction,
|
2020-09-24 12:23:09 -07:00
|
|
|
),
|
|
|
|
]
|
2020-08-14 12:32:45 -07:00
|
|
|
}
|
|
|
|
|
2022-02-16 10:48:55 -08:00
|
|
|
/// place holder for precompile programs, remove when the precompile program is deactivated via feature activation
|
2021-09-28 23:25:08 -07:00
|
|
|
fn dummy_process_instruction(
|
2021-10-08 02:41:07 -07:00
|
|
|
_first_instruction_account: usize,
|
2021-12-02 09:47:16 -08:00
|
|
|
_invoke_context: &mut InvokeContext,
|
2021-09-28 23:25:08 -07:00
|
|
|
) -> Result<(), InstructionError> {
|
|
|
|
Ok(())
|
|
|
|
}
|
|
|
|
|
2022-02-18 18:36:59 -08:00
|
|
|
/// Dynamic feature transitions for builtin programs
|
|
|
|
fn builtin_feature_transitions() -> Vec<BuiltinFeatureTransition> {
|
2021-09-03 14:35:38 -07:00
|
|
|
vec![
|
2022-06-23 05:22:30 -07:00
|
|
|
BuiltinFeatureTransition::Add {
|
2022-02-18 18:36:59 -08:00
|
|
|
builtin: Builtin::new(
|
2021-09-03 14:35:38 -07:00
|
|
|
"compute_budget_program",
|
|
|
|
solana_sdk::compute_budget::id(),
|
|
|
|
solana_compute_budget_program::process_instruction,
|
|
|
|
),
|
2022-02-18 18:36:59 -08:00
|
|
|
feature_id: feature_set::add_compute_budget_program::id(),
|
2022-06-23 05:22:30 -07:00
|
|
|
},
|
|
|
|
BuiltinFeatureTransition::RemoveOrRetain {
|
2022-02-22 04:54:08 -08:00
|
|
|
previously_added_builtin: Builtin::new(
|
2021-09-28 23:25:08 -07:00
|
|
|
"secp256k1_program",
|
|
|
|
solana_sdk::secp256k1_program::id(),
|
|
|
|
dummy_process_instruction,
|
2022-02-16 10:48:55 -08:00
|
|
|
),
|
2022-02-22 04:54:08 -08:00
|
|
|
addition_feature_id: feature_set::secp256k1_program_enabled::id(),
|
2022-02-18 18:36:59 -08:00
|
|
|
removal_feature_id: feature_set::prevent_calling_precompiles_as_programs::id(),
|
2022-06-23 05:22:30 -07:00
|
|
|
},
|
|
|
|
BuiltinFeatureTransition::RemoveOrRetain {
|
2022-02-22 04:54:08 -08:00
|
|
|
previously_added_builtin: Builtin::new(
|
2022-02-16 10:48:55 -08:00
|
|
|
"ed25519_program",
|
|
|
|
solana_sdk::ed25519_program::id(),
|
|
|
|
dummy_process_instruction,
|
2021-09-03 14:35:38 -07:00
|
|
|
),
|
2022-02-22 04:54:08 -08:00
|
|
|
addition_feature_id: feature_set::ed25519_program_enabled::id(),
|
2022-02-18 18:36:59 -08:00
|
|
|
removal_feature_id: feature_set::prevent_calling_precompiles_as_programs::id(),
|
2022-06-23 05:22:30 -07:00
|
|
|
},
|
|
|
|
BuiltinFeatureTransition::Add {
|
2022-02-18 18:36:59 -08:00
|
|
|
builtin: Builtin::new(
|
2021-12-10 13:02:16 -08:00
|
|
|
"address_lookup_table_program",
|
|
|
|
solana_address_lookup_table_program::id(),
|
|
|
|
solana_address_lookup_table_program::processor::process_instruction,
|
|
|
|
),
|
2022-02-18 18:36:59 -08:00
|
|
|
feature_id: feature_set::versioned_tx_message_enabled::id(),
|
2022-06-23 05:22:30 -07:00
|
|
|
},
|
|
|
|
BuiltinFeatureTransition::Add {
|
2022-02-18 18:36:59 -08:00
|
|
|
builtin: Builtin::new(
|
2022-01-04 22:55:26 -08:00
|
|
|
"zk_token_proof_program",
|
|
|
|
solana_zk_token_sdk::zk_token_proof_program::id(),
|
2022-05-25 16:27:00 -07:00
|
|
|
solana_zk_token_proof_program::process_instruction,
|
2022-01-04 22:55:26 -08:00
|
|
|
),
|
2022-02-18 18:36:59 -08:00
|
|
|
feature_id: feature_set::zk_token_sdk_enabled::id(),
|
2022-06-23 05:22:30 -07:00
|
|
|
},
|
2021-09-03 14:35:38 -07:00
|
|
|
]
|
2020-09-21 22:36:23 -07:00
|
|
|
}
|
|
|
|
|
2020-09-24 12:23:09 -07:00
|
|
|
pub(crate) fn get() -> Builtins {
|
|
|
|
Builtins {
|
|
|
|
genesis_builtins: genesis_builtins(),
|
2022-02-18 18:36:59 -08:00
|
|
|
feature_transitions: builtin_feature_transitions(),
|
2020-08-25 09:49:15 -07:00
|
|
|
}
|
2020-08-14 12:32:45 -07:00
|
|
|
}
|
2022-06-22 10:17:43 -07:00
|
|
|
|
|
|
|
/// Returns the addresses of all builtin programs.
|
|
|
|
pub fn get_pubkeys() -> Vec<Pubkey> {
|
|
|
|
let builtins = get();
|
|
|
|
|
|
|
|
let mut pubkeys = Vec::new();
|
|
|
|
pubkeys.extend(builtins.genesis_builtins.iter().map(|b| b.id));
|
2022-06-23 09:56:09 -07:00
|
|
|
pubkeys.extend(builtins.feature_transitions.iter().filter_map(|f| match f {
|
|
|
|
BuiltinFeatureTransition::Add { builtin, .. } => Some(builtin.id),
|
|
|
|
BuiltinFeatureTransition::RemoveOrRetain { .. } => None,
|
|
|
|
}));
|
2022-06-22 10:17:43 -07:00
|
|
|
pubkeys
|
|
|
|
}
|