feat(docs): cheatcode docs by rahul-kothari · Pull Request #1585 · AztecProtocol/aztec-packages

rahul-kothari · 2023-08-16T11:31:26Z

LHerskind

Nits and grits

docs/docs/dev_docs/testing/cheat_codes.md

LHerskind · 2023-08-16T13:49:13Z

docs/docs/dev_docs/testing/cheat_codes.md

+
+## Introduction
+
+Most of the time, simply testing your smart contract isn't enough. To manipulate the state of the Aztec blockchain, as well as test for specific reverts and events, the sandbox is shipped with a set of cheatcodes.


The start is a little weird. It is mainly to help you in the testing that we want to provide a bit of cheat-codes.

When mentioning specific reverts and such, we should probably have examples with that 👀 .

docs/docs/dev_docs/testing/cheat_codes.md

LHerskind · 2023-08-16T13:57:21Z

docs/docs/dev_docs/testing/cheat_codes.md

+const value = await cc.l2.loadPublic(contract, 1n) // current_value is stored in slot 1
+```
+
+### computeSlotInMap


Think it would be neat to flip the ordering of computeSlotInMap and loadPublic, mainly as we could then very easily show using the computed slot for reading balances or similar. Just to carve it in neon what people can use it for etc.

Separately, the example is made with private storage, which you cannot access from cheatcodes etc. Think using public storage would be better, and then it can be bundled with the loadPublic as mentioned.

docs/docs/dev_docs/testing/cheat_codes.md

Maddiaa0

temp review before pushing changes

Maddiaa0 · 2023-08-17T10:41:33Z

docs/docs/dev_docs/testing/cheat_codes.md

+
+Most of the time, simply testing your smart contract isn't enough. To manipulate the state of the Aztec blockchain, as well as test for specific reverts and events, the sandbox is shipped with a set of cheatcodes.
+
+Cheatcodes allow you to change the time of the L2 block, load certain state or more easily manipulate L1 instead of having to write dedicated RPC calls to anvil. 


This has just made me think, should we make the cheat codes agnostic of hardhat / anvil

hmm aztec uses anvil within the sandbox though

Think anvil will also accept the hardhat naming and is just used as aliases, so if we use the hardhat ones, it might cover both more easily.

docs/docs/dev_docs/testing/cheat_codes.md

In case we like the `.eth` and `.aztec` variation over `.l1` and `.l2` in cheatcodes! This would get merged into my docs pr #1585

Maddiaa0 · 2023-08-18T10:36:01Z

docs/docs/dev_docs/testing/cheat_codes.md

+
+#### Description
+Sets the timestamp (unix format in seconds) for the next mined block on Ethereum.
+Remember that timestamp can only be set in the future and not in the past.


nit its probably worth being explicit about the erroring

Probably related to: #1585 (comment)

docs/docs/dev_docs/testing/cheat_codes.md

Maddiaa0 · 2023-08-18T10:41:19Z

docs/docs/dev_docs/testing/cheat_codes.md

+- @aztec/aztec.js
+
+### Initialisation
+```js


should get better highlighting using `ts rather than js

Maddiaa0 · 2023-08-18T10:42:11Z

docs/docs/dev_docs/testing/cheat_codes.md

+These are cheatcodes exposed from anvil/hardhat conveniently wrapped for ease of use in the Sandbox.
+
+### Interface
+```


annotate `ts

Maddiaa0 · 2023-08-18T10:42:28Z

docs/docs/dev_docs/testing/cheat_codes.md

+These are cheatcodes specific to manipulating the state of Aztec rollup.
+
+### Interface
+```


annotate ts

Maddiaa0 · 2023-08-18T10:42:41Z

docs/docs/dev_docs/testing/cheat_codes.md

+
+#### Example  
+```
+/// struct Storage {


noir snippets can be annotated rust for better results

Maddiaa0

Overall great content, however noir snippets can be annotated with rust, the ones currently js should be ts to get better highlighting and solidity ones can be separated rather than inline commented and annotated with solidity

Maddiaa0 · 2023-08-18T10:47:16Z

docs/docs/dev_docs/testing/cheat_codes.md

+```
+/// contract LeetContract {
+///     uint256 private leet = 1337; // slot 0
+/// }
+
+const leetContractAddress = EthAddress.fromString('0x1234...');
+await cc.eth.store(leetContractAddress, BigInt(0), BigInt(1000));
+const value = await cc.eth.load(leetContractAddress, BigInt(0));
+console.log(value); // 1000
+```


contract LeetContract { uint256 private leet = 1337; // slot 0 }

const leetContractAddress = EthAddress.fromString('0x1234...'); await cc.eth.store(leetContractAddress, BigInt(0), BigInt(1000)); const value = await cc.eth.load(leetContractAddress, BigInt(0)); console.log(value); // 1000

Solidity blocks can be annotated with solidity, they arent perfect in docusaurus but it does offer some highlighting.

In case we like the `.eth` and `.aztec` variation over `.l1` and `.l2` in cheatcodes! This would get merged into my docs pr #1585

Maddiaa0 · 2023-08-18T11:25:32Z

docs/docs/dev_docs/testing/cheat_codes.md

+#### Example  
+```rust
+struct Storage {
+    // highlight-next-line:PublicState


is this still required

Maddiaa0 · 2023-08-18T11:27:57Z

docs/docs/dev_docs/testing/cheat_codes.md

+#### Description
+Loads the value stored at the given slot in the public storage of the given contract. 
+
+Note: One Field element occupies a storage slot. So structs with multiple field elements won't fit in a single slot. So using loadPublic would only load a part of the struct (depending on the size of the attributes within it).


Suggested change

Note: One Field element occupies a storage slot. So structs with multiple field elements won't fit in a single slot. So using loadPublic would only load a part of the struct (depending on the size of the attributes within it).

Note: One Field element occupies a storage slot. Hence, structs with multiple field elements will be spread over multiple slots, rather they will be spread over multiple sequential slots. Using loadPublic will only load a single field of the struct (depending on the size of the attributes within it).

Id reword this slightly

Maddiaa0 · 2023-08-18T11:28:12Z

docs/docs/dev_docs/testing/cheat_codes.md

+
+Keep up with the latest discussion and join the conversation in the [Aztec forum](https://discourse.aztec.network).
+
+You can also use the above link to request for more cheatcodes.


Suggested change

You can also use the above link to request for more cheatcodes.

You can also use the above link to request more cheatcodes.

Maddiaa0 · 2023-08-18T11:30:05Z

docs/docs/dev_docs/testing/cheat_codes.md

+#### Description
+Dumps the current Ethereum chain state to a file.
+Stores a hex string representing the complete state of the chain in a file with the provided path. Can be re-imported into a fresh/restarted instance of Anvil to reattain the same state.
+When combined with `loadChainState()` cheatcode, it can be let you easily import the current state of mainnet into the Anvil instance of the sandbox, to use Uniswap for example.


The uniswap example here is really specific to our testing case and probably confusing without context. Lets drop it, people looking for this feature likely have in mind a specific use case

Co-authored-by: Lasse Herskind <16536249+LHerskind@users.noreply.github.com>

In case we like the `.eth` and `.aztec` variation over `.l1` and `.l2` in cheatcodes! This would get merged into my docs pr #1585

LHerskind · 2023-08-18T11:40:58Z

docs/docs/dev_docs/testing/cheat_codes.md

+#### Description
+Dumps the current Ethereum chain state to a file.
+Stores a hex string representing the complete state of the chain in a file with the provided path. Can be re-imported into a fresh/restarted instance of Anvil to reattain the same state.
+When combined with `loadChainState()` cheatcode, it can be let you easily import the current state of mainnet into the Anvil instance of the sandbox.


The wording is a little weird here, it can be let you and it might not be the current state. Maybe fine to point to the other cheatcode and say use in combination.

Suggested change

When combined with `loadChainState()` cheatcode, it can be let you easily import the current state of mainnet into the Anvil instance of the sandbox.

To be used in combination with `loadChainState()`

rahul-kothari requested review from LHerskind, Maddiaa0 and iAmMichaelConnor August 16, 2023 11:31

LHerskind reviewed Aug 16, 2023

View reviewed changes

rahul-kothari force-pushed the rk/cc_docs branch from cfd6998 to 5078689 Compare August 17, 2023 10:35

Maddiaa0 reviewed Aug 17, 2023

View reviewed changes

rahul-kothari requested review from LHerskind and Maddiaa0 August 17, 2023 15:27

rahul-kothari force-pushed the rk/cc_docs branch from 4cb3ebf to 32cdeb8 Compare August 17, 2023 15:39

rahul-kothari mentioned this pull request Aug 17, 2023

use .eth and .aztec instead of .l1 and .l2 #1611

Merged

rahul-kothari added a commit that referenced this pull request Aug 18, 2023

use .eth and .aztec instead of .l1 and .l2 (#1611)

97b49ea

In case we like the `.eth` and `.aztec` variation over `.l1` and `.l2` in cheatcodes! This would get merged into my docs pr #1585

rahul-kothari added a commit that referenced this pull request Aug 18, 2023

use .eth and .aztec instead of .l1 and .l2 (#1611)

c4baf0c

In case we like the `.eth` and `.aztec` variation over `.l1` and `.l2` in cheatcodes! This would get merged into my docs pr #1585

rahul-kothari force-pushed the rk/cc_docs branch from 97b49ea to d75435a Compare August 18, 2023 10:29

Maddiaa0 requested changes Aug 18, 2023

View reviewed changes

Maddiaa0 reviewed Aug 18, 2023

View reviewed changes

rahul-kothari added a commit that referenced this pull request Aug 18, 2023

use .eth and .aztec instead of .l1 and .l2 (#1611)

7453873

In case we like the `.eth` and `.aztec` variation over `.l1` and `.l2` in cheatcodes! This would get merged into my docs pr #1585

rahul-kothari force-pushed the rk/cc_docs branch from d75435a to d429f42 Compare August 18, 2023 11:07

rahul-kothari requested a review from Maddiaa0 August 18, 2023 11:10

Maddiaa0 changed the title ~~add cheatcode docs~~ feat(docs): cheatcode docs Aug 18, 2023

Maddiaa0 reviewed Aug 18, 2023

View reviewed changes

Maddiaa0 approved these changes Aug 18, 2023

View reviewed changes

rahul-kothari enabled auto-merge (squash) August 18, 2023 11:35

rahul-kothari disabled auto-merge August 18, 2023 11:36

rahul-kothari and others added 7 commits August 18, 2023 11:37

add cheatcode docs

bda3737

Apply suggestions from code review

52ef038

Co-authored-by: Lasse Herskind <16536249+LHerskind@users.noreply.github.com>

prank->impersonate, add throw tests, respond to PR comments

d75aaec

use .eth and .aztec instead of .l1 and .l2 (#1611)

a349f75

In case we like the `.eth` and `.aztec` variation over `.l1` and `.l2` in cheatcodes! This would get merged into my docs pr #1585

use hardhat_*

95c08b1

use better syntax highlighting

4402dd6

explicit error

83a09b3

rahul-kothari added 2 commits August 18, 2023 11:37

address sean's nits

298532c

improve struct slot wording

89c3d8e

rahul-kothari force-pushed the rk/cc_docs branch from 3be10c8 to 89c3d8e Compare August 18, 2023 11:37

rahul-kothari enabled auto-merge (squash) August 18, 2023 11:38

LHerskind reviewed Aug 18, 2023

View reviewed changes

rahul-kothari merged commit b1a2f8f into master Aug 18, 2023

rahul-kothari deleted the rk/cc_docs branch August 18, 2023 11:47


		## Introduction

		Most of the time, simply testing your smart contract isn't enough. To manipulate the state of the Aztec blockchain, as well as test for specific reverts and events, the sandbox is shipped with a set of cheatcodes.


		Most of the time, simply testing your smart contract isn't enough. To manipulate the state of the Aztec blockchain, as well as test for specific reverts and events, the sandbox is shipped with a set of cheatcodes.

		Cheatcodes allow you to change the time of the L2 block, load certain state or more easily manipulate L1 instead of having to write dedicated RPC calls to anvil.

	Note: One Field element occupies a storage slot. So structs with multiple field elements won't fit in a single slot. So using loadPublic would only load a part of the struct (depending on the size of the attributes within it).
	Note: One Field element occupies a storage slot. Hence, structs with multiple field elements will be spread over multiple slots, rather they will be spread over multiple sequential slots. Using loadPublic will only load a single field of the struct (depending on the size of the attributes within it).


		Keep up with the latest discussion and join the conversation in the [Aztec forum](https://discourse.aztec.network).

		You can also use the above link to request for more cheatcodes.

	When combined with `loadChainState()` cheatcode, it can be let you easily import the current state of mainnet into the Anvil instance of the sandbox.
	To be used in combination with `loadChainState()`

Conversation

rahul-kothari commented Aug 16, 2023

Uh oh!

LHerskind left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Maddiaa0 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Maddiaa0 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants