tests: add compute convenience function (#179)

Author: 2501babe

Cargo.lock

@@ -54,24 +54,24 @@ Previously, the Stake Program was essentially free, costing 1500 Compute Units i
 
 For the initial 1.0.0 release, we followed the existing Agave code as closely as possible, to minimize the possibility of introducing any bugs or changing any behaviors in the port because of the total rewrite of the calling interface the port necessitated. This means the existing program is expected to be non-optimal. With the ability to test more thoroughly against this 1.0.0 version, we expect to be able to optimize these costs in the future.
 
-Based on the sample invocations in `program/tests/interface.rs`, approximate costs as of 2025-07-28 are as follows. These should be treated as baselines and are rounded to thousands; instructions may do less or more work depending on arguments and account states.
+Based on the sample invocations in `program/tests/interface.rs`, approximate costs as of 2025-11-14 are as follows. These should be treated as baselines and are rounded to hundreds; instructions may do less or more work depending on arguments and account states.
 
 | Instruction | Estimated Cost |
 | --- | --- |
-| `Initialize` | 9000 |
-| `Authorize` | 12000 |
-| `DelegateStake` | 15000 |
-| `Split` | 20000 |
-| `Withdraw` | 8000 |
-| `Deactivate` | 13000 |
-| `SetLockup` | 11000 |
-| `Merge` | 21000 |
-| `AuthorizeWithSeed` | 14000 |
-| `InitializeChecked` | 6000 |
-| `AuthorizeChecked` | 12000 |
-| `AuthorizeCheckedWithSeed` | 14000 |
-| `SetLockupChecked` | 11000 |
+| `Authorize` | 10500 |
+| `AuthorizeChecked` | 10200 |
+| `AuthorizeCheckedWithSeed` | 11500 |
+| `AuthorizeWithSeed` | 11700 |
+| `Deactivate` | 10600 |
+| `DeactivateDelinquent` | 11400 |
+| `DelegateStake` | 10800 |
 | `GetMinimumDelegation` | (negligible) |
-| `DeactivateDelinquent` | 18000 |
-| `MoveStake` | 25000 |
-| `MoveLamports` | 15000 |
+| `Initialize` | 7500 |
+| `InitializeChecked` | 5200 |
+| `Merge` | 17600 |
+| `MoveLamports` | 12500 |
+| `MoveStake` | 21700 |
+| `SetLockup` | 9300 |
+| `SetLockupChecked` | 9100 |
+| `Split` | 16900 |
+| `Withdraw` | 7300 |

README.md

@@ -41,6 +41,7 @@ solana-program-test = "3.0.10"
 solana-sdk-ids = "3.0.0"
 solana-signature = "3.0.0"
 solana-signer = "3.0.0"
+solana-svm-log-collector = "3.0.0"
 solana-system-interface = { version = "2.0.0", features = ["bincode"] }
 solana-sysvar-id = "3.0.0"
 solana-transaction = "3.0.0"

program/Cargo.toml

@@ -22,6 +22,7 @@ use {
         },
     },
     solana_stake_program::{get_minimum_delegation, id},
+    solana_svm_log_collector::LogCollector,
     solana_sysvar_id::SysvarId,
     solana_vote_interface::{
         program as vote_program,
@@ -1123,3 +1124,89 @@ fn test_no_use_dealloc() {
         }
     }
 }
+
+// this prints ballpark compute unit costs suitable for insertion in README.md
+// run with `cargo test --test interface show_compute_usage -- --nocapture --ignored`
+#[test]
+#[ignore]
+fn show_compute_usage() {
+    let mut env = Env::init();
+    solana_logger::setup_with("");
+    env.mollusk.logger = Some(LogCollector::new_ref());
+    let mut compute_tracker = ComputeTracker::new();
+
+    for declaration in &*INSTRUCTION_DECLARATIONS {
+        let instruction = declaration.to_instruction(&mut env);
+        env.process_success(&instruction);
+
+        let logs = env
+            .mollusk
+            .logger
+            .as_ref()
+            .unwrap()
+            .replace(LogCollector::default())
+            .into_messages();
+
+        compute_tracker.add(&logs);
+        env.reset();
+    }
+
+    compute_tracker.show();
+}
+
+struct ComputeTracker(HashMap<String, u64>);
+impl ComputeTracker {
+    fn new() -> Self {
+        Self(HashMap::from([("GetMinimumDelegation".to_string(), 0)]))
+    }
+
+    fn add(&mut self, logs: &[String]) {
+        const IX_PREFIX: &str = "Program log: Instruction: ";
+        const CU_PREFIX: &str = "Program Stake11111111111111111111111111111111111111 consumed ";
+
+        let instruction = logs
+            .iter()
+            .find_map(|line| {
+                line.strip_prefix(IX_PREFIX)
+                    .map(|rest| rest.split_whitespace().next().unwrap().to_string())
+            })
+            .unwrap();
+
+        let compute_units = logs
+            .iter()
+            .find_map(|line| {
+                line.strip_prefix(CU_PREFIX).map(|rest| {
+                    rest.split_whitespace()
+                        .next()
+                        .unwrap()
+                        .parse::<u64>()
+                        .unwrap()
+                })
+            })
+            .unwrap();
+
+        self.0
+            .entry(instruction)
+            .and_modify(|v| *v = std::cmp::max(compute_units, *v))
+            .or_insert(compute_units);
+    }
+
+    fn show(&self) {
+        let mut instructions = self.0.keys().collect::<Vec<_>>();
+        instructions.sort();
+
+        println!("\n| Instruction | Estimated Cost |");
+        println!("| --- | --- |");
+
+        for instruction in instructions.into_iter() {
+            let compute_units = match self.0[instruction] {
+                n if n < 100 => "(negligible)".to_string(),
+                n => ((n + 50) / 100 * 100).to_string(),
+            };
+
+            println!("| `{}` | {} |", instruction, compute_units);
+        }
+
+        println!();
+    }
+}