@theliem/xmarket-sdk 3.25.0 → 3.27.0

package/dist/index.d.mts

@@ -231,6 +231,30 @@ interface SignedCollectFeeOrder {
     /** Ed25519 signature (64 bytes) from order.user over serializeCollectFeeOrderToBytes() */
     signature: Uint8Array;
 }
+/**
+ * Authorization for CLOB to collect YES or NO tokens for redeem/merge, returning net USDS after fee.
+ * Used with batchRedeemWithFee and batchMergeWithFee instructions.
+ */
+interface RedeemFeeOrder {
+    user: PublicKey;
+    condition: PublicKey;
+    tokenMint: PublicKey;
+    amount: BN;
+    /** Net USDS to receive back after fee deduction. 0 for the losing side. */
+    takerAmount: BN;
+    nonce: BN;
+    expiry: BN;
+}
+interface SignedRedeemFeeOrder {
+    order: RedeemFeeOrder;
+    /** Ed25519 signature (64 bytes) from order.user over serializeRedeemFeeOrderToBytes() */
+    signature: Uint8Array;
+}
+/** A pair of YES + NO orders for one user in batchRedeemWithFee / batchMergeWithFee. */
+interface RedeemFeeOrderPair {
+    yes: SignedRedeemFeeOrder;
+    no: SignedRedeemFeeOrder;
+}
 declare class XMarketError extends Error {
     code?: string | undefined;
     constructor(message: string, code?: string | undefined);
@@ -864,6 +888,36 @@ declare class ClobClient {
         marketOracleVault?: PublicKey;
         lookupTable?: AddressLookupTableAccount;
     }): Promise<VersionedTransaction>;
+    /**
+     * Build a Transaction to register a RedeemFeeOrder on-chain (Ed25519 verify + PDA).
+     * Must be sent before calling buildBatchRedeemWithFeeTx / buildBatchMergeWithFeeTx.
+     *
+     * ix[0]: batched Ed25519 { pubkey=order.user, sig, msg=128 bytes }
+     * ix[1]: register_redeem_fee_order(nonce)
+     */
+    buildRegisterRedeemFeeOrderTx(signedOrder: SignedRedeemFeeOrder, payer: PublicKey): Promise<anchor.web3.Transaction>;
+    /**
+     * Build a VersionedTransaction for batchRedeemWithFee.
+     * Each pair has a YES order + NO order for the same user (same signer or different).
+     * After resolution: YES holder taker_amount > 0, NO holder taker_amount = 0 (or vice versa).
+     *
+     * Prerequisite: each order's RedeemFeeOrderRecord must be registered via buildRegisterRedeemFeeOrderTx.
+     */
+    buildBatchRedeemWithFeeTx(orderPairs: RedeemFeeOrderPair[], condition: PublicKey, operator: PublicKey, payer: PublicKey, opts?: {
+        marketOracleVault?: PublicKey;
+        lookupTable?: AddressLookupTableAccount;
+    }): Promise<VersionedTransaction>;
+    /**
+     * Build a VersionedTransaction for batchMergeWithFee (pre-resolution merge with fee).
+     * Each pair: YES order + NO order with equal amounts for the same user.
+     * Only yes_signer receives net USDS (mirrors EVM _matchMergeOrder).
+     *
+     * Prerequisite: each order's RedeemFeeOrderRecord must be registered via buildRegisterRedeemFeeOrderTx.
+     */
+    buildBatchMergeWithFeeTx(orderPairs: RedeemFeeOrderPair[], condition: PublicKey, operator: PublicKey, payer: PublicKey, opts?: {
+        marketOracleVault?: PublicKey;
+        lookupTable?: AddressLookupTableAccount;
+    }): Promise<VersionedTransaction>;
     /**
      * Build ALT for batchCollectRedeemEarly — includes per-user accounts so all
      * remaining_accounts fit as 1-byte ALT indices instead of 32-byte inline addresses.
@@ -975,6 +1029,11 @@ declare class MarketOracleClient {
      */
     claimFeesShare(marketOraclePda: PublicKey, user?: PublicKey, payer?: PublicKey): Promise<Transaction>;
     fetchMarketOracle(marketOraclePda: PublicKey): Promise<MarketOracleInfo | null>;
+    /**
+     * Derive marketOracleVault from presaleAddress and return its USDS balance.
+     * presaleAddress is used as the questionId seed in the question PDA.
+     */
+    getOracleVaultBalance(presaleAddress: PublicKey, qmConfigPda: PublicKey, collateralMint: PublicKey): Promise<number>;
     fetchUserClaimRecord(marketOraclePda: PublicKey, user: PublicKey): Promise<UserClaimRecord | null>;
 }
 
@@ -1187,6 +1246,7 @@ declare class PDA {
     static orderStatus(maker: PublicKey, nonce: BN, programIds: Pick<ProgramIds, "clobExchange">): [PublicKey, number];
     static orderRecord(maker: PublicKey, nonce: BN, programIds: Pick<ProgramIds, "clobExchange">): [PublicKey, number];
     static collectFeeOrderRecord(user: PublicKey, nonce: BN, programIds: Pick<ProgramIds, "clobExchange">): [PublicKey, number];
+    static redeemFeeOrderRecord(user: PublicKey, nonce: BN, programIds: Pick<ProgramIds, "clobExchange">): [PublicKey, number];
     static feeConfig(owner: PublicKey, programIds: Pick<ProgramIds, "feeManagement">): [PublicKey, number];
     static questionFee(conditionPda: PublicKey, programIds: Pick<ProgramIds, "feeManagement">): [PublicKey, number];
     static marketFeeOverride(conditionPda: PublicKey, programIds: Pick<ProgramIds, "feeManagement">): [PublicKey, number];
@@ -1259,6 +1319,22 @@ declare function serializeCollectFeeOrderToBytes(order: CollectFeeOrder): Uint8A
  * Same layout as buildBatchedEd25519Instruction but with 120-byte messages.
  */
 declare function buildBatchedCollectFeeEd25519Instruction(orders: SignedCollectFeeOrder[]): TransactionInstruction;
+/**
+ * Serialize a RedeemFeeOrder to 128 bytes — must match Rust `RedeemFeeOrder::to_signable_bytes()`.
+ *   [0..32]    user pubkey
+ *   [32..64]   condition pubkey
+ *   [64..96]   token_mint pubkey
+ *   [96..104]  amount (u64 le)
+ *   [104..112] taker_amount (u64 le)
+ *   [112..120] nonce (u64 le)
+ *   [120..128] expiry (i64 le)
+ */
+declare function serializeRedeemFeeOrderToBytes(order: RedeemFeeOrder): Uint8Array;
+/**
+ * Build a batched Ed25519 precompile instruction for N signed RedeemFeeOrders.
+ * Same layout as buildBatchedCollectFeeEd25519Instruction but with 128-byte messages.
+ */
+declare function buildBatchedRedeemFeeEd25519Instruction(orders: SignedRedeemFeeOrder[]): TransactionInstruction;
 
 /**
  * High-level order utilities — build, sign, serialize, verify, detect match type.
@@ -1411,4 +1487,4 @@ declare function buildApproveCollateralTx(collateralMint: PublicKey, signer: Pub
  */
 declare function buildApproveAllOutcomeTokensTx(condition: PublicKey, signer: PublicKey, payer: PublicKey, delegate: PublicKey, programIds: ProgramIds, amount?: BN): Transaction;
 
-export { AccountNotFoundError, AdminClient, type AdminConfigInfo, type ClaimRecordInfo, ClobClient, type ClobConfig, type CollateralConfig, type CollateralVault, type CollectFeeOrder, type Condition, type CreateQuestionParams, CtfClient, type CtfConfig, DisputeClient, type DisputeConfigInfo, type DisputeMarketInfo, FEE_DENOMINATOR, FeeManagementClient, HookClient, type HookConfig, IX_SYSVAR, InvalidParamError, MAX_APPROVE_AMOUNT, MarketClient, MarketOracleClient, type MarketOracleInfo, type MatchType, type NetworkConfig, type NetworkName, OracleClient, type OracleConfig, type Order, type OrderStatus, PDA, type Position, PresaleClient, type PresaleInfo, type ProgramIds, type Question, type QuestionFee, type QuestionMarketConfig, type QuestionResult, QuestionStatus, ReferralClient, type ReferralConfigInfo, SEEDS, type SignedCollectFeeOrder, type SignedOrder, type TxResult, UnauthorizedError, type UserBuyRecord, type UserClaimRecord, type UserDisputeInfo, XMarketError, XMarketSDK, buildApproveAllOutcomeTokensTx, buildApproveCollateralTx, buildBatchedCollectFeeEd25519Instruction, buildBatchedEd25519Instruction, buildCreateUserAtasTx, buildOrder, buildOrderFromPrice, deserializeSignedOrder, detectMatchType, generateContentHash, generateQuestionId, getOrderSignBytes, orderAmountsFromPrice, serializeCollectFeeOrderToBytes, serializeOrderToBytes, serializeSignedOrder, signOrder, signOrderWithKeypair, verifySignedOrder };
+export { AccountNotFoundError, AdminClient, type AdminConfigInfo, type ClaimRecordInfo, ClobClient, type ClobConfig, type CollateralConfig, type CollateralVault, type CollectFeeOrder, type Condition, type CreateQuestionParams, CtfClient, type CtfConfig, DisputeClient, type DisputeConfigInfo, type DisputeMarketInfo, FEE_DENOMINATOR, FeeManagementClient, HookClient, type HookConfig, IX_SYSVAR, InvalidParamError, MAX_APPROVE_AMOUNT, MarketClient, MarketOracleClient, type MarketOracleInfo, type MatchType, type NetworkConfig, type NetworkName, OracleClient, type OracleConfig, type Order, type OrderStatus, PDA, type Position, PresaleClient, type PresaleInfo, type ProgramIds, type Question, type QuestionFee, type QuestionMarketConfig, type QuestionResult, QuestionStatus, type RedeemFeeOrder, type RedeemFeeOrderPair, ReferralClient, type ReferralConfigInfo, SEEDS, type SignedCollectFeeOrder, type SignedOrder, type SignedRedeemFeeOrder, type TxResult, UnauthorizedError, type UserBuyRecord, type UserClaimRecord, type UserDisputeInfo, XMarketError, XMarketSDK, buildApproveAllOutcomeTokensTx, buildApproveCollateralTx, buildBatchedCollectFeeEd25519Instruction, buildBatchedEd25519Instruction, buildBatchedRedeemFeeEd25519Instruction, buildCreateUserAtasTx, buildOrder, buildOrderFromPrice, deserializeSignedOrder, detectMatchType, generateContentHash, generateQuestionId, getOrderSignBytes, orderAmountsFromPrice, serializeCollectFeeOrderToBytes, serializeOrderToBytes, serializeRedeemFeeOrderToBytes, serializeSignedOrder, signOrder, signOrderWithKeypair, verifySignedOrder };

package/dist/index.d.ts

@@ -231,6 +231,30 @@ interface SignedCollectFeeOrder {
     /** Ed25519 signature (64 bytes) from order.user over serializeCollectFeeOrderToBytes() */
     signature: Uint8Array;
 }
+/**
+ * Authorization for CLOB to collect YES or NO tokens for redeem/merge, returning net USDS after fee.
+ * Used with batchRedeemWithFee and batchMergeWithFee instructions.
+ */
+interface RedeemFeeOrder {
+    user: PublicKey;
+    condition: PublicKey;
+    tokenMint: PublicKey;
+    amount: BN;
+    /** Net USDS to receive back after fee deduction. 0 for the losing side. */
+    takerAmount: BN;
+    nonce: BN;
+    expiry: BN;
+}
+interface SignedRedeemFeeOrder {
+    order: RedeemFeeOrder;
+    /** Ed25519 signature (64 bytes) from order.user over serializeRedeemFeeOrderToBytes() */
+    signature: Uint8Array;
+}
+/** A pair of YES + NO orders for one user in batchRedeemWithFee / batchMergeWithFee. */
+interface RedeemFeeOrderPair {
+    yes: SignedRedeemFeeOrder;
+    no: SignedRedeemFeeOrder;
+}
 declare class XMarketError extends Error {
     code?: string | undefined;
     constructor(message: string, code?: string | undefined);
@@ -864,6 +888,36 @@ declare class ClobClient {
         marketOracleVault?: PublicKey;
         lookupTable?: AddressLookupTableAccount;
     }): Promise<VersionedTransaction>;
+    /**
+     * Build a Transaction to register a RedeemFeeOrder on-chain (Ed25519 verify + PDA).
+     * Must be sent before calling buildBatchRedeemWithFeeTx / buildBatchMergeWithFeeTx.
+     *
+     * ix[0]: batched Ed25519 { pubkey=order.user, sig, msg=128 bytes }
+     * ix[1]: register_redeem_fee_order(nonce)
+     */
+    buildRegisterRedeemFeeOrderTx(signedOrder: SignedRedeemFeeOrder, payer: PublicKey): Promise<anchor.web3.Transaction>;
+    /**
+     * Build a VersionedTransaction for batchRedeemWithFee.
+     * Each pair has a YES order + NO order for the same user (same signer or different).
+     * After resolution: YES holder taker_amount > 0, NO holder taker_amount = 0 (or vice versa).
+     *
+     * Prerequisite: each order's RedeemFeeOrderRecord must be registered via buildRegisterRedeemFeeOrderTx.
+     */
+    buildBatchRedeemWithFeeTx(orderPairs: RedeemFeeOrderPair[], condition: PublicKey, operator: PublicKey, payer: PublicKey, opts?: {
+        marketOracleVault?: PublicKey;
+        lookupTable?: AddressLookupTableAccount;
+    }): Promise<VersionedTransaction>;
+    /**
+     * Build a VersionedTransaction for batchMergeWithFee (pre-resolution merge with fee).
+     * Each pair: YES order + NO order with equal amounts for the same user.
+     * Only yes_signer receives net USDS (mirrors EVM _matchMergeOrder).
+     *
+     * Prerequisite: each order's RedeemFeeOrderRecord must be registered via buildRegisterRedeemFeeOrderTx.
+     */
+    buildBatchMergeWithFeeTx(orderPairs: RedeemFeeOrderPair[], condition: PublicKey, operator: PublicKey, payer: PublicKey, opts?: {
+        marketOracleVault?: PublicKey;
+        lookupTable?: AddressLookupTableAccount;
+    }): Promise<VersionedTransaction>;
     /**
      * Build ALT for batchCollectRedeemEarly — includes per-user accounts so all
      * remaining_accounts fit as 1-byte ALT indices instead of 32-byte inline addresses.
@@ -975,6 +1029,11 @@ declare class MarketOracleClient {
      */
     claimFeesShare(marketOraclePda: PublicKey, user?: PublicKey, payer?: PublicKey): Promise<Transaction>;
     fetchMarketOracle(marketOraclePda: PublicKey): Promise<MarketOracleInfo | null>;
+    /**
+     * Derive marketOracleVault from presaleAddress and return its USDS balance.
+     * presaleAddress is used as the questionId seed in the question PDA.
+     */
+    getOracleVaultBalance(presaleAddress: PublicKey, qmConfigPda: PublicKey, collateralMint: PublicKey): Promise<number>;
     fetchUserClaimRecord(marketOraclePda: PublicKey, user: PublicKey): Promise<UserClaimRecord | null>;
 }
 
@@ -1187,6 +1246,7 @@ declare class PDA {
     static orderStatus(maker: PublicKey, nonce: BN, programIds: Pick<ProgramIds, "clobExchange">): [PublicKey, number];
     static orderRecord(maker: PublicKey, nonce: BN, programIds: Pick<ProgramIds, "clobExchange">): [PublicKey, number];
     static collectFeeOrderRecord(user: PublicKey, nonce: BN, programIds: Pick<ProgramIds, "clobExchange">): [PublicKey, number];
+    static redeemFeeOrderRecord(user: PublicKey, nonce: BN, programIds: Pick<ProgramIds, "clobExchange">): [PublicKey, number];
     static feeConfig(owner: PublicKey, programIds: Pick<ProgramIds, "feeManagement">): [PublicKey, number];
     static questionFee(conditionPda: PublicKey, programIds: Pick<ProgramIds, "feeManagement">): [PublicKey, number];
     static marketFeeOverride(conditionPda: PublicKey, programIds: Pick<ProgramIds, "feeManagement">): [PublicKey, number];
@@ -1259,6 +1319,22 @@ declare function serializeCollectFeeOrderToBytes(order: CollectFeeOrder): Uint8A
  * Same layout as buildBatchedEd25519Instruction but with 120-byte messages.
  */
 declare function buildBatchedCollectFeeEd25519Instruction(orders: SignedCollectFeeOrder[]): TransactionInstruction;
+/**
+ * Serialize a RedeemFeeOrder to 128 bytes — must match Rust `RedeemFeeOrder::to_signable_bytes()`.
+ *   [0..32]    user pubkey
+ *   [32..64]   condition pubkey
+ *   [64..96]   token_mint pubkey
+ *   [96..104]  amount (u64 le)
+ *   [104..112] taker_amount (u64 le)
+ *   [112..120] nonce (u64 le)
+ *   [120..128] expiry (i64 le)
+ */
+declare function serializeRedeemFeeOrderToBytes(order: RedeemFeeOrder): Uint8Array;
+/**
+ * Build a batched Ed25519 precompile instruction for N signed RedeemFeeOrders.
+ * Same layout as buildBatchedCollectFeeEd25519Instruction but with 128-byte messages.
+ */
+declare function buildBatchedRedeemFeeEd25519Instruction(orders: SignedRedeemFeeOrder[]): TransactionInstruction;
 
 /**
  * High-level order utilities — build, sign, serialize, verify, detect match type.
@@ -1411,4 +1487,4 @@ declare function buildApproveCollateralTx(collateralMint: PublicKey, signer: Pub
  */
 declare function buildApproveAllOutcomeTokensTx(condition: PublicKey, signer: PublicKey, payer: PublicKey, delegate: PublicKey, programIds: ProgramIds, amount?: BN): Transaction;
 
-export { AccountNotFoundError, AdminClient, type AdminConfigInfo, type ClaimRecordInfo, ClobClient, type ClobConfig, type CollateralConfig, type CollateralVault, type CollectFeeOrder, type Condition, type CreateQuestionParams, CtfClient, type CtfConfig, DisputeClient, type DisputeConfigInfo, type DisputeMarketInfo, FEE_DENOMINATOR, FeeManagementClient, HookClient, type HookConfig, IX_SYSVAR, InvalidParamError, MAX_APPROVE_AMOUNT, MarketClient, MarketOracleClient, type MarketOracleInfo, type MatchType, type NetworkConfig, type NetworkName, OracleClient, type OracleConfig, type Order, type OrderStatus, PDA, type Position, PresaleClient, type PresaleInfo, type ProgramIds, type Question, type QuestionFee, type QuestionMarketConfig, type QuestionResult, QuestionStatus, ReferralClient, type ReferralConfigInfo, SEEDS, type SignedCollectFeeOrder, type SignedOrder, type TxResult, UnauthorizedError, type UserBuyRecord, type UserClaimRecord, type UserDisputeInfo, XMarketError, XMarketSDK, buildApproveAllOutcomeTokensTx, buildApproveCollateralTx, buildBatchedCollectFeeEd25519Instruction, buildBatchedEd25519Instruction, buildCreateUserAtasTx, buildOrder, buildOrderFromPrice, deserializeSignedOrder, detectMatchType, generateContentHash, generateQuestionId, getOrderSignBytes, orderAmountsFromPrice, serializeCollectFeeOrderToBytes, serializeOrderToBytes, serializeSignedOrder, signOrder, signOrderWithKeypair, verifySignedOrder };
+export { AccountNotFoundError, AdminClient, type AdminConfigInfo, type ClaimRecordInfo, ClobClient, type ClobConfig, type CollateralConfig, type CollateralVault, type CollectFeeOrder, type Condition, type CreateQuestionParams, CtfClient, type CtfConfig, DisputeClient, type DisputeConfigInfo, type DisputeMarketInfo, FEE_DENOMINATOR, FeeManagementClient, HookClient, type HookConfig, IX_SYSVAR, InvalidParamError, MAX_APPROVE_AMOUNT, MarketClient, MarketOracleClient, type MarketOracleInfo, type MatchType, type NetworkConfig, type NetworkName, OracleClient, type OracleConfig, type Order, type OrderStatus, PDA, type Position, PresaleClient, type PresaleInfo, type ProgramIds, type Question, type QuestionFee, type QuestionMarketConfig, type QuestionResult, QuestionStatus, type RedeemFeeOrder, type RedeemFeeOrderPair, ReferralClient, type ReferralConfigInfo, SEEDS, type SignedCollectFeeOrder, type SignedOrder, type SignedRedeemFeeOrder, type TxResult, UnauthorizedError, type UserBuyRecord, type UserClaimRecord, type UserDisputeInfo, XMarketError, XMarketSDK, buildApproveAllOutcomeTokensTx, buildApproveCollateralTx, buildBatchedCollectFeeEd25519Instruction, buildBatchedEd25519Instruction, buildBatchedRedeemFeeEd25519Instruction, buildCreateUserAtasTx, buildOrder, buildOrderFromPrice, deserializeSignedOrder, detectMatchType, generateContentHash, generateQuestionId, getOrderSignBytes, orderAmountsFromPrice, serializeCollectFeeOrderToBytes, serializeOrderToBytes, serializeRedeemFeeOrderToBytes, serializeSignedOrder, signOrder, signOrderWithKeypair, verifySignedOrder };