feat!: upgrade to v4x.x.x

.eslintrc

@@ -4,7 +4,7 @@
     "es2021": true,
     "node": true
   },
-  "plugins": ["import"],
+  "plugins": ["import", "eslint-rules"],
   "parserOptions": {
     "sourceType": "module"
   },
@@ -29,30 +29,48 @@
         "enableFixer": true
       }
     ],
-    "jsdoc/require-jsdoc": [
-      "warn",
+    "jsdoc/require-param-type": "error",
+    "jsdoc/require-returns-type": "error",
+    "jsdoc/no-types": "off",
+    "jsdoc/require-jsdoc": "off",
+    "jsdoc/match-description": [
+      "error",
       {
-        "publicOnly": {
-          "ancestorsOnly": true
-        },
-        "enableFixer": false,
-        "require": {
-          "FunctionDeclaration": true,
-          "MethodDefinition": true,
-          "ClassDeclaration": true,
-          "ArrowFunctionExpression": true
+        "matchDescription": "[A-Z].*",
+        "tags": {
+          "example": {
+            "message": "Example tags must provide a code block with a language identifier.",
+            "match": "```(js|javascript|ts|tsx)([\\s\\S]*)```"
+          }
         }
       }
+    ],
+    "eslint-rules/require-jsdoc-on-reexported-functions": [
+      "error",
+      {
+        "fixBatchSize": 0
+      }
     ]
   },
   "overrides": [
     {
-      "files": ["site/snippets/**/*.ts", "site/snippets/**/*.tsx"],
+      "files": [
+        "site/snippets/**/*.ts",
+        "site/snippets/**/*.tsx",
+        "**/site/**/*.mdx"
+      ],
       "rules": {
         "@typescript-eslint/no-unused-vars": "off",
         "import/extensions": ["off", "ignorePackages"],
         "jsdoc/require-jsdoc": "off"
       }
+    },
+    {
+      "files": ["**/*.mdx"],
+      "extends": ["plugin:mdx/recommended"],
+      "settings": {
+        "import/extensions": ["off", "ignorePackages"]
+      }
     }
   ]
 }

.gitattributes

@@ -0,0 +1,3 @@
+.site/**/*/reference/**/*.md linguist-generated
+site/**/*/reference/**/*.mdx linguist-generated
+site/sidebar/**/*.ts linguist-generated

.github/actions/setup-node/action.yml

@@ -0,0 +1,31 @@
+name: 'Setup Node with Cache'
+description: 'Setup Node.js with caching for node_modules and install dependencies'
+inputs:
+  node-version:
+    description: 'Node.js version'
+    required: false
+    default: '22'
+
+runs:
+  using: 'composite'
+  steps:
+    - name: Setup Node.js
+      uses: actions/setup-node@v3
+      with:
+        node-version: ${{ inputs.node-version }}
+        cache: yarn
+
+    - name: Install dependencies
+      run: yarn install --frozen-lockfile
+      shell: bash
+
+    - name: Cache Nx and Node modules
+      id: cache-nx
+      uses: actions/cache@v3
+      with:
+        path: |
+          .nx
+          node_modules/.cache/nx
+        key: ${{ runner.os }}-nx-${{ hashFiles('**/yarn.lock') }}
+        restore-keys: |
+          ${{ runner.os }}-nx-

.github/workflows/on-pull-request.yml

@@ -9,14 +9,8 @@ jobs:
     steps:
       - uses: actions/checkout@v2
 
-      - name: Setup Node.js
-        uses: actions/setup-node@v3
-        with:
-          node-version: 18
-          cache: "yarn"
-
-      - name: Install dependencies
-        run: yarn install --frozen-lockfile
+      - name: Setup Node
+        uses: ./.github/actions/setup-node
 
       - name: Use commitlint to check PR title
         env:
@@ -31,20 +25,19 @@ jobs:
       pull-requests: write 
     env:
       REVIEWDOG_GITHUB_API_TOKEN: ${{ secrets.ALCHEMY_BOT_PAT }}
+      OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
     steps:
       - uses: actions/checkout@v3
         with:
           token: ${{ secrets.ALCHEMY_BOT_PAT }}
           fetch-depth: "0"
 
-      - name: Setup Node.js
-        uses: actions/setup-node@v3
-        with:
-          node-version: 18
-          cache: "yarn"
+      - name: Setup Node
+        uses: ./.github/actions/setup-node
 
-      - name: Install dependencies
-        run: yarn install --frozen-lockfile
+      - name: Build eslint plugin
+        run: |
+          cd templates/eslint && yarn build
 
       - uses: reviewdog/action-setup@v1
         with:
@@ -53,6 +46,9 @@ jobs:
       - name: Run eslint with reviewdog
         run: |
           npx --no-install -c "eslint -f=rdjson ." | reviewdog -f=rdjson -reporter=github-pr-review -filter-mode=added -tee
+
+      - name: Run eslint for errors
+        run: yarn lint:check
 
   build_and_lint_and_test:
     name: Build and Test
@@ -65,14 +61,26 @@ jobs:
           fetch-depth: "0"
           submodules: "recursive"
 
-      - name: Setup Node.js
-        uses: actions/setup-node@v3
+      # using your own fork url avoids getting rate limited by the public api
+      # later we'll look at deploying everything we need directly to anvil so
+      # so we don't need a fork url
+      - name: Conditionally set fork url
+        if: ${{ env.API_KEY != '' }}
+        run: echo "VITEST_SEPOLIA_FORK_URL=https://eth-sepolia.g.alchemy.com/v2/${{ env.API_KEY }}" >> $GITHUB_ENV
+
+      - name: Set up foundry
+        uses: foundry-rs/foundry-toolchain@v1
+
+      - name: Set up Rundler
+        uses: jaxxstorm/[email protected]
         with:
-          node-version: 18
-          cache: "yarn"
+          repo: alchemyplatform/rundler
+          platform: linux
+          tag: v0.2.2
+          cache: enable
 
-      - name: Install dependencies
-        run: yarn install --frozen-lockfile
+      - name: Setup Node
+        uses: ./.github/actions/setup-node
 
       - name: Build
         uses: nick-fields/retry@v3
@@ -81,7 +89,8 @@ jobs:
         with:
           timeout_minutes: 5
           max_attempts: 2
-          command: yarn build
+          # it's ok to run the dev build here because the site gets built in vercel for each branch
+          command: yarn build:dev
 
       - name: Unit Test
-        run: yarn test
+        run: yarn test:ci

.github/workflows/publish-package.yml

@@ -46,10 +46,13 @@ jobs:
           fetch-depth: "0"
           submodules: "recursive"
 
-      - name: Set Node.js 18.x
+      - name: Set up foundry
+        uses: foundry-rs/foundry-toolchain@v1
+
+      - name: Set Node.js 22.x
         uses: actions/setup-node@v3
         with:
-          node-version: 18
+          node-version: 22
           cache: "yarn"
 
       - name: Set Github User Details
@@ -63,7 +66,7 @@ jobs:
         run: echo "//registry.npmjs.org/:_authToken=$NPM_TOKEN" > .npmrc
 
       - name: Install dependencies
-        run: yarn
+        run: yarn install --frozen-lockfile
 
       - name: Build
         env:

.gitignore

@@ -33,3 +33,5 @@ site/**/*.js
 **/userop.json
 
 vocs.config.tsx.timestamp-*.mjs
+
+bin

.vitest/globalSetup.ts

@@ -0,0 +1,30 @@
+import dotenv from "dotenv";
+dotenv.config();
+
+import isCi from "is-ci";
+import { rundlerBinaryPath } from "./src/constants";
+import * as instances from "./src/instances";
+import {
+  cleanupRundler,
+  downloadLatestRundlerRelease,
+  isRundlerInstalled,
+} from "./src/rundler";
+
+export default async function () {
+  if (!isCi && !(await isRundlerInstalled(rundlerBinaryPath))) {
+    await downloadLatestRundlerRelease(rundlerBinaryPath);
+  }
+
+  const shutdown = await Promise.all(
+    Object.values(instances).map(async (instance) => {
+      const shutdown = instance.start();
+
+      return shutdown;
+    })
+  );
+
+  return async () => {
+    await Promise.all(shutdown.map((stop) => stop()));
+    await cleanupRundler(rundlerBinaryPath);
+  };
+}

.vitest/package.json

@@ -0,0 +1,17 @@
+{
+  "name": "local-vitest",
+  "version": "0.0.0",
+  "private": true,
+  "type": "module",
+  "devDependencies": {
+    "@types/is-ci": "^3.0.4",
+    "is-ci": "^3.0.1",
+    "prool": "^0.0.15",
+    "tar": "^7.4.1",
+    "typescript-template": "*",
+    "viem": "2.20.0"
+  },
+  "dependencies": {
+    "@aa-sdk/core": "^4.0.0-alpha.8"
+  }
+}

.vitest/setupTests.ts

@@ -1,6 +1,39 @@
 import dotenv from "dotenv";
-import fetch from "node-fetch";
 dotenv.config();
 
-// @ts-expect-error wut
+import fetch from "node-fetch";
+import { setAutomine } from "viem/actions";
+import { beforeAll } from "vitest";
+import { poolId } from "./src/constants.js";
+import { local060Instance, local070Instance } from "./src/instances.js";
+import { paymaster060 } from "./src/paymaster/paymaster060.js";
+import { paymaster070 } from "./src/paymaster/paymaster070.js";
+
+// @ts-expect-error this does exist but ts is not liking it
 global.fetch = fetch;
+
+beforeAll(async () => {
+  const client060 = local060Instance.getClient();
+  const client070 = local070Instance.getClient();
+  await setAutomine(client060, true);
+  await setAutomine(client070, true);
+
+  await paymaster060.deployPaymasterContract(client060);
+  await paymaster070.deployPaymasterContract(client070);
+}, 60_000);
+
+afterEach(() => {
+  onTestFailed(async () => {
+    console.log(`Logs for failed test [${poolId()}]:`);
+    console.log(await local060Instance.getLogs("anvil"));
+    console.log(await local060Instance.getLogs("bundler"));
+
+    console.log(await local070Instance.getLogs("anvil"));
+    console.log(await local070Instance.getLogs("bundler"));
+  });
+});
+
+afterAll(async () => {
+  await local060Instance.restart();
+  await local070Instance.restart();
+});

.vitest/src/Proxy.ts

@@ -0,0 +1,70 @@
+export const ERC1967ProxyAbi = {
+  abi: [
+    {
+      type: "constructor",
+      inputs: [
+        { name: "_logic", type: "address", internalType: "address" },
+        { name: "_data", type: "bytes", internalType: "bytes" },
+      ],
+      stateMutability: "payable",
+    },
+    { type: "fallback", stateMutability: "payable" },
+    { type: "receive", stateMutability: "payable" },
+    {
+      type: "event",
+      name: "AdminChanged",
+      inputs: [
+        {
+          name: "previousAdmin",
+          type: "address",
+          indexed: false,
+          internalType: "address",
+        },
+        {
+          name: "newAdmin",
+          type: "address",
+          indexed: false,
+          internalType: "address",
+        },
+      ],
+      anonymous: false,
+    },
+    {
+      type: "event",
+      name: "BeaconUpgraded",
+      inputs: [
+        {
+          name: "beacon",
+          type: "address",
+          indexed: true,
+          internalType: "address",
+        },
+      ],
+      anonymous: false,
+    },
+    {
+      type: "event",
+      name: "Upgraded",
+      inputs: [
+        {
+          name: "implementation",
+          type: "address",
+          indexed: true,
+          internalType: "address",
+        },
+      ],
+      anonymous: false,
+    },
+  ],
+  bytecode: {
+    object:
+      "0x60406080815261042c908138038061001681610218565b93843982019181818403126102135780516001600160a01b038116808203610213576020838101516001600160401b0394919391858211610213570186601f820112156102135780519061007161006c83610253565b610218565b918083528583019886828401011161021357888661008f930161026e565b813b156101b9577f360894a13ba1a3210667c828492db98dca3e2076cc3735a920a3ca505d382bbc80546001600160a01b031916841790556000927fbc7cd75a20ee27fd9adebab32041f755214dbc6bffa90cc0225b39da2e5c2d3b8480a28051158015906101b2575b61010b575b855160e790816103458239f35b855194606086019081118682101761019e578697849283926101889952602788527f416464726573733a206c6f772d6c6576656c2064656c65676174652063616c6c87890152660819985a5b195960ca1b8a8901525190845af4913d15610194573d9061017a61006c83610253565b91825281943d92013e610291565b508038808080806100fe565b5060609250610291565b634e487b7160e01b84526041600452602484fd5b50826100f9565b855162461bcd60e51b815260048101859052602d60248201527f455243313936373a206e657720696d706c656d656e746174696f6e206973206e60448201526c1bdd08184818dbdb9d1c9858dd609a1b6064820152608490fd5b600080fd5b6040519190601f01601f191682016001600160401b0381118382101761023d57604052565b634e487b7160e01b600052604160045260246000fd5b6001600160401b03811161023d57601f01601f191660200190565b60005b8381106102815750506000910152565b8181015183820152602001610271565b919290156102f357508151156102a5575090565b3b156102ae5790565b60405162461bcd60e51b815260206004820152601d60248201527f416464726573733a2063616c6c20746f206e6f6e2d636f6e74726163740000006044820152606490fd5b8251909150156103065750805190602001fd5b6044604051809262461bcd60e51b825260206004830152610336815180928160248601526020868601910161026e565b601f01601f19168101030190fdfe60806040523615605f5773ffffffffffffffffffffffffffffffffffffffff7f360894a13ba1a3210667c828492db98dca3e2076cc3735a920a3ca505d382bbc54166000808092368280378136915af43d82803e15605b573d90f35b3d90fd5b73ffffffffffffffffffffffffffffffffffffffff7f360894a13ba1a3210667c828492db98dca3e2076cc3735a920a3ca505d382bbc54166000808092368280378136915af43d82803e15605b573d90f3fea26469706673582212202e7baf1368345efcec935186bf9faf2338cba6a5337e8e5fdf2e25a91695dad464736f6c63430008110033",
+    linkReferences: {},
+  },
+  deployedBytecode: {
+    object:
+      "0x60806040523615605f5773ffffffffffffffffffffffffffffffffffffffff7f360894a13ba1a3210667c828492db98dca3e2076cc3735a920a3ca505d382bbc54166000808092368280378136915af43d82803e15605b573d90f35b3d90fd5b73ffffffffffffffffffffffffffffffffffffffff7f360894a13ba1a3210667c828492db98dca3e2076cc3735a920a3ca505d382bbc54166000808092368280378136915af43d82803e15605b573d90f3fea26469706673582212202e7baf1368345efcec935186bf9faf2338cba6a5337e8e5fdf2e25a91695dad464736f6c63430008110033",
+    linkReferences: {},
+  },
+  methodIdentifiers: {},
+} as const;