Initial commit

.github/pull_request_template.md

@@ -0,0 +1,19 @@
+## 📝 Summary
+
+<!--- A general summary of your changes -->
+
+## ⛱ Motivation and Context
+
+<!--- Why is this change required? What problem does it solve? -->
+
+## 📚 References
+
+<!-- Any interesting external links to documentation, articles, tweets which add value to the PR -->
+
+---
+
+## ✅ I have run these commands
+
+* [ ] `make lint`
+* [ ] `make test`
+* [ ] `go mod tidy`

.github/workflows/checks.yml

@@ -0,0 +1,58 @@
+name: Checks
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+jobs:
+  test:
+    name: Test
+    runs-on: ubuntu-latest
+    steps:
+      - name: Set up Go
+        uses: actions/setup-go@v3
+        with:
+          go-version: ^1.21
+        id: go
+
+      - name: Check out code into the Go module directory
+        uses: actions/checkout@v2
+
+      - name: Run unit tests and generate the coverage report
+        run: make test-race
+
+  lint:
+    name: Lint
+    runs-on: ubuntu-latest
+    steps:
+      - name: Set up Go
+        uses: actions/setup-go@v3
+        with:
+          go-version: ^1.21
+        id: go
+
+      - name: Check out code into the Go module directory
+        uses: actions/checkout@v2
+
+      - name: Install gofumpt
+        run: go install mvdan.cc/[email protected]
+
+      - name: Install staticcheck
+        run: go install honnef.co/go/tools/cmd/[email protected]
+
+      - name: Install golangci-lint
+        run: go install github.com/golangci/golangci-lint/cmd/[email protected]
+
+      - name: Install NilAway
+        run: go install go.uber.org/nilaway/cmd/[email protected]
+
+      - name: Lint
+        run: make lint
+
+      - name: Ensure go mod tidy runs without changes
+        run: |
+          go mod tidy
+          git update-index -q --really-refresh
+          git diff-index HEAD

.github/workflows/release.yaml

@@ -0,0 +1,97 @@
+# name: Release
+
+on:
+  push:
+    tags:
+      - 'v*'
+
+jobs:
+
+  dummy:
+    name: Dummy
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Dummy
+        run: exit 0
+
+
+#   docker-image:
+#     name: Publish Docker Image
+#     runs-on: ubuntu-latest
+
+#     steps:
+#       - name: Checkout sources
+#         uses: actions/checkout@v2
+
+#       - name: Get tag version
+#         run: echo "RELEASE_VERSION=${GITHUB_REF#refs/*/}" >> $GITHUB_ENV
+
+#       - name: Print version
+#         run: |
+#           echo $RELEASE_VERSION
+#           echo ${{ env.RELEASE_VERSION }}
+
+#       - name: Set up QEMU
+#         uses: docker/setup-qemu-action@v3
+
+#       - name: Set up Docker Buildx
+#         uses: docker/setup-buildx-action@v3
+
+#       - name: Extract metadata (tags, labels) for Docker
+#          id: meta
+#          uses: docker/metadata-action@v5
+#          with:
+#            images: flashbots/go-template
+#            tags: |
+#              type=sha
+#              type=pep440,pattern={{version}}
+#              type=pep440,pattern={{major}}.{{minor}}
+#              type=raw,value=latest,enable=${{ !contains(env.RELEASE_VERSION, '-') }}
+
+#       - name: Login to DockerHub
+#         uses: docker/login-action@v3
+#         with:
+#           username: ${{ secrets.DOCKERHUB_USERNAME }}
+#           password: ${{ secrets.DOCKERHUB_TOKEN }}
+
+#      - name: Go Build Cache for Docker
+#        uses: actions/cache@v3
+#        with:
+#          path: go-build-cache
+#          key: ${{ runner.os }}-go-build-cache-${{ hashFiles('**/go.sum') }}
+
+#      - name: inject go-build-cache into docker
+#        uses: reproducible-containers/[email protected]
+#        with:
+#          cache-source: go-build-cache
+
+#       - name: Build and push
+#         uses: docker/build-push-action@v5
+#         with:
+#           context: .
+#           build-args: |
+#             VERSION=${{ env.RELEASE_VERSION }}
+#           push: true
+#           tags: ${{ steps.meta.outputs.tags }}
+#           labels: ${{ steps.meta.outputs.labels }}
+#           platforms: linux/amd64,linux/arm64
+#           cache-from: type=gha
+#           cache-to: type=gha,mode=max
+
+#   github-release:
+#     runs-on: ubuntu-latest
+#     steps:
+#       - name: Checkout sources
+#         uses: actions/checkout@v2
+
+#       - name: Create release
+#         id: create_release
+#         uses: actions/create-release@v1
+#         env:
+#           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # This token is provided by Actions, you do not need to create your own token
+#         with:
+#           tag_name: ${{ github.ref }}
+#           release_name: ${{ github.ref }}
+#           draft: false
+#           prerelease: false

.gitignore

@@ -0,0 +1,21 @@
+# Binaries for programs and plugins
+*.exe
+*.exe~
+*.dll
+*.so
+*.dylib
+
+# Test binary, built with `go test -c`
+*.test
+
+# Output of the go coverage tool, specifically when used with LiteIDE
+*.out
+
+# Dependency directories (remove the comment below to include it)
+# vendor/
+
+# IDE
+.vscode
+
+# Builds
+/build

.golangci.yaml

@@ -0,0 +1,98 @@
+linters:
+  enable-all: true
+  disable:
+    - cyclop
+    - forbidigo
+    - funlen
+    - gci
+    - gochecknoglobals
+    - gochecknoinits
+    - gocritic
+    - godot
+    - godox
+    - gomnd
+    - mnd
+    - lll
+    - nestif
+    - nilnil
+    - nlreturn
+    - noctx
+    - nonamedreturns
+    - nosnakecase
+    - paralleltest
+    - revive
+    - testpackage
+    - unparam
+    - varnamelen
+    - wrapcheck
+    - wsl
+    - deadcode
+    - varcheck
+    - exhaustruct
+    - depguard
+
+    #
+    # Disabled because of generics:
+    #
+    - contextcheck
+    - rowserrcheck
+    - sqlclosecheck
+    - structcheck
+    - wastedassign
+
+    #
+    # Disabled because deprecated:
+    #
+    - exhaustivestruct
+    - golint
+    - ifshort
+    - interfacer
+    - maligned
+    - scopelint
+
+linters-settings:
+  #
+  # The G108 rule throws a false positive. We're not actually vulnerable. If
+  # you're not careful the profiling endpoint is automatically exposed on
+  # /debug/pprof if you import net/http/pprof. See this link:
+  #
+  #   https://mmcloughlin.com/posts/your-pprof-is-showing
+  #
+  gosec:
+    excludes:
+      - G108
+
+  tagliatelle:
+    case:
+      rules:
+        json: snake
+
+  gofumpt:
+    extra-rules: true
+
+  exhaustruct:
+    exclude:
+      #
+      # Because it's easier to read without the other fields.
+      #
+      - 'GetPayloadsFilters'
+
+      #
+      # Structures outside our control that have a ton of settings. It doesn't
+      # make sense to specify all of the fields.
+      #
+      - 'cobra.Command'
+      - 'database.*Entry'
+      - 'http.Server'
+      - 'logrus.*Formatter'
+      - 'Options' # redis
+
+      #
+      # Excluded because there are private fields (not capitalized) that are
+      # not initialized. If possible, I think these should be altered.
+      #
+      - 'Datastore'
+      - 'Housekeeper'
+      - 'MockBeaconClient'
+      - 'RelayAPI'
+      - 'Webserver'

LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2021-2024 Flashbots
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.