add ethers-v5 client entrypoint

Author: cesarenaldi

packages/client/package.json

@@ -22,6 +22,10 @@
       "types": "./dist/decorators/index.d.ts",
       "default": "./dist/decorators/index.js"
     },
+    "./ethers-v5": {
+      "types": "./dist/ethers-v5.d.ts",
+      "default": "./dist/ethers-v5.js"
+    },
     "./viem": {
       "types": "./dist/viem/index.d.ts",
       "default": "./dist/viem/index.js"
@@ -38,6 +42,9 @@
       "decorators": [
         "./dist/decorators/index.d.ts"
       ],
+      "ethers-v5": [
+        "./dist/ethers-v5.d.ts"
+      ],
       "viem": [
         "./dist/viem/index.d.ts"
       ]
@@ -52,6 +59,7 @@
     "typecheck": "tsc -p tsconfig.json --noEmit"
   },
   "devDependencies": {
+    "ethers-v5": "npm:ethers@^5.8.0",
     "tsup": "^8.5.1",
     "typescript": "^6.0.2",
     "viem": "^2.46.3"
@@ -61,9 +69,13 @@
     "access": "public"
   },
   "peerDependencies": {
+    "ethers-v5": "^5.8.0",
     "viem": "^2.46.3"
   },
   "peerDependenciesMeta": {
+    "ethers-v5": {
+      "optional": true
+    },
     "viem": {
       "optional": true
     }

packages/client/src/ethers-v5.test.ts

@@ -0,0 +1,88 @@
+import {
+  type AcceptedOrderResponse,
+  OrderSide,
+  OrderType,
+} from '@polymarket/bindings/clob';
+import { expectPresent } from '@polymarket/types';
+import { ethers } from 'ethers-v5';
+import { polygon } from 'viem/chains';
+import { describe, expect, it } from 'vitest';
+import {
+  cancelOrder,
+  fetchApiKeys,
+  fetchMarket,
+  prepareLimitOrderPosting,
+} from './actions';
+import { authenticateWith, completeWith } from './ethers-v5';
+import {
+  publicClient,
+  runMeteredTests,
+  safeWalletAddress,
+  testPrivateKey,
+} from './testing';
+
+const TEST_MARKET_SLUG = 'eth-flipped-in-2026';
+
+const provider = new ethers.providers.JsonRpcProvider(
+  polygon.rpcUrls.default.http[0],
+  {
+    chainId: polygon.id,
+    name: polygon.name,
+  },
+);
+
+function createSigner() {
+  return new ethers.Wallet(testPrivateKey, provider);
+}
+
+describe('ethers-v5', () => {
+  describe('authenticateWith', () => {
+    it('authenticates a secure client from an authentication workflow', async () => {
+      const secureClient = await publicClient
+        .beginAuthentication({ wallet: safeWalletAddress })
+        .then(authenticateWith(createSigner()));
+
+      await expect(fetchApiKeys(secureClient)).resolves.toBeDefined();
+    });
+  });
+
+  describe('completeWith', () => {
+    it.runIf(runMeteredTests)('places and cancels a limit order', async () => {
+      const signer = createSigner();
+      const market = await fetchMarket(publicClient, {
+        slug: TEST_MARKET_SLUG,
+      });
+      const [yesTokenId] = expectPresent(market.clobTokenIds);
+      const price = expectPresent(market.orderPriceMinTickSize);
+      const size = expectPresent(market.orderMinSize);
+      const secureClient = await publicClient
+        .beginAuthentication({ wallet: safeWalletAddress })
+        .then(authenticateWith(signer));
+
+      const response = await prepareLimitOrderPosting(secureClient, {
+        orderType: OrderType.GTC,
+        price,
+        size,
+        side: OrderSide.BUY,
+        tokenId: yesTokenId,
+      }).then(completeWith(signer));
+
+      expect(response.ok).toBe(true);
+      const acceptedResponse = expectAcceptedOrderResponse(response);
+
+      await expect(
+        cancelOrder(secureClient, { orderId: acceptedResponse.orderId }),
+      ).resolves.toEqual(
+        expect.objectContaining({
+          canceled: expect.arrayContaining([acceptedResponse.orderId]),
+        }),
+      );
+    });
+  });
+});
+
+function expectAcceptedOrderResponse(response: unknown): AcceptedOrderResponse {
+  expect(response).toEqual(expect.objectContaining({ ok: true }));
+
+  return response as AcceptedOrderResponse;
+}