@exponent-labs/exponent-sdk 0.1.8 → 0.9.0

package/build/orderbook/orderbook.d.ts

@@ -1,30 +1,31 @@
-/// <reference types="bn.js" />
-import { BN, web3 } from "@coral-xyz/anchor";
 import { ExponentAdminPda } from "@exponent-labs/exponent-admin-pda";
 import { ExponentOrderbookPDA, ExponentPDA } from "@exponent-labs/exponent-pda";
 import { AccountInfo, ConfigurationOptions, OrderbookState } from "@exponent-labs/exponent-types";
-import { ClaimAmount } from "@exponent-labs/marginfi-sy-sdk";
 import { Environment } from "../environment";
 import { Vault } from "../vault";
-import { Offer, OfferOptionsAnchor, OfferTypeAnchor, OrderbookLoadOptions, QuoteDirection } from "./types";
+import { Offer, OrderbookLoadOptions, QuoteDirection } from "./types";
+import * as exponentOrderbook from '../client/orderbook';
+import { PublicKey, Connection, TransactionInstruction } from "@solana/web3.js";
 export declare class Orderbook {
     state: OrderbookState;
-    selfAddress: web3.PublicKey;
+    selfAddress: PublicKey;
     env: Environment;
-    connection: web3.Connection;
-    vaulLookupTable: web3.PublicKey;
-    private orderbookProgram;
-    private coreProgram;
-    constructor(state: OrderbookState, selfAddress: web3.PublicKey, env: Environment, connection: web3.Connection, vaulLookupTable: web3.PublicKey);
-    static load(env: Environment, connection: web3.Connection, address: web3.PublicKey, options?: OrderbookLoadOptions, vault?: Vault): Promise<Orderbook>;
-    reload(conn?: web3.Connection): Promise<Orderbook>;
+    connection: Connection;
+    vaulLookupTable: PublicKey;
+    /** Vault instance - required for merge/strip which uses vault's SY position (owned by vault authority) */
+    vault: Vault;
+    constructor(state: OrderbookState, selfAddress: PublicKey, env: Environment, connection: Connection, vaulLookupTable: PublicKey, 
+    /** Vault instance - required for merge/strip which uses vault's SY position (owned by vault authority) */
+    vault: Vault);
+    static load(env: Environment, connection: Connection, address: PublicKey, options?: OrderbookLoadOptions, vault?: Vault): Promise<Orderbook>;
+    reload(conn?: Connection): Promise<Orderbook>;
     get corePda(): ExponentPDA;
     get pda(): ExponentOrderbookPDA;
     get adminPda(): ExponentAdminPda;
-    get eventAuthority(): web3.PublicKey;
-    get coreEventAuthority(): web3.PublicKey;
-    get mintYt(): web3.PublicKey;
-    get mintPt(): web3.PublicKey;
+    get eventAuthority(): PublicKey;
+    get coreEventAuthority(): PublicKey;
+    get mintYt(): PublicKey;
+    get mintPt(): PublicKey;
     get syCpiAccounts(): import("@exponent-labs/exponent-types").CpiAccountsRaw;
     get exponentCoreCpiAccounts(): import("@exponent-labs/exponent-types").ExponentCoreCpiAccountsRaw;
     get flavor(): import("@exponent-labs/exponent-types").Flavor;
@@ -36,127 +37,182 @@ export declare class Orderbook {
     get makerFeeRate(): number;
     get takerFeeRate(): number;
     /** Post offer instruction */
-    ixPostOffer({ trader, price, amount, offerType, offerOption, virtualOffer, expirySeconds, mintSy, ptSrc: ptSrcParam, ytSrc: ytSrcParam, sySrc: sySrcParam, }: {
-        trader: web3.PublicKey;
+    ixPostOffer({ trader, price, amount, offerType, offerOption, virtualOffer, expirySeconds, offerIdx, mintSy, ptSrc: ptSrcParam, ytSrc: ytSrcParam, sySrc: sySrcParam, }: {
+        trader: PublicKey;
         price: number;
-        amount: BN;
-        offerType: OfferTypeAnchor;
-        offerOption: OfferOptionsAnchor;
+        amount: bigint;
+        offerType: exponentOrderbook.OfferType;
+        offerOption: exponentOrderbook.OfferOptions;
         virtualOffer: boolean;
         expirySeconds: number;
-        mintSy: web3.PublicKey;
-        ptSrc?: web3.PublicKey;
-        ytSrc?: web3.PublicKey;
-        sySrc?: web3.PublicKey;
-    }): Promise<web3.TransactionInstruction>;
+        offerIdx?: number | null;
+        mintSy: PublicKey;
+        ptSrc?: PublicKey;
+        ytSrc?: PublicKey;
+        sySrc?: PublicKey;
+    }): TransactionInstruction;
     /** Market offer instruction */
     ixMarketOffer({ trader, maxPriceApy, amount, minAmountOut, offerType, virtualOffer, mintSy, ptSrc: ptSrcParam, ytSrc: ytSrcParam, sySrc: sySrcParam, }: {
-        trader: web3.PublicKey;
+        trader: PublicKey;
         maxPriceApy: number;
-        amount: BN;
-        minAmountOut: BN;
-        offerType: OfferTypeAnchor;
+        amount: bigint;
+        minAmountOut: bigint;
+        offerType: exponentOrderbook.OfferType;
         virtualOffer: boolean;
-        mintSy: web3.PublicKey;
-        ptSrc?: web3.PublicKey;
-        ytSrc?: web3.PublicKey;
-        sySrc?: web3.PublicKey;
-    }): Promise<web3.TransactionInstruction>;
+        mintSy: PublicKey;
+        ptSrc?: PublicKey;
+        ytSrc?: PublicKey;
+        sySrc?: PublicKey;
+    }): TransactionInstruction;
     /** High trust set configuration options instruction */
     ixSetConfigurationOptions({ admin, configurationOptions, }: {
-        admin: web3.PublicKey;
+        admin: PublicKey;
         configurationOptions: ConfigurationOptions;
-    }): Promise<web3.TransactionInstruction>;
+    }): TransactionInstruction;
+    /**
+     * Set a single configuration option on the orderbook.
+     *
+     * Each call sets exactly one of the four on-chain enum variants:
+     *   { thresholdAmount: bigint }  – minimum lot size (u64)
+     *   { priceDecimals: number }    – APY tick precision (u8), e.g. 6 → 0.0001% resolution
+     *   { takerFeeRateBp: number }   – ln-space taker fee rate (f64)
+     *   { makerFeeRateBp: number }   – ln-space maker fee rate (f64)
+     */
+    ixSetConfigurationOption({ admin, option, }: {
+        admin: PublicKey;
+        option: {
+            thresholdAmount: bigint;
+        } | {
+            priceDecimals: number;
+        } | {
+            takerFeeRateBp: number;
+        } | {
+            makerFeeRateBp: number;
+        };
+    }): TransactionInstruction;
+    /**
+     * Build a `setConfigurationOptions` instruction without loading the full orderbook.
+     *
+     * Use this when you only have the orderbook address and admin key — it avoids
+     * fetching the vault, ALT, or any other on-chain state.
+     */
+    static buildSetConfigurationOptionIx({ orderbookAddress, admin, option, }: {
+        orderbookAddress: PublicKey;
+        admin: PublicKey;
+        option: {
+            thresholdAmount: bigint;
+        } | {
+            priceDecimals: number;
+        } | {
+            takerFeeRateBp: number;
+        } | {
+            makerFeeRateBp: number;
+        };
+    }): TransactionInstruction;
     getOffers(): Offer[];
     /** Remove offer instruction */
     ixRemoveOffer({ trader, offerIdx, mintSy, ptSrc: ptSrcParam, ytSrc: ytSrcParam, sySrc: sySrcParam, }: {
-        trader: web3.PublicKey;
+        trader: PublicKey;
         offerIdx: number;
-        mintSy: web3.PublicKey;
-        ptSrc?: web3.PublicKey;
-        ytSrc?: web3.PublicKey;
-        sySrc?: web3.PublicKey;
-    }): Promise<web3.TransactionInstruction>;
-    /** Post offer instruction */
-    ixWrapperPostOffer({ trader, price, amount, offerType, offerOption, virtualOffer, expirySeconds, mintSy, ptSrc: ptSrcParam, ytSrc: ytSrcParam, sySrc: sySrcParam, tokenBaseTrader: tokenBaseTraderParam, }: {
-        trader: web3.PublicKey;
+        mintSy: PublicKey;
+        ptSrc?: PublicKey;
+        ytSrc?: PublicKey;
+        sySrc?: PublicKey;
+    }): TransactionInstruction;
+    /** Post offer instruction
+     * @param offerIdx - Optional offer index for vault position tracking. Must be unique per trader when provided.
+     *                   For vault managers, this should be tracked in the vault's OrderbookEntry.offerIdxVec.
+     *                   Omit for direct user orders (no vault position tracking).
+     */
+    ixWrapperPostOffer({ trader, setupPayer, price, amount, offerType, offerOption, virtualOffer, expirySeconds, mintSy, offerIdx, ptSrc: ptSrcParam, ytSrc: ytSrcParam, sySrc: sySrcParam, tokenBaseTrader: tokenBaseTraderParam, }: {
+        trader: PublicKey;
+        setupPayer?: PublicKey;
         price: number;
-        amount: BN;
-        offerType: OfferTypeAnchor;
-        offerOption: OfferOptionsAnchor;
+        amount: bigint;
+        offerType: exponentOrderbook.OfferType;
+        offerOption: exponentOrderbook.OfferOptions;
         virtualOffer: boolean;
         expirySeconds: number;
-        mintSy: web3.PublicKey;
-        ptSrc?: web3.PublicKey;
-        ytSrc?: web3.PublicKey;
-        sySrc?: web3.PublicKey;
-        tokenBaseTrader?: web3.PublicKey;
-    }): Promise<web3.TransactionInstruction>;
+        mintSy: PublicKey;
+        /** Offer index for vault position tracking. Omit for direct user orders. */
+        offerIdx?: number | null;
+        ptSrc?: PublicKey;
+        ytSrc?: PublicKey;
+        sySrc?: PublicKey;
+        tokenBaseTrader?: PublicKey;
+    }): Promise<{
+        ix: TransactionInstruction;
+        setupIxs: TransactionInstruction[];
+    }>;
     /** Market offer instruction */
-    ixWrapperMarketOffer({ trader, maxPriceApy, amount, offerType, minAmountOut, virtualOffer, mintSy, ptSrc: ptSrcParam, ytSrc: ytSrcParam, sySrc: sySrcParam, tokenBaseTrader: tokenBaseTraderParam, }: {
-        trader: web3.PublicKey;
+    ixWrapperMarketOffer({ trader, setupPayer, maxPriceApy, amount, offerType, minAmountOut, virtualOffer, mintSy, ptSrc: ptSrcParam, ytSrc: ytSrcParam, sySrc: sySrcParam, tokenBaseTrader: tokenBaseTraderParam, }: {
+        trader: PublicKey;
+        setupPayer?: PublicKey;
         maxPriceApy: number;
-        amount: BN;
-        offerType: OfferTypeAnchor;
-        minAmountOut: BN;
+        amount: bigint;
+        offerType: exponentOrderbook.OfferType;
+        minAmountOut: bigint;
         virtualOffer: boolean;
-        mintSy: web3.PublicKey;
-        ptSrc?: web3.PublicKey;
-        ytSrc?: web3.PublicKey;
-        sySrc?: web3.PublicKey;
-        tokenBaseTrader?: web3.PublicKey;
-    }): Promise<web3.TransactionInstruction>;
+        mintSy: PublicKey;
+        ptSrc?: PublicKey;
+        ytSrc?: PublicKey;
+        sySrc?: PublicKey;
+        tokenBaseTrader?: PublicKey;
+    }): Promise<{
+        ix: TransactionInstruction;
+        setupIxs: TransactionInstruction[];
+    }>;
     /** Wrapper remove offer instruction */
     ixWrapperRemoveOffer({ trader, offerIdx, mintSy, ptSrc: ptSrcParam, ytSrc: ytSrcParam, sySrc: sySrcParam, tokenBaseTrader: tokenBaseTraderParam, }: {
-        trader: web3.PublicKey;
+        trader: PublicKey;
         offerIdx: number;
-        mintSy: web3.PublicKey;
-        ptSrc?: web3.PublicKey;
-        ytSrc?: web3.PublicKey;
-        sySrc?: web3.PublicKey;
-        tokenBaseTrader?: web3.PublicKey;
-    }): Promise<web3.TransactionInstruction>;
+        mintSy: PublicKey;
+        ptSrc?: PublicKey;
+        ytSrc?: PublicKey;
+        sySrc?: PublicKey;
+        tokenBaseTrader?: PublicKey;
+    }): Promise<TransactionInstruction>;
     /** Wrapper collect interest instruction */
     ixWrapperCollectInterest({ trader, mintSy, sySrc: sySrcParam, tokenBaseTrader: tokenBaseTraderParam, }: {
-        trader: web3.PublicKey;
-        mintSy: web3.PublicKey;
-        sySrc?: web3.PublicKey;
-        tokenBaseTrader?: web3.PublicKey;
-    }): Promise<web3.TransactionInstruction>;
+        trader: PublicKey;
+        mintSy: PublicKey;
+        sySrc?: PublicKey;
+        tokenBaseTrader?: PublicKey;
+    }): Promise<TransactionInstruction>;
     /** Wrapper withdraw funds instruction */
     ixWrapperWithdrawFunds({ trader, mintSy, ptAmount, ytAmount, syAmount, ptSrc: ptSrcParam, ytSrc: ytSrcParam, sySrc: sySrcParam, tokenBaseTrader: tokenBaseTraderParam, }: {
-        trader: web3.PublicKey;
-        mintSy: web3.PublicKey;
-        ptAmount: ClaimAmount;
-        ytAmount: ClaimAmount;
-        syAmount: ClaimAmount;
-        ptSrc?: web3.PublicKey;
-        ytSrc?: web3.PublicKey;
-        sySrc?: web3.PublicKey;
-        tokenBaseTrader?: web3.PublicKey;
-    }): Promise<web3.TransactionInstruction>;
+        trader: PublicKey;
+        mintSy: PublicKey;
+        ptAmount: exponentOrderbook.Amount;
+        ytAmount: exponentOrderbook.Amount;
+        syAmount: exponentOrderbook.Amount;
+        ptSrc?: PublicKey;
+        ytSrc?: PublicKey;
+        sySrc?: PublicKey;
+        tokenBaseTrader?: PublicKey;
+    }): Promise<TransactionInstruction>;
     /** Wrapper collect admin fee instruction */
     ixWrapperCollectAdminFee({ admin, mintSy }: {
-        admin: web3.PublicKey;
-        mintSy: web3.PublicKey;
-    }): Promise<web3.TransactionInstruction>;
+        admin: PublicKey;
+        mintSy: PublicKey;
+    }): Promise<TransactionInstruction>;
     /** Wrapper collect admin emission instruction */
     ixCollectAdminEmission({ emissionEscrow, amount, index, treasuryEmissionTokenAccount, tokenEmissionAdmin, }: {
-        emissionEscrow: web3.PublicKey;
+        emissionEscrow: PublicKey;
         index: number;
-        amount: ClaimAmount;
-        treasuryEmissionTokenAccount: web3.PublicKey;
-        tokenEmissionAdmin: web3.PublicKey;
-    }): Promise<web3.TransactionInstruction>;
+        amount: exponentOrderbook.Amount;
+        treasuryEmissionTokenAccount: PublicKey;
+        tokenEmissionAdmin: PublicKey;
+    }): TransactionInstruction;
     collectAdminEmissionCoreAccounts({ emissionDst, emissionEscrow, treasuryEmissionTokenAccount, }: {
-        emissionDst: web3.PublicKey;
-        emissionEscrow: web3.PublicKey;
-        treasuryEmissionTokenAccount: web3.PublicKey;
+        emissionDst: PublicKey;
+        emissionEscrow: PublicKey;
+        treasuryEmissionTokenAccount: PublicKey;
     }): AccountInfo[];
     /** Wrapper collect admin fee instruction */
     ixRemoveExpiredOffers({ admin }: {
-        admin: web3.PublicKey;
-    }): Promise<web3.TransactionInstruction>;
+        admin: PublicKey;
+    }): TransactionInstruction;
     getQuote({ priceApy: rawPriceApy, inAmount: inAmountRaw, direction, unixNow, syExchangeRate, }: {
         priceApy?: number;
         inAmount: number;
@@ -169,7 +225,29 @@ export declare class Orderbook {
         takerFees: number;
     };
     depositYtAccounts({ owner, ytSrc: ytSrcParam, }: {
-        owner: web3.PublicKey;
-        ytSrc?: web3.PublicKey;
-    }): Promise<web3.TransactionInstruction>;
+        owner: PublicKey;
+        ytSrc?: PublicKey;
+    }): TransactionInstruction;
+    /**
+     * Gets the user's escrow balances locked in the orderbook
+     * Returns PT, YT, and SY token amounts held in escrow for active orders
+     */
+    getUserBalances(user: PublicKey): {
+        pt: string;
+        yt: string;
+        sy: string;
+        stakedYt: string;
+        staged: string;
+    };
+    /**
+     * Gets all open orders for a specific user
+     * Returns detailed information about each order including type, price, amount, and expiry
+     */
+    getUserOpenOrders(user: PublicKey): Offer[];
+    /**
+     * Gets the next offer index that will be allocated by the orderbook.
+     * Use the free-list head when available, otherwise fall back to the bump index
+     * for fresh allocations.
+     */
+    getNextOfferIndex(): number;
 }