Merge branch 'main' into test_doc_generation

Author: Tofel

.github/workflows/framework-golden-tests.yml

@@ -10,6 +10,9 @@ jobs:
     env:
       LOKI_TENANT_ID: promtail
       LOKI_URL: http://localhost:3030/loki/api/v1/push
+      # this is not the best practice, and it must be fixed, run your tests WITHOUT IT!
+      # however, on current latest image we must use this flag
+      CTF_IGNORE_CRITICAL_LOGS: true
     runs-on: ubuntu-latest
     permissions:
       id-token: write

.github/workflows/generate-go-docs.yaml

@@ -9,7 +9,7 @@ on:
 
 jobs:
   generate_docs_new_pr:
-    if: ${{ github.event.pull_request.labels && contains(github.event.issue.labels.*.name, 'generate_go_docs') }}
+    if: ${{ contains(github.event.issue.labels.*.name, 'generate_go_docs') }}
     runs-on: ubuntu-latest
 
     steps:
@@ -76,7 +76,7 @@ jobs:
         id: setup-github-token
         uses: smartcontractkit/.github/actions/setup-github-token@9e7cc0779934cae4a9028b8588c9adb64d8ce68c # [email protected]
         with:
-          aws-role-arn: ${{ secrets.AWS_ROLE_ARN_CREATE_PR }}
+          aws-role-arn: ${{ secrets.AWS_ROLE_ARN_READ_GENERATE_GO_DOC_REPO }}
           aws-lambda-url: ${{ secrets.GATI_LAMBDA_TT_URL }}
           aws-region: ${{ secrets.AWS_REGION }}          
 

book/src/SUMMARY.md

@@ -10,8 +10,10 @@
     - [NodeSet with Capabilities](./framework/nodeset_capabilities.md)
     - [NodeSet (Local Docker builds)](./framework/nodeset_docker_rebuild.md)
     - [NodeSet Compat Environment](./framework/nodeset_compatibility.md)
+    - [Creating your own components](./developing/developing_components.md)
     - [Fork Testing](./framework/fork.md)
     - [Quick Contracts Deployment](./framework/quick_deployment.md)
+    - [Verifying Contracts](./framework/verify.md)
     - [NodeSet with External Blockchain]()
     - [CLI](./framework/cli.md)
     - [Configuration](./framework/configuration.md)
@@ -33,8 +35,7 @@
     - [Blockscout](framework/observability/blockscout.md)
     - [Components](framework/components/overview.md)
         - [Blockchains](framework/components/blockchains/overview.md)
-            - [Anvil](framework/components/blockchains/anvil.md)
-            - [Geth]()
+            - [EVM](framework/components/blockchains/evm.md)
             - [Optimism Stack]()
             - [Arbitrum Stack]()
         - [Chainlink](framework/components/chainlink.md)
@@ -83,8 +84,6 @@
 
 ---
 
-- [Developing](developing.md)
-  - [Components](developing/developing_components.md)
 - [Releasing modules](releasing_modules.md)
 
 ---
@@ -93,6 +92,7 @@
     - [Kubernetes](lib/k8s/KUBERNETES.md)
     - [K8s Remote Run](lib/k8s/REMOTE_RUN.md)
     - [K8s Tutorial](lib/k8s/TUTORIAL.md)
+    - [k8s chain.link labels](lib/k8s/labels.md)
     - [Config](lib/config/config.md)
     - [CRIB Connector](lib/crib.md)
 ---

book/src/developing.md

@@ -5,4 +5,4 @@ Here we describe good practices for developing components for our framework.
 Rules for components are simple:
 - Component should declare some `Input` and an optional `Output` (we use that so we can skip or cache any component results)
 - Components should be isolated, they should not return anything except basic types like `int`, `string`, `maps` or `structs`
-- Component **must** have documentation under [Components](./framework/components/overview.md), here is an [example](./framework/components/blockchains/anvil.md)
+- Component **must** have documentation under [Components](./framework/components/overview.md), here is an [example](./framework/components/chainlink/node.md)

book/src/developing/developing_components.md

@@ -47,13 +47,13 @@ Each component can define inputs and outputs, following these rules:
 - If your component is used for side effects output can be omitted.
 - `input.Out.UseCache` should be added if you'd like to use caching, see more [here](caching)
 
-### Docker components good practices for [testcontainers-go](https://golang.testcontainers.org/):
+### Building Local Images
 
-An example [simple component](https://github.com/smartcontractkit/chainlink-testing-framework/blob/main/framework/components/blockchain/anvil.go)
+Use `framework.BuildImage` or `framework.BuildImageOnce` to build the docker image.
 
-An example of [complex component](https://github.com/smartcontractkit/chainlink-testing-framework/blob/main/framework/components/clnode/clnode.go)
+Do not use `testcontainers.NewDockerProvider()` methods, see issues: [#1](https://github.com/testcontainers/testcontainers-go/pull/2482), [#2](https://github.com/testcontainers/testcontainers-go/issues/1484)
 
-An example of [composite component](https://github.com/smartcontractkit/chainlink-testing-framework/blob/main/framework/components/simple_node_set/node_set.go)
+### Docker components good practices for [testcontainers-go](https://golang.testcontainers.org/):
 
 - Inputs should include at least `image`, `tag` and `pull_image` field
 ```golang
@@ -94,3 +94,10 @@ An example of [composite component](https://github.com/smartcontractkit/chainlin
 		HostURL:   fmt.Sprintf("http://%s:%s", host, mp.Port()),
 	}, nil
 ```
+
+An example [simple component](https://github.com/smartcontractkit/chainlink-testing-framework/blob/main/framework/components/blockchain/anvil.go)
+
+An example of [complex component](https://github.com/smartcontractkit/chainlink-testing-framework/blob/main/framework/components/clnode/clnode.go)
+
+An example of [composite component](https://github.com/smartcontractkit/chainlink-testing-framework/blob/main/framework/components/simple_node_set/node_set.go)
+

…ramework/components/blockchains/anvil.md …/framework/components/blockchains/evm.mdbook/src/framework/components/blockchains/anvil.md renamed to book/src/framework/components/blockchains/evm.md book/src/framework/components/blockchains/anvil.md renamed to book/src/framework/components/blockchains/evm.md

@@ -1,27 +1,33 @@
-# Anvil
-[Anvil](https://book.getfoundry.sh/anvil/) is a Foundry local EVM blockchain simulator
+# EVM Blockchain Clients
+
+We support 3 EVM clients at the moment: [Geth](https://geth.ethereum.org/docs/fundamentals/command-line-options), [Anvil](https://book.getfoundry.sh/anvil/) and [Besu](https://besu.hyperledger.org/)
 
 ## Configuration
 ```toml
 [blockchain_a]
-  # Blockchain node type, can be "anvil" or "geth"
+  # Blockchain node type, can be "anvil", "geth" or "besu
   type = "anvil"
   # Chain ID
-  chain_id = "31337"
+  chain_id = "1337"
   # Anvil command line params, ex.: docker_cmd_params = ['--block-time=1', '...']
   docker_cmd_params = []
   # Docker image and tag
   image = "f4hrenh9it/foundry:latest"
-  # External port to expose
+  # External port to expose (HTTP API)
   port = "8545"
+  # External port to expose (WS API)
+  port_ws = "8546"
   # Pulls the image every time if set to 'true', used like that in CI. Can be set to 'false' to speed up local runs
   pull_image = false
 
   # Outputs are the results of deploying a component that can be used by another component
   [blockchain_a.out]
-    chain_id = "31337"
     # If 'use_cache' equals 'true' we skip component setup when we run the test and return the outputs
     use_cache = true
+    # Chain ID
+    chain_id = "1337"
+    # Chain family, "evm", "solana", "cosmos", "op", "arb"
+    family = "evm"
 
     [[blockchain_a.out.nodes]]
       # URLs to access the node(s) inside docker network, used by other components
@@ -58,3 +64,13 @@ func TestDON(t *testing.T) {
 }
 ```
 
+## Test Private Keys
+
+For `Geth` and `Anvil` we use the same key
+```
+Public: 0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266
+Private: ac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80
+```
+
+Test keys for `Besu` can be found [here](https://besu.hyperledger.org/23.4.1/private-networks/reference/accounts-for-testing)
+

book/src/framework/components/chainlink/nodeset.md

@@ -14,7 +14,7 @@ This component requires some Blockchain to be deployed, add this to config
   # Blockchain node type, can be "anvil" or "geth"
   type = "anvil"
   # Chain ID
-  chain_id = "31337"
+  chain_id = "1337"
   # Anvil command line params, ex.: docker_cmd_params = ['--block-time=1', '...']
   docker_cmd_params = []
   # Docker image and tag
@@ -26,7 +26,7 @@ This component requires some Blockchain to be deployed, add this to config
 
   # Outputs are the results of deploying a component that can be used by another component
   [blockchain_a.out]
-    chain_id = "31337"
+    chain_id = "1337"
     # If 'use_cache' equals 'true' we skip component setup when we run the test and return the outputs
     use_cache = true
 

book/src/framework/components/configuration.md

@@ -34,7 +34,7 @@ func TestDON(t *testing.T) {
 In `TOML`:
 ```
 [blockchain_a]
-chain_id = "31337"
+chain_id = "1337"
 image = "f4hrenh9it/foundry:latest"
 port = "8500"
 type = "anvil"

book/src/framework/components/external.md

@@ -12,7 +12,7 @@ For example, to integrate with remote `k8s` environment you can use `CTF_CONFIGS
 [blockchain_a]
 
   [blockchain_a.out]
-    chain_id = "31337"
+    chain_id = "1337"
     use_cache = true
 
     [[blockchain_a.out.nodes]]

book/src/framework/configuration.md

@@ -11,3 +11,5 @@
 |        LOKI_TENANT_ID        |                                                Streams all components logs to `Loki`, see params below                                                 |                 `string` |                     `promtail`                      |    🚫     |
 |       LOKI_BASIC_AUTH        |                                                          Basic auth in format $user:$password                                                          |        `$user:$password` |                          -                          |    🚫     |
 |         RESTY_DEBUG          |                                                            Log all Resty client HTTP calls                                                             |          `true`, `false` |                       `false`                       |    🚫     |
+|   CTF_IGNORE_CRITICAL_LOGS   |                                      Ignore all logs that has CRIT,FATAL or PANIC levels (Chainlink nodes only!)                                       |          `true`, `false` |                       `false`                       |    🚫     |
+|     CTF_CHAINLINK_IMAGE      |                                           Flag to override Chainlink Docker image in format $repository:$tag                                           |         $repository:$tag |                          -                          |    🚫     |