@rainprotocolsdk/sdk 1.2.0 → 1.3.0

package/README.md

@@ -150,7 +150,7 @@ interface CreateMarketTxParams {
 
 ### Minimum Liquidity Rule
 
-# inputAmountWei >= 10 tokens
+#### inputAmountWei >= 10 tokens
 
 ### Return Type
 
@@ -287,6 +287,54 @@ rain.buildLimitBuyOptionTx({
 
 ---
 
+## buildClaimTx
+
+Builds a **raw EVM transaction** to claim the funds from a Rain market.
+
+This function **does not send the transaction** — it only prepares calldata.
+
+### Method Signature
+
+```ts
+buildClaimTx(params: ClaimTxParams): Promise<RawTransaction>
+```
+
+### Parameters
+
+```ts
+interface ClaimTxParams {
+  marketId: string;
+  walletAddress: `0x${string}`;
+}
+```
+
+### Validations
+
+| Parameter       | Type          | Required | Description                        |
+| --------------- | ------------- | -------- | ---------------------------------- |
+| `marketId`      | `string`      | ✅        | Unique identifier of the market    |
+| `walletAddress` | `0x${string}` | ✅        | Address of the user claiming funds |
+
+### Return Type
+
+```ts
+interface RawTransaction {
+  to: `0x${string}`;
+  data: `0x${string}`;
+}
+```
+
+### Example
+
+```ts
+rain.buildClaimTx({
+  marketId: "698c8f116e985bbfacc7fc01",
+  walletAddress: '0x996ea23940f4a01610181D04bdB6F862719b63f0'
+})
+```
+
+---
+
 ## RainAA Class (Account Abstraction)
 
 `RainAA` is responsible for:

package/dist/Rain.d.ts

@@ -1,15 +1,17 @@
 import { GetMarketsParams, Market } from './markets/types.js';
-import { ApproveTxParams, CreateMarketTxParams, EnterLimitOptionTxParams, EnterOptionTxParams, RawTransaction } from './tx/types.js';
+import { ApproveTxParams, ClaimTxParams, CreateMarketTxParams, EnterLimitOptionTxParams, EnterOptionTxParams, RawTransaction } from './tx/types.js';
 import { RainCoreConfig, RainEnvironment } from './types.js';
 export declare class Rain {
     readonly environment: RainEnvironment;
     private readonly marketFactory;
     private readonly apiUrl;
     private readonly distute_initial_timer;
+    private readonly rpcUrl?;
     constructor(config?: RainCoreConfig);
     getPublicMarkets(params: GetMarketsParams): Promise<Market[]>;
     buildApprovalTx(params: ApproveTxParams): RawTransaction | Error;
     buildBuyOptionRawTx(params: EnterOptionTxParams): RawTransaction;
     buildLimitBuyOptionTx(params: EnterLimitOptionTxParams): RawTransaction;
     buildCreateMarketTx(params: CreateMarketTxParams): RawTransaction;
+    buildClaimTx(params: ClaimTxParams): Promise<RawTransaction>;
 }

package/dist/Rain.js

@@ -2,14 +2,16 @@ import { getMarkets } from './markets/getMarkets.js';
 import { buildEnterOptionRawTx, buildLimitBuyOrderRawTx } from './tx/buildRawTransactions.js';
 import { buildApproveRawTx } from './tx/buildApprovalRawTx.js';
 import { buildCreateMarketRawTx } from './tx/CreateMarket/buildCreateMarketRawTx.js';
-import { ALLOWED_ENVIRONMENTS, ENV_CONFIG } from './config/environments.js';
+import { ALLOWED_ENVIRONMENTS, ENV_CONFIG, getRandomRpc } from './config/environments.js';
+import { buildClaimRawTx } from './tx/ClaimFunds/buildClaimFundsRawTx.js';
 export class Rain {
     environment;
     marketFactory;
     apiUrl;
     distute_initial_timer;
+    rpcUrl;
     constructor(config = {}) {
-        const { environment = "development" } = config;
+        const { environment = "development", rpcUrl } = config;
         function isValidEnvironment(env) {
             return ALLOWED_ENVIRONMENTS.includes(env);
         }
@@ -17,6 +19,7 @@ export class Rain {
             throw new Error(`Invalid environment "${environment}". Allowed values: ${ALLOWED_ENVIRONMENTS.join(", ")}`);
         }
         this.environment = environment;
+        this.rpcUrl = rpcUrl ?? getRandomRpc();
         const envConfig = ENV_CONFIG[this.environment];
         this.marketFactory = envConfig.market_factory_address;
         this.apiUrl = envConfig.apiUrl;
@@ -37,4 +40,7 @@ export class Rain {
     buildCreateMarketTx(params) {
         return buildCreateMarketRawTx({ ...params, factoryContractAddress: this.marketFactory, disputeTimer: this.distute_initial_timer });
     }
+    async buildClaimTx(params) {
+        return buildClaimRawTx({ ...params, apiUrl: this.apiUrl, rpcUrl: this.rpcUrl });
+    }
 }

package/dist/config/environments.d.ts

@@ -1,4 +1,6 @@
 export declare const ALLOWED_ENVIRONMENTS: readonly ["development", "stage", "production"];
+export declare const DEFAULT_RPCS: string[];
+export declare function getRandomRpc(): string;
 export declare const ENV_CONFIG: {
     readonly development: {
         readonly apiUrl: "https://dev-api.rain.one";

package/dist/config/environments.js

@@ -1,4 +1,13 @@
 export const ALLOWED_ENVIRONMENTS = ["development", "stage", "production"];
+export const DEFAULT_RPCS = [
+    "https://arbitrum.meowrpc.com",
+    "https://rpc.sentio.xyz/arbitrum-one",
+    "https://rpc.owlracle.info/arb/70d38ce1826c4a60bb2a8e05a6c8b20f"
+];
+export function getRandomRpc() {
+    const index = Math.floor(Math.random() * DEFAULT_RPCS.length);
+    return DEFAULT_RPCS[index];
+}
 export const ENV_CONFIG = {
     development: {
         apiUrl: "https://dev-api.rain.one",

package/dist/constants/contractmethods.d.ts

@@ -2,3 +2,4 @@ export declare const ENTER_OPTION = "enterOption";
 export declare const PLACE_BUY_ORDER = "placeBuyOrder";
 export declare const APPROVE_TOKEN = "approve";
 export declare const CREATE_MARKET = "createPool";
+export declare const CLAIM = "claim";

package/dist/constants/contractmethods.js

@@ -2,3 +2,4 @@ export const ENTER_OPTION = 'enterOption';
 export const PLACE_BUY_ORDER = 'placeBuyOrder';
 export const APPROVE_TOKEN = 'approve';
 export const CREATE_MARKET = 'createPool';
+export const CLAIM = "claim";

package/dist/tx/ClaimFunds/buildClaimFundsRawTx.d.ts

@@ -0,0 +1,2 @@
+import { ClaimTxParams, RawTransaction } from "../types.js";
+export declare function buildClaimRawTx(params: ClaimTxParams): Promise<RawTransaction>;

package/dist/tx/ClaimFunds/buildClaimFundsRawTx.js

@@ -0,0 +1,34 @@
+import { encodeFunctionData } from "viem";
+import { TradePoolAbi } from "../../abi/TradeMarketsAbi.js";
+import { getMarket, getUserOptionShares, isRpcValid } from "./helpers.js";
+import { MARKET_STATUS } from "../../markets/constants.js";
+import { CLAIM } from "../../constants/contractmethods.js";
+export async function buildClaimRawTx(params) {
+    const { marketId, walletAddress, apiUrl, rpcUrl } = params;
+    if (!apiUrl) {
+        throw new Error("Environemnt is not set properly, api url is missing");
+    }
+    const isRpcWorking = await isRpcValid(rpcUrl);
+    if (!rpcUrl || !isRpcWorking) {
+        throw new Error("Provided RPC URL is not valid or not working");
+    }
+    if (!marketId)
+        throw new Error("marketContractAddress is required");
+    if (!walletAddress)
+        throw new Error("walletAddress is required");
+    const { data } = await getMarket({ marketId, apiUrl });
+    if (data?.status !== MARKET_STATUS.Closed)
+        throw new Error("Market is not closed yet. Please wait until the market is closed to claim your funds.");
+    const marketContractAddress = data?.contractAddress;
+    const options = data?.options || 0;
+    const userShares = await getUserOptionShares({ marketContractAddress: marketContractAddress, walletAddress: walletAddress, options: options, rpcUrl: rpcUrl });
+    if (userShares?.length <= 0)
+        throw new Error("No shares to claim for this market");
+    return {
+        to: marketContractAddress,
+        data: encodeFunctionData({
+            abi: TradePoolAbi,
+            functionName: CLAIM,
+        }),
+    };
+}

package/dist/tx/ClaimFunds/helpers.d.ts

@@ -0,0 +1,8 @@
+import { Market } from "../../markets/types.js";
+import { GetUserOptionSharesParams } from "../types.js";
+export declare function getMarket(params: {
+    marketId: string;
+    apiUrl: string;
+}): Promise<Market>;
+export declare function isRpcValid(rpcUrl: string | undefined): Promise<boolean>;
+export declare function getUserOptionShares(params: GetUserOptionSharesParams): Promise<number[]>;

package/dist/tx/ClaimFunds/helpers.js

@@ -0,0 +1,37 @@
+import { Contract, JsonRpcProvider } from "ethers";
+import { TradePoolAbi } from "../../abi/TradeMarketsAbi.js";
+export async function getMarket(params) {
+    if (!params?.apiUrl) {
+        throw new Error("Environemnt is not set properly, api url is missing");
+    }
+    const res = await fetch(`${params.apiUrl}/pools/pool/${params.marketId}`);
+    if (!res.ok) {
+        throw new Error(`Failed to fetch markets: ${res.status}`);
+    }
+    const data = await res.json();
+    return data;
+}
+export async function isRpcValid(rpcUrl) {
+    if (!rpcUrl)
+        return false;
+    const provider = new JsonRpcProvider(rpcUrl);
+    try {
+        await provider.getNetwork();
+        return true;
+    }
+    catch (error) {
+        return false;
+    }
+}
+export async function getUserOptionShares(params) {
+    const { marketContractAddress, options, walletAddress, rpcUrl } = params;
+    const provider = new JsonRpcProvider(rpcUrl);
+    const userShares = [];
+    for (let i = 0; i < options.length; i++) {
+        const choiceIndex = options[i].choiceIndex;
+        const contract = new Contract(marketContractAddress, TradePoolAbi, provider);
+        const userVotes = await contract.userVotes(choiceIndex, walletAddress);
+        Number(userVotes) > 0 && userShares.push(Number(userVotes));
+    }
+    return userShares;
+}

package/dist/tx/types.d.ts

@@ -35,3 +35,18 @@ export interface CreateMarketTxParams {
     tokenDecimals?: number;
     factoryContractAddress?: `0x${string}`;
 }
+export interface ClaimTxParams {
+    marketId: string;
+    walletAddress: `0x${string}`;
+    apiUrl?: string;
+    rpcUrl?: string;
+}
+export interface GetUserOptionSharesParams {
+    options: [{
+        choiceIndex: number;
+        optionName: string;
+    }];
+    walletAddress: `0x${string}`;
+    marketContractAddress: `0x${string}`;
+    rpcUrl: string;
+}

package/dist/types.d.ts

@@ -10,4 +10,5 @@ export interface RainConfig {
 export type RainEnvironment = "development" | "stage" | "production";
 export interface RainCoreConfig {
     environment?: RainEnvironment;
+    rpcUrl?: string;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@rainprotocolsdk/sdk",
-    "version": "1.2.0",
+    "version": "1.3.0",
     "type": "module",
     "description": "Rain SDK",
     "main": "dist/index.js",