rain-sdk-v2 1.0.5 → 1.0.7

package/README.md

@@ -192,17 +192,19 @@ const txsRain = await rain.buildCreateMarketTx({
 
 ### Trading
 
-#### `buildEnterOptionTx(params: EnterOptionTxParams): RawTransaction`
+#### `buildEnterOptionTx(params): Promise<RawTransaction[]>`
 
-Buy shares of an option (AMM trade).
+Buy shares of an option (AMM trade). Automatically reads the market's base token, checks allowance, and includes approval TX if needed.
 
 ```typescript
-const tx = rain.buildEnterOptionTx({
+const txs = await rain.buildEnterOptionTx({
   marketContractAddress: '0x...',
   selectedOption: 1n, // 1-based option index
   optionSide: OptionSide.Yes, // Yes = 1, No = 2
-  buyAmountInWei: parseUnits('5', 6), // 5 USDT
+  buyAmountInWei: parseUnits('5', 6), // 5 USDT (or parseUnits('5', 18) for RAIN)
+  walletAddress: '0x...', // user's wallet address
 });
+// Returns [approveTx?, enterOptionTx]
 ```
 
 | Parameter | Type | Description |
@@ -211,26 +213,29 @@ const tx = rain.buildEnterOptionTx({
 | `selectedOption` | `bigint` | Option index (1-based) |
 | `optionSide` | `OptionSide` | `Yes (1)` or `No (2)` |
 | `buyAmountInWei` | `bigint` | Amount in base token wei |
+| `walletAddress` | `0x${string}` | User's wallet address (for allowance check) |
 
-> **Note:** Requires prior ERC20 approval to the market contract.
+> **Note:** Approval is handled automatically. The SDK reads `baseToken` from the market contract and checks allowance before building transactions.
 
 ---
 
 ### Split & Merge
 
-#### `buildSplitTx(params: SplitTxParams): RawTransaction`
+#### `buildSplitTx(params): Promise<RawTransaction[]>`
 
-Split base tokens into equal Yes + No shares for an option.
+Split base tokens into equal Yes + No shares for an option. Automatically checks allowance and includes approval TX if needed.
 
 ```typescript
-const tx = rain.buildSplitTx({
+const txs = await rain.buildSplitTx({
   marketContractAddress: '0x...',
   option: 1n,
   amount: parseUnits('5', 6), // 5 USDT -> 5 Yes shares + 5 No shares
+  walletAddress: '0x...', // user's wallet address
 });
+// Returns [approveTx?, splitTx]
 ```
 
-> **Note:** Requires prior ERC20 approval to the market contract.
+> **Note:** Approval is handled automatically.
 
 #### `buildMergeTx(params: MergeTxParams): RawTransaction`
 
@@ -250,19 +255,21 @@ const tx = rain.buildMergeTx({
 
 ### Liquidity
 
-#### `buildAddLiquidityTx(params: AddLiquidityTxParams): RawTransaction`
+#### `buildAddLiquidityTx(params): Promise<RawTransaction[]>`
 
-Add liquidity to a specific option.
+Add liquidity to a specific option. Automatically checks allowance and includes approval TX if needed.
 
 ```typescript
-const tx = rain.buildAddLiquidityTx({
+const txs = await rain.buildAddLiquidityTx({
   marketContractAddress: '0x...',
   option: 1n,
   totalAmountInWei: parseUnits('10', 6), // 10 USDT
+  walletAddress: '0x...', // user's wallet address
 });
+// Returns [approveTx?, addLiquidityTx]
 ```
 
-> **Note:** Requires prior ERC20 approval to the market contract.
+> **Note:** Approval is handled automatically.
 
 #### `buildRemoveLiquidityTx(params: RemoveLiquidityTxParams): RawTransaction`
 
@@ -286,21 +293,23 @@ const tx = rain.buildRemoveLiquidityTx({
 
 ### Order Book
 
-#### `buildPlaceBuyOrderTx(params: PlaceBuyOrderTxParams): RawTransaction`
+#### `buildPlaceBuyOrderTx(params): Promise<RawTransaction[]>`
 
-Place a limit buy order.
+Place a limit buy order. Automatically checks allowance and includes approval TX if needed.
 
 ```typescript
-const tx = rain.buildPlaceBuyOrderTx({
+const txs = await rain.buildPlaceBuyOrderTx({
   marketContractAddress: '0x...',
   option: 1n,
   optionSide: OptionSide.Yes,
   price: parseEther('0.5'), // 50% price in 1e18 scale
   amount: parseUnits('10', 6), // 10 USDT
+  walletAddress: '0x...', // user's wallet address
 });
+// Returns [approveTx?, placeBuyOrderTx]
 ```
 
-> **Note:** Requires prior ERC20 approval to the market contract. Available when AMM pool is closed.
+> **Note:** Approval is handled automatically. Available when AMM pool is closed.
 
 #### `buildPlaceSellOrderTx(params: PlaceSellOrderTxParams): RawTransaction`
 
@@ -912,7 +921,11 @@ await rain.markNotificationAsRead({ notificationId: '...' }, accessToken);
 
 ```typescript
 // Get price data for a pool
-const prices = await rain.getPriceData({ poolId: '...', interval: '1h' });
+const prices = await rain.getPriceData({
+  contractAddress: '0x...', // market contract address
+  side: 1, // 1 = YES, 2 = NO
+  filter: '1D', // '1H' | '6H' | '1D' | '1W' | '1M' | 'ALL'
+});
 ```
 
 ### Pool Reviews

package/dist/Rain.d.ts

@@ -16,8 +16,12 @@ export declare class Rain {
     getTokenConfig(tokenAddress: `0x${string}`): import("./config/environments.js").TokenConfig | null;
     buildApprovalTx(params: ApproveTxParams): RawTransaction;
     buildCreateMarketTx(params: CreateMarketTxParams): Promise<RawTransaction[]>;
-    buildEnterOptionTx(params: EnterOptionTxParams): RawTransaction;
-    buildAddLiquidityTx(params: AddLiquidityTxParams): RawTransaction;
+    buildEnterOptionTx(params: EnterOptionTxParams & {
+        walletAddress: `0x${string}`;
+    }): Promise<RawTransaction[]>;
+    buildAddLiquidityTx(params: AddLiquidityTxParams & {
+        walletAddress: `0x${string}`;
+    }): Promise<RawTransaction[]>;
     buildRemoveLiquidityTx(params: RemoveLiquidityTxParams): RawTransaction;
     getUserOptionLPShares(params: {
         marketContractAddress: `0x${string}`;
@@ -30,12 +34,16 @@ export declare class Rain {
         optionSide: number;
         userAddress: `0x${string}`;
     }): Promise<bigint>;
-    buildSplitTx(params: SplitTxParams): RawTransaction;
+    buildSplitTx(params: SplitTxParams & {
+        walletAddress: `0x${string}`;
+    }): Promise<RawTransaction[]>;
     buildMergeTx(params: MergeTxParams): RawTransaction;
     buildClosePoolAITx(params: ClosePoolAITxParams): Promise<RawTransaction[]>;
     buildClosePoolManualTx(params: ClosePoolManualTxParams): Promise<RawTransaction[]>;
     buildChooseWinnerTx(params: ChooseWinnerTxParams): RawTransaction;
-    buildPlaceBuyOrderTx(params: PlaceBuyOrderTxParams): RawTransaction;
+    buildPlaceBuyOrderTx(params: PlaceBuyOrderTxParams & {
+        walletAddress: `0x${string}`;
+    }): Promise<RawTransaction[]>;
     buildPlaceSellOrderTx(params: PlaceSellOrderTxParams): RawTransaction;
     buildOpenDisputeTx(params: OpenDisputeTxParams): Promise<RawTransaction[]>;
     buildCalculateWinnerTx(params: CalculateWinnerTxParams): Promise<RawTransaction>;

package/dist/Rain.js

@@ -74,11 +74,11 @@ export class Rain {
         const tokenDecimals = params.tokenDecimals ?? tokenConfig?.decimals ?? 6;
         return buildCreateMarketRawTx({ ...params, tokenDecimals, factoryContractAddress: this.marketFactory, apiUrl: this.apiUrl, rpcUrl: this.rpcUrl, disputeTimer: this.distute_initial_timer, oracleFixedFeePerOption });
     }
-    buildEnterOptionTx(params) {
-        return buildEnterOptionRawTx(params);
+    async buildEnterOptionTx(params) {
+        return buildEnterOptionRawTx({ ...params, rpcUrl: this.rpcUrl });
     }
-    buildAddLiquidityTx(params) {
-        return buildAddLiquidityRawTx(params);
+    async buildAddLiquidityTx(params) {
+        return buildAddLiquidityRawTx({ ...params, rpcUrl: this.rpcUrl });
     }
     buildRemoveLiquidityTx(params) {
         return buildRemoveLiquidityRawTx(params);
@@ -89,8 +89,8 @@ export class Rain {
     async getUserOptionShares(params) {
         return getUserOptionShares({ ...params, rpcUrl: this.rpcUrl });
     }
-    buildSplitTx(params) {
-        return buildSplitRawTx(params);
+    async buildSplitTx(params) {
+        return buildSplitRawTx({ ...params, rpcUrl: this.rpcUrl });
     }
     buildMergeTx(params) {
         return buildMergeRawTx(params);
@@ -104,8 +104,8 @@ export class Rain {
     buildChooseWinnerTx(params) {
         return buildChooseWinnerRawTx(params);
     }
-    buildPlaceBuyOrderTx(params) {
-        return buildPlaceBuyOrderRawTx(params);
+    async buildPlaceBuyOrderTx(params) {
+        return buildPlaceBuyOrderRawTx({ ...params, rpcUrl: this.rpcUrl });
     }
     buildPlaceSellOrderTx(params) {
         return buildPlaceSellOrderRawTx(params);

package/dist/api/priceData.js

@@ -1,6 +1,6 @@
 import { buildHeaders, buildQuery, handleResponse } from './helpers.js';
 export async function getPriceData(params, config) {
-    const qs = buildQuery({ subPool: params.subPool, side: params.side, filter: params.filter });
+    const qs = buildQuery({ contractAddress: params.contractAddress, side: params.side, filter: params.filter });
     const res = await fetch(`${config.apiUrl}/price-data/get-price-data${qs}`, {
         method: 'GET',
         headers: buildHeaders(config),

package/dist/api/types.d.ts

@@ -193,7 +193,7 @@ export interface PnlByPoolIdParams {
     poolId: string;
 }
 export interface PriceDataParams {
-    subPool: string;
+    contractAddress: string;
     side: 1 | 2;
     filter?: '1H' | '6H' | '1D' | '1W' | '1M' | 'ALL';
 }

package/dist/tx/buildAddLiquidityRawTx.d.ts

@@ -1,2 +1,5 @@
 import { AddLiquidityTxParams, RawTransaction } from "./types.js";
-export declare function buildAddLiquidityRawTx(params: AddLiquidityTxParams): RawTransaction;
+export declare function buildAddLiquidityRawTx(params: AddLiquidityTxParams & {
+    walletAddress: `0x${string}`;
+    rpcUrl: string;
+}): Promise<RawTransaction[]>;

package/dist/tx/buildAddLiquidityRawTx.js

@@ -1,8 +1,10 @@
 import { encodeFunctionData } from "viem";
 import { MarketsAbi } from "../abi/MarketsAbi.js";
 import { ENTER_LIQUIDITY } from "../constants/contractmethods.js";
-export function buildAddLiquidityRawTx(params) {
-    const { marketContractAddress, option, totalAmountInWei } = params;
+import { checkMarketTokenAllowance } from "../utils/helpers.js";
+import { buildApproveRawTx } from "./buildApprovalRawTx.js";
+export async function buildAddLiquidityRawTx(params) {
+    const { marketContractAddress, option, totalAmountInWei, walletAddress, rpcUrl } = params;
     if (!marketContractAddress)
         throw new Error("marketContractAddress is required");
     if (option === undefined || option === null)
@@ -11,7 +13,12 @@ export function buildAddLiquidityRawTx(params) {
         throw new Error("totalAmountInWei is required");
     if (totalAmountInWei <= 0n)
         throw new Error("totalAmountInWei must be greater than 0");
-    return {
+    const { allowance, baseToken } = await checkMarketTokenAllowance({ marketContractAddress, owner: walletAddress, rpcUrl });
+    const txs = [];
+    if (allowance < totalAmountInWei) {
+        txs.push(buildApproveRawTx({ tokenAddress: baseToken, spender: marketContractAddress, amount: totalAmountInWei }));
+    }
+    txs.push({
         to: marketContractAddress,
         data: encodeFunctionData({
             abi: MarketsAbi,
@@ -19,5 +26,6 @@ export function buildAddLiquidityRawTx(params) {
             args: [option, totalAmountInWei],
         }),
         value: 0n,
-    };
+    });
+    return txs;
 }

package/dist/tx/buildEnterOptionRawTx.d.ts

@@ -1,2 +1,5 @@
 import { EnterOptionTxParams, RawTransaction } from "./types.js";
-export declare function buildEnterOptionRawTx(params: EnterOptionTxParams): RawTransaction;
+export declare function buildEnterOptionRawTx(params: EnterOptionTxParams & {
+    walletAddress: `0x${string}`;
+    rpcUrl: string;
+}): Promise<RawTransaction[]>;

package/dist/tx/buildEnterOptionRawTx.js

@@ -1,8 +1,10 @@
 import { encodeFunctionData } from "viem";
 import { MarketsAbi } from "../abi/MarketsAbi.js";
 import { ENTER_OPTION } from "../constants/contractmethods.js";
-export function buildEnterOptionRawTx(params) {
-    const { marketContractAddress, selectedOption, optionSide, buyAmountInWei } = params;
+import { checkMarketTokenAllowance } from "../utils/helpers.js";
+import { buildApproveRawTx } from "./buildApprovalRawTx.js";
+export async function buildEnterOptionRawTx(params) {
+    const { marketContractAddress, selectedOption, optionSide, buyAmountInWei, walletAddress, rpcUrl } = params;
     if (!marketContractAddress)
         throw new Error("marketContractAddress is required");
     if (selectedOption === undefined || selectedOption === null)
@@ -13,7 +15,12 @@ export function buildEnterOptionRawTx(params) {
         throw new Error("buyAmountInWei is required");
     if (buyAmountInWei <= 0n)
         throw new Error("buyAmountInWei must be greater than 0");
-    return {
+    const { allowance, baseToken } = await checkMarketTokenAllowance({ marketContractAddress, owner: walletAddress, rpcUrl });
+    const txs = [];
+    if (allowance < buyAmountInWei) {
+        txs.push(buildApproveRawTx({ tokenAddress: baseToken, spender: marketContractAddress, amount: buyAmountInWei }));
+    }
+    txs.push({
         to: marketContractAddress,
         data: encodeFunctionData({
             abi: MarketsAbi,
@@ -21,5 +28,6 @@ export function buildEnterOptionRawTx(params) {
             args: [selectedOption, optionSide, buyAmountInWei],
         }),
         value: 0n,
-    };
+    });
+    return txs;
 }

package/dist/tx/buildPlaceOrderRawTx.d.ts

@@ -1,3 +1,6 @@
 import { PlaceBuyOrderTxParams, PlaceSellOrderTxParams, RawTransaction } from "./types.js";
-export declare function buildPlaceBuyOrderRawTx(params: PlaceBuyOrderTxParams): RawTransaction;
+export declare function buildPlaceBuyOrderRawTx(params: PlaceBuyOrderTxParams & {
+    walletAddress: `0x${string}`;
+    rpcUrl: string;
+}): Promise<RawTransaction[]>;
 export declare function buildPlaceSellOrderRawTx(params: PlaceSellOrderTxParams): RawTransaction;

package/dist/tx/buildPlaceOrderRawTx.js

@@ -1,8 +1,10 @@
 import { encodeFunctionData } from "viem";
 import { MarketsAbi } from "../abi/MarketsAbi.js";
 import { PLACE_BUY_ORDER, PLACE_SELL_ORDER } from "../constants/contractmethods.js";
-export function buildPlaceBuyOrderRawTx(params) {
-    const { marketContractAddress, option, optionSide, price, amount } = params;
+import { checkMarketTokenAllowance } from "../utils/helpers.js";
+import { buildApproveRawTx } from "./buildApprovalRawTx.js";
+export async function buildPlaceBuyOrderRawTx(params) {
+    const { marketContractAddress, option, optionSide, price, amount, walletAddress, rpcUrl } = params;
     if (!marketContractAddress)
         throw new Error("marketContractAddress is required");
     if (option === undefined || option === null)
@@ -13,7 +15,12 @@ export function buildPlaceBuyOrderRawTx(params) {
         throw new Error("price must be greater than 0");
     if (!amount || amount <= 0n)
         throw new Error("amount must be greater than 0");
-    return {
+    const { allowance, baseToken } = await checkMarketTokenAllowance({ marketContractAddress, owner: walletAddress, rpcUrl });
+    const txs = [];
+    if (allowance < amount) {
+        txs.push(buildApproveRawTx({ tokenAddress: baseToken, spender: marketContractAddress, amount }));
+    }
+    txs.push({
         to: marketContractAddress,
         data: encodeFunctionData({
             abi: MarketsAbi,
@@ -21,7 +28,8 @@ export function buildPlaceBuyOrderRawTx(params) {
             args: [option, optionSide, price, amount],
         }),
         value: 0n,
-    };
+    });
+    return txs;
 }
 export function buildPlaceSellOrderRawTx(params) {
     const { marketContractAddress, option, optionSide, price, shares } = params;

package/dist/tx/buildSplitRawTx.d.ts

@@ -1,2 +1,5 @@
 import { SplitTxParams, RawTransaction } from "./types.js";
-export declare function buildSplitRawTx(params: SplitTxParams): RawTransaction;
+export declare function buildSplitRawTx(params: SplitTxParams & {
+    walletAddress: `0x${string}`;
+    rpcUrl: string;
+}): Promise<RawTransaction[]>;

package/dist/tx/buildSplitRawTx.js

@@ -1,15 +1,22 @@
 import { encodeFunctionData } from "viem";
 import { MarketsAbi } from "../abi/MarketsAbi.js";
 import { SPLIT } from "../constants/contractmethods.js";
-export function buildSplitRawTx(params) {
-    const { marketContractAddress, option, amount } = params;
+import { checkMarketTokenAllowance } from "../utils/helpers.js";
+import { buildApproveRawTx } from "./buildApprovalRawTx.js";
+export async function buildSplitRawTx(params) {
+    const { marketContractAddress, option, amount, walletAddress, rpcUrl } = params;
     if (!marketContractAddress)
         throw new Error("marketContractAddress is required");
     if (option === undefined || option === null)
         throw new Error("option is required");
     if (!amount || amount <= 0n)
         throw new Error("amount must be greater than 0");
-    return {
+    const { allowance, baseToken } = await checkMarketTokenAllowance({ marketContractAddress, owner: walletAddress, rpcUrl });
+    const txs = [];
+    if (allowance < amount) {
+        txs.push(buildApproveRawTx({ tokenAddress: baseToken, spender: marketContractAddress, amount }));
+    }
+    txs.push({
         to: marketContractAddress,
         data: encodeFunctionData({
             abi: MarketsAbi,
@@ -17,5 +24,6 @@ export function buildSplitRawTx(params) {
             args: [option, amount],
         }),
         value: 0n,
-    };
+    });
+    return txs;
 }

package/dist/utils/helpers.d.ts

@@ -2,3 +2,17 @@ import { CreateMarketTxParams } from "../tx/types.js";
 export declare const convertToWeiEthers: (value: string | bigint, decimals: number) => bigint;
 export declare function isRpcValid(rpcUrl: string | undefined): Promise<boolean>;
 export declare function getUserAllowance(params: CreateMarketTxParams): Promise<number>;
+/**
+ * Checks allowance for a market's base token.
+ * Reads baseToken from the market contract, then checks the ERC20 allowance.
+ * Also returns the token decimals by reading from the ERC20 contract.
+ */
+export declare function checkMarketTokenAllowance(params: {
+    marketContractAddress: `0x${string}`;
+    owner: `0x${string}`;
+    rpcUrl: string;
+}): Promise<{
+    allowance: bigint;
+    baseToken: `0x${string}`;
+    decimals: number;
+}>;

package/dist/utils/helpers.js

@@ -1,5 +1,6 @@
 import { ethers, JsonRpcProvider, Contract } from "ethers";
 import { ERC20Abi } from "../abi/ERC20Abi.js";
+import { getMarketBaseToken } from "../markets/getResolverBondAmount.js";
 export const convertToWeiEthers = (value, decimals) => {
     return ethers.parseUnits(value.toString(), decimals);
 };
@@ -26,3 +27,27 @@ export async function getUserAllowance(params) {
     const userAllowance = await ERC20ApprovalContract.allowance(creator, factoryContractAddress);
     return userAllowance;
 }
+/**
+ * Checks allowance for a market's base token.
+ * Reads baseToken from the market contract, then checks the ERC20 allowance.
+ * Also returns the token decimals by reading from the ERC20 contract.
+ */
+export async function checkMarketTokenAllowance(params) {
+    const { marketContractAddress, owner, rpcUrl } = params;
+    const isRpcWorking = await isRpcValid(rpcUrl);
+    if (!rpcUrl || !isRpcWorking) {
+        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 [userAllowance, tokenDecimals] = await Promise.all([
+        tokenContract.allowance(owner, marketContractAddress),
+        tokenContract.decimals(),
+    ]);
+    return {
+        allowance: BigInt(userAllowance),
+        baseToken,
+        decimals: Number(tokenDecimals),
+    };
+}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "rain-sdk-v2",
-    "version": "1.0.5",
+    "version": "1.0.7",
     "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",