Merge branch 'paradigmxyz:main' into main

.dockerignore

@@ -1,6 +1,19 @@
-/target
-/book
-/assets
-/.github
-/data
-*.tar.gz
+# exclude everything
+*
+
+# include source files
+!/bin
+!/crates
+!/testing
+!book.toml
+!Cargo.lock
+!Cargo.toml
+!Cross.toml
+!deny.toml
+!Makefile
+
+# include dist directory, where the reth binary is located after compilation
+!/dist
+
+# include licenses
+!LICENSE-*

.github/ISSUE_TEMPLATE/bug.yml

@@ -58,7 +58,20 @@ body:
   - type: input
     attributes:
       label: What version/commit are you on?
-      description: This can be obtained with e.g. `git rev-parse HEAD`
+      description: This can be obtained with `reth --version` or `git rev-parse HEAD` if you've built Reth from source
+    validations:
+      required: false
+  - type: textarea
+    attributes:
+      label: What database version are you on?
+      description: This can be obtained with `reth db version`
+    validations:
+      required: false
+  - type: input
+    attributes:
+      label: If you've built Reth from source, provide the full command you used
+    validations:
+      required: false
   - type: checkboxes
     id: terms
     attributes:

.github/workflows/bench.yml

@@ -14,6 +14,8 @@ name: bench
 jobs:
   iai:
     runs-on: ubuntu-latest
+    # Only run benchmarks in merge groups
+    if: github.event_name != 'pull_request'
     steps:
       - name: Checkout main sources
         uses: actions/checkout@v3
@@ -67,9 +69,14 @@ jobs:
       - name: Check if benchmarks build
         run: cargo bench --all --all-features --all-targets --no-run
 
+
   bench-success:
+    if: always()
     name: bench success
     needs: bench-check
     runs-on: ubuntu-latest
     steps:
-      - run: echo Success!
+      - name: Decide whether the needed jobs succeeded or failed
+        uses: re-actors/alls-green@release/v1
+        with:
+          jobs: ${{ toJSON(needs) }}

.github/workflows/book.yml

@@ -29,6 +29,24 @@ jobs:
       - name: Run tests
         run: mdbook test
 
+  lint:
+    runs-on: ubuntu-latest
+    name: lint
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Install mdbook-linkcheck
+        run: |
+          mkdir mdbook-linkcheck
+          curl -sSL -o mdbook-linkcheck.zip https://github.com/Michael-F-Bryan/mdbook-linkcheck/releases/latest/download/mdbook-linkcheck.x86_64-unknown-linux-gnu.zip
+          unzip mdbook-linkcheck.zip -d ./mdbook-linkcheck
+          chmod +x `pwd`/mdbook-linkcheck/mdbook-linkcheck
+          echo `pwd`/mdbook-linkcheck >> $GITHUB_PATH
+
+      - name: Run linkcheck
+        run: mdbook-linkcheck --standalone
+
   build:
     runs-on: ubuntu-latest
     steps:
@@ -64,16 +82,34 @@ jobs:
         run: |
           mv target/doc target/book/docs
 
-      - name: Save pages artifact
-        uses: actions/upload-pages-artifact@v1
+      - name: Archive artifact
+        shell: sh
+        run: |
+          chmod -c -R +rX "target/book" |
+          while read line; do
+             echo "::warning title=Invalid file permissions automatically fixed::$line"
+          done
+          tar \
+            --dereference --hard-dereference \
+            --directory "target/book" \
+            -cvf "$RUNNER_TEMP/artifact.tar" \
+            --exclude=.git \
+            --exclude=.github \
+            .
+
+      - name: Upload artifact
+        uses: actions/upload-artifact@v3
         with:
-          path: target/book
+          name: github-pages
+          path: ${{ runner.temp }}/artifact.tar
+          retention-days: 1
+          if-no-files-found: error
 
   deploy:
     # Only deploy if a push to main
     if: github.ref_name == 'main' && github.event_name == 'push'
     runs-on: ubuntu-latest
-    needs: [test, build]
+    needs: [test, lint, build]
 
     # Grant GITHUB_TOKEN the permissions required to make a Pages deployment
     permissions:
@@ -87,4 +123,4 @@ jobs:
     steps:
       - name: Deploy to GitHub Pages
         id: deployment
-        uses: actions/deploy-pages@v1
+        uses: actions/deploy-pages@v2

.github/workflows/ci.yml

@@ -1,7 +1,4 @@
 on:
-  push:
-    branches:
-      - main
   pull_request:
   merge_group:
 
@@ -52,9 +49,23 @@ jobs:
       - name: Check if documentation builds
         run: RUSTDOCFLAGS="-D warnings" cargo doc --all --no-deps --all-features --document-private-items
 
+  grafana-lint:
+    name: grafana lint
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Check dashboard JSON with jq
+        uses: sergeysova/jq-action@v2
+        with:
+          cmd: jq empty etc/grafana/dashboards/overview.json
+
   lint-success:
+    if: always()
     name: lint success
     runs-on: ubuntu-latest
-    needs: [lint, doc-lint]
+    needs: [lint, doc-lint, grafana-lint]
     steps:
-      - run: echo Success!
+      - name: Decide whether the needed jobs succeeded or failed
+        uses: re-actors/alls-green@release/v1
+        with:
+          jobs: ${{ toJSON(needs) }}

.github/workflows/fuzz.yml

@@ -1,7 +1,4 @@
 on:
-  push:
-    branches:
-      - main
   pull_request:
   merge_group:
 
@@ -63,8 +60,14 @@ jobs:
           flags: fuzz-tests
 
   fuzz-success:
+    if: always()
     name: fuzz success
     runs-on: ubuntu-latest
     needs: all
     steps:
-      - run: echo Success!
+      # Note: This check is a dummy because we currently have fuzz tests disabled.
+      - run: echo OK.
+      #- name: Decide whether the needed jobs succeeded or failed
+      #  uses: re-actors/alls-green@release/v1
+      #  with:
+      #    jobs: ${{ toJSON(needs) }}

.github/workflows/hive.yml

@@ -90,7 +90,7 @@ jobs:
             experimental: true
             # eth_ rpc methods
           - sim: ethereum/rpc-compat
-            include: [eth_blockNumber, eth_call, eth_chainId, eth_createAccessList, eth_estimateGas, eth_feeHistory, eth_getBalance, eth_getBlockBy, eth_getBlockTransactionCountBy, eth_getCode, eth_getStorage, eth_getTransactionBy, eth_getTransactionCount, eth_sendRawTransaction, eth_syncing]
+            include: [eth_blockNumber, eth_call, eth_chainId, eth_createAccessList, eth_estimateGas, eth_feeHistory, eth_getBalance, eth_getBlockBy, eth_getBlockTransactionCountBy, eth_getCode, eth_getStorage, eth_getTransactionBy, eth_getTransactionCount, eth_getTransactionReceipt, eth_sendRawTransaction, eth_syncing]
             experimental: true
             # not running eth_getProof tests because we do not support
             # eth_getProof yet

.github/workflows/integration.yml

@@ -1,14 +1,12 @@
 on:
-  push:
-    branches:
-      - main
   pull_request:
   merge_group:
 
 env:
   RUSTFLAGS: -D warnings
   CARGO_TERM_COLOR: always
   GETH_BUILD: 1.12.0-e501b3b0
+  SEED: rustethereumethereumrust
 
 concurrency:
   group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
@@ -65,6 +63,8 @@ jobs:
 
   sync:
     name: sync / 100k blocks
+    # Only run sync tests in merge groups
+    if: github.event_name == 'merge_group'
     runs-on: ubuntu-latest
     env:
       RUST_LOG: info,sync=error
@@ -84,15 +84,19 @@ jobs:
 
       - name: Run sync (${{ matrix.profile }})
         run: |
-          cargo run --profile release --features jemalloc,only-info-logs \
+          cargo run --profile release --features jemalloc,min-error-logs \
             --bin reth -- node \
             --debug.tip 0x91c90676cab257a59cd956d7cb0bceb9b1a71d79755c23c7277a0697ccfaf8c4 \
             --debug.max-block 100000 \
             --debug.terminate
 
   integration-success:
+    if: always()
     name: integration success
     runs-on: ubuntu-latest
-    needs: [test, sync]
+    needs: [test]
     steps:
-      - run: echo Success!
+      - name: Decide whether the needed jobs succeeded or failed
+        uses: re-actors/alls-green@release/v1
+        with:
+          jobs: ${{ toJSON(needs) }}

.github/workflows/release.yml

@@ -222,7 +222,7 @@ jobs:
           | <img src="https://simpleicons.org/icons/apple.svg" style="width: 32px;"/> | aarch64 | [reth-${{ env.VERSION }}-aarch64-apple-darwin.tar.gz](https://github.com/${{ env.REPO_NAME }}/releases/download/${{ env.VERSION }}/reth-${{ env.VERSION }}-aarch64-apple-darwin.tar.gz) | [PGP Signature](https://github.com/${{ env.REPO_NAME }}/releases/download/${{ env.VERSION }}/reth-${{ env.VERSION }}-aarch64-apple-darwin.tar.gz.asc) |
           | | | | |
           | **System** | **Option** | - | **Resource** |
-          | <img src="https://simpleicons.org/icons/docker.svg" style="width: 32px;"/> | Docker | [${{ env.VERSION }}](https://hub.docker.com/r/${{ env.IMAGE_NAME }}/tags?page=1&ordering=last_updated&name=${{ env.VERSION }}) | [${{ env.IMAGE_NAME }}](https://hub.docker.com/r/${{ env.IMAGE_NAME }}) |
+          | <img src="https://simpleicons.org/icons/docker.svg" style="width: 32px;"/> | Docker | [${{ env.VERSION }}](https://github.com/paradigmxyz/reth/pkgs/container/reth/102974600?tag=${{ env.VERSION }}) | [${{ env.IMAGE_NAME }}](https://github.com/paradigmxyz/reth/pkgs/container/reth) |
           ENDBODY
           )
           assets=()

.github/workflows/unit.yml

@@ -1,13 +1,11 @@
 on:
-  push:
-    branches:
-      - main
   pull_request:
   merge_group:
 
 env:
   RUSTFLAGS: -D warnings
   CARGO_TERM_COLOR: always
+  SEED: rustethereumethereumrust
 
 concurrency:
   group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
@@ -95,8 +93,12 @@ jobs:
         run: cargo test --doc --all --all-features
 
   unit-success:
+    if: always()
     name: unit success
     runs-on: ubuntu-latest
     needs: [test, eth-blockchain, doc-test]
     steps:
-      - run: echo Success!
+      - name: Decide whether the needed jobs succeeded or failed
+        uses: re-actors/alls-green@release/v1
+        with:
+          jobs: ${{ toJSON(needs) }}

.gitignore

@@ -29,4 +29,10 @@ data/
 proptest-regressions/
 
 # Release artifacts
-dist/
+dist/
+
+# Database debugging tools
+db-tools/
+
+# VSCode
+.vscode