Add custom IDL support with verification and override control

src/lib.rs

@@ -1,6 +1,14 @@
-pub mod solana {
-    pub mod parser;
-    pub mod structs;
-    pub mod idl_parser;
-    pub mod idl_db;
-}
+pub mod solana;
+
+// Re-export commonly used types and functions for convenience
+pub use solana::idl_parser::{
+    compute_idl_hash, construct_custom_idl_records_map,
+    construct_custom_idl_records_map_with_overrides, construct_idl_records_map, decode_idl_data,
+    parse_instruction_with_idl,
+};
+pub use solana::parser::{parse_transaction, parse_transaction_with_idls};
+pub use solana::structs::{
+    CustomIdl, CustomIdlConfig, Idl, IdlSource, ProgramType, SolanaInstruction, SolanaMetadata,
+    SolanaParseResponse, SolanaParsedInstructionData, SolanaParsedTransaction,
+    SolanaParsedTransactionPayload,
+};

src/main.rs

@@ -1,47 +1,135 @@
+use std::collections::HashMap;
 use std::env;
+use std::fs;
 
 mod solana;
 
 use crate::solana::parser::parse_transaction;
-use crate::solana::structs::{SolanaParsedTransactionPayload, SolanaParsedInstructionData};
-
+use crate::solana::structs::{
+    IdlSource, SolanaParsedInstructionData, SolanaParsedTransactionPayload,
+};
 
 fn main() {
     let args: Vec<String> = env::args().collect();
 
-    if args.len() != 4 {
-        println!("Usage: `cargo run parse <unsigned transaction> --message OR cargo run parse <unsinged transaction> --transaction`");
+    if args.len() < 4 {
+        print_usage();
         return;
     }
 
     let command = &args[1];
-        match command.as_str() {
-            "parse" => {
-                let unsigned_tx = &args[3];
-                let flag = if args.len() > 3 { Some(&args[2]) } else { None };
-                match flag {
-                    Some(flag) if flag == "--message" || flag == "--transaction" => {
-                        let is_transaction = flag == "--transaction";
-                        let result = parse_transaction(unsigned_tx.to_string(), is_transaction);
-                        match result {
-                            Ok(response) => {
-                                print_parsed_transaction(response.solana_parsed_transaction.payload.unwrap());
-                            },
-                            Err(e) => println!("Error: {}", e),
+    match command.as_str() {
+        "parse" => {
+            let flag = &args[2];
+            let unsigned_tx = &args[3];
+
+            match flag.as_str() {
+                "--message" | "--transaction" => {
+                    let is_transaction = flag == "--transaction";
+
+                    // Check for optional custom IDL parameters
+                    let custom_idls = parse_custom_idl_args(&args[4..]);
+
+                    let result =
+                        parse_transaction(unsigned_tx.to_string(), is_transaction, custom_idls);
+
+                    match result {
+                        Ok(response) => {
+                            print_parsed_transaction(
+                                response.solana_parsed_transaction.payload.unwrap(),
+                            );
                         }
+                        Err(e) => println!("Error: {}", e),
                     }
-                    _ => {
-                        println!("Invalid or missing flag. Use either --message or --transaction.");
-                    }
                 }
+                _ => {
+                    println!("Invalid flag. Use either --message or --transaction.");
+                    print_usage();
+                }
+            }
+        }
+        _ => {
+            println!("Unknown command: {}", command);
+            print_usage();
+        }
+    }
+}
+
+fn print_usage() {
+    println!("Usage:");
+    println!("  cargo run parse --message <unsigned_tx_hex>");
+    println!("  cargo run parse --transaction <unsigned_tx_hex>");
+    println!();
+    println!("Optional custom IDL parameters:");
+    println!("  --custom-idl <program_id> <idl_json_file_or_string> [--override]");
+    println!();
+    println!("Examples:");
+    println!("  cargo run parse --message <tx_hex>");
+    println!("  cargo run parse --message <tx_hex> --custom-idl <program_id> /path/to/idl.json");
+    println!("  cargo run parse --message <tx_hex> --custom-idl <program_id> /path/to/idl.json --override");
+}
+
+fn parse_custom_idl_args(args: &[String]) -> Option<HashMap<String, (String, bool)>> {
+    if args.is_empty() {
+        return None;
+    }
+
+    let mut custom_idls = HashMap::new();
+    let mut i = 0;
+
+    while i < args.len() {
+        if args[i] == "--custom-idl" {
+            if i + 2 >= args.len() {
+                eprintln!(
+                    "Error: --custom-idl requires <program_id> and <idl_json_file_or_string>"
+                );
+                return None;
             }
-            _ => println!("Unknown command: {}", command),
+
+            let program_id = args[i + 1].clone();
+            let idl_arg = &args[i + 2];
+
+            // Check if it's a file path or JSON string
+            let idl_json = if std::path::Path::new(idl_arg).exists() {
+                match fs::read_to_string(idl_arg) {
+                    Ok(content) => content,
+                    Err(e) => {
+                        eprintln!("Error reading IDL file {}: {}", idl_arg, e);
+                        return None;
+                    }
+                }
+            } else {
+                idl_arg.clone()
+            };
+
+            // Check for --override flag
+            let override_builtin = if i + 3 < args.len() && args[i + 3] == "--override" {
+                i += 1; // Skip the --override flag
+                true
+            } else {
+                false
+            };
+
+            custom_idls.insert(program_id, (idl_json, override_builtin));
+            i += 3;
+        } else {
+            i += 1;
         }
+    }
+
+    if custom_idls.is_empty() {
+        None
+    } else {
+        Some(custom_idls)
+    }
 }
 
 fn print_parsed_transaction(transaction_payload: SolanaParsedTransactionPayload) {
     println!("Solana Parsed Transaction Payload:");
-    println!("  Unsigned Payload: {}", transaction_payload.unsigned_payload);
+    println!(
+        "  Unsigned Payload: {}",
+        transaction_payload.unsigned_payload
+    );
     if let Some(metadata) = transaction_payload.transaction_metadata {
         println!("  Transaction Metadata:");
         println!("    Signatures: {:?}", metadata.signatures);
@@ -53,8 +141,14 @@ fn print_parsed_transaction(transaction_payload: SolanaParsedTransactionPayload)
             println!("      Instruction {}:", i + 1);
             println!("        Program Key: {}", instruction.program_key);
             println!("        Accounts: {:?}", instruction.accounts);
-            println!("        Instruction Data (hex): {}", instruction.instruction_data_hex);
-            println!("        Address Table Lookups: {:?}", instruction.address_table_lookups);
+            println!(
+                "        Instruction Data (hex): {}",
+                instruction.instruction_data_hex
+            );
+            println!(
+                "        Address Table Lookups: {:?}",
+                instruction.address_table_lookups
+            );
             print_parsed_instruction_data(instruction.parsed_instruction.clone());
         }
         println!("    Transfers:");
@@ -84,14 +178,35 @@ fn print_parsed_transaction(transaction_payload: SolanaParsedTransactionPayload)
                 println!("        Fee: {}", fee);
             }
         }
-        println!("    Address Table Lookups: {:?}", metadata.address_table_lookups);
+        println!(
+            "    Address Table Lookups: {:?}",
+            metadata.address_table_lookups
+        );
     }
 }
 
 fn print_parsed_instruction_data(p_inst_data: Option<SolanaParsedInstructionData>) {
     println!("        Parsed Instruction Data:");
     if let Some(parsed_data) = p_inst_data {
-        println!("          Instruction Name: {}", parsed_data.instruction_name);
+        println!(
+            "          Instruction Name: {}",
+            parsed_data.instruction_name
+        );
+
+        // Display IDL source information
+        match &parsed_data.idl_source {
+            IdlSource::BuiltIn(program_type) => {
+                println!(
+                    "          IDL Source: Built-in ({})",
+                    program_type.program_name()
+                );
+            }
+            IdlSource::Custom => {
+                println!("          IDL Source: Custom");
+            }
+        }
+        println!("          IDL Hash: {}", parsed_data.idl_hash);
+
         println!("          Named Accounts:");
         for k in parsed_data.named_accounts.keys() {
             let acct_string = parsed_data.named_accounts[k].clone();
@@ -105,4 +220,4 @@ fn print_parsed_instruction_data(p_inst_data: Option<SolanaParsedInstructionData
     } else {
         println!("          NO PARSED INSTRUCTION DATA -- NO MATCHING IDL")
     }
-}
+}

src/solana/embedded_idls.rs

@@ -0,0 +1,18 @@
+//! Embedded IDL files - all built-in IDLs are compiled into the binary
+//! This eliminates the need for runtime file access and ensures the library
+//! works regardless of the working directory.
+
+// Embed all built-in IDL files at compile time
+pub const APE_PRO_IDL: &str = include_str!("idls/ape_pro.json");
+pub const CANDY_MACHINE_IDL: &str = include_str!("idls/cndy.json");
+pub const DRIFT_IDL: &str = include_str!("idls/drift.json");
+pub const JUPITER_LIMIT_IDL: &str = include_str!("idls/jupiter_limit.json");
+pub const JUPITER_IDL: &str = include_str!("idls/jupiter.json");
+pub const KAMINO_IDL: &str = include_str!("idls/kamino.json");
+pub const LIFINITY_IDL: &str = include_str!("idls/lifinity.json");
+pub const METEORA_IDL: &str = include_str!("idls/meteora.json");
+pub const OPENBOOK_IDL: &str = include_str!("idls/openbook.json");
+pub const ORCA_IDL: &str = include_str!("idls/orca.json");
+pub const RAYDIUM_IDL: &str = include_str!("idls/raydium.json");
+pub const STABBLE_IDL: &str = include_str!("idls/stabble.json");
+pub const JUPITER_AGG_V6_IDL: &str = include_str!("idls/jupiter_agg_v6.json");

src/solana/idl_db.rs

@@ -1,15 +1,70 @@
+// Legacy IDL database - kept for backwards compatibility
+// Use ProgramType::all() and ProgramType methods instead
+#[allow(dead_code)]
 pub const IDL_DB: [(&str, &str, &str); 13] = [
-    ("Ape Pro", "JSW99DKmxNyREQM14SQLDykeBvEUG63TeohrvmofEiw", "ape_pro.json"),
-    ("Metaplex Candy Machine", "cndyAnrLdpjq1Ssp1z8xxDsB8dxe7u4HL5Nxi2K5WXZ", "cndy.json"),
-    ("Drift Protocol V2", "dRiftyHA39MWEi3m9aunc5MzRF1JYuBsbn6VPcn33UH", "drift.json"),
-    ("Jupiter Limit", "j1o2qRpjcyUwEvwtcfhEQefh773ZgjxcVRry7LDqg5X", "jupiter_limit.json"),
-    ("Jupiter Swap", "JUP4Fb2cqiRUcaTHdrPC8h2gNsA2ETXiPDD33WcGuJB", "jupiter.json"),
-    ("Kamino", "6LtLpnUFNByNXLyCoK9wA2MykKAmQNZKBdY8s47dehDc", "kamino.json"),
-    ("Lifinity Swap V2", "2wT8Yq49kHgDzXuPxZSaeLaH1qbmGXtEyPy64bL7aD3c", "lifinity.json"),
-    ("Meteora", "LBUZKhRxPF3XUpBCjp4YzTKgLccjZhTSDM9YuVaPwxo", "meteora.json"),
-    ("Openbook", "opnb2LAfJYbRMAHHvqjCwQxanZn7ReEHp1k81EohpZb", "openbook.json"),
-    ("Orca Whirlpool", "whirLbMiicVdio4qvUfM5KAg6Ct8VwpYzGff3uctyCc", "orca.json"),
-    ("Raydium", "CPMMoo8L3F4NbTegBCKVNunggL7H1ZpdTHKxQB5qKP1C", "raydium.json"),
-    ("Stabble", "swapNyd8XiQwJ6ianp9snpu4brUqFxadzvHebnAXjJZ", "stabble.json"),
-    ("Jupiter Aggregator V6", "JUP6LkbZbjS1jKKwapdHNy74zcZ3tLUZoi5QNyVTaV4", "jupiter_agg_v6.json"),
-];
+    (
+        "Ape Pro",
+        "JSW99DKmxNyREQM14SQLDykeBvEUG63TeohrvmofEiw",
+        "ape_pro.json",
+    ),
+    (
+        "Metaplex Candy Machine",
+        "cndyAnrLdpjq1Ssp1z8xxDsB8dxe7u4HL5Nxi2K5WXZ",
+        "cndy.json",
+    ),
+    (
+        "Drift Protocol V2",
+        "dRiftyHA39MWEi3m9aunc5MzRF1JYuBsbn6VPcn33UH",
+        "drift.json",
+    ),
+    (
+        "Jupiter Limit",
+        "j1o2qRpjcyUwEvwtcfhEQefh773ZgjxcVRry7LDqg5X",
+        "jupiter_limit.json",
+    ),
+    (
+        "Jupiter Swap",
+        "JUP4Fb2cqiRUcaTHdrPC8h2gNsA2ETXiPDD33WcGuJB",
+        "jupiter.json",
+    ),
+    (
+        "Kamino",
+        "6LtLpnUFNByNXLyCoK9wA2MykKAmQNZKBdY8s47dehDc",
+        "kamino.json",
+    ),
+    (
+        "Lifinity Swap V2",
+        "2wT8Yq49kHgDzXuPxZSaeLaH1qbmGXtEyPy64bL7aD3c",
+        "lifinity.json",
+    ),
+    (
+        "Meteora",
+        "LBUZKhRxPF3XUpBCjp4YzTKgLccjZhTSDM9YuVaPwxo",
+        "meteora.json",
+    ),
+    (
+        "Openbook",
+        "opnb2LAfJYbRMAHHvqjCwQxanZn7ReEHp1k81EohpZb",
+        "openbook.json",
+    ),
+    (
+        "Orca Whirlpool",
+        "whirLbMiicVdio4qvUfM5KAg6Ct8VwpYzGff3uctyCc",
+        "orca.json",
+    ),
+    (
+        "Raydium",
+        "CPMMoo8L3F4NbTegBCKVNunggL7H1ZpdTHKxQB5qKP1C",
+        "raydium.json",
+    ),
+    (
+        "Stabble",
+        "swapNyd8XiQwJ6ianp9snpu4brUqFxadzvHebnAXjJZ",
+        "stabble.json",
+    ),
+    (
+        "Jupiter Aggregator V6",
+        "JUP6LkbZbjS1jKKwapdHNy74zcZ3tLUZoi5QNyVTaV4",
+        "jupiter_agg_v6.json",
+    ),
+];