feat: replace deployer allowlist hardhat tests with simulated backend (#1845)

Signed-off-by: Jonathan Oppenheimer <[email protected]>
Signed-off-by: Jonathan Oppenheimer <[email protected]>
Signed-off-by: Ceyhun Onur <[email protected]>
Co-authored-by: Jonathan Oppenheimer <[email protected]>
Co-authored-by: Austin Larson <[email protected]>

Author: 3 people

.github/workflows/ci.yml

@@ -22,6 +22,11 @@ jobs:
           cache-dependency-path: |
             go.sum
             tools/go.sum
+            tools/legacy-golangci-lint.sum
+      - name: Set up solc
+        uses: ARR4N/[email protected]
+        with:
+          versions: '0.8.30'
       - name: Run all lint checks
         run: ./scripts/run_task.sh lint-all-ci
       - name: Check go.mod and go.sum are up-to-date

.gitignore

@@ -64,3 +64,6 @@ avalanchego/
 
 # Contract compilation artifacts (binary files are not committed)
 contracts/artifacts/
+
+# solc downloads from setup-solc GitHub Action
+setup-solc_downloads/

Taskfile.yml

@@ -66,6 +66,12 @@ tasks:
       - task: generate-rlp
       - task: check-clean-branch
 
+  check-generate-bindings:
+    desc: Checks that generated Go bindings from Solidity contracts in precompile are up-to-date (requires a clean git working tree)
+    cmds:
+      - task: generate-bindings
+      - task: check-clean-branch
+
   check-go-mod-tidy:
     desc: Checks that all go.mod and go.sum files are up-to-date (requires a clean git working tree)
     cmds:
@@ -96,6 +102,17 @@ tasks:
       - cmd: grep -lr -E '^// Code generated by rlpgen\. DO NOT EDIT.\.$' . | xargs -r rm
       - cmd: go generate -run rlpgen ./...
 
+  generate-bindings:
+    desc: Generates Go bindings from Solidity contracts in precompile
+    cmds:
+      - cmd: |
+          # Find and remove generated binding files in precompile directories only
+          find ./precompile -type f -name 'gen_*binding.go' -exec grep -l '^// Code generated - DO NOT EDIT\.$' {} \; | xargs -r rm
+      - cmd: |
+          # Generate bindings for precompile packages (contracts/ bindings are handled by setup-contracts separately)
+          go generate ./precompile/...
+
+
   install-avalanchego-release:
     desc: Download and install AvalancheGo release binary for testing, with fallback to building from source
     cmd: ./scripts/install_avalanchego_release.sh # ci.yml
@@ -113,6 +130,7 @@ tasks:
       - check-generate-codec
       - check-generate-mocks
       - check-generate-rlp
+      - check-generate-bindings
 
   lint-all-ci:
     desc: Runs all lint checks one-by-one
@@ -123,6 +141,7 @@ tasks:
       - task: check-generate-codec
       - task: check-generate-mocks
       - task: check-generate-rlp
+      - task: check-generate-bindings
 
   lint-fix:
     desc: Run golangci-lint with auto-fix where possible

contracts/contracts/ExampleDeployerList.sol

@@ -4,12 +4,11 @@
 package contracts
 
 // Step 1: Compile Solidity contracts to generate ABI and bin files
-//go:generate solc-v0.8.30 -o ../artifacts --overwrite --abi --bin --base-path . @openzeppelin/contracts/=../node_modules/@openzeppelin/contracts/ AllowList.sol ERC20NativeMinter.sol ExampleDeployerList.sol ExampleFeeManager.sol ExampleRewardManager.sol ExampleTxAllowList.sol ExampleWarp.sol
+//go:generate solc-v0.8.30 -o ../artifacts --overwrite --abi --bin --base-path . @openzeppelin/contracts/=../node_modules/@openzeppelin/contracts/ AllowList.sol ERC20NativeMinter.sol ExampleFeeManager.sol ExampleRewardManager.sol ExampleTxAllowList.sol ExampleWarp.sol
 
 // Step 2: Generate Go bindings from the compiled artifacts
 //go:generate go run github.com/ava-labs/libevm/cmd/abigen --pkg bindings --type AllowList --abi ../artifacts/AllowList.abi --bin ../artifacts/AllowList.bin --out ../bindings/gen_allowlist.go
 //go:generate go run github.com/ava-labs/libevm/cmd/abigen --pkg bindings --type ERC20NativeMinter --abi ../artifacts/ERC20NativeMinter.abi --bin ../artifacts/ERC20NativeMinter.bin --out ../bindings/gen_erc20nativeminter.go
-//go:generate go run github.com/ava-labs/libevm/cmd/abigen --pkg bindings --type ExampleDeployerList --abi ../artifacts/ExampleDeployerList.abi --bin ../artifacts/ExampleDeployerList.bin --out ../bindings/gen_exampledeployerlist.go
 //go:generate go run github.com/ava-labs/libevm/cmd/abigen --pkg bindings --type ExampleFeeManager --abi ../artifacts/ExampleFeeManager.abi --bin ../artifacts/ExampleFeeManager.bin --out ../bindings/gen_examplefeemanager.go
 //go:generate go run github.com/ava-labs/libevm/cmd/abigen --pkg bindings --type ExampleRewardManager --abi ../artifacts/ExampleRewardManager.abi --bin ../artifacts/ExampleRewardManager.bin --out ../bindings/gen_examplerewardmanager.go
 //go:generate go run github.com/ava-labs/libevm/cmd/abigen --pkg bindings --type ExampleTxAllowList --abi ../artifacts/ExampleTxAllowList.abi --bin ../artifacts/ExampleTxAllowList.bin --out ../bindings/gen_exampletxallowlist.go

contracts/contracts/compile.go

@@ -51,3 +51,10 @@ func WithCallGasLimit(gaslimit uint64) func(nodeConf *node.Config, ethConf *ethc
 		ethConf.RPCGasCap = gaslimit
 	}
 }
+
+// WithChainConfig configures the simulated backend to use a specific chain configuration.
+func WithChainConfig(chainConfig *params.ChainConfig) func(nodeConf *node.Config, ethConf *ethconfig.Config) {
+	return func(nodeConf *node.Config, ethConf *ethconfig.Config) {
+		ethConf.Genesis.Config = chainConfig
+	}
+}

contracts/contracts/test/ExampleDeployerListTest.sol

@@ -0,0 +1 @@
+artifacts/