Files
khadhroony-solana-project/crates/ksp-core-lib/src/program_ids.rs

493 lines
19 KiB
Rust

// file: crates/ksp-core-lib/src/program_ids.rs
// version: 4
const DOMAIN_SOLANA: &str = "solana";
const FAMILY_CONSENSUS: &str = "consensus";
const FAMILY_LOADER: &str = "loader";
const FAMILY_PRECOMPILE: &str = "precompile";
const FAMILY_PROOF: &str = "proof";
const FAMILY_RUNTIME: &str = "runtime";
const PROTOCOL_SOLANA: &str = "solana";
/// Declares one KSP-owned Solana Program ID as matching Base58 and typed constants.
///
/// The Base58 literal is written once and decoded at compile time through [`crate::Pubkey`].
#[macro_export]
macro_rules! declare_program_id {
($string_name:ident, $pubkey_name:ident, $value:literal) => {
#[doc = concat!("Base58 Program ID declared as `", stringify!($string_name), "`.")]
pub const $string_name: &str = $value;
#[doc = concat!("Typed Program ID corresponding to `", stringify!($string_name), "`.")]
pub const $pubkey_name: $crate::Pubkey = $crate::Pubkey::from_str_const($string_name);
};
}
crate::declare_program_id!(PRGID_SOLANA_ADDRESS_LOOKUP_TABLE, PRGIDPK_SOLANA_ADDRESS_LOOKUP_TABLE, "AddressLookupTab1e1111111111111111111111111");
crate::declare_program_id!(PRGID_SOLANA_LOADER_BPF_V1, PRGIDPK_SOLANA_LOADER_BPF_V1, "BPFLoader1111111111111111111111111111111111");
crate::declare_program_id!(PRGID_SOLANA_LOADER_BPF_V2, PRGIDPK_SOLANA_LOADER_BPF_V2, "BPFLoader2111111111111111111111111111111111");
crate::declare_program_id!(PRGID_SOLANA_LOADER_BPF_UPGRADEABLE, PRGIDPK_SOLANA_LOADER_BPF_UPGRADEABLE, "BPFLoaderUpgradeab1e11111111111111111111111");
crate::declare_program_id!(PRGID_SOLANA_COMPUTE_BUDGET, PRGIDPK_SOLANA_COMPUTE_BUDGET, "ComputeBudget111111111111111111111111111111");
crate::declare_program_id!(PRGID_SOLANA_CONFIG, PRGIDPK_SOLANA_CONFIG, "Config1111111111111111111111111111111111111");
crate::declare_program_id!(PRGID_SOLANA_PRECOMPILE_ED25519, PRGIDPK_SOLANA_PRECOMPILE_ED25519, "Ed25519SigVerify111111111111111111111111111");
crate::declare_program_id!(PRGID_SOLANA_FEATURE, PRGIDPK_SOLANA_FEATURE, "Feature111111111111111111111111111111111111");
crate::declare_program_id!(PRGID_SOLANA_LOADER_V4, PRGIDPK_SOLANA_LOADER_V4, "LoaderV411111111111111111111111111111111111");
crate::declare_program_id!(PRGID_SOLANA_LOADER_NATIVE, PRGIDPK_SOLANA_LOADER_NATIVE, "NativeLoader1111111111111111111111111111111");
crate::declare_program_id!(PRGID_SOLANA_PRECOMPILE_SECP256K1, PRGIDPK_SOLANA_PRECOMPILE_SECP256K1, "KeccakSecp256k11111111111111111111111111111");
crate::declare_program_id!(PRGID_SOLANA_PRECOMPILE_SECP256R1, PRGIDPK_SOLANA_PRECOMPILE_SECP256R1, "Secp256r1SigVerify1111111111111111111111111");
crate::declare_program_id!(PRGID_SOLANA_SLASHING, PRGIDPK_SOLANA_SLASHING, "S1ashing11111111111111111111111111111111111");
crate::declare_program_id!(PRGID_SOLANA_STAKE, PRGIDPK_SOLANA_STAKE, "Stake11111111111111111111111111111111111111");
crate::declare_program_id!(PRGID_SOLANA_SYSTEM, PRGIDPK_SOLANA_SYSTEM, "11111111111111111111111111111111");
crate::declare_program_id!(PRGID_SOLANA_VOTE, PRGIDPK_SOLANA_VOTE, "Vote111111111111111111111111111111111111111");
crate::declare_program_id!(PRGID_SOLANA_ZK_ELGAMAL_PROOF, PRGIDPK_SOLANA_ZK_ELGAMAL_PROOF, "ZkE1Gama1Proof11111111111111111111111111111");
crate::declare_program_id!(PRGID_SOLANA_ZK_TOKEN_PROOF, PRGIDPK_SOLANA_ZK_TOKEN_PROOF, "ZkTokenProof1111111111111111111111111111111");
/// Technical classification of a registered Program ID.
#[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)]
pub enum ProgramIdKind {
/// A regular executable program belonging to the registered protocol surface.
Program,
/// A Solana program loader.
Loader,
/// A runtime precompile exposed through a Program ID.
Precompile,
/// An enshrined on-chain program deployed as part of the Solana protocol.
EnshrinedProgram,
}
/// Immutable descriptor for one KSP-owned Program ID.
#[derive(Clone, Copy, Debug, Eq, PartialEq)]
pub struct ProgramIdEntry {
code: &'static str,
name: &'static str,
program_id: &'static str,
pubkey: crate::Pubkey,
domain: &'static str,
family: &'static str,
protocol: &'static str,
subfamily: std::option::Option<&'static str>,
program_version: std::option::Option<&'static str>,
kind: crate::ProgramIdKind,
}
impl ProgramIdEntry {
const fn new(code: &'static str, name: &'static str, program_id: &'static str, pubkey: crate::Pubkey) -> Self {
return Self {
code,
name,
program_id,
pubkey,
domain: "",
family: "",
protocol: "",
subfamily: std::option::Option::None,
program_version: std::option::Option::None,
kind: crate::ProgramIdKind::Program,
};
}
const fn with_taxonomy(
mut self,
domain: &'static str,
family: &'static str,
protocol: &'static str,
subfamily: std::option::Option<&'static str>,
program_version: std::option::Option<&'static str>,
kind: crate::ProgramIdKind,
) -> Self {
self.domain = domain;
self.family = family;
self.protocol = protocol;
self.subfamily = subfamily;
self.program_version = program_version;
self.kind = kind;
return self;
}
/// Returns the stable KSP machine-readable code of this entry.
#[must_use]
pub const fn code(&self) -> &'static str {
return self.code;
}
/// Returns the human-readable program name.
#[must_use]
pub const fn name(&self) -> &'static str {
return self.name;
}
/// Returns the canonical Base58 Program ID.
#[must_use]
pub const fn program_id(&self) -> &'static str {
return self.program_id;
}
/// Returns the typed Solana Program ID.
#[must_use]
pub const fn pubkey(&self) -> crate::Pubkey {
return self.pubkey;
}
/// Returns the broad functional domain.
#[must_use]
pub const fn domain(&self) -> &'static str {
return self.domain;
}
/// Returns the functional family within the domain.
#[must_use]
pub const fn family(&self) -> &'static str {
return self.family;
}
/// Returns the owning protocol or project identifier.
#[must_use]
pub const fn protocol(&self) -> &'static str {
return self.protocol;
}
/// Returns the optional architectural branch or product subfamily.
#[must_use]
pub const fn subfamily(&self) -> std::option::Option<&'static str> {
return self.subfamily;
}
/// Returns the optional public generation of this program lineage.
#[must_use]
pub const fn program_version(&self) -> std::option::Option<&'static str> {
return self.program_version;
}
/// Returns the technical Program ID classification.
#[must_use]
pub const fn kind(&self) -> crate::ProgramIdKind {
return self.kind;
}
}
/// Borrowed filter used to select Program IDs from the canonical KSP registry.
#[derive(Clone, Copy, Debug, Default, Eq, PartialEq)]
pub struct ProgramIdFilter<'a> {
domain: std::option::Option<&'a str>,
family: std::option::Option<&'a str>,
protocol: std::option::Option<&'a str>,
subfamily: std::option::Option<&'a str>,
program_version: std::option::Option<&'a str>,
kind: std::option::Option<crate::ProgramIdKind>,
}
impl<'a> ProgramIdFilter<'a> {
/// Creates an empty filter matching every registered Program ID.
#[must_use]
pub const fn new() -> Self {
return Self {
domain: std::option::Option::None,
family: std::option::Option::None,
protocol: std::option::Option::None,
subfamily: std::option::Option::None,
program_version: std::option::Option::None,
kind: std::option::Option::None,
};
}
/// Restricts the filter to one functional domain.
#[must_use]
pub const fn with_domain(mut self, domain: &'a str) -> Self {
self.domain = std::option::Option::Some(domain);
return self;
}
/// Restricts the filter to one functional family.
#[must_use]
pub const fn with_family(mut self, family: &'a str) -> Self {
self.family = std::option::Option::Some(family);
return self;
}
/// Restricts the filter to one protocol or project.
#[must_use]
pub const fn with_protocol(mut self, protocol: &'a str) -> Self {
self.protocol = std::option::Option::Some(protocol);
return self;
}
/// Restricts the filter to one architectural subfamily.
#[must_use]
pub const fn with_subfamily(mut self, subfamily: &'a str) -> Self {
self.subfamily = std::option::Option::Some(subfamily);
return self;
}
/// Restricts the filter to one public program generation.
#[must_use]
pub const fn with_program_version(mut self, program_version: &'a str) -> Self {
self.program_version = std::option::Option::Some(program_version);
return self;
}
/// Restricts the filter to one technical Program ID kind.
#[must_use]
pub const fn with_kind(mut self, kind: crate::ProgramIdKind) -> Self {
self.kind = std::option::Option::Some(kind);
return self;
}
fn matches(&self, entry: &crate::ProgramIdEntry) -> bool {
if let std::option::Option::Some(domain) = self.domain
&& entry.domain() != domain
{
return false;
}
if let std::option::Option::Some(family) = self.family
&& entry.family() != family
{
return false;
}
if let std::option::Option::Some(protocol) = self.protocol
&& entry.protocol() != protocol
{
return false;
}
if let std::option::Option::Some(subfamily) = self.subfamily
&& entry.subfamily() != std::option::Option::Some(subfamily)
{
return false;
}
if let std::option::Option::Some(program_version) = self.program_version
&& entry.program_version() != std::option::Option::Some(program_version)
{
return false;
}
if let std::option::Option::Some(kind) = self.kind
&& entry.kind() != kind
{
return false;
}
return true;
}
}
/// Returns the canonical KSP Program ID registry.
#[must_use]
pub const fn entries() -> &'static [crate::ProgramIdEntry] {
return PROGRAM_ID_ENTRIES;
}
const PROGRAM_ID_ENTRIES: &[crate::ProgramIdEntry] = &[
crate::ProgramIdEntry::new(
"solana.address_lookup_table",
"Address Lookup Table Program",
crate::PRGID_SOLANA_ADDRESS_LOOKUP_TABLE,
crate::PRGIDPK_SOLANA_ADDRESS_LOOKUP_TABLE,
)
.with_taxonomy(DOMAIN_SOLANA, FAMILY_RUNTIME, PROTOCOL_SOLANA, std::option::Option::None, std::option::Option::None, crate::ProgramIdKind::Program),
crate::ProgramIdEntry::new("solana.loader.bpf.v1", "Deprecated BPF Loader", crate::PRGID_SOLANA_LOADER_BPF_V1, crate::PRGIDPK_SOLANA_LOADER_BPF_V1)
.with_taxonomy(
DOMAIN_SOLANA,
FAMILY_LOADER,
PROTOCOL_SOLANA,
std::option::Option::Some("bpf"),
std::option::Option::Some("v1"),
crate::ProgramIdKind::Loader,
),
crate::ProgramIdEntry::new("solana.loader.bpf.v2", "BPF Loader v2", crate::PRGID_SOLANA_LOADER_BPF_V2, crate::PRGIDPK_SOLANA_LOADER_BPF_V2).with_taxonomy(
DOMAIN_SOLANA,
FAMILY_LOADER,
PROTOCOL_SOLANA,
std::option::Option::Some("bpf"),
std::option::Option::Some("v2"),
crate::ProgramIdKind::Loader,
),
crate::ProgramIdEntry::new(
"solana.loader.bpf_upgradeable",
"Upgradeable BPF Loader",
crate::PRGID_SOLANA_LOADER_BPF_UPGRADEABLE,
crate::PRGIDPK_SOLANA_LOADER_BPF_UPGRADEABLE,
)
.with_taxonomy(
DOMAIN_SOLANA,
FAMILY_LOADER,
PROTOCOL_SOLANA,
std::option::Option::Some("bpf"),
std::option::Option::None,
crate::ProgramIdKind::Loader,
),
crate::ProgramIdEntry::new("solana.compute_budget", "Compute Budget Program", crate::PRGID_SOLANA_COMPUTE_BUDGET, crate::PRGIDPK_SOLANA_COMPUTE_BUDGET)
.with_taxonomy(DOMAIN_SOLANA, FAMILY_RUNTIME, PROTOCOL_SOLANA, std::option::Option::None, std::option::Option::None, crate::ProgramIdKind::Program),
crate::ProgramIdEntry::new("solana.config", "Config Program", crate::PRGID_SOLANA_CONFIG, crate::PRGIDPK_SOLANA_CONFIG).with_taxonomy(
DOMAIN_SOLANA,
FAMILY_RUNTIME,
PROTOCOL_SOLANA,
std::option::Option::None,
std::option::Option::None,
crate::ProgramIdKind::Program,
),
crate::ProgramIdEntry::new(
"solana.precompile.ed25519",
"Ed25519 Signature Verification Precompile",
crate::PRGID_SOLANA_PRECOMPILE_ED25519,
crate::PRGIDPK_SOLANA_PRECOMPILE_ED25519,
)
.with_taxonomy(
DOMAIN_SOLANA,
FAMILY_PRECOMPILE,
PROTOCOL_SOLANA,
std::option::Option::Some("ed25519"),
std::option::Option::None,
crate::ProgramIdKind::Precompile,
),
crate::ProgramIdEntry::new("solana.feature", "Feature Program", crate::PRGID_SOLANA_FEATURE, crate::PRGIDPK_SOLANA_FEATURE).with_taxonomy(
DOMAIN_SOLANA,
FAMILY_RUNTIME,
PROTOCOL_SOLANA,
std::option::Option::None,
std::option::Option::None,
crate::ProgramIdKind::Program,
),
crate::ProgramIdEntry::new("solana.loader.v4", "Loader v4", crate::PRGID_SOLANA_LOADER_V4, crate::PRGIDPK_SOLANA_LOADER_V4).with_taxonomy(
DOMAIN_SOLANA,
FAMILY_LOADER,
PROTOCOL_SOLANA,
std::option::Option::None,
std::option::Option::Some("v4"),
crate::ProgramIdKind::Loader,
),
crate::ProgramIdEntry::new("solana.loader.native", "Native Loader", crate::PRGID_SOLANA_LOADER_NATIVE, crate::PRGIDPK_SOLANA_LOADER_NATIVE).with_taxonomy(
DOMAIN_SOLANA,
FAMILY_LOADER,
PROTOCOL_SOLANA,
std::option::Option::Some("native"),
std::option::Option::None,
crate::ProgramIdKind::Loader,
),
crate::ProgramIdEntry::new(
"solana.precompile.secp256k1",
"Secp256k1 Signature Verification Precompile",
crate::PRGID_SOLANA_PRECOMPILE_SECP256K1,
crate::PRGIDPK_SOLANA_PRECOMPILE_SECP256K1,
)
.with_taxonomy(
DOMAIN_SOLANA,
FAMILY_PRECOMPILE,
PROTOCOL_SOLANA,
std::option::Option::Some("secp256k1"),
std::option::Option::None,
crate::ProgramIdKind::Precompile,
),
crate::ProgramIdEntry::new(
"solana.precompile.secp256r1",
"Secp256r1 Signature Verification Precompile",
crate::PRGID_SOLANA_PRECOMPILE_SECP256R1,
crate::PRGIDPK_SOLANA_PRECOMPILE_SECP256R1,
)
.with_taxonomy(
DOMAIN_SOLANA,
FAMILY_PRECOMPILE,
PROTOCOL_SOLANA,
std::option::Option::Some("secp256r1"),
std::option::Option::None,
crate::ProgramIdKind::Precompile,
),
crate::ProgramIdEntry::new("solana.slashing", "Slashing Program", crate::PRGID_SOLANA_SLASHING, crate::PRGIDPK_SOLANA_SLASHING).with_taxonomy(
DOMAIN_SOLANA,
FAMILY_CONSENSUS,
PROTOCOL_SOLANA,
std::option::Option::None,
std::option::Option::None,
crate::ProgramIdKind::EnshrinedProgram,
),
crate::ProgramIdEntry::new("solana.stake", "Stake Program", crate::PRGID_SOLANA_STAKE, crate::PRGIDPK_SOLANA_STAKE).with_taxonomy(
DOMAIN_SOLANA,
FAMILY_CONSENSUS,
PROTOCOL_SOLANA,
std::option::Option::None,
std::option::Option::None,
crate::ProgramIdKind::Program,
),
crate::ProgramIdEntry::new("solana.system", "System Program", crate::PRGID_SOLANA_SYSTEM, crate::PRGIDPK_SOLANA_SYSTEM).with_taxonomy(
DOMAIN_SOLANA,
FAMILY_RUNTIME,
PROTOCOL_SOLANA,
std::option::Option::None,
std::option::Option::None,
crate::ProgramIdKind::Program,
),
crate::ProgramIdEntry::new("solana.vote", "Vote Program", crate::PRGID_SOLANA_VOTE, crate::PRGIDPK_SOLANA_VOTE).with_taxonomy(
DOMAIN_SOLANA,
FAMILY_CONSENSUS,
PROTOCOL_SOLANA,
std::option::Option::None,
std::option::Option::None,
crate::ProgramIdKind::Program,
),
crate::ProgramIdEntry::new(
"solana.proof.zk_elgamal",
"ZK ElGamal Proof Program",
crate::PRGID_SOLANA_ZK_ELGAMAL_PROOF,
crate::PRGIDPK_SOLANA_ZK_ELGAMAL_PROOF,
)
.with_taxonomy(
DOMAIN_SOLANA,
FAMILY_PROOF,
PROTOCOL_SOLANA,
std::option::Option::Some("zk_elgamal"),
std::option::Option::None,
crate::ProgramIdKind::Program,
),
crate::ProgramIdEntry::new("solana.proof.zk_token", "ZK Token Proof Program", crate::PRGID_SOLANA_ZK_TOKEN_PROOF, crate::PRGIDPK_SOLANA_ZK_TOKEN_PROOF)
.with_taxonomy(
DOMAIN_SOLANA,
FAMILY_PROOF,
PROTOCOL_SOLANA,
std::option::Option::Some("zk_token"),
std::option::Option::None,
crate::ProgramIdKind::Program,
),
];
/// Returns a lazy view of Program IDs matching all configured filter axes.
pub fn program_ids<'a>(filter: crate::ProgramIdFilter<'a>) -> impl std::iter::Iterator<Item = &'static crate::ProgramIdEntry> + 'a {
return PROGRAM_ID_ENTRIES.iter().filter(move |entry| {
return filter.matches(entry);
});
}
/// Returns all Solana core/native Program IDs, including loaders, precompiles and enshrined programs.
pub fn native_program_ids() -> impl std::iter::Iterator<Item = &'static crate::ProgramIdEntry> {
return crate::program_ids(crate::ProgramIdFilter::new().with_domain(DOMAIN_SOLANA).with_protocol(PROTOCOL_SOLANA));
}
/// Returns a lazy view of Program IDs belonging to one functional domain.
pub fn program_ids_by_domain<'a>(domain: &'a str) -> impl std::iter::Iterator<Item = &'static crate::ProgramIdEntry> + 'a {
return crate::program_ids(crate::ProgramIdFilter::new().with_domain(domain));
}
/// Returns a lazy view of Program IDs belonging to one functional family.
pub fn program_ids_by_family<'a>(family: &'a str) -> impl std::iter::Iterator<Item = &'static crate::ProgramIdEntry> + 'a {
return crate::program_ids(crate::ProgramIdFilter::new().with_family(family));
}
/// Returns a lazy view of Program IDs belonging to one protocol or project.
pub fn program_ids_by_protocol<'a>(protocol: &'a str) -> impl std::iter::Iterator<Item = &'static crate::ProgramIdEntry> + 'a {
return crate::program_ids(crate::ProgramIdFilter::new().with_protocol(protocol));
}
/// Finds one registered Program ID by its canonical Base58 representation.
#[must_use]
pub fn find_program_id(program_id: &str) -> std::option::Option<&'static crate::ProgramIdEntry> {
return PROGRAM_ID_ENTRIES.iter().find(|entry| {
return entry.program_id() == program_id;
});
}
/// Finds one registered Program ID by its typed Solana representation.
#[must_use]
pub fn find_program_pubkey(program_id: &crate::Pubkey) -> std::option::Option<&'static crate::ProgramIdEntry> {
return PROGRAM_ID_ENTRIES.iter().find(|entry| {
return entry.pubkey() == *program_id;
});
}
#[cfg(test)]
#[path = "../unit_tests/program_ids.rs"]
mod tests;