rain-sdk-v2 2.4.0 → 2.5.1

package/CHANGELOG.md

@@ -9,6 +9,44 @@ 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.5.1] - Add LICENSE
+
+### Added
+- MIT `LICENSE` file at the repo root so GitHub detects the license (npm already
+  declared MIT). No code changes.
+
+## [2.5.0] - Sell slippage + create-market validation
+
+### Fixed
+- **Unprotected sells (critical):** `buildSellOptionTx` hard-coded `minAmountOut = 0`
+  and silently ignored slippage — every SDK sell shipped with zero MEV/slippage
+  protection despite the docs. It now quotes `getSellProceeds` on-chain and applies
+  `slippageTolerance` (default 5%) when `minAmountOut` is omitted. Verified against
+  live Arbitrum: the quote is the correct (slightly conservative) `minAmountOut`
+  basis. Pass `minAmountOut: 0n` to opt out explicitly.
+- **Silent market-odds corruption:** `createMarket` now validates bar values and
+  option arrays and **throws** instead of silently redistributing the rounding
+  remainder onto the last option (which turned `[60,60]` into a 60/40 market).
+  Enforced: `no_of_options ≥ 2`; `marketOptions` / `barValues` / `initialYesPrices`
+  lengths equal `no_of_options`; each bar value in `0–100`; bar values sum to 100;
+  each `initialYesPrice` in `(0, 1e18)`.
+- **`split` / `merge` option guard:** both now reject `option: 0n` (options are
+  1-based) before any network call — the last two builders missing the guard.
+
+### Changed (breaking)
+- **`buildSellOptionTx` is now async** (`Promise<RawTransaction>`) because it makes
+  an on-chain quote — this matches what the README already documented. Callers must
+  `await` it. `SellOptionTxParams` gains `slippageTolerance?`.
+
+### Added
+- Test coverage grew to cover sell slippage derivation (mocked quote), create-market
+  validation, and the split/merge option guards.
+
+### Note for integrators
+- Confirm the fee treatment of `getSellProceeds` vs. `sellOption` with the contract
+  team; the SDK uses it as the contract's own sell quote and applies the slippage
+  discount to it (empirically a conservative, safe floor).
+
 ## [2.4.0] - Production readiness
 
 No breaking changes to the public API.

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Rain Protocol
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -199,6 +199,8 @@ const txsRain = await rain.buildCreateMarketTx({
 | `tradingModel` | `TradingModel` | `AMM (0)` or `OrderBook (1)` |
 | `marketImage` | `string` | Market image URL (required) |
 
+> **Constraints (validated, throws if violated):** `no_of_options ≥ 2`; `marketOptions`, `barValues`, and (if provided) `initialYesPrices` must each have length `no_of_options`; every `barValue` must be within `0–100` and the set must **sum to 100**; each `initialYesPrice` must be within `(0, 1e18)` exclusive. Previously out-of-spec bar values were silently redistributed onto the last option — they are now rejected.
+
 ---
 
 ### Trading
@@ -237,7 +239,7 @@ const txs = await rain.buildEnterOptionTx({
 
 #### `buildSellOptionTx(params): Promise<RawTransaction>`
 
-Market-sell shares of an option into the resting buy order book. No approval needed (you're selling shares, not tokens). Slippage protection is auto-calculated from on-chain `getCurrentPrice`.
+Market-sell shares of an option into the resting buy order book. No approval needed (you're selling shares, not tokens). Slippage protection is auto-calculated from on-chain `getSellProceeds` (default 5%) when `minAmountOut` is omitted. Pass `minAmountOut: 0n` to opt out explicitly.
 
 ```typescript
 const tx = await rain.buildSellOptionTx({
@@ -257,7 +259,7 @@ const tx = await rain.buildSellOptionTx({
 | `selectedOption` | `bigint` | Option index (1-based) |
 | `optionSide` | `OptionSide` | `Yes (1)` or `No (2)` |
 | `sharesAmount` | `bigint` | Number of shares to sell |
-| `minAmountOut` | `bigint` | *(Optional)* Minimum base tokens to receive. Auto-calculated from `getCurrentPrice` with slippage if not set |
+| `minAmountOut` | `bigint` | *(Optional)* Minimum base tokens to receive. Auto-calculated from `getSellProceeds` with slippage if not set. Pass `0n` to opt out |
 | `slippageTolerance` | `bigint` | *(Optional)* Slippage percentage (e.g. `5n` = 5%). Default: 5% |
 | `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/Rain.d.ts

@@ -56,7 +56,7 @@ export declare class Rain {
     buildEnterOptionTx(params: EnterOptionTxParams & {
         walletAddress: `0x${string}`;
     }): Promise<RawTransaction[]>;
-    buildSellOptionTx(params: SellOptionTxParams): RawTransaction;
+    buildSellOptionTx(params: SellOptionTxParams): Promise<RawTransaction>;
     buildAddLiquidityTx(params: AddLiquidityTxParams & {
         walletAddress: `0x${string}`;
     }): Promise<RawTransaction[]>;

package/dist/Rain.js

@@ -164,8 +164,8 @@ export class Rain {
     async buildEnterOptionTx(params) {
         return buildEnterOptionRawTx({ ...params, rpcUrl: this.rpcUrl });
     }
-    buildSellOptionTx(params) {
-        return buildSellOptionRawTx(params);
+    async buildSellOptionTx(params) {
+        return buildSellOptionRawTx({ ...params, rpcUrl: this.rpcUrl });
     }
     async buildAddLiquidityTx(params) {
         return buildAddLiquidityRawTx({ ...params, rpcUrl: this.rpcUrl });

package/dist/tx/CreateMarket/createMarketValidation.js

@@ -1,5 +1,5 @@
 export function validateCreateMarketParams(params) {
-    const { marketQuestion, marketOptions, marketTags, marketDescription, isPublic, isPublicPoolResolverAi, creator, startTime, endTime, no_of_options, inputAmountWei, barValues, baseToken, factoryContractAddress, tokenDecimals, } = params;
+    const { marketQuestion, marketOptions, marketTags, marketDescription, isPublic, isPublicPoolResolverAi, creator, startTime, endTime, no_of_options, inputAmountWei, barValues, baseToken, factoryContractAddress, tokenDecimals, initialYesPrices, } = params;
     // Required field validations
     if (typeof isPublic !== "boolean")
         throw new Error("isPublic is required and must be a boolean");
@@ -48,5 +48,33 @@ export function validateCreateMarketParams(params) {
     }
     if (startTime >= endTime)
         throw new Error("startTime must be earlier than endTime");
+    // Cross-field validation — these previously slipped through and were silently
+    // "fixed" by normalizeBarValues (which dumped the rounding remainder onto the
+    // last option, producing odds the caller never asked for). Reject loudly instead.
+    const optionCount = Number(no_of_options);
+    if (optionCount < 2)
+        throw new Error("no_of_options must be at least 2");
+    if (marketOptions.length !== optionCount) {
+        throw new Error(`marketOptions length (${marketOptions.length}) must equal no_of_options (${optionCount})`);
+    }
+    if (barValues.length !== optionCount) {
+        throw new Error(`barValues length (${barValues.length}) must equal no_of_options (${optionCount})`);
+    }
+    if (barValues.some(v => typeof v !== "number" || !Number.isFinite(v) || v < 0 || v > 100)) {
+        throw new Error("each barValue must be a number between 0 and 100");
+    }
+    const barSum = barValues.reduce((s, v) => s + v, 0);
+    if (Math.abs(barSum - 100) > 0.01) {
+        throw new Error(`barValues must sum to 100 (got ${barSum})`);
+    }
+    if (initialYesPrices !== undefined) {
+        if (initialYesPrices.length !== optionCount) {
+            throw new Error(`initialYesPrices length (${initialYesPrices.length}) must equal no_of_options (${optionCount})`);
+        }
+        const ONE = 10n ** 18n;
+        if (initialYesPrices.some(p => p <= 0n || p >= ONE)) {
+            throw new Error("each initialYesPrice must be within (0, 1e18) exclusive");
+        }
+    }
     return true;
 }

package/dist/tx/buildMergeRawTx.js

@@ -1,6 +1,7 @@
 import { encodeFunctionData } from "viem";
 import { MarketsAbi } from "../abi/MarketsAbi.js";
 import { MERGE } from "../constants/contractmethods.js";
+import { assertOption } from "./validation.js";
 export function buildMergeRawTx(params) {
     const { marketContractAddress, option, amount } = params;
     if (!marketContractAddress)
@@ -9,6 +10,7 @@ export function buildMergeRawTx(params) {
         throw new Error("option is required");
     if (!amount || amount <= 0n)
         throw new Error("amount must be greater than 0");
+    assertOption(option);
     return {
         to: marketContractAddress,
         data: encodeFunctionData({

package/dist/tx/buildSellOptionRawTx.d.ts

@@ -1,2 +1,4 @@
 import { SellOptionTxParams, RawTransaction } from "./types.js";
-export declare function buildSellOptionRawTx(params: SellOptionTxParams): RawTransaction;
+export declare function buildSellOptionRawTx(params: SellOptionTxParams & {
+    rpcUrl: string;
+}): Promise<RawTransaction>;

package/dist/tx/buildSellOptionRawTx.js

@@ -1,10 +1,12 @@
 import { encodeFunctionData } from "viem";
 import { MarketsAbi } from "../abi/MarketsAbi.js";
 import { SELL_OPTION } from "../constants/contractmethods.js";
-import { assertOption, assertDeadline } from "./validation.js";
+import { assertOption, assertSlippage, assertDeadline } from "./validation.js";
+import { getSellProceeds } from "../markets/getSellProceeds.js";
+const DEFAULT_SLIPPAGE = 5n; // 5%
 const DEFAULT_DEADLINE_DURATION = 600; // 10 minutes
-export function buildSellOptionRawTx(params) {
-    const { marketContractAddress, selectedOption, optionSide, sharesAmount, minAmountOut, deadline } = params;
+export async function buildSellOptionRawTx(params) {
+    const { marketContractAddress, selectedOption, optionSide, sharesAmount, minAmountOut, slippageTolerance, deadline, rpcUrl } = params;
     const effectiveDeadline = deadline ?? BigInt(Math.floor(Date.now() / 1000) + DEFAULT_DEADLINE_DURATION);
     if (!marketContractAddress)
         throw new Error("marketContractAddress is required");
@@ -17,13 +19,29 @@ export function buildSellOptionRawTx(params) {
     if (sharesAmount <= 0n)
         throw new Error("sharesAmount must be greater than 0");
     assertOption(selectedOption, "selectedOption");
+    assertSlippage(slippageTolerance);
     assertDeadline(deadline);
+    // Slippage protection: when the caller does not pin minAmountOut, quote the
+    // expected proceeds on-chain (getSellProceeds — a conservative quote) and
+    // apply the slippage tolerance. Pass minAmountOut: 0n to opt out explicitly.
+    let effectiveMinAmountOut = minAmountOut;
+    if (effectiveMinAmountOut === undefined || effectiveMinAmountOut === null) {
+        const { proceeds } = await getSellProceeds({
+            marketContractAddress,
+            option: selectedOption,
+            optionSide,
+            shares: sharesAmount,
+            rpcUrl,
+        });
+        const slippage = slippageTolerance ?? DEFAULT_SLIPPAGE;
+        effectiveMinAmountOut = proceeds * (100n - slippage) / 100n;
+    }
     return {
         to: marketContractAddress,
         data: encodeFunctionData({
             abi: MarketsAbi,
             functionName: SELL_OPTION,
-            args: [selectedOption, optionSide, sharesAmount, minAmountOut ?? 0n, effectiveDeadline],
+            args: [selectedOption, optionSide, sharesAmount, effectiveMinAmountOut, effectiveDeadline],
         }),
         value: 0n,
     };

package/dist/tx/buildSplitRawTx.js

@@ -3,6 +3,7 @@ import { MarketsAbi } from "../abi/MarketsAbi.js";
 import { SPLIT } from "../constants/contractmethods.js";
 import { checkMarketTokenAllowance } from "../utils/helpers.js";
 import { buildApproveRawTx } from "./buildApprovalRawTx.js";
+import { assertOption } from "./validation.js";
 export async function buildSplitRawTx(params) {
     const { marketContractAddress, option, amount, walletAddress, rpcUrl } = params;
     if (!marketContractAddress)
@@ -11,6 +12,7 @@ export async function buildSplitRawTx(params) {
         throw new Error("option is required");
     if (!amount || amount <= 0n)
         throw new Error("amount must be greater than 0");
+    assertOption(option);
     const { allowance, baseToken } = await checkMarketTokenAllowance({ marketContractAddress, owner: walletAddress, rpcUrl });
     const txs = [];
     if (allowance < amount) {

package/dist/tx/types.d.ts

@@ -31,6 +31,7 @@ export interface SellOptionTxParams {
     optionSide: OptionSide;
     sharesAmount: bigint;
     minAmountOut?: bigint;
+    slippageTolerance?: bigint;
     deadline?: bigint;
 }
 export interface PlaceBuyOrderTxParams {

package/package.json

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