@rainprotocolsdk/sdk 1.0.4 → 1.1.0

package/README.md

@@ -71,6 +71,37 @@ const markets = await rain.getPublicMarkets({
 
 ---
 
+## buildApprovalTx
+
+```
+Builds a raw ERC20 approval transaction if needed.
+
+This function prepares an unsigned approve(spender, amount) transaction and does not execute it.
+
+If amount is not provided, a default large allowance is approved.
+```
+
+### Return Type
+
+```ts
+interface RawTransaction {
+  to: `0x${string}`;
+  data: `0x${string}`;
+}
+```
+
+### Example
+
+```ts
+const approvalTx = rain.buildApprovalTx({ 
+  tokenAddress: `0x${string}`, // Approval token address 
+  spender: `0x${string}`,  // Market contract address
+  amount?: 1000000000000000000n // optional parameter
+   });
+```
+
+---
+
 ## buildBuyOptionRawTx
 
 Builds a **raw EVM transaction** for entering a market option.
@@ -113,15 +144,38 @@ const rawTx = rain.buildBuyOptionRawTx({
 ```
 ---
 
-## buildApprovalTx
+## buildLimitBuyOptionTx
 
+Builds a **raw EVM transaction** for placing a limit buy order on a Rain market.
+
+This function **does not send the transaction** — it only prepares calldata.
+
+### Method Signature
+
+```ts
+buildLimitBuyOptionTx(params: EnterLimitOptionTxParams): RawTransaction
 ```
-Builds a raw ERC20 approval transaction if needed.
 
-This function prepares an unsigned approve(spender, amount) transaction and does not execute it.
+### Parameters
 
-If amount is not provided, a default large allowance is approved.
+```ts
+interface EnterLimitOptionTxParams {
+    marketContractAddress: `0x${string}`; // market contract address
+    selectedOption: number; // Option index
+    pricePerShare: bigint; // price per share
+    buyAmountInWei: bigint; // total buy amount (already converted to token wei)
+    tokenDecimals?: number; // token decimals optional (default: `6`)
+}
 ```
+### Validations
+
+| Field                   | Type          | Required | Description                                            |
+| ----------------------- | ------------- | -------- | ------------------------------------------------------ |
+| `marketContractAddress` | `0x${string}` | ✅        | Address of the market contract             |
+| `selectedOption`        | `number`      | ✅        | Option index to place the buy order for                |
+| `pricePerShare`         | `number`      | ✅        | Limit price per share (between `0` and `1`)            |
+| `buyAmountInWei`        | `bigint`      | ✅        | Total amount to spend (already converted to token wei) |
+| `tokenDecimals`         | `number`      | ❌        | Token decimals optional (default: `6`)                          |
 
 ### Return Type
 
@@ -135,11 +189,12 @@ interface RawTransaction {
 ### Example
 
 ```ts
-const approvalTx = rain.buildApprovalTx({ 
-  tokenAddress: `0x${string}`, // Approval token address 
-  spender: `0x${string}`,  // Market contract address
-  amount?: 1000000000000000000n // optional parameter
-   });
+rain.buildLimitBuyOptionTx({
+    marketContractAddress: `0x${string}`,
+    buyAmountInWei: 1000000,
+    pricePerShare: 0.1,
+    selectedOption: 1,
+  })
 ```
 
 ---

package/dist/Rain.d.ts

@@ -1,7 +1,8 @@
 import { GetMarketsParams, Market } from './markets/types.js';
-import { ApproveTxParams, EnterOptionTxParams, RawTransaction } from './tx/types.js';
+import { ApproveTxParams, EnterLimitOptionTxParams, EnterOptionTxParams, RawTransaction } from './tx/types.js';
 export declare class Rain {
     getPublicMarkets(params: GetMarketsParams): Promise<Market[]>;
     buildApprovalTx(params: ApproveTxParams): RawTransaction | Error;
     buildBuyOptionRawTx(params: EnterOptionTxParams): RawTransaction;
+    buildLimitBuyOptionTx(params: EnterLimitOptionTxParams): RawTransaction;
 }

package/dist/Rain.js

@@ -1,5 +1,5 @@
 import { getMarkets } from './markets/getMarkets.js';
-import { buildEnterOptionRawTx } from './tx/buildRawTransactions.js';
+import { buildEnterOptionRawTx, buildLimitBuyOrderRawTx } from './tx/buildRawTransactions.js';
 import { buildApproveRawTx } from './tx/buildApprovalRawTx.js';
 export class Rain {
     async getPublicMarkets(params) {
@@ -11,4 +11,7 @@ export class Rain {
     buildBuyOptionRawTx(params) {
         return buildEnterOptionRawTx(params);
     }
+    buildLimitBuyOptionTx(params) {
+        return buildLimitBuyOrderRawTx(params);
+    }
 }

package/dist/constants/contractmethods.d.ts

@@ -0,0 +1,3 @@
+export declare const ENTER_OPTION = "enterOption";
+export declare const PLACE_BUY_ORDER = "placeBuyOrder";
+export declare const APPROVE_TOKEN = "approve";

package/dist/constants/contractmethods.js

@@ -0,0 +1,3 @@
+export const ENTER_OPTION = 'enterOption';
+export const PLACE_BUY_ORDER = 'placeBuyOrder';
+export const APPROVE_TOKEN = 'approve';

package/dist/tx/buildApprovalRawTx.js

@@ -1,6 +1,7 @@
 import { encodeFunctionData } from "viem";
 import { ERC20Abi } from "../abi/ERC20Abi.js";
 import { ethers } from "ethers";
+import { APPROVE_TOKEN } from "../constants/contractmethods.js";
 const DEFAULT_APPROVE_AMOUNT = ethers.MaxUint256;
 export function buildApproveRawTx(params) {
     const { tokenAddress, spender, amount = DEFAULT_APPROVE_AMOUNT, } = params;
@@ -12,7 +13,7 @@ export function buildApproveRawTx(params) {
         to: tokenAddress,
         data: encodeFunctionData({
             abi: ERC20Abi,
-            functionName: "approve",
+            functionName: APPROVE_TOKEN,
             args: [spender, amount],
         }),
         value: 0n,

package/dist/tx/buildRawTransactions.d.ts

@@ -1,2 +1,3 @@
-import { EnterOptionTxParams, RawTransaction } from './types.js';
+import { EnterLimitOptionTxParams, EnterOptionTxParams, RawTransaction } from './types.js';
 export declare function buildEnterOptionRawTx(params: EnterOptionTxParams): RawTransaction;
+export declare function buildLimitBuyOrderRawTx(params: EnterLimitOptionTxParams): RawTransaction;

package/dist/tx/buildRawTransactions.js

@@ -1,5 +1,7 @@
 import { encodeFunctionData } from 'viem';
 import { TradePoolAbi } from '../abi/TradeMarketsAbi.js';
+import { convertToWeiEthers } from '../utils/helpers.js';
+import { ENTER_OPTION, PLACE_BUY_ORDER } from '../constants/contractmethods.js';
 export function buildEnterOptionRawTx(params) {
     const { marketContractAddress, selectedOption, buyAmountInWei } = params;
     if (!marketContractAddress)
@@ -12,8 +14,44 @@ export function buildEnterOptionRawTx(params) {
         to: marketContractAddress,
         data: encodeFunctionData({
             abi: TradePoolAbi,
-            functionName: 'enterOption',
+            functionName: ENTER_OPTION,
             args: [selectedOption, buyAmountInWei],
         }),
     };
 }
+export function buildLimitBuyOrderRawTx(params) {
+    const { marketContractAddress, selectedOption, pricePerShare, buyAmountInWei, tokenDecimals } = params;
+    const decimals = tokenDecimals ?? 6;
+    const oneTokenInWei = 10n ** BigInt(decimals);
+    if (!marketContractAddress) {
+        throw new Error("market address is required");
+    }
+    if (selectedOption === undefined) {
+        throw new Error("selectedOption is required");
+    }
+    if (!pricePerShare) {
+        throw new Error("price per share is required");
+    }
+    if (pricePerShare <= 0 || pricePerShare >= 1) {
+        throw new Error("price per share should be in between 0 to 1, make sure to convert to correct decimals");
+    }
+    if (!buyAmountInWei) {
+        throw new Error("buy amount in wei is required");
+    }
+    if (buyAmountInWei < oneTokenInWei) {
+        throw new Error("order amount should be more then $1");
+    }
+    const pricePerShareInEther = convertToWeiEthers(pricePerShare, 18);
+    return {
+        to: marketContractAddress,
+        data: encodeFunctionData({
+            abi: TradePoolAbi,
+            functionName: PLACE_BUY_ORDER,
+            args: [
+                BigInt(selectedOption),
+                pricePerShareInEther,
+                buyAmountInWei,
+            ],
+        }),
+    };
+}

package/dist/tx/types.d.ts

@@ -13,3 +13,10 @@ export type ApproveTxParams = {
     spender: `0x${string}`;
     amount?: bigint;
 };
+export interface EnterLimitOptionTxParams {
+    marketContractAddress: `0x${string}`;
+    selectedOption: number;
+    pricePerShare: bigint;
+    buyAmountInWei: bigint;
+    tokenDecimals?: number;
+}

package/dist/utils/helpers.d.ts

@@ -0,0 +1 @@
+export declare const convertToWeiEthers: (value: string | bigint, decimals: number) => bigint;

package/dist/utils/helpers.js

@@ -0,0 +1,4 @@
+import { ethers } from "ethers";
+export const convertToWeiEthers = (value, decimals) => {
+    return ethers.parseUnits(value.toString(), decimals);
+};

package/package.json

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