Modernized viem SDK + separate Ethers SDK, both using shared core

.changeset/config.json

@@ -1,11 +1,11 @@
 {
-  "$schema": "https://unpkg.com/@changesets/config@2.3.0/schema.json",
-  "changelog": "@changesets/cli/changelog",
-  "commit": false,
-  "fixed": [],
-  "linked": [],
-  "access": "restricted",
-  "baseBranch": "main",
-  "updateInternalDependencies": "patch",
-  "ignore": ["vite-wagmi"]
+	"$schema": "https://unpkg.com/@changesets/config@2.3.0/schema.json",
+	"changelog": "@changesets/cli/changelog",
+	"commit": false,
+	"fixed": [],
+	"linked": [],
+	"access": "public",
+	"baseBranch": "main",
+	"updateInternalDependencies": "patch",
+	"ignore": ["vite-wagmi"]
 }

.changeset/viem-first-sdk.md

@@ -0,0 +1,59 @@
+---
+"@tokenbound/sdk": major
+"@tokenbound/ethers": minor
+---
+
+Make `@tokenbound/sdk` viem-first and move ethers v5/v6 support into a new
+`@tokenbound/ethers` package.
+
+**`@tokenbound/sdk`**
+
+- Removed the `signer` option and all ethers-specific types, utilities and
+  runtime branches. The SDK no longer has ethers anywhere in its dependency
+  graph.
+- Added an idiomatic viem client decorator: `.extend(tokenboundActions())`
+  exposes the API under `client.tokenbound.*`, with write actions typed only for
+  clients that carry an account.
+- Extracted a library-independent protocol layer (`@tokenbound/sdk/protocol`)
+  that operates on `Address`/`Hex`/`bigint`/chain ids/ABIs, shared by the viem
+  core and `@tokenbound/ethers`.
+- **Breaking:** `chain` is now required; passing only `chainId` is no longer
+  supported. The internal `chainIdToChain` lookup eagerly imported 17 chains
+  from `viem/chains` into every consumer bundle.
+- **Breaking:** the constructor `chainId` option is removed; the chain id now
+  always comes from `chain`. Per-method `chainId` params (cross-chain execution,
+  deriving an account for another chain) are unchanged.
+- **Breaking:** `signMessage` accepts only viem's `SignableMessage`.
+- Added `./viem` and `./protocol` subpath exports and `"sideEffects": false`.
+- Relocated the ERC-6551 ABIs out of the test tree, so generated test fixtures
+  (Zora, WETH) no longer end up in the published bundle.
+- Bundle: 251.7 kB → 15.9 kB (74.5 kB → 3.8 kB gzipped). Published tarball:
+  226.2 kB → ~80 kB. Bundle analysis is now opt-in (`ANALYZE=true pnpm build`)
+  and no longer writes a 668 kB `stats.html` into `dist/`.
+
+**`@tokenbound/ethers`** (new)
+
+- Ethers v5 and v6 compatibility, detected automatically at construction.
+- Same public API as the SDK's `TokenboundClient`, so ethers users migrate by
+  changing the import and passing a `chain`.
+- Reuses all ERC-6551 protocol logic from `@tokenbound/sdk`; no duplication.
+
+**Examples**
+
+- Updated the viem example to the `.extend(tokenboundActions())` API, and
+  repointed the ethers examples at `@tokenbound/ethers`.
+- Bumped the examples to Vite 5. Vite 4 bundles esbuild 0.18, which cannot parse
+  the import attributes (`with { type: "json" }`) used by `@base-org/account` via
+  wagmi's connectors, so `vite dev` failed to start.
+
+**Packaging / tooling**
+
+- Added `description`, `keywords`, `repository`, `homepage` and `bugs` to both
+  packages — none were previously set, so npm had no linked source or issues.
+- Dropped unused React/testing-library devDependencies from `@tokenbound/sdk`
+  (no React components or DOM tests remain) and removed the dead jest-dom test
+  setup file.
+- Switched `moduleResolution` from the deprecated `Node` (node10, removed in
+  TypeScript 7) to `Bundler`, which also resolves the package `exports` map.
+
+See `MIGRATION.md` for full migration notes.

.github/workflows/ci.yml

@@ -0,0 +1,95 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+jobs:
+  build-and-validate:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: pnpm/action-setup@v4
+        with:
+          version: 10
+
+      - uses: actions/setup-node@v4
+        with:
+          node-version-file: .nvmrc
+          cache: pnpm
+
+      - name: Install dependencies
+        run: pnpm install --frozen-lockfile
+
+      - name: Lint and format check
+        run: pnpm biome ci .
+
+      - name: Typecheck @tokenbound/sdk
+        run: pnpm --filter @tokenbound/sdk exec tsc --noEmit
+
+      - name: Build @tokenbound/sdk
+        run: pnpm --filter @tokenbound/sdk build
+
+      - name: Typecheck @tokenbound/ethers
+        run: pnpm --filter @tokenbound/ethers exec tsc --noEmit
+
+      - name: Build @tokenbound/ethers
+        run: pnpm --filter @tokenbound/ethers build
+
+      # Fails if tests, examples, stats.html, coverage or raw sources would be
+      # published, and reports packed/unpacked sizes so regressions are visible.
+      - name: Validate published package contents
+        run: node scripts/validate-package-contents.mjs
+
+      - name: Assert @tokenbound/sdk pulls in no ethers
+        run: |
+          if pnpm --filter @tokenbound/sdk why ethers 2>/dev/null | grep -q 'ethers@'; then
+            echo "::error::@tokenbound/sdk must not depend on ethers"
+            pnpm --filter @tokenbound/sdk why ethers
+            exit 1
+          fi
+          echo "✓ @tokenbound/sdk has no ethers in its dependency graph"
+
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: pnpm/action-setup@v4
+        with:
+          version: 10
+
+      - uses: actions/setup-node@v4
+        with:
+          node-version-file: .nvmrc
+          cache: pnpm
+
+      - name: Install Foundry
+        uses: foundry-rs/foundry-toolchain@v1
+
+      - name: Install dependencies
+        run: pnpm install --frozen-lockfile
+
+      - name: Build @tokenbound/sdk
+        run: pnpm --filter @tokenbound/sdk build
+
+      # Deterministic protocol + viem extension tests, including the
+      # type-level assertions (expectTypeOf) for the .extend() surface.
+      - name: Unit and type tests (@tokenbound/sdk)
+        run: pnpm --filter @tokenbound/sdk exec vitest --watch=false --typecheck run src/test/unit/
+
+      # ethers v5 and v6 are exercised independently, each against its own fork,
+      # across both the ERC-6551 V2 (legacy) and V3 deployments. The suites run
+      # as separate vitest processes because ethers caches nonces per provider.
+      - name: Ethers v5/v6 tests (@tokenbound/ethers)
+        run: pnpm --filter @tokenbound/ethers test
+        env:
+          VITE_ANVIL_MAINNET_FORK_ENDPOINT: ${{ secrets.VITE_ANVIL_MAINNET_FORK_ENDPOINT }}
+
+      # Anvil-backed viem integration suite.
+      - name: Integration tests (@tokenbound/sdk)
+        run: pnpm --filter @tokenbound/sdk test
+        env:
+          VITE_ANVIL_MAINNET_FORK_ENDPOINT: ${{ secrets.VITE_ANVIL_MAINNET_FORK_ENDPOINT }}

.github/workflows/on-create-release.yml

@@ -4,40 +4,70 @@ on:
   release:
     types: [published]
 
+permissions:
+  contents: read
+  # Lets npm sign a provenance attestation tying each version to this workflow
+  # run and commit.
+  id-token: write
+
 jobs:
   publish:
     runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        node-version: [18]
     steps:
+      # A release event checks out the release's tag, so what is published is
+      # exactly what was released, not whatever main has moved on to since.
       - name: Clone repository
         uses: actions/checkout@v4
         with:
-          ref: 'main' # Ensure we're on the main branch
+          fetch-depth: 0
+
+      - name: Require the release tag to be on main
+        run: |
+          if ! git merge-base --is-ancestor HEAD origin/main; then
+            echo "::error::Release tag ${{ github.ref_name }} is not on main"
+            exit 1
+          fi
 
       - name: Set up PNPM
-        uses: pnpm/action-setup@v2
+        uses: pnpm/action-setup@v4
         with:
-          version: 8
+          version: 10
 
-      - name: Set up Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v3
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
         with:
-          node-version: ${{ matrix.node-version }}
+          node-version-file: .nvmrc
           registry-url: 'https://registry.npmjs.org'
+          cache: pnpm
+
+      - name: Install dependencies
+        run: pnpm install --frozen-lockfile
+
+      - name: Lint and format check
+        run: pnpm biome ci .
 
-      # Navigate to the specific package directory within the monorepo
-      - name: Change to package directory
-        run: cd packages/sdk
+      # @tokenbound/ethers depends on @tokenbound/sdk, so the SDK builds first.
+      - name: Build packages 🔧
+        run: |
+          pnpm --filter @tokenbound/sdk build
+          pnpm --filter @tokenbound/ethers build
 
-      # - name: Install dependencies
-      #   run: pnpm install
-      - name: Clean install and build 🔧
-        run: cd packages/sdk && pnpm i --force --frozen-lockfile && pnpm build
-        # run: pnpm ci && pnpm build // pnpm ci not yet implemented: https://github.com/pnpm/pnpm/issues/6100
+      # The fork-backed suites already ran in CI on main; these are the
+      # deterministic tests, which need no RPC endpoint or anvil.
+      - name: Unit and type tests
+        run: pnpm --filter @tokenbound/sdk exec vitest --watch=false --typecheck run src/test/unit/
+
+      - name: Validate published package contents
+        run: node scripts/validate-package-contents.mjs
+
+      - name: Publish @tokenbound/sdk 📦
+        run: pnpm --filter @tokenbound/sdk publish --access public --no-git-checks
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_ACCESS_TOKEN }}
+          NPM_CONFIG_PROVENANCE: true
 
-      - name: Publish package on NPM 📦
-        run: cd packages/sdk && pnpm publish --publish-branch main --access public
+      - name: Publish @tokenbound/ethers 📦
+        run: pnpm --filter @tokenbound/ethers publish --access public --no-git-checks
         env:
           NODE_AUTH_TOKEN: ${{ secrets.NPM_ACCESS_TOKEN }}
+          NPM_CONFIG_PROVENANCE: true

.gitignore

@@ -29,3 +29,6 @@ dist-ssr
 /cache
 /out
 /.vscode
+
+# Vite leaves these behind when a build is interrupted mid-config-load
+*.timestamp-*.mjs

.nvmrc

@@ -0,0 +1 @@
+22