[migrate-coreth][2] Add 'graft/coreth/' from commit 4819e747

flake.nix

@@ -63,6 +63,9 @@
             protoc-gen-go-grpc
             protoc-gen-connect-go
 
+            # Line-oriented search tool
+            ripgrep
+
             # Solidity compiler
             solc
 

graft/README.md

@@ -0,0 +1,88 @@
+# Monorepo Grafting
+
+This directory is intended to be the initial point of migration for
+other git repos being added to this repo. Such 'grafts' do not have to
+initially adhere to repo standards but will be expected to be
+refactored where necessary to meet such standards as part of a
+PR-based process of migrating to more permanent locations.
+
+## Migrating a Repo
+
+### Stacked Branches
+
+As with with any changes to a codebase, minimizing review friction is
+essential. While it would be possible to require review of a huge PR
+commit-by-commit, any changes to those commits would need to be
+correlated with their originals and the friction would be
+considerable. Instead, a [stacked
+branch](https://andrewlock.net/working-with-stacked-branches-in-git-part-1/)
+approach is suggested to enable effective review of a large migration
+in a piecemeal fashion:
+
+ - Create a branch per reviewable task
+   - Subtree merge would be one task, import rewrite another, etc
+   - The branch for a task subsequent to the initial task would be
+     based on the previous task branch
+ - Create a PR per branch
+   - The initial task would use the master branch as its base
+   - A subsequent task would use the previous task's branch as its base
+   - Mark each PR as draft to avoid premature merge
+ - Request review in order from the initial PR but do not merge yet
+ - Once all PRs in the series have been approved
+   - Freeze develoment on the origin repo
+   - Merge from the top down into the subtree merge PR
+     - Avoids cascading rebases and merge conflicts
+ - Once only the subtree merge PR is left, manually merge the branch
+   - Merging the PR with squash enabled would discard the history that
+     we want to retain
+ - Close the subtree merge PR
+ - Archive the original repo
+
+Tooling such as
+[git-machete](https://github.com/VirtusLab/git-machete) or
+[jujutsu](https://github.com/jj-vcs/jj) is suggested to simplify
+maintaining the series of stacked branches.
+
+### Suggested Procedure
+
+The following do not represent an exhaustive list of tasks and are
+used for example purposes only. Regardless of the steps involved, the
+creation of an initial branch from master is assumed before the first
+step, and the commit of all changes and creation of a new branch from
+the current branch before beginning a subsequent step.
+
+ - [ ] Add tasks for subtree merge and import rewrite to graft/Taskfile.yml (as per the example of existing tasks)
+   - These tasks are intended to simplify the repeated invocation that
+     will be required when a repo is being developed in parallel with
+     migration.
+ - [ ] Execute the subtree merge task (it will commit the result automatically)
+ - [ ] Remove files made redundant by the migration
+   - Prioritizing file removal before modification minimizes the changes requiring review
+ - [ ] Execute the rewrite imports task (it will commit the result automatically)
+ - [ ] Perform required go module changes
+ - [ ] Migrate CI jobs (unit test, e2e, linting, etc)
+ - [ ] Get CI jobs passing
+
+### Rebasing Inflight PRs
+
+Provided a subtree merge was used to perform the graft, a common merge
+base will exist with which to rebase PRs targeted at the original git
+repo. This allows for repo migration and ongoing development to
+proceed in parallel. Once a graft has been finalized, outstanding PR
+branches from the original repo can be migrated as follows:
+
+```bash
+# Fetch the PR branch from the standalone repo's remote
+git fetch REMOTE PR_BRANCH_NAME
+
+# Create a local branch from the PR branch.
+# Don't track since the new branch is intended to target the new repo.
+git checkout -b PR_BRANCH_NAME REMOTE/PR_BRANCH_NAME --no-track
+
+# Rebase onto the target branch in this repo, treating graft/REPO as the subtree root.
+# Conflict resolution may be required.
+git rebase -Xsubtree=graft/REPO --onto origin/master REMOTE/master
+
+# Push the new PR branch
+git push -u origin PR_BRANCH_NAME
+```

graft/Taskfile.yml

@@ -0,0 +1,19 @@
+# https://taskfile.dev
+# To run on a system without task installed, `../scripts/run_task.sh` will execute it with `go run`.
+# If in the nix dev shell, `task` is available.
+
+version: '3'
+
+vars:
+  CORETH_MODULE: github.com/ava-labs/coreth
+
+tasks:
+  default: ../scripts/run_task.sh --list
+
+  coreth-rewrite-imports:
+    desc: Rewrite imports of out-of-tree coreth to in-tree coreth
+    cmd: bash ./scripts/rewrite-imports.sh {{.CORETH_MODULE}}
+
+  coreth-subtree-merge:
+    desc: Perform git subtree merge of coreth into graft/coreth (commits)
+    cmd: bash ./scripts/subtree-merge.sh {{.CORETH_MODULE}} master

graft/coreth/.avalanche-golangci.yml

@@ -0,0 +1,255 @@
+# 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
+    rules:
+      # Exclude some linters from running on test files.
+      # 1. Exclude the top level tests/ directory.
+      # 2. Exclude any file prefixed with test_ in any directory.
+      # 3. Exclude any directory suffixed with test.
+      # 4. Exclude any file suffixed with _test.go.
+      - path: "(^tests/)|(^(.*/)*test_[^/]*\\.go$)|(.*test/.*)|(.*_test\\.go$)"
+        linters:
+          - gosec

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}"