rain-sdk-v2 2.3.0 → 2.4.0

package/CHANGELOG.md

@@ -9,6 +9,36 @@ APIs slated for removal are marked `@deprecated` in the type declarations for at
 least one minor release before they are removed, with the replacement named in
 the deprecation notice. Breaking removals land only in a major version.
 
+## [2.4.0] - Production readiness
+
+No breaking changes to the public API.
+
+### Fixed
+- **Docs correctness:** the `deadline` examples and parameter tables in the README
+  no longer show `deadline: 600n` (a duration), which the builders reject since
+  2.2.0. They now show an absolute unix timestamp and note the default 10-min window.
+
+### Changed
+- **viem-only (dropped `ethers`):** `utils/helpers.ts` (allowance + decimals reads,
+  `parseUnits`, RPC liveness) is ported to viem. `ethers` is removed from
+  dependencies — one web3 stack, smaller install/bundle. The redundant
+  per-call `getNetwork()` RPC round-trip before allowance checks is gone.
+- **`RainAA` browser-only, documented + guarded:** session methods now throw a
+  clear error when `indexedDB` is unavailable (Node/SSR) instead of a cryptic
+  `ReferenceError`. Documented in the README and class JSDoc. Use `Rain` for
+  server-side flows.
+
+### Added
+- **Test suite (vitest):** unit tests for the validators and encoders, plus a
+  gated Arbitrum integration test (`npm run test:integration`) exercising the
+  on-chain read path. Scripts: `test`, `test:watch`, `test:integration`.
+- **CI:** GitHub Actions — build + test on push/PR, and publish-on-release
+  (`.github/workflows/`).
+
+### Removed
+- Dead `getRandomRpc` export (superseded by `getDefaultRpc` in 2.3.0).
+- Committed `*.tgz` tarball removed from the repo and gitignored.
+
 ## [2.3.0] - Developer experience
 
 Additive, non-breaking. Fills in the untyped core data model and adds the

package/README.md

@@ -71,6 +71,8 @@ const rain = new Rain(config?: RainCoreConfig);
 
 Stateful class for smart account (Account Abstraction) management with Alchemy gas sponsorship.
 
+> ⚠️ **Browser-only.** `RainAA` persists session keys in `indexedDB`, so it is **not supported in Node.js or SSR** — session methods throw a descriptive error in those environments. For server-side flows use the stateless `Rain` class (transaction building and on-chain reads), which runs anywhere.
+
 #### Constructor
 
 ```typescript
@@ -213,7 +215,7 @@ const txs = await rain.buildEnterOptionTx({
   buyAmountInWei: parseUnits('5', 6), // 5 USDT (or parseUnits('5', 18) for RAIN)
   walletAddress: '0x...', // user's wallet address
   slippageTolerance: 5n, // optional, default 5% — percentage tolerance for minSharesOut
-  deadline: 600n, // optional, default 600 (10 min) — duration in seconds
+  deadline: BigInt(Math.floor(Date.now() / 1000) + 600), // optional — absolute unix timestamp; omit for a default 10-min window
 });
 // Returns [approveTx?, enterOptionTx]
 ```
@@ -227,7 +229,7 @@ const txs = await rain.buildEnterOptionTx({
 | `walletAddress` | `0x${string}` | User's wallet address (for allowance check) |
 | `minSharesOut` | `bigint` | *(Optional)* Minimum shares to receive. Auto-calculated from `getEntryShares` with slippage if not set |
 | `slippageTolerance` | `bigint` | *(Optional)* Slippage percentage (e.g. `5n` = 5%). Default: 5% |
-| `deadline` | `bigint` | *(Optional)* Duration in seconds (e.g. `600n` = 10 min). Default: 600 |
+| `deadline` | `bigint` | *(Optional)* Absolute unix timestamp in seconds, e.g. `BigInt(Math.floor(Date.now()/1000) + 600)`. Omit for a default 10-min window. A small duration like `600n` is **rejected** (`RainValidationError`). |
 
 > **Note:** Approval is handled automatically. The SDK reads `baseToken` from the market contract and checks allowance before building transactions. Slippage protection is auto-calculated: the SDK calls `getEntryShares` on-chain to get expected shares, then applies the slippage tolerance.
 
@@ -244,7 +246,7 @@ const tx = await rain.buildSellOptionTx({
   optionSide: OptionSide.Yes, // Yes = 1, No = 2
   sharesAmount: parseUnits('10', 6), // shares to sell
   slippageTolerance: 5n, // optional, default 5%
-  deadline: 600n, // optional, default 600 (10 min) — duration in seconds
+  deadline: BigInt(Math.floor(Date.now() / 1000) + 600), // optional — absolute unix timestamp; omit for a default 10-min window
 });
 // Returns a single RawTransaction (no approval needed)
 ```
@@ -257,7 +259,7 @@ const tx = await rain.buildSellOptionTx({
 | `sharesAmount` | `bigint` | Number of shares to sell |
 | `minAmountOut` | `bigint` | *(Optional)* Minimum base tokens to receive. Auto-calculated from `getCurrentPrice` with slippage if not set |
 | `slippageTolerance` | `bigint` | *(Optional)* Slippage percentage (e.g. `5n` = 5%). Default: 5% |
-| `deadline` | `bigint` | *(Optional)* Duration in seconds (e.g. `600n` = 10 min). Default: 600 |
+| `deadline` | `bigint` | *(Optional)* Absolute unix timestamp in seconds, e.g. `BigInt(Math.floor(Date.now()/1000) + 600)`. Omit for a default 10-min window. A small duration like `600n` is **rejected** (`RainValidationError`). |
 
 ---
 
@@ -308,7 +310,7 @@ const txs = await rain.buildAddLiquidityTx({
   totalAmountInWei: parseUnits('10', 6), // 10 USDT
   walletAddress: '0x...', // user's wallet address
   slippageTolerance: 5n, // optional, default 5%
-  deadline: 600n, // optional, default 600 (10 min) — duration in seconds
+  deadline: BigInt(Math.floor(Date.now() / 1000) + 600), // optional — absolute unix timestamp; omit for a default 10-min window
 });
 // Returns [approveTx?, addLiquidityTx]
 ```
@@ -322,7 +324,7 @@ const txs = await rain.buildAddLiquidityTx({
 | `minYesToDeposit` | `bigint` | *(Optional)* Min yes tokens to deposit. Auto-calculated from reserves if not set |
 | `minNoToDeposit` | `bigint` | *(Optional)* Min no tokens to deposit. Auto-calculated from reserves if not set |
 | `slippageTolerance` | `bigint` | *(Optional)* Slippage percentage (e.g. `5n` = 5%). Default: 5% |
-| `deadline` | `bigint` | *(Optional)* Duration in seconds (e.g. `600n` = 10 min). Default: 600 |
+| `deadline` | `bigint` | *(Optional)* Absolute unix timestamp in seconds, e.g. `BigInt(Math.floor(Date.now()/1000) + 600)`. Omit for a default 10-min window. A small duration like `600n` is **rejected** (`RainValidationError`). |
 
 > **Note:** Approval is handled automatically. Slippage protection is auto-calculated from `ammYesReserve`/`ammNoReserve` proportionally.
 
@@ -342,7 +344,7 @@ const tx = await rain.buildRemoveLiquidityTx({
   option: 1n,
   lpShares, // raw LP shares amount
   slippageTolerance: 5n, // optional, default 5%
-  deadline: 600n, // optional, default 600 (10 min) — duration in seconds
+  deadline: BigInt(Math.floor(Date.now() / 1000) + 600), // optional — absolute unix timestamp; omit for a default 10-min window
 });
 ```
 
@@ -354,7 +356,7 @@ const tx = await rain.buildRemoveLiquidityTx({
 | `minYesOut` | `bigint` | *(Optional)* Min yes tokens to receive. Auto-calculated from `getRemovedLiquidity` if not set |
 | `minNoOut` | `bigint` | *(Optional)* Min no tokens to receive. Auto-calculated if not set |
 | `slippageTolerance` | `bigint` | *(Optional)* Slippage percentage (e.g. `5n` = 5%). Default: 5% |
-| `deadline` | `bigint` | *(Optional)* Duration in seconds (e.g. `600n` = 10 min). Default: 600 |
+| `deadline` | `bigint` | *(Optional)* Absolute unix timestamp in seconds, e.g. `BigInt(Math.floor(Date.now()/1000) + 600)`. Omit for a default 10-min window. A small duration like `600n` is **rejected** (`RainValidationError`). |
 
 ---
 

package/dist/RainAA.d.ts

@@ -1,5 +1,12 @@
 import { RainConfig } from './types.js';
 import { RawTransaction } from './tx/types.js';
+/**
+ * Smart-account (Account Abstraction) manager with Alchemy gas sponsorship.
+ *
+ * ⚠️ **Browser-only.** Session persistence uses `indexedDB`, so `RainAA` is not
+ * supported in Node.js or SSR — session methods throw a descriptive error there.
+ * The stateless `Rain` class works in any environment; use it for server-side flows.
+ */
 export declare class RainAA {
     private config;
     private _client;

package/dist/RainAA.js

@@ -3,6 +3,10 @@ const SESSION_DURATION_SEC = 60 * 60 * 24; // 24 hours
 const DB_NAME = 'RainSDKV2';
 const STORE_NAME = 'sessions';
 function openSessionDB() {
+    if (typeof indexedDB === 'undefined') {
+        return Promise.reject(new Error('RainAA requires a browser environment: session persistence uses indexedDB, ' +
+            'which is unavailable in Node.js/SSR. RainAA is browser-only.'));
+    }
     return new Promise((resolve, reject) => {
         const req = indexedDB.open(DB_NAME, 1);
         req.onupgradeneeded = () => {
@@ -42,6 +46,13 @@ async function deleteSession(key) {
         tx.onerror = () => reject(tx.error);
     });
 }
+/**
+ * Smart-account (Account Abstraction) manager with Alchemy gas sponsorship.
+ *
+ * ⚠️ **Browser-only.** Session persistence uses `indexedDB`, so `RainAA` is not
+ * supported in Node.js or SSR — session methods throw a descriptive error there.
+ * The stateless `Rain` class works in any environment; use it for server-side flows.
+ */
 export class RainAA {
     config;
     _client = null; // EOA-signed client (for grantPermissions)

package/dist/auth/login.js

@@ -1,15 +1,12 @@
-/** Decode the `exp` (unix seconds) claim from a JWT without verifying it. Cross-environment (browser + Node). */
+/** Decode the `exp` (unix seconds) claim from a JWT without verifying it. Uses `atob` (browser + Node 18+). */
 function decodeJwtExp(token) {
     try {
         const part = token.split('.')[1];
-        if (!part)
+        if (!part || typeof atob !== 'function')
             return undefined;
         const b64 = part.replace(/-/g, '+').replace(/_/g, '/');
         const padded = b64 + '='.repeat((4 - (b64.length % 4)) % 4);
-        const json = typeof atob === 'function'
-            ? atob(padded)
-            : Buffer.from(padded, 'base64').toString('binary');
-        const payload = JSON.parse(json);
+        const payload = JSON.parse(atob(padded));
         return typeof payload?.exp === 'number' ? payload.exp : undefined;
     }
     catch {

package/dist/config/environments.d.ts

@@ -1,6 +1,5 @@
 export declare const ALLOWED_ENVIRONMENTS: readonly ["development", "stage", "production"];
 export declare const DEFAULT_RPCS: string[];
-export declare function getRandomRpc(): string;
 /** Deterministic default RPC — every instance resolves to the same endpoint. */
 export declare function getDefaultRpc(): string;
 export declare const USDT_SYMBOL_DEV = "USDTm";

package/dist/config/environments.js

@@ -4,10 +4,6 @@ export const DEFAULT_RPCS = [
     "https://arbitrum-one.publicnode.com",
     "https://rpc.sentio.xyz/arbitrum-one"
 ];
-export function getRandomRpc() {
-    const index = Math.floor(Math.random() * DEFAULT_RPCS.length);
-    return DEFAULT_RPCS[index];
-}
 /** Deterministic default RPC — every instance resolves to the same endpoint. */
 export function getDefaultRpc() {
     return DEFAULT_RPCS[0];

package/dist/utils/helpers.d.ts

@@ -1,7 +1,8 @@
 import { CreateMarketTxParams } from "../tx/types.js";
 export declare const convertToWeiEthers: (value: string | bigint, decimals: number) => bigint;
+/** Lightweight RPC liveness check via viem `getChainId`. Kept for callers that want a pre-flight probe. */
 export declare function isRpcValid(rpcUrl: string | undefined): Promise<boolean>;
-export declare function getUserAllowance(params: CreateMarketTxParams): Promise<number>;
+export declare function getUserAllowance(params: CreateMarketTxParams): Promise<bigint>;
 /**
  * Checks allowance for a market's base token.
  * Reads baseToken from the market contract, then checks the ERC20 allowance.

package/dist/utils/helpers.js

@@ -1,31 +1,36 @@
-import { ethers, JsonRpcProvider, Contract } from "ethers";
+import { parseUnits, createPublicClient, http } from "viem";
+import { arbitrum } from "viem/chains";
 import { ERC20Abi } from "../abi/ERC20Abi.js";
 import { getMarketBaseToken } from "../markets/getResolverBondAmount.js";
+const erc20Abi = ERC20Abi;
 export const convertToWeiEthers = (value, decimals) => {
-    return ethers.parseUnits(value.toString(), decimals);
+    return parseUnits(value.toString(), decimals);
 };
+/** Lightweight RPC liveness check via viem `getChainId`. Kept for callers that want a pre-flight probe. */
 export async function isRpcValid(rpcUrl) {
     if (!rpcUrl)
         return false;
-    const provider = new JsonRpcProvider(rpcUrl);
     try {
-        await provider.getNetwork();
+        const client = createPublicClient({ chain: arbitrum, transport: http(rpcUrl) });
+        await client.getChainId();
         return true;
     }
-    catch (error) {
+    catch {
         return false;
     }
 }
 export async function getUserAllowance(params) {
     const { factoryContractAddress, baseToken, creator, rpcUrl } = params;
-    const isRpcWorking = await isRpcValid(rpcUrl);
-    if (!rpcUrl || !isRpcWorking) {
+    if (!rpcUrl)
         throw new Error("Provided RPC URL is not valid or not working");
-    }
-    const provider = new JsonRpcProvider(rpcUrl);
-    const ERC20ApprovalContract = new Contract(baseToken, ERC20Abi, provider);
-    const userAllowance = await ERC20ApprovalContract.allowance(creator, factoryContractAddress);
-    return userAllowance;
+    const client = createPublicClient({ chain: arbitrum, transport: http(rpcUrl) });
+    const allowance = await client.readContract({
+        address: baseToken,
+        abi: erc20Abi,
+        functionName: 'allowance',
+        args: [creator, factoryContractAddress],
+    });
+    return allowance;
 }
 /**
  * Checks allowance for a market's base token.
@@ -34,19 +39,16 @@ export async function getUserAllowance(params) {
  */
 export async function checkMarketTokenAllowance(params) {
     const { marketContractAddress, owner, rpcUrl } = params;
-    const isRpcWorking = await isRpcValid(rpcUrl);
-    if (!rpcUrl || !isRpcWorking) {
+    if (!rpcUrl)
         throw new Error("Provided RPC URL is not valid or not working");
-    }
     const baseToken = await getMarketBaseToken({ marketContractAddress, rpcUrl });
-    const provider = new JsonRpcProvider(rpcUrl);
-    const tokenContract = new Contract(baseToken, ERC20Abi, provider);
+    const client = createPublicClient({ chain: arbitrum, transport: http(rpcUrl) });
     const [userAllowance, tokenDecimals] = await Promise.all([
-        tokenContract.allowance(owner, marketContractAddress),
-        tokenContract.decimals(),
+        client.readContract({ address: baseToken, abi: erc20Abi, functionName: 'allowance', args: [owner, marketContractAddress] }),
+        client.readContract({ address: baseToken, abi: erc20Abi, functionName: 'decimals' }),
     ]);
     return {
-        allowance: BigInt(userAllowance),
+        allowance: userAllowance,
         baseToken,
         decimals: Number(tokenDecimals),
     };

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "rain-sdk-v2",
-    "version": "2.3.0",
+    "version": "2.4.0",
     "type": "module",
     "description": "Rain SDK V2 — TypeScript SDK for Rain prediction markets on Arbitrum. Market creation, trading, liquidity, order book, split/merge, dispute, and smart account support.",
     "main": "dist/index.js",
@@ -19,6 +19,9 @@
     "scripts": {
         "build": "tsc",
         "dev": "tsc -w",
+        "test": "vitest run",
+        "test:watch": "vitest",
+        "test:integration": "RUN_INTEGRATION=1 vitest run test/integration.test.ts",
         "prepublishOnly": "npm run build"
     },
     "repository": {
@@ -57,11 +60,11 @@
         }
     },
     "dependencies": {
-        "ethers": "^6.16.0",
         "socket.io-client": "^4.8.3"
     },
     "devDependencies": {
         "typescript": "^5.9.3",
-        "viem": "^2.48.8"
+        "viem": "^2.48.8",
+        "vitest": "^5.0.1"
     }
 }