Skip to content

Commit

Permalink
feat: add support for keccak syscall
Browse files Browse the repository at this point in the history
  • Loading branch information
varex83 committed Nov 11, 2024
1 parent 0686747 commit 6040a7c
Show file tree
Hide file tree
Showing 3 changed files with 50 additions and 5 deletions.
47 changes: 44 additions & 3 deletions crates/blockifier/src/execution/native/syscall_handler.rs
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ use crate::execution::secp;
use crate::execution::syscalls::hint_processor::{
SyscallCounter,
SyscallExecutionError,
INVALID_INPUT_LENGTH_ERROR,
OUT_OF_GAS_ERROR,
};
use crate::execution::syscalls::SyscallSelector;
Expand Down Expand Up @@ -105,7 +106,6 @@ impl<'state> NativeSyscallHandler<'state> {

/// Handles all gas-related logics and additional metadata such as `SyscallCounter`. In native,
/// we need to explicitly call this method at the beginning of each syscall.
#[allow(dead_code)]
fn pre_execute_syscall(
&mut self,
remaining_gas: &mut u128,
Expand Down Expand Up @@ -227,8 +227,49 @@ impl<'state> StarknetSyscallHandler for &mut NativeSyscallHandler<'state> {
todo!("Implement send_message_to_l1 syscall.");
}

fn keccak(&mut self, _input: &[u64], _remaining_gas: &mut u128) -> SyscallResult<U256> {
todo!("Implement keccak syscall.");
fn keccak(&mut self, input: &[u64], remaining_gas: &mut u128) -> SyscallResult<U256> {
self.pre_execute_syscall(
remaining_gas,
SyscallSelector::Keccak,
self.context.gas_costs().keccak_gas_cost,
)?;

const KECCAK_FULL_RATE_IN_WORDS: usize = 17;

let input_length = input.len();
let (n_rounds, remainder) = num_integer::div_rem(input_length, KECCAK_FULL_RATE_IN_WORDS);

if remainder != 0 {
// In VM this error is wrapped into `SyscallExecutionError::SyscallError`
return Err(vec![Felt::from_hex(INVALID_INPUT_LENGTH_ERROR).unwrap()]);
}

// TODO(Ori, 1/2/2024): Write an indicative expect message explaining why the conversion
// works.
let n_rounds_as_u128 = u128::try_from(n_rounds).expect("Failed to convert usize to u128.");
let gas_cost =
n_rounds_as_u128 * u128::from(self.context.gas_costs().keccak_round_cost_gas_cost);

if gas_cost > *remaining_gas {
// In VM this error is wrapped into `SyscallExecutionError::SyscallError`
return Err(vec![Felt::from_hex(OUT_OF_GAS_ERROR).unwrap()]);
}
*remaining_gas -= gas_cost;

self.increment_syscall_count_by(&SyscallSelector::Keccak, n_rounds);

let mut state = [0u64; 25];
for chunk in input.chunks(KECCAK_FULL_RATE_IN_WORDS) {
for (i, val) in chunk.iter().enumerate() {
state[i] ^= val;
}
keccak::f1600(&mut state)
}

Ok(U256 {
hi: u128::from(state[2]) | (u128::from(state[3]) << 64),
lo: u128::from(state[0]) | (u128::from(state[1]) << 64),
})
}

fn secp256k1_new(
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,10 @@ use crate::test_utils::initial_test_state::test_state;
use crate::test_utils::{trivial_external_entry_point_new, CairoVersion, BALANCE};

#[test_case(FeatureContract::TestContract(CairoVersion::Cairo1), 254910; "VM")]
#[cfg_attr(
feature = "cairo_native",
test_case(FeatureContract::TestContract(CairoVersion::Native), 265110; "Native")
)]
fn test_keccak(test_contract: FeatureContract, expected_gas: u64) {
let chain_info = &ChainInfo::create_for_testing();
let mut state = test_state(chain_info, BALANCE, &[(test_contract, 1)]);
Expand All @@ -22,7 +26,7 @@ fn test_keccak(test_contract: FeatureContract, expected_gas: u64) {
..trivial_external_entry_point_new(test_contract)
};

assert_eq!(
pretty_assertions::assert_eq!(
entry_point_call.execute_directly(&mut state).unwrap().execution,
CallExecution { gas_consumed: expected_gas, ..CallExecution::from_retdata(retdata![]) }
);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ use crate::test_utils::{trivial_external_entry_point_new, CairoVersion, BALANCE}

#[cfg_attr(
feature = "cairo_native",
test_case(FeatureContract::TestContract(CairoVersion::Native), 674500; "Native")
test_case(FeatureContract::TestContract(CairoVersion::Native), 17046546; "Native")
)]
#[test_case(FeatureContract::TestContract(CairoVersion::Cairo1), 17034156; "VM")]
fn test_secp256k1(test_contract: FeatureContract, expected_gas: u64) {
Expand Down

0 comments on commit 6040a7c

Please sign in to comment.