wip: agnostic core

.github/workflows/build-test.yml

@@ -18,15 +18,17 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v4
 
+      - name: Install pnpm
+        uses: pnpm/action-setup@v4
+
       - name: Set up Node.js
         uses: actions/setup-node@v4
         with:
           node-version: ${{ matrix.node-version }}
+          cache: 'pnpm'
 
-      - name: Install node_modules
-        uses: OffchainLabs/actions/node-modules/install@main
-        with:
-          cache-key: ${{ runner.os }}-yarn-${{ hashFiles('yarn.lock') }}-monorepo
+      - name: Install dependencies
+        run: pnpm install --frozen-lockfile
 
   lint:
     name: Lint on Node.js v${{ matrix.node-version }}
@@ -43,21 +45,23 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v4
 
+      - name: Install pnpm
+        uses: pnpm/action-setup@v4
+
       - name: Set up Node.js
         uses: actions/setup-node@v4
         with:
           node-version: ${{ matrix.node-version }}
+          cache: 'pnpm'
 
-      - name: Install node_modules
-        uses: OffchainLabs/actions/node-modules/install@main
-        with:
-          cache-key: ${{ runner.os }}-yarn-${{ hashFiles('yarn.lock') }}-monorepo
+      - name: Install dependencies
+        run: pnpm install --frozen-lockfile
 
       - name: Lint sdk
         run: |
-          yarn gen:abi
-          yarn build
-          yarn lint --format junit -o $TEST_PATH/sdk-lint.xml
+          pnpm gen:abi
+          pnpm build
+          pnpm lint --format junit -o $TEST_PATH/sdk-lint.xml
 
       - name: Upload build artifacts
         uses: actions/upload-artifact@v4
@@ -83,17 +87,19 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v4
 
+      - name: Install pnpm
+        uses: pnpm/action-setup@v4
+
       - name: Set up Node.js
         uses: actions/setup-node@v4
         with:
           node-version: ${{ matrix.node-version }}
+          cache: 'pnpm'
 
-      - name: Install node_modules
-        uses: OffchainLabs/actions/node-modules/install@main
-        with:
-          cache-key: ${{ runner.os }}-yarn-${{ hashFiles('yarn.lock') }}-monorepo
+      - name: Install dependencies
+        run: pnpm install --frozen-lockfile
 
-      - run: yarn audit:ci
+      - run: pnpm audit:ci
 
   test-unit:
     name: Test (Unit) on Node.js v${{ matrix.node-version }}
@@ -106,23 +112,25 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v4
 
+      - name: Install pnpm
+        uses: pnpm/action-setup@v4
+
       - name: Set up Node.js
         uses: actions/setup-node@v4
         with:
           node-version: ${{ matrix.node-version }}
+          cache: 'pnpm'
 
-      - name: Install node_modules
-        uses: OffchainLabs/actions/node-modules/install@main
-        with:
-          cache-key: ${{ runner.os }}-yarn-${{ hashFiles('yarn.lock') }}-monorepo
+      - name: Install dependencies
+        run: pnpm install --frozen-lockfile
 
       - name: Build
         run: |
-          yarn gen:abi
-          yarn build
+          pnpm gen:abi
+          pnpm build
 
       - name: Run unit tests
-        run: CI=true yarn test:unit
+        run: CI=true pnpm test:unit
 
   test-integration:
     name: Test (Integration) on Node.js v${{ matrix.node-version }}${{ matrix.orbit-test == '1' && ' with L3' || '' }}${{ matrix.decimals == '16' && ' with custom gas token (16 decimals)' || matrix.decimals == '20' && ' with custom gas token (20 decimals)' || matrix.decimals == '18' && ' with custom gas token (18 decimals)' || '' }}
@@ -157,15 +165,17 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v4
 
+      - name: Install pnpm
+        uses: pnpm/action-setup@v4
+
       - name: Set up Node.js
         uses: actions/setup-node@v4
         with:
           node-version: ${{ matrix.node-version }}
+          cache: 'pnpm'
 
-      - name: Install node_modules
-        uses: OffchainLabs/actions/node-modules/install@main
-        with:
-          cache-key: ${{ runner.os }}-yarn-${{ hashFiles('yarn.lock') }}-monorepo
+      - name: Install dependencies
+        run: pnpm install --frozen-lockfile
 
       - name: Set up the local node
         uses: OffchainLabs/actions/run-nitro-test-node@main
@@ -179,13 +189,13 @@ jobs:
 
       - name: Build
         run: |
-          yarn gen:abi
-          yarn build
+          pnpm gen:abi
+          pnpm build
 
       - name: Generate network file
-        run: yarn gen:network
+        run: pnpm gen:network
 
       - name: Run integration tests
         env:
           NODE_OPTIONS: --no-experimental-strip-types
-        run: CI=true yarn test:integration
+        run: CI=true pnpm test:integration

.npmrc

@@ -1 +1,6 @@
 engine-strict = true
+public-hoist-pattern[]=@types/*
+public-hoist-pattern[]=@ethersproject/*
+public-hoist-pattern[]=typescript
+public-hoist-pattern[]=*eslint*
+public-hoist-pattern[]=*prettier*

.vscode/launch.json

@@ -5,17 +5,17 @@
       "type": "node",
       "request": "launch",
       "name": "Run Unit Tests",
-      "runtimeExecutable": "yarn",
-      "runtimeVersion": "18",
+      "runtimeExecutable": "pnpm",
+      "runtimeVersion": "24",
       "runtimeArgs": ["test:unit"],
       "skipFiles": ["<node_internals>/**"]
     },
     {
       "type": "node",
       "request": "launch",
       "name": "Run Integration Tests",
-      "runtimeExecutable": "yarn",
-      "runtimeVersion": "18",
+      "runtimeExecutable": "pnpm",
+      "runtimeVersion": "24",
       "runtimeArgs": ["test:integration"],
       "skipFiles": ["<node_internals>/**"]
     }

README.md

@@ -40,6 +40,10 @@ npm install @arbitrum/sdk
 # or
 
 yarn add @arbitrum/sdk
+
+# or
+
+pnpm add @arbitrum/sdk
 ```
 
 ## Key Features
@@ -92,13 +96,13 @@ For more detailed usage examples and API references, please refer to the [Arbitr
 3. Generate the network configuration against your active Nitro test node:
 
    ```sh
-   yarn gen:network
+   pnpm gen:network
    ```
 
 4. Execute the integration tests:
 
    ```sh
-   yarn test:integration
+   pnpm test:integration
    ```
 
 ## Documentation

audit-ci.jsonc

@@ -174,6 +174,22 @@
     // https://github.com/advisories/GHSA-4992-7rv2-5pvq
     // undici CRLF injection via `upgrade` option
     // from: hardhat>undici
-    "GHSA-4992-7rv2-5pvq"
+    "GHSA-4992-7rv2-5pvq",
+
+    // sol2uml transitive dev deps (dev-only, diagram generation for contracts)
+    // These surfaced under pnpm where yarn's resolutions had previously shadowed them.
+    // from: @offchainlabs/l1-l3-teleport-contracts>@arbitrum/nitro-contracts>sol2uml>...
+    // https://github.com/advisories/GHSA-xxjr-mmjv-4gpg — lodash
+    "GHSA-xxjr-mmjv-4gpg",
+    // https://github.com/advisories/GHSA-r5fr-rjxr-66jc — lodash
+    "GHSA-r5fr-rjxr-66jc",
+    // https://github.com/advisories/GHSA-f23m-r3pf-42rh — lodash
+    "GHSA-f23m-r3pf-42rh",
+    // https://github.com/advisories/GHSA-r4q5-vmmm-2653 — follow-redirects
+    "GHSA-r4q5-vmmm-2653",
+    // https://github.com/advisories/GHSA-3p68-rc4w-qgx5 — axios
+    "GHSA-3p68-rc4w-qgx5",
+    // https://github.com/advisories/GHSA-fvcv-3m26-pcqx — axios
+    "GHSA-fvcv-3m26-pcqx"
   ]
 }

package.json

@@ -1,19 +1,15 @@
 {
   "private": true,
+  "packageManager": "pnpm@10.33.0",
   "scripts": {
     "audit:ci": "audit-ci --config ./audit-ci.jsonc",
-    "build": "yarn workspace @arbitrum/sdk build",
-    "lint": "yarn workspaces run lint",
-    "format": "yarn workspaces run format",
-    "test:unit": "yarn workspaces run test:unit",
-    "test:integration": "yarn workspace @arbitrum/sdk test:integration",
-    "gen:abi": "yarn workspace @arbitrum/sdk gen:abi",
-    "gen:network": "yarn workspace @arbitrum/sdk gen:network"
-  },
-  "workspaces": {
-    "packages": [
-      "packages/*"
-    ]
+    "build": "pnpm --filter @arbitrum/core build && pnpm --filter @arbitrum/ethers5 build && pnpm --filter @arbitrum/ethers6 build && pnpm --filter @arbitrum/viem build && pnpm --filter @arbitrum/sdk build",
+    "lint": "pnpm -r run lint",
+    "format": "pnpm -r run format",
+    "test:unit": "pnpm --filter @arbitrum/core test:unit && pnpm --filter @arbitrum/ethers5 test:unit && pnpm --filter @arbitrum/ethers6 test:unit && pnpm --filter @arbitrum/viem test:unit",
+    "test:integration": "pnpm --filter @arbitrum/ethers5 test:integration && pnpm --filter @arbitrum/ethers6 test:integration && pnpm --filter @arbitrum/viem test:integration",
+    "gen:abi": "pnpm --filter @arbitrum/sdk gen:abi && pnpm --filter @arbitrum/core gen:abi",
+    "gen:network": "pnpm --filter @arbitrum/sdk gen:network"
   },
   "devDependencies": {
     "@arbitrum/nitro-contracts": "^1.1.1",
@@ -53,44 +49,44 @@
     "vitest": "^4.1.2",
     "yargs": "^17.3.1"
   },
-  "resolutions": {
-    "lodash.pick": "https://github.com/lodash/lodash/archive/refs/tags/4.17.21.tar.gz",
-    "**/@ethersproject/providers/ws": "7.5.10",
-    "**/puppeteer/ws": "8.17.1",
-    "**/puppeteer/tar-fs": "2.1.4",
-    "**/hardhat/ws": "7.5.10",
-    "**/hardhat/@sentry/node/cookie": "0.7.0",
-    "**/follow-redirects": "1.15.6",
-    "**/micromatch": "4.0.8",
-    "**/elliptic": "6.6.1",
-    "**/secp256k1": "4.0.4",
-    "**/nanoid": "3.3.8",
-    "**/serialize-javascript": "6.0.2",
-    "**/patch-package/cross-spawn": "6.0.6",
-    "**/eslint/cross-spawn": "7.0.5",
-    "**/foreground-child/cross-spawn": "7.0.5",
-    "**/istanbul-lib-processinfo/cross-spawn": "7.0.5",
-    "**/istanbul-lib-instrument/@babel/core/@babel/helpers": "7.26.10",
-    "**/hardhat/undici": "5.29.0",
-    "**/chokidar/braces": "3.0.3",
-    "**/sol2uml/axios": "0.30.2",
-    "**/brace-expansion": "1.1.12",
-    "**/mocha/minimatch/brace-expansion": "2.0.2",
-    "**/convert-svg-core/glob/minimatch/brace-expansion": "2.0.2",
-    "**/eslint/js-yaml": "3.14.2",
-    "**/eslint/@eslint/eslintrc/js-yaml": "3.14.2",
-    "**/mocha/js-yaml": "4.1.1",
-    "**/diff": "5.2.2",
-    "**/anymatch/picomatch": "2.3.2",
-    "**/readdirp/picomatch": "2.3.2",
-    "**/micromatch/picomatch": "2.3.2",
-    "**/tinyglobby/picomatch": "4.0.4",
-    "**/form-data": "4.0.5",
-    "**/lodash": "4.18.1",
-    "**/minimatch": "3.1.5",
-    "**/immutable": "4.3.8",
-    "**/flatted": "3.4.2",
-    "**/patch-package/yaml": "1.10.3",
-    "**/vite": "8.0.5"
+  "pnpm": {
+    "overrides": {
+      "lodash.pick": "https://github.com/lodash/lodash/archive/refs/tags/4.17.21.tar.gz",
+      "@ethersproject/providers>ws": "7.5.10",
+      "puppeteer>ws": "8.17.1",
+      "puppeteer>tar-fs": "2.1.4",
+      "hardhat>ws": "7.5.10",
+      "@sentry/node>cookie": "0.7.0",
+      "follow-redirects": "1.15.6",
+      "micromatch": "4.0.8",
+      "elliptic": "6.6.1",
+      "secp256k1": "4.0.4",
+      "nanoid": "3.3.8",
+      "serialize-javascript": "6.0.2",
+      "patch-package>cross-spawn": "6.0.6",
+      "eslint>cross-spawn": "7.0.5",
+      "foreground-child>cross-spawn": "7.0.5",
+      "istanbul-lib-processinfo>cross-spawn": "7.0.5",
+      "@babel/core>@babel/helpers": "7.26.10",
+      "hardhat>undici": "5.29.0",
+      "chokidar>braces": "3.0.3",
+      "sol2uml>axios": "0.30.2",
+      "brace-expansion": "1.1.12",
+      "eslint>js-yaml": "3.14.2",
+      "@eslint/eslintrc>js-yaml": "3.14.2",
+      "mocha>js-yaml": "4.1.1",
+      "diff": "5.2.2",
+      "anymatch>picomatch": "2.3.2",
+      "readdirp>picomatch": "2.3.2",
+      "micromatch>picomatch": "2.3.2",
+      "tinyglobby>picomatch": "4.0.4",
+      "form-data": "4.0.5",
+      "lodash": "4.18.1",
+      "minimatch": "3.1.5",
+      "immutable": "4.3.8",
+      "flatted": "3.4.2",
+      "patch-package>yaml": "1.10.3",
+      "vite": "8.0.5"
+    }
   }
 }

packages/core/package.json

@@ -0,0 +1,43 @@
+{
+  "name": "@arbitrum/core",
+  "version": "0.1.0",
+  "description": "Provider-agnostic core library for Arbitrum SDK",
+  "license": "Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/OffchainLabs/arbitrum-sdk.git",
+    "directory": "packages/core"
+  },
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.js"
+    },
+    "./abi": {
+      "types": "./dist/abi/index.d.ts",
+      "import": "./dist/abi/index.js",
+      "require": "./dist/abi/index.js"
+    }
+  },
+  "files": ["dist", "package.json", "README.md", "LICENSE"],
+  "scripts": {
+    "gen:abi": "ts-node ./scripts/genAbi.ts",
+    "build": "tsc",
+    "test": "vitest run",
+    "test:unit": "vitest run --exclude '**/tests/integration/**'",
+    "lint": "echo 'lint not configured yet'",
+    "format": "echo 'format not configured yet'"
+  },
+  "dependencies": {
+    "abitype": "^1.0.8",
+    "@noble/hashes": "^1.7.1",
+    "async-mutex": "^0.4.0"
+  },
+  "devDependencies": {
+    "typescript": "^5.7.2",
+    "vitest": "^4.1.1"
+  }
+}