[AUTO] Rename upstream Go module at ``

.github/pull_request_template.md

@@ -0,0 +1,5 @@
+## Why this should be merged
+
+## How this works
+
+## How this was tested

.github/workflows/go.yml

@@ -1,23 +1,24 @@
-name: i386 linux tests
+name: Go
 
 on:
-  push:
-    branches: [ master ]
-  pull_request:
-    branches: [ master ]
+  # DO NOT MERGE: disabled while developing auto-renaming
+  # push:
+  #   branches: [ main ]
+  # pull_request:
+  #   branches: [ main ]
   workflow_dispatch:
 
 jobs:
-  build:
-    runs-on: self-hosted
+  go_test_short:
+    runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - name: Set up Go
-        uses: actions/setup-go@v2
+        uses: actions/setup-go@v5
         with:
           go-version: 1.21.4
       - name: Run tests
-        run: go test -short ./...
-        env:
-          GOOS: linux
-          GOARCH: 386
+        run: | # Upstream flakes are race conditions exacerbated by concurrent tests
+          FLAKY_REGEX='go-ethereum/(eth|eth/tracers/js|eth/tracers/logger|accounts/abi/bind|accounts/keystore|eth/downloader|miner|ethclient|ethclient/gethclient|eth/catalyst)$';
+          go list ./... | grep -P "${FLAKY_REGEX}" | xargs -n 1 go test -short;
+          go test -short $(go list ./... | grep -Pv "${FLAKY_REGEX}");

.github/workflows/golangci-lint.yml

@@ -0,0 +1,26 @@
+name: golangci-lint
+
+on:
+  # DO NOT MERGE: disabled while developing auto-renaming
+  # push:
+  #   branches: [ main ]
+  # pull_request:
+  #   branches: [ main ]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+jobs:
+  golangci:
+    name: lint
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-go@v5
+        with:
+          go-version: stable
+      - name: golangci-lint
+        uses: golangci/golangci-lint-action@v6
+        with:
+          version: v1.60

.github/workflows/libevm-delta.yml

@@ -0,0 +1,39 @@
+name: libevm delta
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+  workflow_dispatch:
+
+jobs:
+  diffs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0 # everything
+          fetch-tags: true
+
+      - name: Color-blindness a11y
+        run: | # https://davidmathlogic.com/colorblind/#%23D81B60-%231E88E5-%23FFC107-%23004D40:~:text=8%20pairs%20of%20contrasting%20colors
+          git config color.diff.old "#DC3220";
+          git config color.diff.new "#005AB5";
+
+      - name: git diff libevm-base
+        run: |
+          git diff --diff-filter=a --word-diff --unified=0 --color=always \
+            libevm-base \
+            ':(exclude).golangci.yml' \
+            ':(exclude).github/**' \
+            ':(exclude)README.md';
+
+      - name: git diff libevm-base..main
+        run: |
+          git checkout main --;
+          git diff --diff-filter=a --word-diff --unified=0 --color=always \
+            libevm-base \
+            ':(exclude).golangci.yml' \
+            ':(exclude).github/**' \
+            ':(exclude)README.md';

.github/workflows/rename-module.yml

@@ -0,0 +1,72 @@
+name: Rename Go module
+
+on:
+  pull_request: # DO NOT MERGE WITH ANYTHING OTHER THAN workflow_dispatch
+    branches: [ main ]
+  workflow_dispatch:
+    inputs:
+      source_commit:
+        description: 'Upstream commit on which to base module renaming'
+        required: true
+        type: string
+        default: '2bd6bd01d2e8561dd7fc21b631f4a34ac16627a1'
+
+jobs:
+  rename-module:
+    runs-on: ubuntu-latest
+    env:
+      output_branch: "${{ github.ref_name }}_auto-rename-module-${{ inputs.source_commit }}"
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0 # everything
+          fetch-tags: true
+
+      - name: Check out source commit
+        run: git checkout ${{ inputs.source_commit }}
+
+      - name: Globally update module name
+        run: |
+          go mod edit -module github.com/ava-labs/libevm;
+          find . -iname '*.go' -o -iname '*.txt' | xargs sed -i -E \
+            's|(["`]github\.com/)ethereum/go-ethereum|\1ava-labs/libevm|g';
+
+      - name: Remnant references
+        run: |
+          find . -type f | \
+            xargs grep -In github.com/ethereum/go-ethereum | \
+            grep -v "https://github.com/ethereum/go-ethereum"
+
+      - name: Set up Go
+        uses: actions/setup-go@v5
+        with:
+          go-version: 1.21.4
+
+      - name: Smoke tests
+        # `go list` shows us the module name
+        # `go build` is a rudimentary but broad test of correctness
+        # The explicitly tested packages are edge cases:
+        # - bind creates generates tests and a go.mod on the fly
+        # - rlpgen has testdata with imports that need updating
+        run: |
+          go list . | grep ava-labs/libevm;
+          go build ./...;
+          go test ./accounts/abi/bind ./rlp/rlpgen
+
+      - name: Commit to ${{ env.output_branch }} branch
+        uses: devops-infra/action-commit-push@8bc2ff9f9de7aa2a7581fc7e5b6401c04cab54c7
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          target_branch: ${{ env.output_branch }}
+          force: true
+          commit_prefix: "[AUTO] rename Go module + update internal import paths"
+
+      - name: Open PR to "renamed-go-module" iff workflow dispatched on "main"
+        # if: github.event_name == 'workflow_dispatch' && github.ref != 'refs/heads/main'
+        uses: devops-infra/action-pull-request@v0.5.5
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          source_branch: ${{ env.output_branch }}
+          target_branch: renamed-go-module
+          title: "[AUTO] Rename upstream Go module at `${{ inputs.source_commit }}`"
+          body: "_PR generated by GitHub Action_"

.golangci.yml

@@ -3,58 +3,119 @@
 run:
   timeout: 20m
   tests: true
-  # default is true. Enables skipping of directories:
-  #   vendor$, third_party$, testdata$, examples$, Godeps$, builtin$
-  skip-dirs-use-default: true
-  skip-files:
-    - core/genesis_alloc.go
 
 linters:
-  disable-all: true
   enable:
+    # Every available linter at the time of writing was considered (quickly) and
+    # inclusion was liberal. Linters are good at detecting code smells, but if
+    # we find that a particular one causes too many false positives then we can
+    # configure it better or, as a last resort, remove it.
+    - containedctx
+    - errcheck
+    - forcetypeassert
+    - gci
+    - gocheckcompilerdirectives
+    - gofmt
+    - goheader
     - goimports
-    - gosimple
+    - gomodguard
+    - gosec
     - govet
     - ineffassign
+    # TODO(arr4n): investigate ireturn
     - misspell
+    - nakedret
+    - nestif
+    - nilerr
+    - nolintlint
+    - reassign
+    - revive
+    - sloglint
+    - staticcheck
+    - tagliatelle
+    - testableexamples
+    - testifylint
+    - thelper
+    - tparallel
     - unconvert
-    - typecheck
+    - usestdlibvars
     - unused
-    - staticcheck
-    - bidichk
-    - durationcheck
-    - exportloopref
     - whitespace
 
-    # - structcheck # lots of false positives
-    # - errcheck #lot of false positives
-    # - contextcheck
-    # - errchkjson # lots of false positives
-    # - errorlint # this check crashes
-    # - exhaustive # silly check
-    # - makezero # false positives
-    # - nilerr # several intentional
-
 linters-settings:
-  gofmt:
-    simplify: true
+  gci:
+    custom-order: true
+    sections:
+      - standard
+      - default
+      - localmodule
+      # The rest of these break developer expections, in increasing order of
+      # divergence, so are at the end to increase the chance of being seen.
+      - alias
+      - dot
+      - blank
+  goheader:
+    values:
+    template-path: .libevm-header
+
+  gomodguard:
+    blocked:
+      modules:
+        - github.com/ava-labs/avalanchego:
+        - github.com/ava-labs/coreth:
+        - github.com/ava-labs/subnet-evm:
+  revive:
+    rules:
+      - name: unused-parameter
+        # Method parameters may be equired by interfaces and forcing them to be
+        # named _ is of questionable benefit.
+        disabled: true
 
 issues:
-  exclude-rules:
-    - path: crypto/bn256/cloudflare/optate.go
+   exclude-dirs-use-default: false
+   exclude-rules:
+    - path-except: libevm
       linters:
-        - deadcode
+        # If any issue is flagged in a non-libevm file, add the linter here
+        # because the problem isn't under our control.
+        - containedctx
+        - forcetypeassert
+        - errcheck
+        - gci
+        - gofmt
+        - goheader
+        - gosec
+        - gosimple
+        - govet
+        - nakedret
+        - nestif
+        - nilerr
+        - nolintlint
+        - revive
         - staticcheck
-    - path: internal/build/pgp.go
-      text: 'SA1019: "golang.org/x/crypto/openpgp" is deprecated: this package is unmaintained except for security fixes.'
-    - path: core/vm/contracts.go
-      text: 'SA1019: "golang.org/x/crypto/ripemd160" is deprecated: RIPEMD-160 is a legacy hash and should not be used for new applications.'
-    - path: accounts/usbwallet/trezor.go
-      text: 'SA1019: "github.com/golang/protobuf/proto" is deprecated: Use the "google.golang.org/protobuf/proto" package instead.'
-    - path: accounts/usbwallet/trezor/
-      text: 'SA1019: "github.com/golang/protobuf/proto" is deprecated: Use the "google.golang.org/protobuf/proto" package instead.'
-  exclude:
-    - 'SA1019: event.TypeMux is deprecated: use Feed'
-    - 'SA1019: strings.Title is deprecated'
-    - 'SA1019: strings.Title has been deprecated since Go 1.18 and an alternative has been available since Go 1.0: The rule Title uses for word boundaries does not handle Unicode punctuation properly. Use golang.org/x/text/cases instead.'
-    - 'SA1029: should not use built-in type string as key for value'
+        - tagliatelle
+        - testableexamples
+        - testifylint
+        - thelper
+        - tparallel
+        - typecheck
+        - usestdlibvars
+        - varnamelen
+        - wastedassign
+        - whitespace
+   include:
+   # Many of the default exclusions are because, verbatim "Annoying issue",
+   # which defeats the point of a linter.
+        - EXC0002
+        - EXC0004
+        - EXC0005
+        - EXC0006
+        - EXC0007
+        - EXC0008
+        - EXC0009
+        - EXC0010
+        - EXC0011
+        - EXC0012
+        - EXC0013
+        - EXC0014
+        - EXC0015

.libevm-header

@@ -0,0 +1,15 @@
+Copyright {{ MOD-YEAR }} the libevm authors.
+
+The libevm additions to go-ethereum are free software: you can redistribute
+them and/or modify them under the terms of the GNU Lesser General Public License
+as published by the Free Software Foundation, either version 3 of the License,
+or (at your option) any later version.
+
+The libevm additions are distributed in the hope that they will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser
+General Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public License
+along with the go-ethereum library. If not, see
+<http://www.gnu.org/licenses/>.

README.md

@@ -356,3 +356,9 @@ also included in our repository in the `COPYING.LESSER` file.
 The go-ethereum binaries (i.e. all code inside of the `cmd` directory) are licensed under the
 [GNU General Public License v3.0](https://www.gnu.org/licenses/gpl-3.0.en.html), also
 included in our repository in the `COPYING` file.
+
+The libevm (i) _additions_ to the go-ethereum library (i.e. all code in files with `libevm` in their full path,
+be it a directory or file name); and (ii) _modifications_ to existing go-ethereum code; are licensed under the
+[GNU Lesser General Public License v3.0](https://www.gnu.org/licenses/lgpl-3.0.en.html),
+also included in our repository in the `COPYING.LESSER` file. A comprehensive outline of _modifications_ is
+produced by the [libevm delta workflow](https://github.com/ava-labs/libevm/actions/workflows/libevm-delta.yml).

accounts/abi/abi.go

@@ -24,8 +24,8 @@ import (
 	"io"
 	"math/big"
 
-	"github.com/ethereum/go-ethereum/common"
-	"github.com/ethereum/go-ethereum/crypto"
+	"github.com/ava-labs/libevm/common"
+	"github.com/ava-labs/libevm/crypto"
 )
 
 // The ABI holds information about a contract's context and available

accounts/abi/abi_test.go

@@ -26,9 +26,9 @@ import (
 	"strings"
 	"testing"
 
-	"github.com/ethereum/go-ethereum/common"
-	"github.com/ethereum/go-ethereum/common/math"
-	"github.com/ethereum/go-ethereum/crypto"
+	"github.com/ava-labs/libevm/common"
+	"github.com/ava-labs/libevm/common/math"
+	"github.com/ava-labs/libevm/crypto"
 )
 
 const jsondata = `