@rainprotocolsdk/sdk 2.2.0 → 2.3.1

package/README.md

@@ -147,6 +147,8 @@ You use the stateless `Rain` class to construct the transaction. The `buildCreat
 
 Because creating a market usually requires approving the token spend first, this method returns an array of raw transactions that you must execute in order.
 
+Always make sure to estimateGas for each transaction and then execute it, there are transactions that require higher gas limits and may fail if done using a static gas limit value
+
 ```ts
 import { Rain } from '@rainprotocolsdk/sdk';
 
@@ -295,7 +297,24 @@ This single transaction sends the user's original stake plus their winnings dire
 
 Every market on Rain needs liquidity to function. Because trades execute against an Automated Market Maker (AMM), the pool requires an initial supply of funds to price shares and settle outcomes.
 
-When you create a market, you must provide at least $10 in initial liquidity via the `inputAmountWei` parameter in `buildCreateMarketTx`. This is the only way to supply liquidity to a market through the current SDK.
+### Adding Liquidity
+
+Use `buildAddLiquidityTx` to let users supply funds to an existing market. The SDK reads the market's base token on-chain and only requests the approval needed — either USDT or RAIN, depending on the market.
+
+```ts
+const txs = await rain.buildAddLiquidityTx({
+  marketContractAddress: '0x...',
+  walletAddress: '0x...',
+  amount: 100,  // human-readable amount — decimals auto-detected (6 for USDT, 18 for RAIN)
+});
+
+// Execute sequentially
+for (const tx of txs) {
+  await yourProvider.sendTransaction(tx);
+}
+```
+
+Returns `[approveTx, enterLiquidityTx]` if the allowance is insufficient, or `[enterLiquidityTx]` if already approved.
 
 ### How LPs Earn Fees
 
@@ -693,6 +712,14 @@ const closeTx = await rain.buildCloseMarketTx({
   accessToken: 'your-access-token',
 });
 
+// buildAddLiquidityTx(params) — Add liquidity to a market
+const addLiqTxs = await rain.buildAddLiquidityTx({
+  marketContractAddress: '0x...',
+  walletAddress: '0x...',
+  amount: 100,  // human-readable — reads baseToken() on-chain, uses 6 decimals for USDT or 18 for RAIN
+});
+// Returns [approveTx, enterLiquidityTx] or [enterLiquidityTx] if already approved.
+
 // buildClaimTx(params) — Claim winnings after market settles
 const claimTx = await rain.buildClaimTx({
   marketId: '698c8f116e985bbfacc7fc01',
@@ -839,6 +866,7 @@ A complete directory of all available methods in the Rain SDK.
 | `buildLimitSellOptionTx(params)` | `RawTransaction` | No |
 | `buildCancelOrdersTx(params)` | `RawTransaction[]` | No |
 | `buildCancelAllOpenOrdersTx(params)` | `RawTransaction[]` | Yes |
+| `buildAddLiquidityTx(params)` | `RawTransaction[]` | Yes |
 | `buildClaimTx(params)` | `RawTransaction` | Yes |
 | `buildCloseMarketTx(params)` | `RawTransaction[]` | Yes |
 | `buildCreateDisputeTx(params)` | `RawTransaction[]` | Yes |

package/dist/Rain.d.ts

@@ -1,5 +1,5 @@
 import { GetMarketByIdParams, GetMarketsParams, GetUserInvestmentsParams, Market, UserInvestment } from './markets/types.js';
-import { ApproveTxParams, CancelAllOpenOrdersTxParams, CancelOrdersTxParams, ClaimTxParams, CloseMarketTxParams, CreateDisputeTxParams, CreateAppealTxParams, CreateMarketTxParams, EnterLimitOptionTxParams, EnterOptionTxParams, ExtendTimeTxParams, LimitSellOptionTxParams, RawTransaction } from './tx/types.js';
+import { AddLiquidityTxParams, ApproveTxParams, CancelAllOpenOrdersTxParams, CancelOrdersTxParams, ClaimTxParams, CloseMarketTxParams, CreateDisputeTxParams, CreateAppealTxParams, CreateMarketTxParams, EnterLimitOptionTxParams, EnterOptionTxParams, ExtendTimeTxParams, LimitSellOptionTxParams, RawTransaction } from './tx/types.js';
 import { RainCoreConfig, RainEnvironment } from './types.js';
 import { LoginParams, LoginResult } from './auth/types.js';
 export declare class Rain {
@@ -25,5 +25,6 @@ export declare class Rain {
     buildCreateDisputeTx(params: CreateDisputeTxParams): Promise<RawTransaction[]>;
     buildCreateAppealTx(params: CreateAppealTxParams): Promise<RawTransaction[]>;
     buildExtendTimeTx(params: ExtendTimeTxParams): Promise<RawTransaction>;
+    buildAddLiquidityTx(params: AddLiquidityTxParams): Promise<RawTransaction[]>;
     login(params: LoginParams): Promise<LoginResult>;
 }

package/dist/Rain.js

@@ -11,6 +11,7 @@ import { buildCreateMarketRawTx } from './tx/CreateMarket/buildCreateMarketRawTx
 import { ALLOWED_ENVIRONMENTS, ENV_CONFIG, getRandomRpc } from './config/environments.js';
 import { buildClaimRawTx } from './tx/ClaimFunds/buildClaimFundsRawTx.js';
 import { buildExtendTimeRawTx } from './tx/ExtendTime/buildExtendTimeRawTx.js';
+import { buildAddLiquidityRawTx } from './tx/AddLiquidity/buildAddLiquidityRawTx.js';
 import { loginUser } from './auth/login.js';
 export class Rain {
     environment;
@@ -80,6 +81,13 @@ export class Rain {
     async buildExtendTimeTx(params) {
         return buildExtendTimeRawTx({ ...params, apiUrl: this.apiUrl, rpcUrl: this.rpcUrl });
     }
+    async buildAddLiquidityTx(params) {
+        return buildAddLiquidityRawTx({
+            ...params,
+            environment: this.environment,
+            rpcUrl: params.rpcUrl ?? this.rpcUrl,
+        });
+    }
     async login(params) {
         return loginUser({ ...params, apiUrl: this.apiUrl });
     }

package/dist/config/environments.d.ts

@@ -9,17 +9,23 @@ export declare const ENV_CONFIG: {
         readonly market_factory_address: "0x148DA7F2039B2B00633AC2ab566f59C8a4C86313";
         readonly dispute_initial_timer: number;
         readonly usdt_symbol: "USDTm";
+        readonly usdt_token: `0x${string}`;
+        readonly rain_token: `0x${string}`;
     };
     readonly stage: {
         readonly apiUrl: "https://stg-api.rain.one";
         readonly market_factory_address: "0x6109c9f28FE3Ad84c51368f7Ef2d487ca020c561";
         readonly dispute_initial_timer: number;
         readonly usdt_symbol: "USD₮0";
+        readonly usdt_token: `0x${string}`;
+        readonly rain_token: `0x${string}`;
     };
     readonly production: {
         readonly apiUrl: "https://prod-api.rain.one";
         readonly market_factory_address: "0xccCB3C03D9355B01883779EF15C1Be09cf3623F1";
         readonly dispute_initial_timer: number;
         readonly usdt_symbol: "USD₮0";
+        readonly usdt_token: `0x${string}`;
+        readonly rain_token: `0x${string}`;
     };
 };

package/dist/config/environments.js

@@ -16,17 +16,23 @@ export const ENV_CONFIG = {
         market_factory_address: "0x148DA7F2039B2B00633AC2ab566f59C8a4C86313",
         dispute_initial_timer: 1 * 60,
         usdt_symbol: USDT_SYMBOL_DEV,
+        usdt_token: "0xCa4f77A38d8552Dd1D5E44e890173921B67725F4",
+        rain_token: "0x25118290e6A5f4139381D072181157035864099d",
     },
     stage: {
         apiUrl: "https://stg-api.rain.one",
         market_factory_address: "0x6109c9f28FE3Ad84c51368f7Ef2d487ca020c561",
         dispute_initial_timer: 1 * 60,
         usdt_symbol: USDT_SYMBOL_PROD,
+        usdt_token: "0xFd086bC7CD5C481DCC9C85ebE478A1C0b69FCbb9",
+        rain_token: "0x43976a124e6834b541840Ce741243dAD3dd538DA",
     },
     production: {
         apiUrl: "https://prod-api.rain.one",
         market_factory_address: "0xccCB3C03D9355B01883779EF15C1Be09cf3623F1",
         dispute_initial_timer: 120 * 60,
         usdt_symbol: USDT_SYMBOL_PROD,
+        usdt_token: "0xFd086bC7CD5C481DCC9C85ebE478A1C0b69FCbb9",
+        rain_token: "0x43976a124e6834b541840Ce741243dAD3dd538DA",
     },
 };

package/dist/tx/AddLiquidity/buildAddLiquidityRawTx.d.ts

@@ -0,0 +1,8 @@
+import { AddLiquidityTxParams, RawTransaction } from "../types.js";
+import { RainEnvironment } from "../../types.js";
+interface AddLiquidityRawTxInternalParams extends AddLiquidityTxParams {
+    environment: RainEnvironment;
+    rpcUrl: string;
+}
+export declare function buildAddLiquidityRawTx(params: AddLiquidityRawTxInternalParams): Promise<RawTransaction[]>;
+export {};

package/dist/tx/AddLiquidity/buildAddLiquidityRawTx.js

@@ -0,0 +1,51 @@
+import { encodeFunctionData } from "viem";
+import { Contract, JsonRpcProvider, ethers } from "ethers";
+import { TradePoolAbi } from "../../abi/TradeMarketsAbi.js";
+import { buildApproveRawTx } from "../buildApprovalRawTx.js";
+import { getTokenAllowance } from "../CloseMarket/helpers.js";
+import { isRpcValid } from "../ClaimFunds/helpers.js";
+import { ENV_CONFIG, ALLOWED_ENVIRONMENTS } from "../../config/environments.js";
+async function getMarketBaseToken(marketContractAddress, rpcUrl) {
+    const provider = new JsonRpcProvider(rpcUrl);
+    const contract = new Contract(marketContractAddress, TradePoolAbi, provider);
+    return (await contract.baseToken()).toLowerCase();
+}
+export async function buildAddLiquidityRawTx(params) {
+    const { marketContractAddress, walletAddress, amount, environment, rpcUrl } = params;
+    if (!marketContractAddress)
+        throw new Error("marketContractAddress is required");
+    if (!walletAddress)
+        throw new Error("walletAddress is required");
+    if (!amount)
+        throw new Error("amount is required");
+    if (!ALLOWED_ENVIRONMENTS.includes(environment))
+        throw new Error(`Invalid environment: ${environment}`);
+    const isRpcWorking = await isRpcValid(rpcUrl);
+    if (!isRpcWorking)
+        throw new Error("Provided RPC URL is not valid or not working");
+    const { usdt_token, rain_token } = ENV_CONFIG[environment];
+    // Read base token from the market contract
+    const baseToken = await getMarketBaseToken(marketContractAddress, rpcUrl);
+    const isUsdtMarket = baseToken === usdt_token.toLowerCase();
+    const tokenAddress = isUsdtMarket ? usdt_token : rain_token;
+    // USDT uses 6 decimals, RAIN uses 18
+    const decimals = isUsdtMarket ? 6 : 18;
+    const amountInWei = ethers.parseUnits(amount.toString(), decimals);
+    const txs = [];
+    // Check allowance for the correct token only
+    const allowance = await getTokenAllowance(tokenAddress, walletAddress, marketContractAddress, rpcUrl);
+    if (BigInt(allowance) < amountInWei) {
+        txs.push(buildApproveRawTx({ tokenAddress, spender: marketContractAddress }));
+    }
+    // enterLiquidity tx on the market contract
+    txs.push({
+        to: marketContractAddress,
+        data: encodeFunctionData({
+            abi: TradePoolAbi,
+            functionName: "enterLiquidity",
+            args: [amountInWei],
+        }),
+        value: 0n,
+    });
+    return txs;
+}

package/dist/tx/types.d.ts

@@ -99,6 +99,12 @@ export interface CancelAllOpenOrdersTxParams {
     accessToken: string;
     apiUrl?: string;
 }
+export interface AddLiquidityTxParams {
+    marketContractAddress: `0x${string}`;
+    walletAddress: `0x${string}`;
+    amount: string | number;
+    rpcUrl?: string;
+}
 export interface ExtendTimeTxParams {
     marketContractAddress: `0x${string}`;
     walletAddress: `0x${string}`;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@rainprotocolsdk/sdk",
-    "version": "2.2.0",
+    "version": "2.3.1",
     "type": "module",
     "description": "Rain SDK",
     "main": "dist/index.js",
@@ -31,15 +31,21 @@
     "author": "Rain Protocol",
     "license": "MIT",
     "peerDependencies": {
-        "viem": "^2.0.0"
-    },
-    "dependencies": {
+        "viem": "^2.0.0",
         "@account-kit/infra": "^4.48.0",
         "@account-kit/wallet-client": "^0.1.0-alpha.10",
         "@alchemy/aa-alchemy": "^3.0.0",
-        "@alchemy/aa-core": "^3.0.0",
+        "@alchemy/aa-core": "^3.0.0"
+    },
+    "peerDependenciesMeta": {
+        "@account-kit/infra": { "optional": true },
+        "@account-kit/wallet-client": { "optional": true },
+        "@alchemy/aa-alchemy": { "optional": true },
+        "@alchemy/aa-core": { "optional": true }
+    },
+    "dependencies": {
         "ethers": "^6.16.0",
-    "socket.io-client": "^4.8.3"
+        "socket.io-client": "^4.8.3"
     },
     "devDependencies": {
         "typescript": "^5.9.3"