chore: release 1.10.0 (#5836)

.c8rc.json

@@ -0,0 +1,21 @@
+{
+  "all": true,
+  "cache": false,
+  "extension": [".ts", ".js", ".jsx", ".tsx"],
+  "include": [
+  "**/packages/**"
+  ],
+  "exclude": [
+    "**/node_modules/**",
+    "**/test/**"
+  ],
+  "instrument": true,
+  "sourceMap": true,
+  "check-coverage": true,
+  "reporter": [
+    "html",
+    "lcov",
+    "text",
+    "text-summary"
+  ]
+}

.eslintrc.js

@@ -97,7 +97,11 @@ module.exports = {
     "import/no-duplicates": "off",
     "import/no-extraneous-dependencies": [
       "error",
-      {devDependencies: false, optionalDependencies: false, peerDependencies: false},
+      {
+        devDependencies: false,
+        optionalDependencies: false,
+        peerDependencies: false,
+      },
     ],
     "import/no-relative-packages": "error",
     // TEMP Disabled while eslint-plugin-import support ESM (Typescript does support it) https://github.com/import-js/eslint-plugin-import/issues/2170
@@ -152,7 +156,6 @@ module.exports = {
     semi: "off",
   },
   settings: {
-    "import/internal-regex": "^@chainsafe/",
     "import/core-modules": [
       "node:child_process",
       "node:crypto",
@@ -165,6 +168,11 @@ module.exports = {
       "node:util",
       "node:url",
     ],
+    "import/resolver": {
+      typescript: {
+        project: "packages/*/tsconfig.json",
+      },
+    },
   },
   overrides: [
     {

.github/ISSUE_TEMPLATE/bug_report.yaml

@@ -1,6 +1,7 @@
 name: Bug report
 description: Create a bug report to help us improve
 title: "[Descriptive title] "
+labels: [meta-bug]
 body:
   - type: textarea
     id: describe

.github/workflows/benchmark.yml

@@ -32,7 +32,8 @@ jobs:
       - uses: actions/checkout@v3
       - uses: actions/setup-node@v3
         with:
-          node-version: 18
+          node-version: 20
+          check-latest: true
       - name: Node.js version
         id: node
         run: echo "v8CppApiVersion=$(node --print "process.versions.modules")" >> $GITHUB_OUTPUT

.github/workflows/docs-check.yml

@@ -0,0 +1,50 @@
+name: Check docs
+
+on:
+  push:
+    # We intentionally don't run push on feature branches. See PR for rational.
+    branches: [unstable, stable]
+  pull_request:
+
+jobs:
+  build:
+    name: Docs spellcheck
+    runs-on: ubuntu-latest
+    steps:
+      # <common-build> - Uses YAML anchors in the future
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 20
+      - name: Node.js version
+        id: node
+        run: echo "v8CppApiVersion=$(node --print "process.versions.modules")" >> $GITHUB_OUTPUT
+      - name: Restore dependencies
+        uses: actions/cache@master
+        id: cache-deps
+        with:
+          path: |
+            node_modules
+            packages/*/node_modules
+          key: ${{ runner.os }}-${{ steps.node.outputs.v8CppApiVersion }}-${{ hashFiles('**/yarn.lock', '**/package.json') }}
+      - name: Install & build
+        if: steps.cache-deps.outputs.cache-hit != 'true'
+        run: yarn install --frozen-lockfile && yarn build
+      - name: Build
+        run: yarn build
+        if: steps.cache-deps.outputs.cache-hit == 'true'
+
+      - name: Check wordlist is sorted
+        run: scripts/wordlist_sort_check.sh
+
+      - name: Build and collect docs
+        run: yarn build:docs
+
+      # Run prettier check with fix after generating the docs. The CLI reference is formatted with prettier for
+      # deployed version so this will fail if not "fixable"
+      - name: Check docs format
+        run: yarn lint-docs:fix
+
+      # Run spellcheck AFTER building docs, in case the CLI reference has issues
+      - name: Spellcheck
+        uses: rojopolis/[email protected]

.github/workflows/docs.yml

@@ -13,7 +13,8 @@ jobs:
       - uses: actions/checkout@v3
       - uses: actions/setup-node@v3
         with:
-          node-version: 18
+          node-version: 20
+          check-latest: true
       - name: Node.js version
         id: node
         run: echo "v8CppApiVersion=$(node --print "process.versions.modules")" >> $GITHUB_OUTPUT
@@ -36,12 +37,17 @@ jobs:
       - name: Build and collect docs
         run: yarn build:docs
 
+      - name: Lint built docs
+        run: yarn lint-docs:fix
+
       - name: Set up Python
         uses: actions/setup-python@v1
+
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
           pip install -r docs/requirements.txt
+
       - name: Build docs
         run: mkdocs build --site-dir site -v --clean
 

.github/workflows/publish-dev.yml

@@ -20,8 +20,9 @@ jobs:
           fetch-depth: 0
       - uses: actions/setup-node@v3
         with:
-          node-version: 18
+          node-version: 20
           registry-url: "https://registry.npmjs.org"
+          check-latest: true
       - name: Node.js version
         id: node
         run: echo "v8CppApiVersion=$(node --print "process.versions.modules")" >> $GITHUB_OUTPUT

.github/workflows/publish-rc.yml

@@ -52,9 +52,10 @@ jobs:
       - uses: actions/checkout@v3
         with:
           fetch-depth: 0 # Needs full depth for changelog generation
-      - uses: actions/setup-node@v2
+      - uses: actions/setup-node@v3
         with:
-          node-version: 18
+          node-version: 20
+          check-latest: true
       - name: Node.js version
         id: node
         run: echo "v8CppApiVersion=$(node --print "process.versions.modules")" >> $GITHUB_OUTPUT

.github/workflows/publish-stable.yml

@@ -60,7 +60,8 @@ jobs:
           fetch-depth: 0 # Needs full depth for changelog generation
       - uses: actions/setup-node@v3
         with:
-          node-version: 18
+          node-version: 20
+          check-latest: true
       - name: Node.js version
         id: node
         run: echo "v8CppApiVersion=$(node --print "process.versions.modules")" >> $GITHUB_OUTPUT

.github/workflows/test-browser.yml

@@ -19,7 +19,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        node: [18]
+        node: [20]
     steps:
       # <common-build> - Uses YAML anchors in the future
       - uses: actions/checkout@v3
@@ -29,6 +29,7 @@ jobs:
       - uses: actions/setup-node@v3
         with:
           node-version: ${{matrix.node}}
+          check-latest: true
       - name: Node.js version
         id: node
         run: echo "v8CppApiVersion=$(node --print "process.versions.modules")" >> $GITHUB_OUTPUT

.github/workflows/test-e2e.yml

@@ -24,13 +24,14 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        node: [18]
+        node: [20]
     steps:
       # <common-build> - Uses YAML anchors in the future
       - uses: actions/checkout@v3
       - uses: actions/setup-node@v3
         with:
           node-version: ${{matrix.node}}
+          check-latest: true
       - name: Node.js version
         id: node
         run: echo "v8CppApiVersion=$(node --print "process.versions.modules")" >> $GITHUB_OUTPUT

.github/workflows/test-sim-merge.yml

@@ -29,7 +29,8 @@ jobs:
       - uses: actions/checkout@v3
       - uses: actions/setup-node@v3
         with:
-          node-version: 18
+          node-version: 20
+          check-latest: true
       - name: Node.js version
         id: node
         run: echo "v8CppApiVersion=$(node --print "process.versions.modules")" >> $GITHUB_OUTPUT

.github/workflows/test-sim.yml

@@ -31,7 +31,8 @@ jobs:
       - uses: actions/checkout@v3
       - uses: actions/setup-node@v3
         with:
-          node-version: 18
+          node-version: 20
+          check-latest: true
       - name: Node.js version
         id: node
         run: echo "v8CppApiVersion=$(node --print "process.versions.modules")" >> $GITHUB_OUTPUT

.github/workflows/test-spec.yml

@@ -24,7 +24,8 @@ jobs:
       - uses: actions/checkout@v3
       - uses: actions/setup-node@v3
         with:
-          node-version: 18
+          node-version: 20
+          check-latest: true
       - name: Node.js version
         id: node
         run: echo "v8CppApiVersion=$(node --print "process.versions.modules")" >> $GITHUB_OUTPUT

.github/workflows/test.yml

@@ -19,13 +19,14 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        node: [18]
+        node: [20]
     steps:
       # <common-build> - Uses YAML anchors in the future
       - uses: actions/checkout@v3
       - uses: actions/setup-node@v3
         with:
           node-version: ${{matrix.node}}
+          check-latest: true
       - name: Node.js version
         id: node
         run: echo "v8CppApiVersion=$(node --print "process.versions.modules")" >> $GITHUB_OUTPUT
@@ -52,6 +53,9 @@ jobs:
           path: packages/validator/spec-tests
           key: spec-test-data-${{ hashFiles('packages/validator/test/spec/params.ts') }}
 
+      - name: Assert yarn prints no warnings
+        run: scripts/assert_no_yarn_warnings.sh
+
       # Misc sanity checks
       - name: Lint Grafana dashboards
         run: scripts/validate-grafana-dashboards.sh
@@ -67,13 +71,10 @@ jobs:
         run: scripts/assert_eslintrc_sorted.mjs
 
       - name: Check Types
-        run: yarn run check-types
-      # Test docs generation, even if not published
-      - name: Build docs
-        run: yarn build:docs
+        run: yarn check-types
 
       - name: README check
-        run: yarn run check-readme
+        run: yarn check-readme
 
       - name: Lint
         run: yarn lint

.gitignore

@@ -40,10 +40,10 @@ packages/api/oapi-schemas
 # Autogenerated docs
 packages/**/docs
 packages/**/typedocs
+docs/assets
 docs/packages
+docs/reference
 docs/contributing.md
-docs/assets
-docs/reference/cli.md
 /site
 
 # Testnet artifacts
@@ -70,5 +70,6 @@ packages/cli/.git-data.json
 
 # Build artifacts
 .last_build_unixsec
+dictionary.dic
 
 temp/

.prettierignore

@@ -1,3 +1,5 @@
 **/lib
 **/.nyc_output
-/packages/*/spec-tests
+/packages/*/spec-tests
+node_modules
+**/node_modules

.pyspelling.yml

@@ -0,0 +1,42 @@
+matrix:
+  - name: markdown
+    aspell:
+      lang: en
+      ignore-case: true
+    dictionary:
+      wordlists:
+        - .wordlist.txt
+    pipeline:
+      - pyspelling.filters.url:
+      - pyspelling.filters.markdown:
+          markdown_extensions:
+          - pymdownx.superfences:
+          - pymdownx.highlight:
+          - pymdownx.striphtml:
+          - pymdownx.magiclink:
+      - pyspelling.filters.url:
+      - pyspelling.filters.html:
+          comments: false
+          ignores:
+            - code
+            - pre
+      - pyspelling.filters.context:
+          context_visible_first: true
+          delimiters:
+          # Ignore possessive endings
+          - open: '(?<=\w)''s(?!\w)'
+            close: '\b'
+          # Ignore eth methods (e.g. eth_estimateGas)
+          - open: '(?:\s)eth_(?:\w*)'
+            close: '\s'
+          # Ignore flags in cli.md
+          - open: '--(?:\w*)'
+            close: '[^\w]'
+          # Ignore hex strings
+          - open: '0x[a-fA-F0-9]'
+            close: '[^a-fA-F0-9]'
+    sources:
+      - "docs/**/*.md"
+      - "CONTRIBUTING.md"
+      - "README.md"
+      - "packages/*/README.md"