Merge branch 'main' into tt-1806-required-labels

Author: Tofel

.golangci.yaml

@@ -13,7 +13,7 @@ linters:
     - unused
     # extra
     - exhaustive
-    - exportloopref
+    - copyloopvar
     - revive
     - goimports
     - gosec

.tool-versions

@@ -1,8 +1,8 @@
-golang 1.21.9
+golang 1.22.3
 nodejs 18.20.3
 k3d 5.6.3
 act 0.2.52
-golangci-lint 1.57.2
+golangci-lint 1.62.0
 actionlint 1.6.26
 shellcheck 0.9.0
 helm 3.15.2

book/src/SUMMARY.md

@@ -10,6 +10,7 @@
     - [NodeSet with Capabilities](./framework/nodeset_capabilities.md)
     - [NodeSet (Local Docker builds)](./framework/nodeset_docker_rebuild.md)
     - [NodeSet Compat Environment](./framework/nodeset_compatibility.md)
+    - [Fork Testing](./framework/fork.md)
     - [NodeSet with External Blockchain]()
     - [CLI](./framework/cli.md)
     - [Configuration](./framework/configuration.md)

book/src/framework/components/configuration.md

@@ -35,11 +35,10 @@ In `TOML`:
 ```
 [blockchain_a]
 chain_id = "31337"
-docker_cmd_params = ["--block-time=1"]
-image = "f4hrenh9it/foundry"
+image = "f4hrenh9it/foundry:latest"
 port = "8500"
-tag = "latest"
 type = "anvil"
+docker_cmd_params = ["-b", "1"]
 ```
 
 ### Best practices for configuration and validation

book/src/framework/connecting_chainlink_node.md

@@ -9,6 +9,8 @@ Create your configuration in `smoke.toml`
   image = "f4hrenh9it/foundry:latest"
   port = "8545"
   type = "anvil"
+  docker_cmd_params = ["-b", "1"]
+
 
 [cl_node]
 

book/src/framework/first_test.md

@@ -11,6 +11,7 @@ Create your configuration in `smoke.toml`
   image = "f4hrenh9it/foundry:latest"
   port = "8545"
   type = "anvil"
+  docker_cmd_params = ["-b", "1"]
 ```
 
 Create your test in `smoke_test.go`

book/src/framework/fork.md

@@ -0,0 +1,42 @@
+# Fork Testing
+
+We verify our on-chain and off-chain changes using forks of various networks.
+
+Go to example project [dir](https://github.com/smartcontractkit/chainlink-testing-framework/tree/main/framework/examples/myproject) to try the examples yourself.
+
+## On-chain Only
+In this [example](https://github.com/smartcontractkit/chainlink-testing-framework/blob/main/framework/examples/myproject/fork_test.go), we:
+
+- Create two `anvil` networks, each targeting the desired network (change [URLs](https://github.com/smartcontractkit/chainlink-testing-framework/blob/main/framework/examples/myproject/fork.toml) and `anvil` settings as required, see [full anvil](https://book.getfoundry.sh/reference/anvil/) reference).
+- Connect two clients to the respective networks.
+- Deploy two test contracts.
+- Interact with the deployed contracts.
+- Demonstrate interactions using the `anvil` RPC client (more client methods examples are [here](https://github.com/smartcontractkit/chainlink-testing-framework/blob/main/framework/rpc/rpc_test.go))
+
+Run it 
+```
+CTF_CONFIGS=fork.toml go test -v -run TestFork
+```
+
+## On-chain + Off-chain
+
+The chain setup remains the same as in the previous example, but now we have 5 `Chainlink` nodes [connected with 2 networks](https://github.com/smartcontractkit/chainlink-testing-framework/blob/main/framework/examples/myproject/fork_plus_offchain_test.go).
+
+Run it
+```
+CTF_CONFIGS=fork_plus_offchain.toml go test -v -run TestOffChainAndFork
+```
+
+<div class="warning">
+
+Be mindful of RPC rate limits, as your provider may enforce restrictions. Use `docker_cmd_params` field to configure appropriate rate limiting and retries with the following parameters:
+```
+--compute-units-per-second <CUPS>
+--fork-retry-backoff <BACKOFF>
+--retries <retries>
+--timeout <timeout>
+```
+If the network imposes limits, the container will panic, triggering messages indicating that the container health check has failed.
+
+</div>
+

book/src/framework/nodeset_capabilities.md

@@ -21,6 +21,7 @@ Create a configuration file `smoke.toml`
   image = "f4hrenh9it/foundry:latest"
   port = "8545"
   type = "anvil"
+  docker_cmd_params = ["-b", "1"]
 
 [nodeset]
   nodes = 5

book/src/framework/nodeset_compatibility.md

@@ -9,6 +9,7 @@ Create a configuration file `smoke.toml`
   image = "f4hrenh9it/foundry:latest"
   port = "8545"
   type = "anvil"
+  docker_cmd_params = ["-b", "1"]
 
 [nodeset]
   nodes = 5

book/src/framework/nodeset_docker_rebuild.md

@@ -9,6 +9,7 @@ Create a configuration file `smoke.toml`
   image = "f4hrenh9it/foundry:latest"
   port = "8545"
   type = "anvil"
+  docker_cmd_params = ["-b", "1"]
 
 [nodeset]
   nodes = 5