(chore): Move CRE subfolders into versioned folders (#327)

* Combine CRE keystone & workflow into versioned folders

* Re-add gobindings

* Amend compilation scripts

* Regen wrappers

* add -dev to ShardConfig TypeAndVersion

* cleanup foundry.toml, gen wrappers

* move dev to `latest` instead of versioned folder

* Add viaIR flag for cre v1 coverage check

* Exclude WorklowRegistry v1 from coverage due to known limitations

* Replace no-match-contract with no-match-path

* Fixed GHA yaml issue

* Exclude test folder for v1 in coverage step

* Disable coverage check for cre v1 for now

---------

Co-authored-by: Rens Rooimans <github@rensrooimans.nl>
Co-authored-by: Iva Brajer <iva.brajer@smartcontract.com>

Author: 3 people

.github/workflows/solidity-foundry.yml

@@ -29,14 +29,15 @@ jobs:
           cat <<EOF > matrix.json
           [
             { "name": "automation", "setup": { "run-coverage": false, "min-coverage": 98.5, "run-gas-snapshot": false }},
+            { "name": "dev", "setup": { "run-coverage": true, "extra-coverage-params": "--ir-minimum", "min-coverage": 72.8, "run-gas-snapshot": true, "subfolder": "/cre" }},
+            { "name": "v1", "setup": { "run-coverage": false, "extra-coverage-params": "--ir-minimum --no-match-coverage='(.*v1/test.*)|(.*v2/test.*)'", "min-coverage": 72.8, "run-gas-snapshot": true, "subfolder": "/cre" }},
+            { "name": "v2", "setup": { "run-coverage": true, "extra-coverage-params": "--ir-minimum --no-match-coverage='(.*v1/test.*)|(.*v2/test.*)'", "min-coverage": 93, "run-gas-snapshot": true, "subfolder": "/cre" }},
             { "name": "functions", "setup": { "run-coverage": false, "min-coverage": 98.5, "run-gas-snapshot": true }},
             { "name": "l2ep", "setup": { "run-coverage": true, "min-coverage": 65.0, "run-gas-snapshot": true }},
             { "name": "llo-feeds", "setup": { "run-coverage": true, "min-coverage": 49.3, "run-gas-snapshot": true }},
             { "name": "operatorforwarder", "setup": { "run-coverage": true, "min-coverage": 55.7, "run-gas-snapshot": true }},
             { "name": "shared", "setup": { "run-coverage": true, "extra-coverage-params": "--no-match-path='*CallWithExactGas*' --ir-minimum", "min-coverage": 29, "run-gas-snapshot": true }},
             { "name": "vrf", "setup": { "run-coverage": false, "min-coverage": 98.5, "run-gas-snapshot": false }},
-            { "name": "workflow", "setup": { "run-coverage": true, "extra-coverage-params": "--ir-minimum --no-match-coverage='(.*v1/test.*)|(.*v2/test.*)'", "min-coverage": 93.0, "run-gas-snapshot": true, "subfolder": "/cre" }},
-            { "name": "keystone", "setup": { "run-coverage": true, "min-coverage": 72.8, "run-gas-snapshot": false, "subfolder": "/cre" }},
             { "name": "data-feeds", "setup": { "run-coverage": true, "min-coverage": 98.5, "run-gas-snapshot": true, "extra-coverage-params": "--no-match-coverage='WIP*'" }},
             { "name": "payments", "setup": { "run-coverage": true, "min-coverage": 100, "run-gas-snapshot": true, "extra-coverage-params": "" }}
           ]
@@ -87,8 +88,8 @@ jobs:
               - 'contracts/src/v0.8/automation/**/*.sol'
             functions:
               - 'contracts/src/v0.8/functions/**/*.sol'
-            keystone:
-              - 'contracts/cre/src/keystone/**/*.sol'
+            cre:
+              - 'contracts/cre/src/**/*.sol'
             l2ep:
               - 'contracts/src/v0.8/l2ep/**/*.sol'
             llo-feeds:
@@ -100,8 +101,6 @@ jobs:
             shared:
               - 'contracts/src/v0.8/shared/**/*.sol'
               - 'contracts/src/v0.8/vendor/**/*.sol'
-            workflow:
-              - 'contracts/cre/src/workflow/**/*.sol'
             data-feeds:
               - 'contracts/src/v0.8/data-feeds/**/*.sol'
 
@@ -124,6 +123,8 @@ jobs:
               - '!contracts/src/v0.8/**/testhelpers/**'
               - '!contracts/src/v0.8/testhelpers/**'
               - '!contracts/src/v0.8/vendor/**'
+              - '!contracts/cre/src/**/test/**'
+              - '!contracts/cre/src/**/mocks/**'
 
   tests:
     if: ${{ needs.changes.outputs.non_src_changes == 'true' || needs.changes.outputs.sol_modified_added == 'true' }}
@@ -132,7 +133,7 @@ jobs:
       matrix:
         product: ${{fromJson(needs.define-matrix.outputs.matrix)}}
     needs: [define-matrix, changes]
-    name: Foundry Tests ${{ matrix.product.name }}
+    name: Foundry Tests ${{ matrix.product.setup.subfolder || '' }} ${{ matrix.product.name }}
     runs-on: ubuntu-22.04
 
     # The if statements for steps after checkout repo is workaround for

contracts/cre/.solhintignore-test

@@ -1,4 +1,2 @@
-src/keystone/
-
 node_modules/
 

contracts/cre/GNUmakefile

@@ -1,6 +1,6 @@
 # ALL_FOUNDRY_PRODUCTS contains a list of all products that have a foundry
 # profile defined and use the Foundry snapshots.
-ALL_FOUNDRY_PRODUCTS = keystone workflow
+ALL_FOUNDRY_PRODUCTS = dev v1 v2 
 
 # To make a snapshot for a specific product, either set the `FOUNDRY_PROFILE` env var
 # or call the target with `FOUNDRY_PROFILE=product`

contracts/cre/foundry.toml

@@ -1,12 +1,7 @@
 [profile.default]
-auto_detect_solc = true
-optimizer = true
-optimizer_runs = 1_000_000
 evm_version = 'paris'
+optimizer = true
 via_ir = true
-
-src = 'src/'
-test = 'test/'
 out = 'foundry-artifacts'
 cache_path = 'foundry-cache'
 libs = ['node_modules']
@@ -19,43 +14,32 @@ gas_price = 1
 block_timestamp = 1234567890
 block_number = 12345
 
-[fmt]
-tab_width = 2
-multiline_func_header = "params_first"
-sort_imports = true
-single_line_statement_blocks = "preserve"
-ignore = ["src/v0.8/vendor/**/*.sol"]
-number_underscore = "thousands"
-wrap_comments = true
-
-[profile.workflow]
-src = 'src/workflow'
-
-[profile.workflow-v1]
+[profile.v1]
 optimizer_runs = 1_000_000
 solc_version = '0.8.24'
-src = 'src/workflow/v1'
-test = 'src/workflow/v1/test'
+src = 'src/v1'
+test = 'src/v1/test'
 
-[profile.workflow-v2]
+[profile.v2]
 optimizer_runs = 1_000
 solc_version = '0.8.26'
-src = 'src/workflow/v2'
-test = 'src/workflow/v2/test'
+src = 'src/v2'
+test = 'src/v2/test'
 
-[profile.keystone]
+[profile.dev]
 optimizer_runs = 1_000_000
 solc_version = '0.8.24'
-src = 'src/keystone'
-test = 'src/keystone/test'
+src = 'src/dev'
+test = 'src/dev/test'
 via_ir = false
 
-[profile.shardconfig]
-optimizer_runs = 1_000_000
-solc_version = '0.8.24'
-src = 'src/shardconfig'
-test = 'src/shardconfig/test'
-via_ir = false
+[fmt]
+tab_width = 2
+multiline_func_header = "params_first"
+sort_imports = true
+single_line_statement_blocks = "preserve"
+number_underscore = "thousands"
+wrap_comments = true
 
 # See more config options https://github.com/foundry-rs/foundry/tree/master/config
 

contracts/cre/gas-snapshots/dev.gas-snapshot

@@ -0,0 +1,22 @@
+MessageEmitter_BasicTest:test_EmitMessage_EmitsEventAndUpdatesLastMessage() (gas: 66399)
+MessageEmitter_BasicTest:test_EmitMessage_MultipleAddressesSameBlock() (gas: 117924)
+MessageEmitter_BasicTest:test_EmitMessage_SucceedsInNextBlock() (gas: 90723)
+MessageEmitter_BasicTest:test_GetMessage_Succeeds_WhenExists() (gas: 62952)
+MessageEmitter_BasicTest:test_TypeAndVersion() (gas: 9616)
+MockKeystoneForwarder_BasicTest:test_GetTransmissionId_MatchesManual() (gas: 9375)
+MockKeystoneForwarder_BasicTest:test_GetTransmissionInfo_NotAttempted_And_GetTransmitter_Zero() (gas: 19659)
+MockKeystoneForwarder_BasicTest:test_IsForwarder_SelfTrue_AddRemove() (gas: 32448)
+MockKeystoneForwarder_BasicTest:test_Route_Direct_Failure() (gas: 48805)
+MockKeystoneForwarder_BasicTest:test_Route_Direct_Success() (gas: 51514)
+MockKeystoneForwarder_BasicTest:test_TypeAndVersion() (gas: 9731)
+ReserveManagerTest:testOnReportUpdatesStateAndEmitsEvent() (gas: 81553)
+ReserveManagerTest:testSupportsInterface() (gas: 12071)
+ShardConfigTest:testConstructor_RevertZeroShardCount() (gas: 58081)
+ShardConfigTest:testConstructor_Success() (gas: 13715)
+ShardConfigTest:testGetDesiredShardCount() (gas: 10390)
+ShardConfigTest:testOwnershipTransfer() (gas: 29818)
+ShardConfigTest:testSetDesiredShardCount_EmitsEvent() (gas: 17833)
+ShardConfigTest:testSetDesiredShardCount_RevertNotOwner() (gas: 10795)
+ShardConfigTest:testSetDesiredShardCount_RevertZeroCount() (gas: 10648)
+ShardConfigTest:testSetDesiredShardCount_Success() (gas: 18700)
+ShardConfigTest:testTypeAndVersion() (gas: 9705)