chore: add a feature to compile only types needed for the SDK (#117)

* chore: allow to compile only core types to export

* chore: rename core feature to sdk & refactor

* chore: simplify sdk & program feature

* chore: group imports

Author: GabrielePicco

Cargo.lock

@@ -1,7 +1,7 @@
 [package]
 name = "magicblock-delegation-program"
 description = "Delegation program for the Ephemeral Rollups"
-version = "1.1.2"
+version = "1.1.3"
 authors = ["Magicblock Labs <dev@magicblock.gg>"]
 edition = "2021"
 license = "MIT"
@@ -27,34 +27,48 @@ name = "dlp"
 
 [features]
 no-entrypoint = []
-default = ["solana-security-txt"]
+sdk = ["no-entrypoint"]
+program = [
+  "dep:pinocchio",
+  "dep:pinocchio-log",
+  "dep:pinocchio-pubkey",
+  "dep:pinocchio-system",
+  "dep:rkyv",
+  "dep:solana-curve25519",
+]
+
+# Default build = program path + security txt
+default = [
+    "program",
+    "solana-security-txt",
+]
 unit_test_config = []
 log-cost = []
 logging = []
 
 [dependencies]
 borsh = { version = "1.5.3", features = [ "derive" ] }
-paste = "^1.0"
-solana-program = "2.2"
-bytemuck = { version = "1.21", features = [ "derive" ] }
+solana-program = { version = ">=1.16" }
+bytemuck = { version = ">=1", features = [ "derive" ] }
 num_enum = "^0.7.2"
-thiserror = "^1.0.57"
-solana-security-txt = { version = "1.1.1", optional = true }
-solana-curve25519 = "2.2"
-bincode = "1.3.3"
-pinocchio-log = "0.5.0"
-pinocchio = "0.9.2"
-pinocchio-pubkey = "0.3.0"
-pinocchio-system = "0.3.0"
-rkyv = "0.7.45"
+thiserror = { version = ">=1" }
+solana-security-txt = { version = ">=1.1", optional = true }
+solana-curve25519 = { version = ">=2.2", optional = true }
+bincode = { version = "^1.3" }
+pinocchio-log = { version = "0.5.0", optional = true }
+pinocchio = { version = "0.9.2", optional = true }
+pinocchio-pubkey = { version = "0.3.0", optional = true }
+pinocchio-system = { version = "0.3.0", optional = true }
+rkyv = { version = "0.7.45", optional = true }
 static_assertions = "1.1.0"
-strum = { version = "0.27.2", features = ["derive"] }
+strum = { version = ">=0.27", features = ["derive"] }
 
 [dev-dependencies]
-base64 = "0.22.1"
-rand = "0.8.5"
-solana-program-test = "2.2"
-solana-sdk = "2.2"
-tokio = { version = "1.0", features = ["full"] }
+rand = { version = "=0.8.5", features = ["small_rng"] }
+solana-program-test = ">=1.16"
+solana-sdk = ">=1.16"
+tokio = { version = "^1.0", features = ["full"] }
 magicblock-delegation-program = { path = ".", features = ["unit_test_config"] }
 
+[lints.rust]
+unexpected_cfgs = { level = "warn", check-cfg = ['cfg(target_os, values("solana"))'] }

Cargo.toml

@@ -1,27 +1,45 @@
-#![allow(unexpected_cfgs)] // silence clippy for target_os solana and other solana program custom features
+#![allow(unexpected_cfgs)]
+
+// Exactly one of `sdk` or `program` must be enabled
+#[cfg(all(feature = "sdk", feature = "program"))]
+compile_error!("Features `sdk` and `program` are mutually exclusive. Enable exactly one.");
+
+#[cfg(all(not(feature = "sdk"), not(feature = "program")))]
+compile_error!(
+    "Enable either `program` (default) or `sdk`. Building with neither is not supported."
+);
+
+#[cfg(not(feature = "sdk"))]
+use {
+    crate::discriminator::DlpDiscriminator,
+    solana_program::{
+        account_info::AccountInfo, entrypoint::ProgramResult, program_error::ProgramError,
+        pubkey::Pubkey,
+    },
+};
 
-use crate::discriminator::DlpDiscriminator;
-use pinocchio_log::log;
-use solana_program::account_info::AccountInfo;
 use solana_program::declare_id;
-use solana_program::entrypoint::ProgramResult;
-use solana_program::program_error::ProgramError;
-use solana_program::pubkey::Pubkey;
 
 #[cfg(feature = "logging")]
 use solana_program::msg;
 
 pub mod args;
 pub mod consts;
+#[cfg(not(feature = "sdk"))]
 mod discriminator;
+#[cfg(not(feature = "sdk"))]
 pub mod error;
+#[cfg(not(feature = "sdk"))]
 pub mod instruction_builder;
 pub mod pda;
 pub mod state;
 
+#[cfg(not(feature = "sdk"))]
 mod diff;
+#[cfg(not(feature = "sdk"))]
 mod processor;
 
+#[cfg(not(feature = "sdk"))]
 pub use diff::*;
 
 #[cfg(feature = "log-cost")]
@@ -32,20 +50,22 @@ mod entrypoint;
 
 declare_id!("DELeGGvXpWV2fqJUhqcF5ZSYMS4JTLjteaAMARRSaeSh");
 
+#[cfg(not(feature = "sdk"))]
 pub mod fast {
     pinocchio_pubkey::declare_id!("DELeGGvXpWV2fqJUhqcF5ZSYMS4JTLjteaAMARRSaeSh");
 }
 
-#[cfg(all(not(feature = "no-entrypoint"), feature = "solana-security-txt"))]
+#[cfg(feature = "solana-security-txt")]
 solana_security_txt::security_txt! {
     name: "MagicBlock Delegation Program",
-    project_url: "https://magicblock.gg",
+    project_url: "https://magicblock.xyz",
     contacts: "email:dev@magicblock.gg,twitter:@magicblock",
     policy: "https://github.com/magicblock-labs/delegation-program/blob/master/LICENSE.md",
     preferred_languages: "en",
     source_code: "https://github.com/magicblock-labs/delegation-program"
 }
 
+#[cfg(not(feature = "sdk"))]
 pub fn fast_process_instruction(
     program_id: &pinocchio::pubkey::Pubkey,
     accounts: &[pinocchio::account_info::AccountInfo],
@@ -62,7 +82,7 @@ pub fn fast_process_instruction(
     let discriminator = match DlpDiscriminator::try_from(discriminator_bytes[0]) {
         Ok(discriminator) => discriminator,
         Err(_) => {
-            log!("Failed to read and parse discriminator");
+            pinocchio_log::log!("Failed to read and parse discriminator");
             return Some(Err(
                 pinocchio::program_error::ProgramError::InvalidInstructionData,
             ));
@@ -95,6 +115,7 @@ pub fn fast_process_instruction(
     }
 }
 
+#[cfg(not(feature = "sdk"))]
 pub fn slow_process_instruction(
     program_id: &Pubkey,
     accounts: &[AccountInfo],
@@ -139,7 +160,8 @@ pub fn slow_process_instruction(
             processor::process_call_handler(program_id, accounts, data)?
         }
         _ => {
-            log!("PANIC: Instruction must be processed by fast_process_instruction");
+            #[cfg(feature = "logging")]
+            msg!("PANIC: Instruction must be processed by fast_process_instruction");
             return Err(ProgramError::InvalidInstructionData);
         }
     }