@rainprotocolsdk/sdk 1.0.0 → 1.0.1

package/README.md

@@ -0,0 +1,191 @@
+# Rain SDK Documentation
+
+## Overview
+
+Rain SDK is designed as a **clean, modular, and extensible TypeScript SDK** for interacting with Rain markets and preparing on-chain transactions.
+
+The SDK is intentionally split into two layers:
+
+* **Rain** → Stateless, public-facing utilities (data fetching, raw transaction builders)
+* **RainAA** → Stateful Account Abstraction layer (smart accounts)
+
+---
+
+## Installation
+
+```bash
+npm install @rainprotocolsdk/sdk
+```
+
+or
+
+```bash
+yarn add @rainprotocolsdk/sdk
+```
+
+---
+
+### Initialization
+
+```ts
+import { Rain } from "@rainprotocolsdk/sdk";
+
+const rain = new Rain();
+```
+
+> The constructor is intentionally empty to allow future configuration without breaking changes.
+
+---
+
+## getPublicMarkets
+
+Fetches public market data from the Rain backend.
+
+### Method Signature
+
+```ts
+getPublicMarkets(params: GetMarketsParams): Promise<Market[]>;
+```
+
+### Parameters
+
+```ts
+interface GetMarketsParams {
+  limit: number;
+  offset: number;
+  sortBy?: "totalVolume" | "createdAt" | "liquidity";
+  status?: "Live" | "Resolved" | "Closed";
+}
+```
+
+### Example
+
+```ts
+const markets = await rain.getPublicMarkets({
+  limit?: 12,
+  offset?: 1,
+  sortBy?: "totalVolume",
+  status?: "Live",
+});
+```
+
+---
+
+## buildBuyOptionRawTx
+
+Builds a **raw EVM transaction** for entering a market option.
+
+This function **does not send the transaction** — it only prepares calldata.
+
+### Method Signature
+
+```ts
+buildBuyOptionRawTx(params: EnterOptionTxParams): RawTransaction;
+```
+
+### Parameters
+
+```ts
+interface EnterOptionTxParams {
+  address: `0x${string}`;        // Trademarket contract address
+  selectedOption: number;       // Option index
+  buyInWei: bigint;              // Amount in wei
+}
+```
+
+### Return Type
+
+```ts
+interface RawTransaction {
+  to: `0x${string}`;
+  data: `0x${string}`;
+}
+```
+
+### Example
+
+```ts
+const rawTx = rain.buildBuyOptionRawTx({
+  address: `0x${string}`,
+  selectedOption: 1,
+  buyInWei: 1000000000000000000n,
+});
+```
+---
+
+## 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
+   });
+```
+
+---
+
+## RainAA Class (Account Abstraction)
+
+`RainAA` is responsible for:
+
+* Smart account creation
+* Session management (coming soon)
+* Gas-sponsored execution (coming soon)
+* Transaction submission (coming soon)
+
+> `RainAA` consumes raw transactions generated by `Rain`.
+
+### Conceptual Flow
+
+```ts
+Rain (WHAT to do)
+   ↓
+Raw Transaction
+   ↓
+RainAA (HOW to execute)
+```
+
+## Versioning Policy
+
+Rain SDK follows **Semantic Versioning**:
+
+* **Patch** (`1.0.x`) → Bug fixes
+* **Minor** (`1.x.0`) → New features, backward compatible
+* **Major** (`x.0.0`) → Breaking API changes
+
+---
+
+## Recommended Usage Pattern
+
+```ts
+// 1. Read data / build tx
+const rain = new Rain();
+const rawTx = rain.buildBuyOptionRawTx(...);
+
+// 2. Execute via your provider
+await yourprovider.sendTransaction(rawTx);
+```
+
+---
+
+**Rain SDK** is built to scale with both products and protocols.

package/dist/Rain.d.ts

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

package/dist/Rain.js

@@ -1,9 +1,13 @@
 import { getMarkets } from './markets/getMarkets';
 import { buildEnterOptionRawTx } from './tx/buildRawTransactions';
+import { buildApproveRawTx } from './tx/buildApprovalRawTx';
 export class Rain {
     async getPublicMarkets(params) {
         return getMarkets(params);
     }
+    buildApprovalTx(params) {
+        return buildApproveRawTx(params);
+    }
     buildBuyOptionRawTx(params) {
         return buildEnterOptionRawTx(params);
     }

package/dist/{Rainaa.d.ts → RainAA.d.ts}

@@ -1,5 +1,5 @@
 import { RainConfig } from './types';
-export declare class Rain {
+export declare class RainAA {
     private config;
     private _client;
     private _address;

package/dist/{Rainaa.js → RainAA.js}

@@ -2,7 +2,7 @@ import { custom, createWalletClient } from 'viem';
 import { WalletClientSigner } from '@alchemy/aa-core';
 import { alchemy } from "@account-kit/infra";
 import { createSmartWalletClient } from "@account-kit/wallet-client";
-export class Rain {
+export class RainAA {
     config;
     _client = null;
     _address = null;
@@ -15,7 +15,6 @@ export class Rain {
             throw new Error('paymasterPolicyId is required');
         if (!config.chain)
             throw new Error('chain is required');
-        console.log('Rain SDK initialized with config:', config);
         this.config = config;
     }
     /**