Skip to content

Commit

Permalink
Separate inner detail struct into their own model, add tests for each
Browse files Browse the repository at this point in the history
one of them.
  • Loading branch information
tao-stones committed Aug 5, 2024
1 parent 820295f commit b0b1b68
Show file tree
Hide file tree
Showing 6 changed files with 624 additions and 117 deletions.
2 changes: 2 additions & 0 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 3 additions & 1 deletion runtime-transaction/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,9 @@ name = "solana_runtime_transaction"
[dev-dependencies]
bincode = { workspace = true }
rand = { workspace = true }
solana-program ={ workspace = true }
solana-compute-budget-program = { workspace = true }
solana-program = { workspace = true }
solana-system-program = { workspace = true }

[package.metadata.docs.rs]
targets = ["x86_64-unknown-linux-gnu"]
Expand Down
78 changes: 78 additions & 0 deletions runtime-transaction/src/builtin_instruction_details.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
use {
solana_builtins_default_costs::BUILTIN_INSTRUCTION_COSTS,
solana_sdk::{
instruction::CompiledInstruction, pubkey::Pubkey, saturating_add_assign,
transaction::Result,
},
};

#[cfg_attr(test, derive(Clone, Eq, PartialEq))]
#[derive(Default, Debug)]
pub struct BuiltinInstructionDetails {
// builtin instruction details
pub sum_builtin_compute_units: u32,
pub count_builtin_instructions: u32,
pub count_non_builtin_instructions: u32,
}

impl BuiltinInstructionDetails {
pub fn process_instruction<'a>(
&mut self,
program_id: &'a Pubkey,
_instruction: &'a CompiledInstruction, // reserved to identify builtin cost pby instruction
// instead of by program_id
) -> Result<()> {
if let Some(builtin_ix_cost) = BUILTIN_INSTRUCTION_COSTS.get(program_id) {
saturating_add_assign!(
self.sum_builtin_compute_units,
u32::try_from(*builtin_ix_cost).unwrap()
);
saturating_add_assign!(self.count_builtin_instructions, 1);
} else {
saturating_add_assign!(self.count_non_builtin_instructions, 1);
}

Ok(())
}
}

#[cfg(test)]
mod tests {
use super::*;

#[test]
fn test_process_instruction() {
let mut builtin_instruction_details = BuiltinInstructionDetails::default();
let dummy_ix = CompiledInstruction::new_from_raw_parts(0, vec![], vec![]);

// process all builtin with default costs
for (pubkey, cost) in BUILTIN_INSTRUCTION_COSTS.iter() {
let expected_value = BuiltinInstructionDetails {
sum_builtin_compute_units: builtin_instruction_details.sum_builtin_compute_units
+ *cost as u32,
count_builtin_instructions: builtin_instruction_details.count_builtin_instructions
+ 1,
count_non_builtin_instructions: 0,
};

assert!(builtin_instruction_details
.process_instruction(pubkey, &dummy_ix)
.is_ok());
assert_eq!(builtin_instruction_details, expected_value);
}

// continue process non-builtin instruction
let expected_value = BuiltinInstructionDetails {
sum_builtin_compute_units: builtin_instruction_details.sum_builtin_compute_units,
count_builtin_instructions: builtin_instruction_details.count_builtin_instructions,
count_non_builtin_instructions: builtin_instruction_details
.count_non_builtin_instructions
+ 1,
};

assert!(builtin_instruction_details
.process_instruction(&Pubkey::new_unique(), &dummy_ix)
.is_ok());
assert_eq!(builtin_instruction_details, expected_value);
}
}
Loading

0 comments on commit b0b1b68

Please sign in to comment.