Merge branch 'master' into JonathanOppenheimer/sync-pr-1394-ci-lint-fixes

Signed-off-by: Jonathan Oppenheimer <[email protected]>

Author: JonathanOppenheimer

.avalanche-golangci.yml

@@ -82,6 +82,7 @@ linters:
     - unparam
     - unused
     - usestdlibvars
+    - usetesting
     - whitespace
   settings:
     depguard:
@@ -228,6 +229,14 @@ linters:
       # Mark all local variables as used.
       # default: true
       local-variables-are-used: false
+    usetesting:
+      os-create-temp:     true # Disallow `os.CreateTemp("", ...)`
+      os-mkdir-temp:      true # Disallow `os.MkdirTemp()`
+      os-setenv:          true # Disallow `os.Setenv()`
+      os-temp-dir:        true # Disallow `os.TempDir()`
+      os-chdir:           true # Disallow `os.Chdir()`
+      context-background: true # Disallow `context.Background()`
+      context-todo:       true # Disallow `context.TODO()` 
   exclusions:
     generated: lax
     presets:

.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

accounts/abi/bind/util_test.go

@@ -42,26 +42,27 @@ import (
 	"github.com/ava-labs/subnet-evm/params"
 )
 
-var testKey, _ = crypto.HexToECDSA("b71c71a67e1177ad4e901695e1b4b9ee17ae16c6668d313eac2f96dbcda3f291")
-
-var waitDeployedTests = map[string]struct {
-	code        string
-	gas         uint64
-	wantAddress common.Address
-	wantErr     error
-}{
-	"successful deploy": {
-		code:        `6060604052600a8060106000396000f360606040526008565b00`,
-		gas:         3000000,
-		wantAddress: common.HexToAddress("0x3a220f351252089d385b29beca14e27f204c296a"),
-	},
-	"empty code": {
-		code:        ``,
-		gas:         300000,
-		wantErr:     bind.ErrNoCodeAfterDeploy,
-		wantAddress: common.HexToAddress("0x3a220f351252089d385b29beca14e27f204c296a"),
-	},
-}
+var (
+	testKey, _        = crypto.HexToECDSA("b71c71a67e1177ad4e901695e1b4b9ee17ae16c6668d313eac2f96dbcda3f291")
+	waitDeployedTests = map[string]struct {
+		code        string
+		gas         uint64
+		wantAddress common.Address
+		wantErr     error
+	}{
+		"successful deploy": {
+			code:        `6060604052600a8060106000396000f360606040526008565b00`,
+			gas:         3000000,
+			wantAddress: common.HexToAddress("0x3a220f351252089d385b29beca14e27f204c296a"),
+		},
+		"empty code": {
+			code:        ``,
+			gas:         300000,
+			wantErr:     bind.ErrNoCodeAfterDeploy,
+			wantAddress: common.HexToAddress("0x3a220f351252089d385b29beca14e27f204c296a"),
+		},
+	}
+)
 
 func TestWaitDeployed(t *testing.T) {
 	t.Parallel()
@@ -94,7 +95,7 @@ func TestWaitDeployed(t *testing.T) {
 
 		// Send and mine the transaction.
 		if err := backend.Client().SendTransaction(ctx, tx); err != nil {
-			t.Fatalf("Failed to send transaction: %s", err)
+			t.Errorf("test %q: failed to send transaction: %v", name, err)
 		}
 		backend.Commit(true)
 
@@ -113,44 +114,66 @@ func TestWaitDeployed(t *testing.T) {
 }
 
 func TestWaitDeployedCornerCases(t *testing.T) {
-	backend := simulated.NewBackend(
-		types.GenesisAlloc{
-			crypto.PubkeyToAddress(testKey.PublicKey): {Balance: big.NewInt(1000000000000000000)},
-		},
+	var (
+		backend = simulated.NewBackend(
+			types.GenesisAlloc{
+				crypto.PubkeyToAddress(testKey.PublicKey): {Balance: big.NewInt(1000000000000000000)},
+			},
+		)
+		head, _     = backend.Client().HeaderByNumber(t.Context(), nil) // Should be child's, good enough
+		gasPrice    = new(big.Int).Add(head.BaseFee, big.NewInt(1))
+		signer      = types.LatestSignerForChainID(big.NewInt(1337))
+		code        = common.FromHex("6060604052600a8060106000396000f360606040526008565b00")
+		ctx, cancel = context.WithCancel(t.Context())
 	)
 	defer backend.Close()
 
-	head, _ := backend.Client().HeaderByNumber(context.Background(), nil) // Should be child's, good enough
-	gasPrice := new(big.Int).Add(head.BaseFee, big.NewInt(1))
-
-	// Create a transaction to an account.
-	code := "6060604052600a8060106000396000f360606040526008565b00"
-	tx := types.NewTransaction(0, common.HexToAddress("0x01"), big.NewInt(0), 3000000, gasPrice, common.FromHex(code))
-	tx, _ = types.SignTx(tx, types.LatestSignerForChainID(big.NewInt(1337)), testKey)
-	ctx, cancel := context.WithCancel(context.Background())
-	defer cancel()
+	// 1. WaitDeploy on a transaction that does not deploy a contract, verify it
+	// returns an error.
+	tx := types.MustSignNewTx(testKey, signer, &types.LegacyTx{
+		Nonce:    0,
+		To:       &common.Address{0x01},
+		Gas:      300000,
+		GasPrice: gasPrice,
+		Data:     code,
+	})
 	if err := backend.Client().SendTransaction(ctx, tx); err != nil {
-		t.Fatalf("Failed to send transaction: %s", err)
+		t.Errorf("failed to send transaction: %q", err)
 	}
 	backend.Commit(true)
 	notContractCreation := errors.New("tx is not contract creation")
 	if _, err := bind.WaitDeployed(ctx, backend.Client(), tx); err.Error() != notContractCreation.Error() {
 		t.Errorf("error mismatch: want %q, got %q, ", notContractCreation, err)
 	}
 
-	// Create a transaction that is not mined.
-	tx = types.NewContractCreation(1, big.NewInt(0), 3000000, gasPrice, common.FromHex(code))
-	tx, _ = types.SignTx(tx, types.LatestSignerForChainID(big.NewInt(1337)), testKey)
-
+	// 2. Create a contract, but cancel the WaitDeploy before it is mined.
+	tx = types.MustSignNewTx(testKey, signer, &types.LegacyTx{
+		Nonce:    1,
+		Gas:      300000,
+		GasPrice: gasPrice,
+		Data:     code,
+	})
+
+	// Wait in another thread so that we can quickly cancel it after submitting
+	// the transaction.
+	done := make(chan struct{})
 	go func() {
-		contextCanceled := errors.New("context canceled")
-		if _, err := bind.WaitDeployed(ctx, backend.Client(), tx); err.Error() != contextCanceled.Error() {
-			t.Errorf("error mismatch: want %q, got %q, ", contextCanceled, err)
+		defer close(done)
+		_, err := bind.WaitDeployed(ctx, backend.Client(), tx)
+		if !errors.Is(err, context.Canceled) {
+			t.Errorf("error mismatch: want %v, got %v", context.Canceled, err)
 		}
 	}()
 
 	if err := backend.Client().SendTransaction(ctx, tx); err != nil {
-		t.Fatalf("Failed to send transaction: %s", err)
+		t.Errorf("failed to send transaction: %q", err)
 	}
 	cancel()
+
+	// Wait for goroutine to exit or for a timeout.
+	select {
+	case <-done:
+	case <-time.After(time.Second * 2):
+		t.Fatalf("failed to cancel wait deploy")
+	}
 }

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