docs

Author: skudasov

book/src/SUMMARY.md

@@ -62,6 +62,7 @@
   - [Performance]()
   - [Chaos](./framework/chaos/chaos.md)
   - [Fork Testing](./framework/fork.md)
+  - [Fork Testing (Mutating Storage)](./framework/fork_storage.md)
 - [Libraries](./libraries.md)
   - [Seth](./libs/seth.md)
   - [WASP](./libs/wasp/overview.md)

framework/evm_storage/README.md

@@ -4,7 +4,7 @@ This code is used in e2e tests where we need to modify production contracts with
 
 See a simple example where we override different types [struct](layout_api_test.go)
 
-Run it with
+Run it with (devbox shell)
 ```
 ./setup.sh
 go test -v -run TestLayoutAPI

framework/evm_storage/forge/.github/workflows/test.yml

@@ -1,4 +1,5 @@
 [profile.default]
+required_version = "0.1.0"
 src = "src"
 out = "out"
 libs = ["lib"]

framework/evm_storage/forge/foundry.toml

@@ -101,17 +101,17 @@ func mapSlot(baseSlot string, key string) string {
 	return "0x" + hex.EncodeToString(hash)
 }
 
+// ShiftHexByOffset is used to set values in slots with offsets
 func ShiftHexByOffset(hexStr string, offset int) string {
-	// Strip "0x"
 	hexStr = strings.TrimPrefix(hexStr, "0x")
-
-	// Parse into big.Int
 	n := new(big.Int)
 	n.SetString(hexStr, 16)
 
+	if offset < 0 {
+		panic("offset must be non-negative")
+	}
 	// Shift left by offset * 8 bits
 	n.Lsh(n, uint(offset*8))
-
 	// Return as 0x-prefixed, 32-byte hex
 	return fmt.Sprintf("0x%064x", n)
 }
@@ -170,8 +170,10 @@ func MustEncodeStorageSlot(solidityType string, value interface{}) string {
 
 // MergeHex merges two hex strings with bitwise "OR"
 // should be used when you see values with offsets in smart contract storage layout.json file
-// example:
 //
+//	Example layout:
+//	╭----------------+-------------------------------------------+------+--------+-------+-------------------------╮
+//	| Name           | Type                                      | Slot | Offset | Bytes | Contract                |
 //	|----------------+-------------------------------------------+------+--------+-------+-------------------------|
 //	| number_uint8   | uint8                                     | 3    | 0      | 1     | src/Counter.sol:Counter |
 //	|----------------+-------------------------------------------+------+--------+-------+-------------------------|

framework/evm_storage/layout.go

@@ -16,15 +16,15 @@ import (
 
 // TestLayoutAPI that's the example of using helpers to override storage in your contracts
 func TestLayoutAPI(t *testing.T) {
-	//t.Skip("this test is for manual debugging and figuring out layout of custom structs")
+	t.Skip("this test is for manual debugging and figuring out layout of custom structs")
 	// load contract layout file, see testdata/layout.json
 	// more docs here - https://docs.soliditylang.org/en/latest/internals/layout_in_storage.html#
 	layout, err := evm_storage.New(layoutFile)
 	if err != nil {
 		t.Fatalf("failed to load layout: %v", err)
 	}
 
-	encodeFunc := func(addr string, index uint8, group uint8) string {
+	encodeCustomStructFunc := func(addr string, index uint8, group uint8) string {
 		// huge structs can be packed differently to save space
 		// cast storage 0x5FbDB2315678afecb367f032d93F642f64180aa3 0x1 --rpc-url http://localhost:8545
 		addrBytes, _ := hex.DecodeString(strings.TrimPrefix(addr, "0x"))
@@ -82,7 +82,7 @@ func TestLayoutAPI(t *testing.T) {
 	}
 	{
 		slot := layout.MustArraySlot("a_signers", 1)
-		data := encodeFunc("0x00000000000000000000000000000000000000a5", 255, 42)
+		data := encodeCustomStructFunc("0x00000000000000000000000000000000000000a5", 255, 42)
 		fmt.Printf("setting slot: %s with data: %s\n", slot, data)
 		r := rpc.New(testRPCURL, nil)
 		err = r.AnvilSetStorageAt([]interface{}{contractAddr, slot, data})
@@ -91,7 +91,7 @@ func TestLayoutAPI(t *testing.T) {
 	}
 	{
 		slot := layout.MustMapSlot("s_signers", "0x00000000000000000000000000000000000000a5")
-		data := encodeFunc("0x00000000000000000000000000000000000000a5", 254, 40)
+		data := encodeCustomStructFunc("0x00000000000000000000000000000000000000a5", 254, 40)
 		fmt.Printf("setting slot: %s with data: %s\n", slot, data)
 		r := rpc.New(testRPCURL, nil)
 		err = r.AnvilSetStorageAt([]interface{}{contractAddr, slot, data})