refactor: move to automated checks (#62)

* organize script folder

* init bun scripts

* style: init biome

* save metadata to json

* feat: check opcodes

* chore: sort keys

* feat: slice by feature

* build: generate data with 'bun main {chainId}'

* chore: slim down opcode output

* refactor: change to arrays

* feat: add deployed contracts checks

* improve ux

* feat: precompile support

* refactor: move to checks folder

* chore: remove log

* chore: split up lint and fmt jobs

* feat: add addresses that uniquely identify an evm stack

* build: fix lint error

* start UI work

* feat: add opcodes back to UI

* add deployed contracts to UI

* add precompiles to UI

* add stack addrs to UI

* style: reduce row spacing

* build: fix lint errors

* build: move from pnpm to bun

* style: switch from prettier to biome

* chore: unify dirs

* chore: some fixes

* build: watch mode

* chore: remove old comments

* feat: add Base

* feat: load in new chains

* style: some info/UX cleanup

* feat: json diffs

* style: add logos

* style: change toggle

* feat: query params

* update contributing

* style: loading spinner

* style: move things from footer to header

* style: diff scroll improvements

* ci: update for bun

* ci: fix?

* ci: add node

* ci: remove jq from build pipeline since vercel has no jq

* ci: revert ci as test

* ci: back to bun

* ci/style: fmt after merge, add node

* ci: fix build command

* chore: clarify copy

* feat: opcode support for features view

* feat: metadata and opcodes feature comparison

* feat: back button

* feat: more diff tables

* feat: add chains

* cleanup

* refactor home page

* tweaks

* remove old code

* fixes

* add features to the comparison table

* style: fmt

* Add precompile test for secp256r1 (#65)

* Add precompile test for secp256r1

* update chain data

---------

Co-authored-by: Matt Solomon <[email protected]>

* doc: add API key note

* chore: dynamic branch name

* refactor: dedupe feature declarations

* refactor: more cleanup

* cleanup

* style: fmt

* ci: add hourly job to check data

* ci: add workflow dispatch

* ci: limit diff to script/data

* ci: tweak label

* funding.yml

---------

Co-authored-by: Franco Victorio <[email protected]>

Author: mds1

.eslintrc.js

@@ -1,37 +1,37 @@
 module.exports = {
-  env: {
-    browser: true,
-    es2021: true,
-  },
-  extends: [
-    'next/core-web-vitals',
-    'eslint:recommended',
-    'plugin:@typescript-eslint/recommended',
-    'plugin:react/recommended',
-  ],
-  overrides: [
-    {
-      env: {
-        node: true,
-      },
-      files: ['.eslintrc.{js,cjs}'],
-      parserOptions: {
-        sourceType: 'script',
-      },
-    },
-  ],
-  parser: '@typescript-eslint/parser',
-  parserOptions: {
-    ecmaVersion: 'latest',
-    sourceType: 'module',
-  },
-  plugins: ['@typescript-eslint', 'react'],
-  rules: {
-    'react/react-in-jsx-scope': 'off',
-    // Allow unused variables that start with an underscore.
-    '@typescript-eslint/no-unused-vars': [
-      'error',
-      { argsIgnorePattern: '^_', varsIgnorePattern: '^_' },
-    ],
-  },
+	env: {
+		browser: true,
+		es2021: true,
+	},
+	extends: [
+		'next/core-web-vitals',
+		'eslint:recommended',
+		'plugin:@typescript-eslint/recommended',
+		'plugin:react/recommended',
+	],
+	overrides: [
+		{
+			env: {
+				node: true,
+			},
+			files: ['.eslintrc.{js,cjs}'],
+			parserOptions: {
+				sourceType: 'script',
+			},
+		},
+	],
+	parser: '@typescript-eslint/parser',
+	parserOptions: {
+		ecmaVersion: 'latest',
+		sourceType: 'module',
+	},
+	plugins: ['@typescript-eslint', 'react'],
+	rules: {
+		'react/react-in-jsx-scope': 'off',
+		// Allow unused variables that start with an underscore.
+		'@typescript-eslint/no-unused-vars': [
+			'error',
+			{ argsIgnorePattern: '^_', varsIgnorePattern: '^_' },
+		],
+	},
 };

.github/FUNDING.yml

@@ -0,0 +1 @@
+github: [mds1]

.github/workflows/ci.yml

@@ -10,43 +10,40 @@ on:
 jobs:
   build:
     runs-on: ubuntu-latest
-
     steps:
       - uses: actions/checkout@v4
-      - uses: pnpm/action-setup@v2
-        with:
-          version: latest
-
-      - name: Use Node.js 18.x
-        uses: actions/setup-node@v4
-        with:
-          node-version: 18.x
-          cache: 'pnpm'
+      - uses: oven-sh/setup-bun@v1
 
       - name: Install dependencies
-        run: pnpm install
+        run: bun install
 
-      # This runs `next lint` before building.
       - name: Build
-        run: pnpm build
+        run: bun run build
 
-  fmt:
+  lint:
     runs-on: ubuntu-latest
-
     steps:
       - uses: actions/checkout@v4
-      - uses: pnpm/action-setup@v2
-        with:
-          version: latest
+      - uses: oven-sh/setup-bun@v1
+
+      - name: Install dependencies
+        run: bun install
 
-      - name: Use Node.js 18.x
-        uses: actions/setup-node@v4
-        with:
-          node-version: 18.x
-          cache: 'pnpm'
+      - name: Check linting and formatting
+        run: bun check
+
+  chain-list:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: oven-sh/setup-bun@v1
 
       - name: Install dependencies
-        run: pnpm install
+        run: bun install
+
+      - name: Generate list of chains for the UI
+        run: bun prepare-chain-data
 
-      - name: Check formatting
-        run: pnpm fmt:check
+      # When this fails, run `bun prepare-chain-data` locally and commit the changes
+      - name: Ensure no diff
+        run: git diff --exit-code script/data

.github/workflows/fetch-data.yml

@@ -0,0 +1,55 @@
+name: Fetch Chain Data
+
+on:
+  workflow_dispatch:
+  schedule:
+    - cron: '0 * * * *'
+
+jobs:
+  fetch-data:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: oven-sh/setup-bun@v1
+
+      - name: Install dependencies
+        run: bun install
+
+      - name: Fetch data for all chains
+        run: bun fetch-data
+
+      - name: Check for changes
+        id: diff
+        run: |
+          if git diff --exit-code --quiet script/data; then
+            echo "No changes detected"
+          else
+            echo "::set-output name=changed::true"
+            exit 1
+          fi
+
+      - name: Check for existing open issue
+        if: failure() && steps.diff.outputs.changed == 'true'
+        id: existing_issue
+        run: |
+          issue_title="Chain Data Updated"
+          issue_search=$(gh issue list --state open --label "data mismatch" --limit 1 --json title --jq '.[].title')
+          if [[ "$issue_search" == "$issue_title" ]]; then
+            echo "::set-output name=exists::true"
+          else
+            echo "::set-output name=exists::false"
+          fi
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Open issue if changes detected and no existing open issue
+        if: failure() && steps.diff.outputs.changed == 'true' && steps.existing_issue.outputs.exists == 'false'
+        run: |
+          title="Chain Data Updated"
+          body="The chain data has been updated. Please review the changes.
+
+          Triggered by GitHub Actions run: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}"
+
+          gh issue create --title "$title" --body "$body" --label "data mismatch"
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.prettierignore

@@ -1,4 +1,5 @@
 .next
 pnpm-lock.yaml
 public/prism-light.css
-public/prism-dark.css
+public/prism-dark.css
+script/

CONTRIBUTING.md

@@ -1,38 +1,45 @@
 # Contributing
 
-This repo uses [Next.js](https://github.com/vercel/next.js/), [Tailwind CSS](https://github.com/tailwindlabs/tailwindcss), [TypeScript](https://github.com/microsoft/TypeScript), [pnpm](https://github.com/pnpm/pnpm), and [viem](https://github.com/wagmi-dev/viem). To get started:
+## Issues
+
+See the open [issues](https://github.com/mds1/evm-diff/issues) for current needs, and feel free to create new issues for bugs, feature requests, or other ideas.
+
+## Development
+
+If you are interested in working on an issue, please comment on the issue so it can be assigned to you.
+Before opening a PR, run `bun check` to ensure linting and formatting are correct.
+
+This repo uses [Next.js](https://github.com/vercel/next.js/), [Tailwind CSS](https://github.com/tailwindlabs/tailwindcss), [TypeScript](https://github.com/microsoft/TypeScript), [bun](https://bun.sh/), and [viem](https://github.com/wagmi-dev/viem).
+
+To get started building the app:
 
 ```sh
 # Install dependencies.
-pnpm install
+bun install
 
 # Start the development server.
-pnpm dev
+bun dev
 
 # Format files.
-pnpm fmt
-```
-
-See the open [issues](https://github.com/mds1/evm-diff/issues) for current needs, and feel free to create new issues for bugs, feature requests, or other ideas.
+bun fmt
 
-## Bounties
+# Lint.
+bun lint
 
-Most issues are eligible for bounties. Some issues will have something like "(bounty: X ETH 🔴)" at the end of the issue title, where `X ETH` is the number of ETH paid out for this bounty. Others will say nothing, but are still eligible—I just haven't gotten around to assigning a payment amount.
-
-To apply for and claim a bounty:
+# Add a new chain to the UI, format, and lint.
+bun check
+```
 
-1. If the issue has no bounty listed, message me on [Twitter](https://twitter.com/msolomon44), [Telegram](https://t.me/msolomon4), or [Discord](https://discordapp.com/users/417428774653657089) to work out an amount.
-2. Leave a brief comment explaining your work plan (may be very brief is issue is well-scoped), and wait to begin work until you are assigned to the issue. If you have any questions about the issue scope, you can ask in the issue or message me. (There is no guarantee that leaving a comment means you will be assigned, if multiple people are interested in the same issue).
-3. I'm not aware of any sufficient github issue bounty platforms, so there is no intermediary managing the bounties. This means you have to trust that I'll pay it out, which I will if the work meets the issue's requirements and is sufficiently high quality to close that issue.
-4. Feel free to open a draft PR before completion if you have any questions.
-5. Include your **OP Mainnet** payout address (all payouts will be on [OP Mainnet](https://docs.optimism.io/chain/networks#op-mainnet)) in the PR description, and once the PR is reviewed and merged I will transfer the ETH.
+To fetch chain data use the below commands.
+It's recommend to have an `INFURA_API_KEY` set in your environment to improve performance.
 
-## Architecture
+```bash
+# Fetch all data for a single chain.
+bun fetch-data [chainId]
 
-The specs for each chain live in `src/chains/[chainName]/*.ts`.
-Each chain's folder is structured similar to the [ethereum/execution-specs](https://github.com/ethereum/execution-specs) repo.
-For example, the `src/ethereum/shanghai` folder in that repo contains the specs for the latest hard fork (Shanghai) on Ethereum mainnet, and information about precompiles lives in the `vm/precompiled_contracts` subfolder.
-That folder contains one file for each precompile.
-Since EVM Diff doesn't have to actually implement the precompiles, we just use a single file for all precompile data, which lives in this repo at `src/chains/mainnet/vm/precompiles.ts`.
+# Fetch all data for all chains.
+bun fetch-data
 
-As more aspects of the execution spec are added, they should be added in such a way to continue this pattern of mirroring the structure of the execution-specs repo.
+# Add a new chain to the UI, format, and lint.
+bun check
+```

README.md

@@ -2,9 +2,6 @@
 
 Diff EVM-compatible chains in a friendly format.
 
-> [!NOTE]
-> This site is under active development. Check out the [issues](https://github.com/mds1/evm-diff/issues) if you'd like to contribute.
-
 ## Overview
 
 There are lots of EVM-compatible chains, and they can differ in various, subtle ways.

biome.jsonc

@@ -0,0 +1,33 @@
+{
+	"$schema": "https://biomejs.dev/schemas/1.6.4/schema.json",
+	"files": {
+		"ignore": ["archive/**/*", ".next/**/*"]
+	},
+	"organizeImports": {
+		"enabled": true
+	},
+	"formatter": {
+		"lineWidth": 100
+	},
+	"javascript": {
+		"formatter": {
+			"quoteStyle": "single"
+		}
+	},
+	"linter": {
+		"enabled": true,
+		"rules": {
+			"recommended": true,
+			"suspicious": {
+				"noExplicitAny": "off", // Checked by eslint.
+				"noArrayIndexKey": "off" // Sometimes required based on array data.
+			},
+			"a11y": {
+				"all": false // This causes a lot of changes, will enable it later.
+			},
+			"complexity": {
+				"useSimpleNumberKeys": "off"
+			}
+		}
+	}
+}

bun.lockb

@@ -1,10 +1,10 @@
 module.exports = {
-  images: {
-    remotePatterns: [
-      {
-        protocol: 'https',
-        hostname: 'icons.llamao.fi',
-      },
-    ],
-  },
+	images: {
+		remotePatterns: [
+			{
+				protocol: 'https',
+				hostname: 'icons.llamao.fi',
+			},
+		],
+	},
 };