DONOTMERGE: coreth graft with rewritten history

graft/coreth/.avalanche-golangci.yml

@@ -0,0 +1,246 @@
+# https://golangci-lint.run/usage/configuration/
+version: "2"
+run:
+  # If set we pass it to "go list -mod={option}". From "go help modules":
+  # If invoked with -mod=readonly, the go command is disallowed from the implicit
+  # automatic updating of go.mod described above. Instead, it fails when any changes
+  # to go.mod are needed. This setting is most useful to check that go.mod does
+  # not need updates, such as in a continuous integration and testing system.
+  # If invoked with -mod=vendor, the go command assumes that the vendor
+  # directory holds the correct copies of dependencies and ignores
+  # the dependency descriptions in go.mod.
+  #
+  # Allowed values: readonly|vendor|mod
+  # By default, it isn't set.
+  modules-download-mode: readonly
+
+  # Include non-test files tagged as test-only.
+  # Context: https://github.com/ava-labs/avalanchego/pull/3173
+  build-tags:
+    - test
+
+issues:
+  # Make issues output unique by line.
+  uniq-by-line: false
+
+  # Maximum issues count per one linter.
+  max-issues-per-linter: 0
+
+  # Maximum count of issues with the same text.
+  max-same-issues: 0
+
+formatters:
+  enable:
+    - gci
+    - gofmt
+    - gofumpt
+  settings:
+    gci:
+      sections:
+        - standard
+        - default
+        - blank
+        - prefix(github.com/ava-labs/coreth)
+        - alias
+        - dot
+      custom-order: true
+  exclusions:
+    generated: lax
+
+# Avalanche linters should be added incrementally
+linters:
+  default: none
+  enable:
+    - asciicheck
+    - bodyclose
+    - copyloopvar
+    # - depguard
+    # - errcheck
+    - errorlint
+    - forbidigo
+    - goconst
+    - gocritic
+    - goprintffuncname
+    # - gosec
+    - govet
+    - importas
+    - ineffassign
+    - misspell
+    - nakedret
+    - nilerr
+    - noctx
+    - nolintlint
+    - perfsprint
+    - prealloc
+    - predeclared
+    - revive
+    - spancheck
+    - staticcheck
+    - tagalign
+    - testifylint
+    - unconvert
+    - unparam
+    - unused
+    - usestdlibvars
+    - usetesting
+    - whitespace
+  settings:
+    depguard:
+      rules:
+        packages:
+          deny:
+            - pkg: container/list
+              desc: github.com/ava-labs/avalanchego/utils/linked should be used instead.
+            - pkg: github.com/golang/mock/gomock
+              desc: go.uber.org/mock/gomock should be used instead.
+            - pkg: github.com/stretchr/testify/assert
+              desc: github.com/stretchr/testify/require should be used instead.
+            - pkg: io/ioutil
+              desc: io/ioutil is deprecated. Use package io or os instead.
+    errorlint:
+      # Check for plain type assertions and type switches.
+      asserts: false
+      # Check for plain error comparisons.
+      comparison: false
+    forbidigo:
+      # Forbid the following identifiers (list of regexp).
+      forbid:
+        - pattern: require\.Error$(# ErrorIs should be used instead)?
+        - pattern: require\.ErrorContains$(# ErrorIs should be used instead)?
+        - pattern: require\.EqualValues$(# Equal should be used instead)?
+        - pattern: require\.NotEqualValues$(# NotEqual should be used instead)?
+        - pattern: ^(t|b|tb|f)\.(Fatal|Fatalf|Error|Errorf)$(# the require library should be used instead)?
+        - pattern: ^sort\.(Slice|Strings)$(# the slices package should be used instead)?
+      # Exclude godoc examples from forbidigo checks.
+      exclude-godoc-examples: false
+    gosec:
+      excludes:
+        - G107 # Url provided to HTTP request as taint input https://securego.io/docs/rules/g107
+        - G115 # TODO(marun) Enable this ruleset in a follow-up PR
+    importas:
+      # Do not allow unaliased imports of aliased packages.
+      no-unaliased: false
+      # Do not allow non-required aliases.
+      no-extra-aliases: false
+      # List of aliases
+      alias:
+        - pkg: github.com/ava-labs/avalanchego/utils/math
+          alias: safemath
+        - pkg: github.com/ava-labs/avalanchego/utils/json
+          alias: avajson
+    revive:
+      rules:
+        # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#bool-literal-in-expr
+        - name: bool-literal-in-expr
+          disabled: false
+        # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#early-return
+        - name: early-return
+          disabled: false
+        # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#empty-lines
+        - name: empty-lines
+          disabled: false
+        # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#redundant-import-alias
+        - name: redundant-import-alias
+          disabled: false
+        # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#string-format
+        - name: string-format
+          disabled: false
+          arguments:
+            - - b.Logf[0]
+              - /.*%.*/
+              - no format directive, use b.Log instead
+            - - fmt.Errorf[0]
+              - /.*%.*/
+              - no format directive, use errors.New instead
+            - - fmt.Fprintf[1]
+              - /.*%.*/
+              - no format directive, use fmt.Fprint instead
+            - - fmt.Printf[0]
+              - /.*%.*/
+              - no format directive, use fmt.Print instead
+            - - fmt.Sprintf[0]
+              - /.*%.*/
+              - no format directive, use fmt.Sprint instead
+            - - log.Fatalf[0]
+              - /.*%.*/
+              - no format directive, use log.Fatal instead
+            - - log.Printf[0]
+              - /.*%.*/
+              - no format directive, use log.Print instead
+            - - t.Logf[0]
+              - /.*%.*/
+              - no format directive, use t.Log instead
+        # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#struct-tag
+        - name: struct-tag
+          disabled: false
+        # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#unexported-naming
+        - name: unexported-naming
+          disabled: false
+        # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#unhandled-error
+        - name: unhandled-error
+          # prefer the errcheck linter since it can be disabled directly with nolint directive
+          # but revive's disable directive (e.g. //revive:disable:unhandled-error) is not
+          # supported when run under golangci_lint
+          disabled: true
+        # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#unused-parameter
+        - name: unused-parameter
+          disabled: false
+        # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#unused-receiver
+        - name: unused-receiver
+          disabled: false
+        # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#useless-break
+        - name: useless-break
+          disabled: false
+    spancheck:
+      # https://github.com/jjti/go-spancheck#checks
+      checks:
+        - end
+    staticcheck:
+      # https://staticcheck.io/docs/options#checks
+      checks:
+        - all
+        - -SA6002A # Storing non-pointer values in sync.Pool allocates memory
+        - -SA1019 # Using a deprecated function, variable, constant or field
+        - -QF1008 # Unnecessary embedded expressions
+    tagalign:
+      align: true
+      sort: true
+      order:
+        - serialize
+      strict: true
+    testifylint:
+      # Enable all checkers (https://github.com/Antonboom/testifylint#checkers).
+      # Default: false
+      enable-all: true
+      # Disable checkers by name
+      # (in addition to default
+      #   suite-thelper
+      # ).
+      disable:
+        - go-require
+        - float-compare
+    unused:
+      # Mark all struct fields that have been written to as used.
+      # Default: true
+      field-writes-are-uses: false
+      # Treat IncDec statement (e.g. `i++` or `i--`) as both read and write operation instead of just write.
+      # Default: false
+      post-statements-are-reads: true
+      # 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:
+      - comments
+      - common-false-positives
+      - legacy
+      - std-error-handling

graft/coreth/.dockerignore

@@ -0,0 +1,9 @@
+.ci
+.github
+.gitignore
+.golangci.yml
+.idea
+.vscode
+
+LICENSE
+*.md

graft/coreth/.envrc

@@ -0,0 +1,10 @@
+# - Will execute on entry to the containing directory only if authorized with `direnv allow`
+# - Requires a recent version of direnv (https://direnv.net/)
+# - For quieter direnv output, set `export DIRENV_LOG_FORMAT=`
+
+# Determine AVALANCHE_VERSION
+source ./scripts/versions.sh
+
+# - Starts an avalanchego dev shell
+# - Requires nix (https://github.com/DeterminateSystems/nix-installer?tab=readme-ov-file#install-nix)
+use flake "github:ava-labs/avalanchego?ref=${AVALANCHE_VERSION}"

graft/coreth/.github/CODEOWNERS

@@ -0,0 +1,12 @@
+# Each line is a file pattern followed by one or more owners.
+
+# These owners will be the default code owners for everything in the repo.
+
+# Unless a later match takes precedence, these owners will be requested for
+
+# review whenever someone opens a pull request.
+
+* @ava-labs/platform-evm
+/.github/ @maru-ava @ava-labs/platform-evm
+/triedb/firewood/ @alarso16 @ava-labs/platform-evm
+

graft/coreth/.github/CONTRIBUTING.md

@@ -0,0 +1,91 @@
+# Contributing
+
+Thank you for considering to help out with the source code! We welcome 
+contributions from anyone on the internet, and are grateful for even the 
+smallest of fixes!
+
+If you'd like to contribute to coreth, please fork, fix, commit and send a 
+pull request for the maintainers to review and merge into the main code base. If
+you wish to submit more complex changes though, please check up with the core 
+devs first on [Discord](https://chat.avalabs.org) to 
+ensure those changes are in line with the general philosophy of the project 
+and/or get some early feedback which can make both your efforts much lighter as
+well as our review and merge procedures quick and simple.
+
+## Coding guidelines
+
+Please make sure your contributions adhere to our coding guidelines:
+
+ * Code must adhere to the official Go 
+[formatting](https://go.dev/doc/effective_go#formatting) guidelines 
+(i.e. uses [gofmt](https://pkg.go.dev/cmd/gofmt)).
+ * Code must be documented adhering to the official Go 
+[commentary](https://go.dev/doc/effective_go#commentary) guidelines.
+ * Pull requests need to be based on and opened against the `master` branch.
+ * Pull reuqests should include a detailed description
+ * Commits are required to be signed. See [here](https://docs.github.com/en/authentication/managing-commit-signature-verification/signing-commits)
+ for information on signing commits.
+ * Commit messages should be prefixed with the package(s) they modify.
+   * E.g. "eth, rpc: make trace configs optional"
+
+## Can I have feature X
+
+Before you submit a feature request, please check and make sure that it isn't 
+possible through some other means.
+
+## Mocks
+
+Mocks are auto-generated using [mockgen](https://pkg.go.dev/go.uber.org/mock/mockgen) and `//go:generate` commands in the code.
+
+* To **re-generate all mocks**, use the command below from the root of the project:
+
+    ```sh
+    go generate -run mockgen ./...
+    ```
+
+* To **add** an interface that needs a corresponding mock generated:
+  * if the file `mocks_generate_test.go` exists in the package where the interface is located, either:
+    * modify its `//go:generate go tool -modfile=tools/go.mod mockgen` to generate a mock for your interface (preferred); or
+    * add another `//go:generate go tool -modfile=tools/go.mod mockgen` to generate a mock for your interface according to specific mock generation settings
+  * if the file `mocks_generate_test.go` does not exist in the package where the interface is located, create it with content (adapt as needed):
+
+    ```go
+    // Copyright (C) 2025-2025, Ava Labs, Inc. All rights reserved.
+    // See the file LICENSE for licensing terms.
+
+    package mypackage
+
+    //go:generate go tool -modfile=tools/go.mod mockgen -package=${GOPACKAGE} -destination=mocks_test.go . YourInterface
+    ```
+
+    Notes:
+    1. Ideally generate all mocks to `mocks_test.go` for the package you need to use the mocks for and do not export mocks to other packages. This reduces package dependencies, reduces production code pollution and forces to have locally defined narrow interfaces.
+    1. Prefer using reflect mode to generate mocks than source mode, unless you need a mock for an unexported interface, which should be rare.
+* To **remove** an interface from having a corresponding mock generated:
+  1. Edit the `mocks_generate_test.go` file in the directory where the interface is defined
+  1. If the `//go:generate` mockgen command line:
+      * generates a mock file for multiple interfaces, remove your interface from the line
+      * generates a mock file only for the interface, remove the entire line. If the file is empty, remove `mocks_generate_test.go` as well.
+
+## Tool Dependencies
+
+This project uses `go tool` to manage development tool dependencies in `tools/go.mod`. This isolates tool dependencies from the main application dependencies and provides consistent, version-locked tools across the team.
+
+### Managing Tools
+
+* To **add a new tool**:
+  ```sh
+  go get -tool -modfile=tools/go.mod example.com/tool/cmd/toolname@version
+  ```
+
+* To **upgrade a tool**:
+  ```sh
+  go get -tool -modfile=tools/go.mod example.com/tool/cmd/toolname@newversion
+  ```
+
+* To **run a tool manually**:
+  ```sh
+  go tool -modfile=tools/go.mod toolname [args...]
+  ```
+
+Note: `ginkgo` remains in the main `go.mod` as it is used directly in e2e test code.