L1handler refactor

CHANGELOG.md

@@ -13,11 +13,17 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - New required flag `--type` to `account add` command
 
+### Forge
+
+#### Changed
+
+- `L1HandlerTrait::execute()` takes source address and payloads as arguments [Read more here](https://foundry-rs.github.io/starknet-foundry/appendix/cheatcodes/l1_handler.html)
+
+
 ## [0.23.0] - 2024-05-08
 
 ### Forge
 
-
 #### Removed
 - `event_name_hash` removal, in favour of `selector!` usage
 

crates/forge/tests/data/trace_resources/tests/test_l1_handler.cairo

@@ -15,8 +15,5 @@ fn test_l1_handler() {
 
  let mut l1_handler = L1HandlerTrait::new(checker_address, selector!("handle_l1_message"));
 
- l1_handler.from_address = 123;
- l1_handler.payload = array![proxy_address.into(), empty_hash.into(), 2].span();
-
- l1_handler.execute().unwrap();
+ l1_handler.execute(123, array![proxy_address.into(), empty_hash.into(), 2].span()).unwrap();
 }

crates/forge/tests/integration/gas.rs

@@ -675,10 +675,7 @@ fn l1_handler_cost() {
 
  let mut l1_handler = L1HandlerTrait::new(contract_address, selector!("handle_l1_message"));
 
- l1_handler.from_address = 123;
- l1_handler.payload = array![].span();
-
- l1_handler.execute().unwrap();
+ l1_handler.execute(123, array![].span()).unwrap();
  }
  "#
  ),

crates/forge/tests/integration/l1_handler_executor.rs

@@ -25,6 +25,7 @@ fn l1_handler_execute() {
  use array::{ArrayTrait, SpanTrait};
  use core::result::ResultTrait;
  use snforge_std::{declare, ContractClassTrait, L1Handler, L1HandlerTrait};
+ use snforge_std::errors::{ SyscallResultStringErrorTrait, PanicDataOrString };
 
  #[test]
  fn l1_handler_execute() {
@@ -46,10 +47,7 @@ fn l1_handler_execute() {
  selector!("process_l1_message")
  );
 
- l1_handler.from_address = 0x123;
- l1_handler.payload = payload.span();
-
- l1_handler.execute().unwrap();
+ l1_handler.execute(0x123, payload.span()).unwrap();
 
  let dispatcher = IBalanceTokenDispatcher { contract_address };
  assert(dispatcher.get_balance() == 42, dispatcher.get_balance());
@@ -69,16 +67,35 @@ fn l1_handler_execute() {
  selector!("panicking_l1_handler")
  );
 
- l1_handler.from_address = 0x123;
- l1_handler.payload = array![].span();
- match l1_handler.execute() {
+ match l1_handler.execute(0x123, array![].span()) {
  Result::Ok(_) => panic_with_felt252('should have panicked'),
  Result::Err(panic_data) => {
  assert(*panic_data.at(0) == 'custom', 'Wrong 1st panic datum');
  assert(*panic_data.at(1) == 'panic', 'Wrong 2nd panic datum');
  },
  }
  }
+
+ #[test]
+ fn l1_handler_function_missing() {
+ let calldata = array![0x123];
+
+ let contract = declare("l1_handler_executor").unwrap();
+ let (contract_address, _) = contract.deploy(@calldata).unwrap();
+
+
+ let mut l1_handler = L1HandlerTrait::new(
+ contract_address,
+ selector!("this_does_not_exist")
+ );
+
+ match l1_handler.execute(0x123, array![].span()){
+ Result::Ok(_) => panic_with_felt252('should have panicked'),
+ Result::Err(_) => {
+ // Would be nice to assert the error here once it is be possible in cairo
+ },
+ }
+ }
  "#
  ),
  Contract::from_code_path(

crates/forge/tests/integration/trace.rs

@@ -896,10 +896,7 @@ fn trace_l1_handler() {
 
  let mut l1_handler = L1HandlerTrait::new(checker_address, selector!("handle_l1_message"));
 
- l1_handler.from_address = 123;
- l1_handler.payload = array![proxy_address.into()].span();
-
- l1_handler.execute().unwrap();
+ l1_handler.execute(123, array![proxy_address.into()].span()).unwrap();
  assert_trace(get_call_trace(), proxy_address, checker_address);
  }
 

docs/src/SUMMARY.md

@@ -66,7 +66,7 @@
  * [sequencer_address](appendix/cheatcodes/sequencer_address.md)
  * [get_class_hash](appendix/cheatcodes/get_class_hash.md)
  * [replace_bytecode](appendix/cheatcodes/replace_bytecode.md)
- * [l1_handler_execute](appendix/cheatcodes/l1_handler_execute.md)
+ * [l1_handler](appendix/cheatcodes/l1_handler.md)
  * [spy_events](appendix/cheatcodes/spy_events.md)
  * [store](appendix/cheatcodes/store.md)
  * [load](appendix/cheatcodes/load.md)

docs/src/appendix/cheatcodes.md

@@ -22,7 +22,7 @@
 - [`stop_mock_call`](cheatcodes/mock_call.md#stop_mock_call) - cancels the `mock_call` / `start_mock_call` for an entry point
 - [`get_class_hash`](cheatcodes/get_class_hash.md) - retrieves a class hash of a contract
 - [`replace_bytecode`](cheatcodes/replace_bytecode.md) - replace the class hash of a contract
-- [`l1_handler_execute`](cheatcodes/l1_handler_execute.md) - executes a `#[l1_handler]` function to mock a message arriving from Ethereum
+- [`l1_handler`](cheatcodes/l1_handler.md) - executes a `#[l1_handler]` function to mock a message arriving from Ethereum
 - [`spy_events`](cheatcodes/spy_events.md) - creates `EventSpy` instance which spies on events emitted by contracts
 - [`store`](cheatcodes/store.md) - stores values in targeted contact's storage
 - [`load`](cheatcodes/load.md) - loads values directly from targeted contact's storage

docs/src/appendix/cheatcodes/block_number.md

@@ -15,4 +15,4 @@ Changes the block number for the given target.
 # `stop_roll`
 > `fn stop_roll(target: CheatTarget)`
 
-Cancels the `roll` / `start_roll` for the given target.
+Cancels the `roll` / `start_roll` for the given target.

docs/src/appendix/cheatcodes/l1_handler.md

@@ -0,0 +1,7 @@
+# `l1_handler`
+
+> `fn new(target: ContractAddress, selector: felt252) -> L1Handler`
+Returns a structure referring to a L1 handler function.
+
+> `fn execute(self: L1Handler) -> SyscallResult<()>`
+Mocks a L1 -> L2 message from Ethereum handled by the given L1 handler function.

snforge_std/src/cheatcodes/l1_handler.cairo

@@ -5,29 +5,37 @@ use super::super::_cheatcode::handle_cheatcode;
 
 #[derive(Drop, Clone)]
 struct L1Handler {
- contract_address: ContractAddress,
- function_selector: felt252,
- from_address: felt252,
- payload: Span::<felt252>,
+ target: ContractAddress,
+ selector: felt252,
 }
 
 trait L1HandlerTrait {
- fn new(contract_address: ContractAddress, function_selector: felt252) -> L1Handler;
- fn execute(self: L1Handler) -> SyscallResult<()>;
+ fn new(target: ContractAddress, selector: felt252) -> L1Handler;
+ fn execute(
+ self: L1Handler, from_address: felt252, payload: Span::<felt252>
+ ) -> SyscallResult<()>;
 }
 
 impl L1HandlerImpl of L1HandlerTrait {
- fn new(contract_address: ContractAddress, function_selector: felt252) -> L1Handler {
- L1Handler {
- contract_address, function_selector, from_address: 0, payload: array![].span(),
- }
+ /// `target` - The target starknet contract address
+ /// `selector` - Selector of a `#[l1_handler]` function. Can be acquired with `selector!("function_handler_name")` macro
+ /// Returns a structure referring to a L1 handler function
+ fn new(target: ContractAddress, selector: felt252) -> L1Handler {
+ L1Handler { target, selector, }
  }
 
- fn execute(self: L1Handler) -> SyscallResult<()> {
+ /// Mocks L1 -> L2 message from Ethereum handled by the given L1 handler function
+ /// `self` - `L1Handler` structure referring to a L1 handler function
+ /// `from_address` - Ethereum address of the contract that you want to be the message sender
+ /// `payload` - The handlers' function arguments serialized with `Serde`
+ /// Returns () or panic data if it failed
+ fn execute(
+ self: L1Handler, from_address: felt252, payload: Span::<felt252>
+ ) -> SyscallResult<()> {
  let mut inputs: Array::<felt252> = array![
- self.contract_address.into(), self.function_selector, self.from_address,
+ self.target.into(), self.selector, from_address.into(),
  ];
- self.payload.serialize(ref inputs);
+ payload.serialize(ref inputs);
 
  let mut outputs = handle_cheatcode(cheatcode::<'l1_handler_execute'>(inputs.span()));
  let exit_code = *outputs.pop_front().unwrap();