Move elect docs to the cairo doc, merge into one file

foundry-rs · Apr 16, 2024 · c312abc · c312abc
1 parent 8f1a274
commit c312abc
Show file tree

Hide file tree

Showing 8 changed files with 35 additions and 91 deletions.
diff --git a/docs/src/SUMMARY.md b/docs/src/SUMMARY.md
@@ -51,10 +51,7 @@
  * [block_timestamp](appendix/cheatcodes/block_timestamp.md)
  * [mock_call](appendix/cheatcodes/mock_call.md)
  * [tx_info](appendix/cheatcodes/tx_info.md)
- * [sequencer_address](appendix/cheatcodes/sequencer_address/README.md)
- * [elect](appendix/cheatcodes/sequencer_address/elect.md)
- * [start_elect](appendix/cheatcodes/sequencer_address/start_elect.md)
- * [stop_elect](appendix/cheatcodes/sequencer_address/stop_elect.md)
+ * [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)

diff --git a/docs/src/appendix/cheatcodes.md b/docs/src/appendix/cheatcodes.md
@@ -11,9 +11,9 @@
 - [`warp`](cheatcodes/block_timestamp#warp) - changes the block timestamp for contracts, for a number of calls
 - [`start_warp`](cheatcodes/block_timestamp#start_warp) - changes the block timestamp for contracts
 - [`stop_warp`](cheatcodes/block_timestamp#stop_warp) - cancels the `warp` / `start_warp` for contracts
-- [`elect`](cheatcodes/sequencer_address/elect.md) - changes the sequencer address for contracts, for a number of calls
-- [`start_elect`](cheatcodes/sequencer_address/start_elect.md) - changes the sequencer address for contracts
-- [`stop_elect`](cheatcodes/sequencer_address/stop_elect.md) - cancels the `elect` / `start_elect` for contracts
+- [`elect`](cheatcodes/sequencer_address#elect) - changes the sequencer address for contracts, for a number of calls
+- [`start_elect`](cheatcodes/sequencer_address#start_elect) - changes the sequencer address for contracts
+- [`stop_elect`](cheatcodes/sequencer_address#stop_elect) - cancels the `elect` / `start_elect` for contracts
 - [`spoof`](cheatcodes/tx_info#spoof) - changes the transaction context for contracts, for a number of calls
 - [`start_spoof`](cheatcodes/tx_info#start_spoof) - changes the transaction context for contracts
 - [`stop_spoof`](cheatcodes/tx_info#stop_spoof) - cancels the `spoof` / `start_spoof` for contracts

diff --git a/docs/src/appendix/cheatcodes/sequencer_address.md b/docs/src/appendix/cheatcodes/sequencer_address.md
@@ -0,0 +1,21 @@
+# `sequencer_address`
+
+Cheatcodes modifying `sequencer_address`:
+
+## `elect`
+
+> `fn elect(target: CheatTarget, sequencer_address: ContractAddress, span: CheatSpan)`
+
+Changes the sequencer address for the given target and span.
+
+## `start_elect`
+
+> `fn start_elect(target: CheatTarget, sequencer_address: ContractAddress)`
+
+Changes the sequencer address for a given target.
+
+## `stop_elect`
+
+> `fn stop_elect(target: CheatTarget)`
+
+Cancels the `elect` / `start_elect` for the given target.
diff --git a/docs/src/appendix/cheatcodes/sequencer_address/README.md b/docs/src/appendix/cheatcodes/sequencer_address/README.md
diff --git a/docs/src/appendix/cheatcodes/sequencer_address/elect.md b/docs/src/appendix/cheatcodes/sequencer_address/elect.md
diff --git a/docs/src/appendix/cheatcodes/sequencer_address/start_elect.md b/docs/src/appendix/cheatcodes/sequencer_address/start_elect.md
diff --git a/docs/src/appendix/cheatcodes/sequencer_address/stop_elect.md b/docs/src/appendix/cheatcodes/sequencer_address/stop_elect.md
diff --git a/snforge_std/src/cheatcodes.cairo b/snforge_std/src/cheatcodes.cairo
@@ -119,6 +119,10 @@ fn stop_warp(target: CheatTarget) {
  handle_cheatcode(cheatcode::<'stop_warp'>(inputs.span()));
 }
 
+/// Changes the sequencer address for the given target and span.
+/// `target` - instance of `CheatTarget` specifying which contracts to elect
+/// `sequencer_address` - sequencer address to be set
+/// `span` - instance of `CheatSpan` specifying the number of target calls with the cheat applied
 fn elect(target: CheatTarget, sequencer_address: ContractAddress, span: CheatSpan) {
  validate_cheat_target_and_span(@target, @span);
 
@@ -129,10 +133,16 @@ fn elect(target: CheatTarget, sequencer_address: ContractAddress, span: CheatSpa
  handle_cheatcode(cheatcode::<'elect'>(inputs.span()));
 }
 
+/// Changes the sequencer address for a given target.
+/// - `target` - instance of `CheatTarget` specifying which contracts to elect
+/// - `sequencer_address` - sequencer address to be set
 fn start_elect(target: CheatTarget, sequencer_address: ContractAddress) {
  elect(target, sequencer_address, CheatSpan::Indefinite);
 }
 
+
+/// Cancels the `elect` / `start_elect` for the given target.
+/// - `target` - instance of `CheatTarget` specifying which contracts to stop electing
 fn stop_elect(target: CheatTarget) {
  let mut inputs = array![];
  target.serialize(ref inputs);