@coffer_so/sdk 1.0.0

package/dist/clients/CubicPoolClient.d.ts

@@ -0,0 +1,120 @@
+import { PublicKey, Commitment } from "@solana/web3.js";
+import BN from "bn.js";
+import { CofferConfig } from "../config";
+import { PoolInfo } from "../types/pool";
+import { SdkResult } from "../types/result";
+import { AddLiquidityQuote, SwapQuote, SingleTokenDepositQuote } from "../types/tx";
+import { CubicPoolEvent } from "../types/events";
+import { RpcClient } from "./RpcClient";
+import { SelloffWindowStatus } from "../math/maxSelloff";
+import { AddLiquidityParams, BuiltTx, RemoveLiquidityParams, SingleTokenDepositParams, SwapParams } from "../types/tx";
+import { SingleTokenDepositClient } from "./SingleTokenDepositClient";
+export interface CubicPoolClientParams {
+    config: CofferConfig;
+    poolAddress: PublicKey;
+    rpc?: RpcClient | {
+        endpoint?: string;
+        endpoints?: string[];
+        fallbackEndpoints?: string[];
+        apiKey?: string;
+        commitment?: Commitment;
+        timeoutMs?: number;
+    };
+}
+/**
+ * Per-pool client. Fetch the state with `sync()`, then call any of the
+ * quote / buildTx methods off the cached snapshot.
+ */
+export declare class CubicPoolClient {
+    readonly config: CofferConfig;
+    readonly poolAddress: PublicKey;
+    readonly rpc: RpcClient;
+    private cache;
+    /** Raw decoded account from the last `sync()`; holds per-token window data. */
+    private rawAccount;
+    constructor(params: CubicPoolClientParams);
+    /** Last-fetched pool state. `undefined` before first `sync()`. */
+    getCached(): PoolInfo | undefined;
+    /**
+     * Fetch and decode the pool account + BPT mint + per-token mint decimals.
+     * Safe to call repeatedly; subsequent calls replace the cache.
+     */
+    sync(): Promise<SdkResult<PoolInfo>>;
+    /** Derived helper PDA for this pool (used by single-token-deposit). */
+    helperPda(): PublicKey;
+    /**
+     * Quote a swap. Requires the cache to be populated (call `sync()` first).
+     * Returns exact on-chain math result + spot bound + price impact +
+     * slippage-derived minAmountOut.
+     */
+    quoteSwap(tokenInIndex: number, tokenOutIndex: number, amountIn: BN, slippageHundredthsBps?: number, nowSeconds?: number): SdkResult<SwapQuote>;
+    /**
+     * Read-only status of a token's max-selloff window at `now`
+     * (default: current unix seconds). Requires a prior `sync()`.
+     */
+    getSelloffWindowStatus(tokenIndex: number, now?: number): SdkResult<SelloffWindowStatus>;
+    /**
+     * Quote a single-token deposit: split amountIn by W-based shares, quote
+     * each swap leg, then execute the helper cap and proportional-join math.
+     * `helperBalances` supplies existing helper ATA holdings (defaults to zero).
+     * Pass them when the helper contains donations or dust; all leftovers are refunded.
+     */
+    quoteSingleTokenDeposit(tokenInIndex: number, amountIn: BN, slippageHundredthsBps?: number, nowSeconds?: number, helperBalances?: BN[]): SdkResult<SingleTokenDepositQuote>;
+    /** Seed deposit: creator-only, exact amounts, BPT derived from virtual reserves. */
+    quoteSeedDeposit(user: PublicKey, tokenAmounts: BN[], slippageHundredthsBps?: number): SdkResult<AddLiquidityQuote>;
+    /**
+     * Proportional-join quote. `tokenAmounts` is a CEILING (v5.1, audit
+     * M-4 / I-1): the program takes the largest strictly-proportional basket
+     * that fits inside it and leaves the rest in the wallet. This returns the
+     * basket it will actually pull, the BPT it will mint, and a
+     * slippage-derived `minimumBptAmount` to pass to `buildAddLiquidityTx`.
+     *
+     * Not applicable to the seed deposit (BPT supply == 0): the program
+     * mints invariant-based BPT there and takes the full amounts.
+     */
+    quoteAddLiquidity(tokenAmounts: BN[], slippageHundredthsBps?: number): SdkResult<AddLiquidityQuote>;
+    /** Proportional-withdraw quote for a given BPT amount. */
+    quoteRemove(bptIn: BN): SdkResult<{
+        tokenOuts: BN[];
+        effectiveBptIn: BN;
+    }>;
+    /** Build a swap transaction. Requires `sync()` first. */
+    buildSwapTx(params: SwapParams): SdkResult<BuiltTx>;
+    /** Build a proportional add-liquidity transaction. Requires `sync()` first. */
+    buildAddLiquidityTx(params: AddLiquidityParams): SdkResult<BuiltTx>;
+    /** Build a proportional remove-liquidity transaction. Requires `sync()` first. */
+    buildRemoveLiquidityTx(params: RemoveLiquidityParams): SdkResult<BuiltTx>;
+    /**
+     * Build a single-token deposit transaction (swaps + add_liquidity via the
+     * helper program + BPT forward to user). Requires `sync()` first.
+     */
+    buildSingleTokenDepositTx(params: SingleTokenDepositParams): SdkResult<BuiltTx>;
+    /**
+     * Single-token deposit split into `{ setup, deposit }` transactions.
+     *
+     * Required for pools beyond a handful of tokens: the ATA creates and the
+     * zap compete for the same 64-frame instruction-trace budget, and at
+     * N=10 the zap alone uses 52 of them. Send `setup` (idempotent, safe to
+     * repeat), wait for confirmation, then send `deposit` compiled against
+     * the pool's ALT via `compileBuiltTx`.
+     */
+    buildSingleTokenDepositTxs(params: SingleTokenDepositParams): SdkResult<{
+        setup: BuiltTx | null;
+        deposit: BuiltTx;
+    }>;
+    /** Proxy into the dedicated SingleTokenDepositClient for consumers who
+     *  want the quote/build methods exposed on a focused object. */
+    get singleTokenDeposit(): SingleTokenDepositClient;
+    private _std?;
+    /** Parse logs from a confirmed transaction into typed events. */
+    parseEventsFromLogs(logs: string[]): CubicPoolEvent[];
+    /**
+     * Refuse when any of `indices` (or every token, for `"all"`) has an
+     * unsupported Token-2022 extension. The program would revert inside the
+     * token program on transfer, so failing here saves the user a fee.
+     */
+    private requireSupported;
+    private validateDepositWindows;
+    private requireCache;
+}
+//# sourceMappingURL=CubicPoolClient.d.ts.map

package/dist/clients/CubicPoolClient.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"CubicPoolClient.d.ts","sourceRoot":"","sources":["../../src/clients/CubicPoolClient.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,SAAS,EAAE,UAAU,EAAuB,MAAM,iBAAiB,CAAC;AAC7E,OAAO,EAAE,MAAM,OAAO,CAAC;AACvB,OAAO,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AACzC,OAAO,EAAE,QAAQ,EAAiB,MAAM,eAAe,CAAC;AACxD,OAAO,EAAE,SAAS,EAAW,MAAM,iBAAiB,CAAC;AACrD,OAAO,EAAE,iBAAiB,EAAE,SAAS,EAAE,uBAAuB,EAAE,MAAM,aAAa,CAAC;AACpF,OAAO,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AACjD,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAgBxC,OAAO,EAKL,mBAAmB,EACpB,MAAM,oBAAoB,CAAC;AAS5B,OAAO,EACL,kBAAkB,EAClB,OAAO,EACP,qBAAqB,EACrB,wBAAwB,EACxB,UAAU,EACX,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAC;AAEtE,MAAM,WAAW,qBAAqB;IACpC,MAAM,EAAE,YAAY,CAAC;IACrB,WAAW,EAAE,SAAS,CAAC;IACvB,GAAG,CAAC,EACA,SAAS,GACT;QACE,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;QACrB,iBAAiB,CAAC,EAAE,MAAM,EAAE,CAAC;QAC7B,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,UAAU,CAAC,EAAE,UAAU,CAAC;QACxB,SAAS,CAAC,EAAE,MAAM,CAAC;KACpB,CAAC;CACP;AAED;;;GAGG;AACH,qBAAa,eAAe;IAC1B,QAAQ,CAAC,MAAM,EAAE,YAAY,CAAC;IAC9B,QAAQ,CAAC,WAAW,EAAE,SAAS,CAAC;IAChC,QAAQ,CAAC,GAAG,EAAE,SAAS,CAAC;IAExB,OAAO,CAAC,KAAK,CAAuB;IACpC,+EAA+E;IAC/E,OAAO,CAAC,UAAU,CAA6B;gBAEnC,MAAM,EAAE,qBAAqB;IAgBzC,kEAAkE;IAClE,SAAS,IAAI,QAAQ,GAAG,SAAS;IAIjC;;;OAGG;IACG,IAAI,IAAI,OAAO,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;IA+H1C,uEAAuE;IACvE,SAAS,IAAI,SAAS;IAMtB;;;;OAIG;IACH,SAAS,CACP,YAAY,EAAE,MAAM,EACpB,aAAa,EAAE,MAAM,EACrB,QAAQ,EAAE,EAAE,EACZ,qBAAqB,CAAC,EAAE,MAAM,EAC9B,UAAU,CAAC,EAAE,MAAM,GAClB,SAAS,CAAC,SAAS,CAAC;IAgEvB;;;OAGG;IACH,sBAAsB,CAAC,UAAU,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC,mBAAmB,CAAC;IA0BxF;;;;;OAKG;IACH,uBAAuB,CACrB,YAAY,EAAE,MAAM,EACpB,QAAQ,EAAE,EAAE,EACZ,qBAAqB,CAAC,EAAE,MAAM,EAC9B,UAAU,CAAC,EAAE,MAAM,EACnB,cAAc,CAAC,EAAE,EAAE,EAAE,GACpB,SAAS,CAAC,uBAAuB,CAAC;IAoErC,oFAAoF;IACpF,gBAAgB,CAAC,IAAI,EAAE,SAAS,EAAE,YAAY,EAAE,EAAE,EAAE,EAAE,qBAAqB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC,iBAAiB,CAAC;IAwBnH;;;;;;;;;OASG;IACH,iBAAiB,CAAC,YAAY,EAAE,EAAE,EAAE,EAAE,qBAAqB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC,iBAAiB,CAAC;IAyDnG,0DAA0D;IAC1D,WAAW,CAAC,KAAK,EAAE,EAAE,GAAG,SAAS,CAAC;QAAE,SAAS,EAAE,EAAE,EAAE,CAAC;QAAC,cAAc,EAAE,EAAE,CAAA;KAAE,CAAC;IAmC1E,yDAAyD;IACzD,WAAW,CAAC,MAAM,EAAE,UAAU,GAAG,SAAS,CAAC,OAAO,CAAC;IAiCnD,+EAA+E;IAC/E,mBAAmB,CAAC,MAAM,EAAE,kBAAkB,GAAG,SAAS,CAAC,OAAO,CAAC;IAenE,kFAAkF;IAClF,sBAAsB,CAAC,MAAM,EAAE,qBAAqB,GAAG,SAAS,CAAC,OAAO,CAAC;IAqBzE;;;OAGG;IACH,yBAAyB,CAAC,MAAM,EAAE,wBAAwB,GAAG,SAAS,CAAC,OAAO,CAAC;IAa/E;;;;;;;;OAQG;IACH,0BAA0B,CACxB,MAAM,EAAE,wBAAwB,GAC/B,SAAS,CAAC;QAAE,KAAK,EAAE,OAAO,GAAG,IAAI,CAAC;QAAC,OAAO,EAAE,OAAO,CAAA;KAAE,CAAC;IAazD;oEACgE;IAChE,IAAI,kBAAkB,IAAI,wBAAwB,CASjD;IACD,OAAO,CAAC,IAAI,CAAC,CAA2B;IAIxC,iEAAiE;IACjE,mBAAmB,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,cAAc,EAAE;IAMrD;;;;OAIG;IACH,OAAO,CAAC,gBAAgB;IAaxB,OAAO,CAAC,sBAAsB;IAS9B,OAAO,CAAC,YAAY;CAMrB"}