Merge branch 'ethereum:main' into tests/eip7702-7623-estimateGas

Author: bomanaps

.github/workflows/deploy.yaml

@@ -6,48 +6,29 @@ on:
       - main
   workflow_dispatch:
 
-jobs:
-  build:
-    name: Build Docusaurus
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-        with:
-          fetch-depth: 0
-      - uses: actions/setup-node@v4
-        with:
-          node-version: 20
-          cache: npm
+env:
+  GITHUB_REPOSITORY: ${{ github.repository }}
 
-      - name: Install dependencies
-        run: npm install --frozen-lockfile
-        
-      - name: Build specs and website
-        run: |
-          npm run build
-          npm run build:docs
-
-      - name: Upload Build Artifact
-        uses: actions/upload-pages-artifact@v3
-        with:
-          path: build
-
-  deploy:
-    name: Deploy to GitHub Pages
-    needs: build
-
-    # Grant GITHUB_TOKEN the permissions required to make a Pages deployment
+jobs:
+  deploy-gh-pages:
     permissions:
-      pages: write # to deploy to Pages
-      id-token: write # to verify the deployment originates from an appropriate source
-
-    # Deploy to the github-pages environment
-    environment:
-      name: github-pages
-      url: ${{ steps.deployment.outputs.page_url }}
+      pages: write
+      id-token: write
+      contents: write
 
     runs-on: ubuntu-latest
     steps:
+      - uses: actions/checkout@v4
+      - name: Use Node.js 22
+        uses: actions/setup-node@v4
+        with:
+          node-version: '22'
+      - run: npm ci
+      - run: npm run build
+      - run: npm run build:docs
       - name: Deploy to GitHub Pages
-        id: deployment
-        uses: actions/deploy-pages@v4
+        uses: peaceiris/actions-gh-pages@v4
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: build/docs/gatsby/public
+          commit_message: "Deploy to GitHub Pages"

.github/workflows/test-deploy.yaml

@@ -12,13 +12,16 @@ jobs:
   test-deploy:
     name: Test deployment
     runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version: [20, 22, 24]
     steps:
       - uses: actions/checkout@v4
         with:
           fetch-depth: 0
       - uses: actions/setup-node@v4
         with:
-          node-version: 20
+          node-version: ${{ matrix.node-version }}
           cache: npm
 
       - name: Install dependencies

.github/workflows/test.yaml

@@ -6,11 +6,11 @@ jobs:
   lint-and-check:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
-      - name: Use Node.js 15.x
-        uses: actions/setup-node@v1
+      - uses: actions/checkout@v4
+      - name: Use Node.js 22
+        uses: actions/setup-node@v4
         with:
-          node-version: ^15.x
+          node-version: 22
       - run: npm ci
       - run: npm run build
       - run: npm run lint

.gitignore

@@ -7,4 +7,3 @@ data.json
 schema.json
 *.dic
 .idea/
-.docusaurus

README.md

@@ -11,10 +11,10 @@ Ethereum clients as modules that can be swapped at will.
 
 ### Contributing
 
-Please see the contributors guide in [`docs/making-changes.md`][making-changes]
+Please see the [contributors guide][contributors-guide]
 for general information about the process of standardizing new API methods and
 making changes to existing ones. Information on test generation can be found
-in [`tests/README.md`][test-gen]
+in [test-gen][test-gen]
 
 The specification itself is written in [OpenRPC][openrpc]. Refer to the OpenRPC
 specification and the JSON schema [specification][json-schema] to get started.
@@ -112,8 +112,8 @@ This repository is licensed under [CC0](LICENSE).
 [validator]: https://open-rpc.github.io/schema-utils-js/functions/validateOpenRPCDocument.html
 [graphql-schema]: http://graphql-schema.ethdevops.io/?url=https://raw.githubusercontent.com/ethereum/execution-apis/main/graphql.json
 [eip-1767]: https://eips.ethereum.org/EIPS/eip-1767
-[making-changes]: docs/making-changes.md
+[contributors-guide]: docs/reference/contributors-guide.md
 [json-schema]: https://json-schema.org
 [hive]: https://github.com/ethereum/hive
 [rpc-compat]: https://github.com/ethereum/hive/tree/master/simulators/ethereum/rpc-compat
-[test-gen]: tests/README.md
+[test-gen]: docs/reference/tests.md

css/custom.css

@@ -0,0 +1,82 @@
+const remarkGfm = require('remark-gfm');
+
+module.exports = {
+  pathPrefix: "/execution-apis",
+  siteMetadata: {
+    title: 'Ethereum JSON-RPC Specification',
+    description: 'A specification of the standard interface for Ethereum clients.',
+    siteUrl: process.env.GITHUB_REPOSITORY 
+      ? `https://${process.env.GITHUB_REPOSITORY.split('/')[0]}.github.io/execution-apis`
+      : 'https://ethereum.github.io/execution-apis', // fallback for local development
+    logoUrl: 'https://raw.githubusercontent.com/open-rpc/design/master/icons/open-rpc-logo-noText/open-rpc-logo-noText%20(PNG)/256x256.png',
+    primaryColor: '#3f51b5', //material-ui primary color
+    secondaryColor: '#f50057', //material-ui secondary color
+    author: '',
+    menuLinks: [
+      { name: 'Introduction', link: '/intro' },
+      {
+        name: 'API Documentation',
+        link: '/api-documentation'
+      },
+      { name: 'Quickstart', link: '/quickstart' },
+      { name: 'Contributors Guide', link: '/contributors-guide' },
+      { name: 'Testing', link: '/tests'},
+      { name: 'Ethsimulatev1 notes', link: '/ethsimulatev1-notes' },
+    ],
+    footerLinks: [
+      {
+        name: 'OpenRPC',
+        link: 'https://open-rpc.org'
+      }
+    ]
+  },
+  plugins: [
+   {
+      resolve: 'gatsby-plugin-mdx',
+      options: {
+        extensions: ['.mdx', '.md'],
+        gatsbyRemarkPlugins: [
+          {
+            resolve: 'gatsby-remark-autolink-headers',
+            options: {
+              icon: false,
+            },
+          },
+        ],
+        mdxOptions: {
+          remarkPlugins: [remarkGfm],
+        },
+      },
+    },
+    "gatsby-openrpc-theme",
+    {
+      resolve: 'gatsby-plugin-manifest',
+      options: {
+        name: 'pristine-site',
+        short_name: 'pristine-site',
+        start_url: '/execution-apis/',
+        background_color: 'transparent',
+        theme_color: '#3f51b5',
+        display: 'minimal-ui',
+        icon: 'src/images/gatsby-icon.png', // This path is relative to the root of the site.
+      },
+    },
+    "gatsby-plugin-image",
+    "gatsby-plugin-sharp",
+    "gatsby-transformer-sharp",
+    {
+      resolve: "gatsby-source-filesystem",
+      options: {
+        name: "images",
+        path: __dirname + '/src/images',
+      },
+    },
+    {
+      resolve: "gatsby-source-filesystem",
+      options: {
+        name: "docs",
+        path: __dirname + '/../../../docs/reference',
+      },
+    },
+  ],
+}

docs/config/gatsby-config.js

@@ -115,4 +115,4 @@ others don't.
 
 [exec-apis]: https://github.com/ethereum/execution-apis
 [pm]: https://github.com/ethereum/pm
-[test-gen]: https://github.com/ethereum/execution-apis/blob/main/tests/README.md
+[test-gen]: https://github.com/ethereum/execution-apis/blob/main/tests/README.md

docs/reference/making-changes.md renamed to docs/reference/contributors-guide.md

@@ -32,6 +32,7 @@ Unlike `eth_call`, `eth_simulateV1`'s calls are conducted inside blocks. We don'
 
 ## Default values for transactions
 As eth_simulate is an extension to `eth_call` we want to enable the nice user experience that the user does not need to provide all required values for a transaction. We are assuming following defaults if the variable is not provided by the user:
+
 | parameter name | description |
 -----------------|-----------------------
 | type | `0x2` |
@@ -65,7 +66,7 @@ The default values of blocks and transactions can be overriden. For Transactions
 	"blobBaseFee": "0x15"
 },
 ```
-All the other fields are computed automatically (eg, `stateRoot` and `gasUsed`) or kept as their default values (eg. `uncles` or `withdrawals`). When overriding `number` and `time` variables for blocks, we automatically check that the block numbers and time fields are strictly increasing (we don't allow decreasing, or duplicated block numbers or times). If the block number is increased more than `1` compared to the previous block, new empty blocks are generated in between.
+All the other fields are computed automatically (e.g. `stateRoot` and `gasUsed`) or kept as their default values (e.g. `uncles` or `withdrawals`). When overriding `number` and `time` variables for blocks, we automatically check that the block numbers and time fields are strictly increasing (we don't allow decreasing, or duplicated block numbers or times). If the block number is increased more than `1` compared to the previous block, new empty blocks are generated in between.
 
 An interesting note here is that an user can specify block numbers and times of some blocks, but not for others. When block numbers of times are left unspecified, the default values will be used. After the blocks have been constructed, and default values are calculated, the blocks are checked that their block numbers and times are still valid.
 

docs/ethsimulatev1-notes.md renamed to docs/reference/ethsimulatev1-notes.mdx

@@ -1,7 +1,3 @@
----
-slug: /
-sidebar_position: 1
----
 
 # Introduction
 
@@ -40,4 +36,4 @@ Each category serves specific purposes and provides different functionalities fo
 
 ## Contributing
 
-We welcome contributions to improve this documentation. Please see our [Making Changes](/reference/making-changes) guide for more information on how to contribute. 
+We welcome contributions to improve this documentation. Please see our [Contributors Guide](/reference/contributors-guide) guide for more information on how to contribute.