@win-trader/bindings 0.1.0 → 0.3.0

package/request-router/dist/index.d.ts

@@ -1,148 +1,101 @@
 import { Buffer } from "buffer";
 import { AssembledTransaction, Client as ContractClient, ClientOptions as ContractClientOptions, MethodOptions } from "@stellar/stellar-sdk/contract";
-import type { u32, u64, i128 } from "@stellar/stellar-sdk/contract";
+import type { u32, u64, i128, Option } from "@stellar/stellar-sdk/contract";
 export * from "@stellar/stellar-sdk";
 export * as contract from "@stellar/stellar-sdk/contract";
 export * as rpc from "@stellar/stellar-sdk/rpc";
 export declare const RequestRouterError: {
-    1: {
+    400: {
         message: string;
     };
-    2: {
+    410: {
         message: string;
     };
-    3: {
+    420: {
         message: string;
     };
-    4: {
+    430: {
         message: string;
     };
-    5: {
+    440: {
         message: string;
     };
-    6: {
+    441: {
         message: string;
     };
-    7: {
+    442: {
         message: string;
     };
-    /**
-     * `upgrade` called with no pending proposal.
-     */
-    8: {
-        message: string;
-    };
-    /**
-     * `upgrade` called before the proposal's timelock eta.
-     */
-    9: {
-        message: string;
-    };
-    /**
-     * `upgrade` called with a hash that differs from the proposal.
-     */
-    10: {
+    450: {
         message: string;
     };
 };
 /**
- * Authoritative per-market state: the side aggregates, the funding indices,
- * the funding EMA, and the market configuration.
- *
- * Soroban limits UDT field names to 30 characters, so where a doc glossary
- * term is longer the field drops the redundant qualifier and its doc
- * comment carries the full term (e.g. `receiver_backed_index_long` is the
- * doc's `receiver_backed_payer_index` for the long side).
+ * SEP-40 asset identifier. Markets are quoted as `Other(market symbol)`.
  */
+export type Asset = {
+    tag: "Stellar";
+    values: readonly [string];
+} | {
+    tag: "Other";
+    values: readonly [string];
+};
+export interface PriceData {
+    price: i128;
+    timestamp: u64;
+}
+export interface StampedPrice {
+    observed_at: u64;
+    price: i128;
+}
 export interface Market {
     config: MarketConfig;
-    /**
-   * `INDEX_PRECISION`-scaled bps/day payer rate as of the last refresh.
-   */
     current_payer_rate: i128;
     current_payer_side: PayerSide;
     last_funding_checkpoint: u64;
     long: MarketSide;
-    /**
-   * Cumulative payer fee per unit of dominant-side size that is LP
-   * revenue on collection (§8.2).
-   */
+    long_payer_remainders: RemainderGroup;
     lp_backed_index_long: i128;
     lp_backed_index_short: i128;
-    lp_payer_remainder: i128;
-    /**
-   * Sub-stroop carry of the receiver-liability accrual (§8.3).
-   */
-    pending_remainder: i128;
-    /**
-   * Cumulative payer fee per unit of dominant-side size whose collection
-   * restores cash backing an already-accrued receiver claim (§8.2).
-   */
+    pending_receiver_funding: i128;
     receiver_backed_index_long: i128;
     receiver_backed_index_short: i128;
-    /**
-   * Cumulative funding credit per unit of light-side size (§8.2).
-   */
     receiver_index_long: i128;
-    receiver_index_remainder: i128;
     receiver_index_short: i128;
-    receiver_payer_remainder: i128;
     short: MarketSide;
-    /**
-   * §8.1 signed EMA of the instantaneous skew: a fraction of one at
-   * `INDEX_PRECISION` scale, positive when history says longs dominate.
-   * Decays toward the current skew with the global half-life.
-   */
+    short_payer_remainders: RemainderGroup;
     skew_ema: i128;
 }
+export type Trigger = {
+    tag: "None";
+    values: void;
+} | {
+    tag: "Attached";
+    values: readonly [TriggerInstruction];
+};
 export interface LpConfig {
-    lp_request_delay: u64;
+    lp_request_delay_seconds: u64;
     max_withdraw_utilization_bps: u32;
     min_deposit_nav_factor_bps: u32;
 }
-/**
- * Represents a single trader's open leveraged position.
- */
 export interface Position {
-    /**
-   * Asset units at `PRICE_PRECISION`.
-   */
     base_exposure: i128;
-    borrow_debt: i128;
-    /**
-   * Cash owned by an optional-order executor.
-   */
-    execution_budget: i128;
-    funding_paid_to_lps_debt: i128;
-    funding_paid_to_receivers_debt: i128;
-    funding_received_debt: i128;
+    borrow_index_snapshot: i128;
     id: u64;
     is_long: boolean;
-    last_increased_time: u64;
+    lp_payer_index_snapshot: i128;
     market: string;
+    opened_at: u64;
     owner: string;
-    /**
-   * Fixed gross capacity assigned when risk opens.
-   */
+    pending_mutation_action_id: Option<u64>;
+    receiver_index_snapshot: i128;
+    receiver_payer_index_snapshot: i128;
     risk_units: i128;
-    /**
-   * USD notional at `PRICE_PRECISION`.
-   */
     size: i128;
-    /**
-   * Trigger price for the optional stop-loss order; `0` = none.
-   */
-    stop_loss: i128;
-    /**
-   * Trader-owned collateral recorded in contract state (the doc's
-   * "stored collateral"). Effective collateral — stored collateral after
-   * pending fees and funding credits — is always derived, never stored.
-   */
+    stop_loss: Trigger;
     stored_collateral: i128;
-    /**
-   * Trigger price for the optional take-profit order; `0` = none.
-   */
-    take_profit: i128;
+    stored_minimum_borrow_fee: i128;
+    take_profit: Trigger;
 }
 export interface LpRequest {
     amount: i128;
@@ -151,13 +104,12 @@ export interface LpRequest {
     kind: LpRequestKind;
     owner: string;
     request_time: u64;
+    /**
+   * The resolve reward fixed when the request was made.
+   */
+    reward: i128;
     status: LpRequestStatus;
 }
-/**
- * Which side currently pays funding (§8.1: the side the blended integral
- * skew points at — under the EMA this can be the *lighter* side for a
- * while after the book flips). `None` when the blend is exactly zero.
- */
 export type PayerSide = {
     tag: "None";
     values: void;
@@ -181,122 +133,67 @@ export type RiskState = {
     tag: "HardCap";
     values: void;
 };
-/**
- * A pending limit/stop entry order: the frozen `open_position` arguments
- * plus a trigger condition and an expiry. Placing one only writes this
- * record — no funds move. A keeper's `execute_entry_order` pulls the
- * collateral via the owner's token allowance and opens the position
- * exactly as a market open would.
- */
-export interface EntryOrder {
-    acceptable_price: i128;
-    collateral: i128;
-    execution_budget: i128;
-    /**
-   * Ledger timestamp after which the order is dead and swept on the next
-   * touch (user-configurable max TTL).
-   */
-    expires_at: u64;
-    id: u64;
-    is_long: boolean;
-    market: string;
-    owner: string;
-    size: i128;
-    stop_loss: i128;
-    take_profit: i128;
-    /**
-   * True → fill when price ≥ trigger (stop/breakout entry); false → fill
-   * when price ≤ trigger (limit/dip entry). Inferred at placement from
-   * the trigger vs. the current price.
-   */
-    trigger_above: boolean;
-    /**
-   * The oracle price at which the order becomes fillable.
-   */
-    trigger_price: i128;
-}
+export type ActionKind = {
+    tag: "MarketOpen";
+    values: void;
+} | {
+    tag: "LimitOpen";
+    values: void;
+} | {
+    tag: "Decrease";
+    values: void;
+} | {
+    tag: "Close";
+    values: void;
+};
 export interface MarketSide {
     base_exposure: i128;
+    hard_cap_payout_factor: i128;
+    hard_cap_reference_pnl: i128;
     risk_state: RiskState;
     risk_units: i128;
     size_open_interest: i128;
     stored_collateral_total: i128;
 }
-export interface RoundPrice {
-    price: i128;
-    symbol: string;
+export interface OpenPayload {
+    acceptable_price: i128;
+    expires_at: u64;
+    is_long: boolean;
+    size: i128;
+    stop_loss: i128;
+    submitted_collateral: i128;
+    take_profit: i128;
 }
-export interface OracleRound {
-    id: u64;
-    previous_id: u64;
-    previous_timestamp: u64;
-    prices: Array<RoundPrice>;
-    timestamp: u64;
+export interface ClosePayload {
+    acceptable_price: i128;
+    position_id: u64;
 }
 export interface GlobalConfig {
     base_borrow_rate_bps_day: i128;
-    /**
-   * §9.2 borrow-curve exponent, bps: 20_000 = u² (legacy quadratic),
-   * 10_000 = linear. Bounded to ≤ 100_000 (e ≤ 10) by validation.
-   */
-    borrow_exponent_bps: u32;
-    /**
-   * §8.1 half-life of the funding skew EMA, seconds (global: one memory
-   * horizon for every market).
-   */
+    borrow_lp_revenue_share_bps: u32;
+    config_timelock_seconds: u64;
+    fee_lp_revenue_share_bps: u32;
     funding_half_life_seconds: u64;
-    hard_cap_factor_limit_bps: u32;
-    lp_revenue_share_bps: u32;
+    global_hard_cap_limit_bps: u32;
+    hard_cap_relatch_band_bps: u32;
+    keeper_rewards: KeeperRewards;
     max_active_markets: u32;
-    max_adl_reward: i128;
-    max_insolvent_touch_reward: i128;
+    max_market_order_lifetime: u64;
+    max_order_lifetime_seconds: u64;
+    max_price_age_seconds: u64;
     max_variable_borrow_bps_day: i128;
-    /**
-   * §11.2 minimum borrow charge per capitalization: an index delta at
-   * `INDEX_PRECISION` scale applied to the position's risk units
-   * (2e11 = 2 bps of notional at a 10% market risk factor). Zero
-   * disables the floor.
-   */
-    min_borrow_index_delta: i128;
+    min_borrow_fee_seconds: u64;
     min_collateral: i128;
     min_position_lifetime: u64;
-    /**
-   * §11.1 share of a closing fee routed to the trader's referrer, carved
-   * from the protocol slice (keeper and LP shares are untouched). `0`
-   * disables referral accrual globally — a kill switch. Validated so
-   * `lp + keeper + referral ≤ BPS`, keeping the protocol remainder ≥ 0.
-   */
-    referral_fee_share_bps: u32;
     risk_capacity_limit_bps: u32;
-    risk_keeper_revenue_share_bps: u32;
 }
 export interface MarketConfig {
     adl_pnl_factor_bps: u32;
-    adl_reward_bps: u32;
-    /**
-   * §11.1 closing-fee tier when the close worsens skew.
-   */
-    close_fee_high_bps: u32;
-    /**
-   * §11.1 closing-fee tier when the close improves or preserves skew.
-   */
-    close_fee_low_bps: u32;
+    close_pnl_fee_bps: u32;
+    close_size_fee_bps: u32;
     hard_cap_pnl_factor_bps: u32;
-    /**
-   * Margin required to open or add risk (§12.3). Divides max leverage:
-   * a position may not be created closer to liquidation than this.
-   */
     initial_margin_bps: u32;
-    /**
-   * §8.1 weight of the instantaneous skew in the funding blend, in bps;
-   * the rest is the half-life EMA. `BPS` reproduces pure instant skew.
-   */
     instant_weight_bps: u32;
-    liquidation_reward_bps: u32;
-    /**
-   * Margin below which the position is liquidatable (§12.3). Must not
-   * exceed `initial_margin_bps`; the gap is the entry buffer.
-   */
     maintenance_margin_bps: u32;
     market_risk_factor_bps: u32;
     max_funding_rate_bps_day: i128;
@@ -304,37 +201,88 @@ export interface MarketConfig {
     max_long_size_open_interest: i128;
     max_short_base_exposure: i128;
     max_short_size_open_interest: i128;
+    open_fee_bps: u32;
+    order_execution_delay_seconds: u64;
     recovery_pnl_factor_bps: u32;
     warning_pnl_factor_bps: u32;
 }
-/**
- * Global safety thresholds for price validation.
- */
-export interface OracleConfig {
-    /**
-   * How long a cached aggregated price remains valid after the router
-   * fetch (in seconds). A cache hit also requires every source timestamp
-   * used for the cached median to remain within `staleness_threshold`.
-   * Must be > 0 and <= `staleness_threshold`.
-   */
-    cache_duration: u64;
-    /**
-   * Maximum allowed spread between oracle sources in basis points
-   * (e.g., 100 = 1%). Bounded at `crate::constants::MAX_DEVIATION_BPS_CEILING`.
-   */
-    max_deviation_bps: i128;
-    /**
-   * Minimum number of source responses that must agree within
-   * `max_deviation_bps` for OracleRouter to return a price. Floored at
-   * `crate::constants::MIN_REQUIRED_SOURCES_FLOOR`, ceilinged at
-   * `crate::constants::MAX_ORACLE_SOURCES`.
-   */
-    min_required_sources: u32;
-    /**
-   * Maximum age of an external SEP-40 price feed before it is rejected
-   * as stale (in seconds).
-   */
-    staleness_threshold: u64;
+export type ActionOutcome = {
+    tag: "Executed";
+    values: void;
+} | {
+    tag: "Failed";
+    values: void;
+} | {
+    tag: "Cancelled";
+    values: void;
+} | {
+    tag: "Expired";
+    values: void;
+} | {
+    tag: "Superseded";
+    values: void;
+} | {
+    tag: "NotReady";
+    values: void;
+} | {
+    tag: "Pending";
+    values: void;
+} | {
+    tag: "RequiresLiquidation";
+    values: void;
+};
+export type ActionPayload = {
+    tag: "MarketOpen";
+    values: readonly [OpenPayload];
+} | {
+    tag: "LimitOpen";
+    values: readonly [OpenPayload, TriggerCondition];
+} | {
+    tag: "Decrease";
+    values: readonly [DecreasePayload];
+} | {
+    tag: "Close";
+    values: readonly [ClosePayload];
+};
+export type FailureReason = {
+    tag: "PriceBoundExceeded";
+    values: void;
+} | {
+    tag: "CapacityExceeded";
+    values: void;
+} | {
+    tag: "ExposureCapExceeded";
+    values: void;
+} | {
+    tag: "SideRestricted";
+    values: void;
+} | {
+    tag: "InsufficientCollateral";
+    values: void;
+} | {
+    tag: "UnpayableProfit";
+    values: void;
+} | {
+    tag: "PositionGone";
+    values: void;
+} | {
+    tag: "MarketPaused";
+    values: void;
+} | {
+    tag: "SizeTooSmall";
+    values: void;
+};
+export interface KeeperRewards {
+    adl: i128;
+    close: i128;
+    decrease: i128;
+    expiry: i128;
+    limit_order: i128;
+    liquidation: i128;
+    lp_resolve: i128;
+    open: i128;
+    sl: i128;
+    tp: i128;
 }
 export type LpRequestKind = {
     tag: "Deposit";
@@ -343,24 +291,35 @@ export type LpRequestKind = {
     tag: "Withdrawal";
     values: void;
 };
-/**
- * Data required during a WASM migration. Single definition for all contracts.
- */
 export interface MigrationData {
     version: u32;
 }
-/**
- * Pending WASM upgrade — set by `propose_upgrade`, consumed by `upgrade`
- * (cleared atomically on a successful install), or cleared by `cancel_upgrade`.
- * Single shape across every protocol contract. Contracts store it at
- * the shared `pending_upgrade` Symbol key in their own instance storage (see
- * `crate::upgrade::pending_upgrade_key`). `upgrade` refuses to install
- * unless `pending.wasm_hash` matches the supplied hash and `now >= eta`.
- */
+export interface PendingAction {
+    action_id: u64;
+    commit_observed_at: u64;
+    created_at: u64;
+    escrowed_collateral: i128;
+    execute_after: u64;
+    kind: ActionKind;
+    market_id: string;
+    owner: string;
+    payload: ActionPayload;
+}
 export interface PendingUpgrade {
     eta: u64;
     wasm_hash: Buffer;
 }
+export interface RemainderGroup {
+    distribution_remainder: i128;
+    lp_payer_remainder: i128;
+    receiver_liability_remainder: i128;
+    receiver_payer_remainder: i128;
+}
+export interface DecreasePayload {
+    acceptable_price: i128;
+    position_id: u64;
+    size_removed: i128;
+}
 export type LpRequestStatus = {
     tag: "Pending";
     values: void;
@@ -370,32 +329,20 @@ export type LpRequestStatus = {
 } | {
     tag: "Failed";
     values: void;
-} | {
-    tag: "Expired";
-    values: void;
 };
-/**
- * The caller-supplied fields of a `place_entry_order` request, bundled so
- * the entry point stays within Soroban's parameter limit. `owner` and
- * `market` are passed alongside; `id` and `trigger_above` are derived at
- * placement.
- */
-export interface EntryOrderParams {
-    acceptable_price: i128;
-    collateral: i128;
-    execution_budget: i128;
-    expires_at: u64;
-    is_long: boolean;
-    size: i128;
-    stop_loss: i128;
-    take_profit: i128;
-    trigger_price: i128;
+export interface PendingFeesView {
+    borrow: i128;
+    funding_paid_to_lps: i128;
+    funding_paid_to_receivers: i128;
+    funding_received: i128;
+}
+export interface PendingPriceFeed {
+    effective_at: u64;
+    price_feed: string;
 }
 export interface SettlementResult {
-    /**
-   * Shares minted for a deposit or assets paid for a withdrawal.
-   */
     amount: i128;
+    reward: i128;
     status: SettlementStatus;
 }
 export type SettlementStatus = {
@@ -404,19 +351,49 @@ export type SettlementStatus = {
 } | {
     tag: "Failed";
     values: void;
+} | {
+    tag: "NotReady";
+    values: void;
 };
+export interface TriggerCondition {
+    trigger_above: boolean;
+    trigger_price: i128;
+}
 export interface AccountingSnapshot {
     cash_lp_equity: i128;
     cash_shortfall: i128;
+    deleveraging_side_count: u32;
     free_lp_capital: i128;
-    lp_blocked_side_count: u32;
+    min_equity_clear_of_adl: i128;
     non_lp_claims: i128;
     open_position_count: u64;
     physical_cash: i128;
     required_risk_backing: i128;
+    restricted_side_count: u32;
     total_risk_units: i128;
     vault_nav: i128;
 }
+export interface TriggerInstruction {
+    acceptable_price: i128;
+    commit_observed_at: u64;
+    committed_at: u64;
+    execute_after: u64;
+    trigger_price: i128;
+}
+export interface PendingGlobalConfig {
+    config: GlobalConfig;
+    effective_at: u64;
+}
+export interface PendingMarketConfig {
+    config: MarketConfig;
+    effective_at: u64;
+}
+export interface EventHeader {
+    actor: string;
+    event_version: u32;
+    ledger_timestamp: u64;
+    market: string;
+}
 export declare const UpgradeableError: {
     /**
      * When migration is attempted but not allowed due to upgrade state.
@@ -445,16 +422,6 @@ export declare const MerkleDistributorError: {
         message: string;
     };
 };
-/**
- * Storage keys for the data associated with `MerkleDistributor`
- */
-export type MerkleDistributorStorageKey = {
-    tag: "Root";
-    values: void;
-} | {
-    tag: "Claimed";
-    values: readonly [u32];
-};
 /**
  * Rounding direction for division operations
  */
@@ -482,37 +449,47 @@ export declare const SorobanFixedPointError: {
         message: string;
     };
 };
-export declare const CryptoError: {
+export declare const PausableError: {
     /**
-     * The merkle proof length is out of bounds.
+     * The operation failed because the contract is paused.
      */
-    1400: {
+    1000: {
         message: string;
     };
     /**
-     * The index of the leaf is out of bounds.
+     * The operation failed because the contract is not paused.
      */
-    1401: {
+    1001: {
         message: string;
     };
+};
+/**
+ * Storage keys for the data associated with `MerkleDistributor`
+ */
+export type MerkleDistributorStorageKey = {
+    tag: "Root";
+    values: void;
+} | {
+    tag: "Claimed";
+    values: readonly [u32];
+};
+export declare const CryptoError: {
     /**
-     * No data in hasher state.
+     * The merkle proof length is out of bounds.
      */
-    1402: {
+    1400: {
         message: string;
     };
-};
-export declare const PausableError: {
     /**
-     * The operation failed because the contract is paused.
+     * The index of the leaf is out of bounds.
      */
-    1000: {
+    1401: {
         message: string;
     };
     /**
-     * The operation failed because the contract is not paused.
+     * No data in hasher state.
      */
-    1001: {
+    1402: {
         message: string;
     };
 };
@@ -538,6 +515,12 @@ export interface Client {
         new_wasm_hash: Buffer;
         operator: string;
     }, options?: MethodOptions) => Promise<AssembledTransaction<null>>;
+    /**
+     * Construct and simulate a skip_head transaction. Returns an `AssembledTransaction` object which will have a `result` field containing the result of the simulation. If this transaction changes contract state, you will need to call `signAndSend()` on the returned object.
+     */
+    skip_head: ({ caller }: {
+        caller: string;
+    }, options?: MethodOptions) => Promise<AssembledTransaction<null>>;
     /**
      * Construct and simulate a get_request transaction. Returns an `AssembledTransaction` object which will have a `result` field containing the result of the simulation. If this transaction changes contract state, you will need to call `signAndSend()` on the returned object.
      */
@@ -556,6 +539,12 @@ export interface Client {
     cancel_upgrade: ({ caller }: {
         caller: string;
     }, options?: MethodOptions) => Promise<AssembledTransaction<null>>;
+    /**
+     * Construct and simulate a claim_lp_payout transaction. Returns an `AssembledTransaction` object which will have a `result` field containing the result of the simulation. If this transaction changes contract state, you will need to call `signAndSend()` on the returned object.
+     */
+    claim_lp_payout: ({ owner }: {
+        owner: string;
+    }, options?: MethodOptions) => Promise<AssembledTransaction<i128>>;
     /**
      * Construct and simulate a propose_upgrade transaction. Returns an `AssembledTransaction` object which will have a `result` field containing the result of the simulation. If this transaction changes contract state, you will need to call `signAndSend()` on the returned object.
      */
@@ -577,6 +566,12 @@ export interface Client {
         owner: string;
         shares: i128;
     }, options?: MethodOptions) => Promise<AssembledTransaction<u64>>;
+    /**
+     * Construct and simulate a lp_payout_claimable transaction. Returns an `AssembledTransaction` object which will have a `result` field containing the result of the simulation. If this transaction changes contract state, you will need to call `signAndSend()` on the returned object.
+     */
+    lp_payout_claimable: ({ owner }: {
+        owner: string;
+    }, options?: MethodOptions) => Promise<AssembledTransaction<i128>>;
     /**
      * Construct and simulate a next_request_to_resolve transaction. Returns an `AssembledTransaction` object which will have a `result` field containing the result of the simulation. If this transaction changes contract state, you will need to call `signAndSend()` on the returned object.
      */
@@ -586,10 +581,9 @@ export declare class Client extends ContractClient {
     readonly options: ContractClientOptions;
     static deploy<T = Client>(
     /** Constructor/Initialization Args for the contract's `__constructor` method */
-    { asset_address, vault_address, oracle_router, config_manager_address }: {
+    { asset_address, vault_address, config_manager_address }: {
         asset_address: string;
         vault_address: string;
-        oracle_router: string;
         config_manager_address: string;
     }, 
     /** Options for initializing a Client as well as for calling a method, with extras specific to deploying. */
@@ -605,12 +599,15 @@ export declare class Client extends ContractClient {
     readonly fromJSON: {
         migrate: (json: string) => AssembledTransaction<null>;
         upgrade: (json: string) => AssembledTransaction<null>;
+        skip_head: (json: string) => AssembledTransaction<null>;
         get_request: (json: string) => AssembledTransaction<LpRequest>;
         resolve_next: (json: string) => AssembledTransaction<SettlementResult>;
         cancel_upgrade: (json: string) => AssembledTransaction<null>;
+        claim_lp_payout: (json: string) => AssembledTransaction<bigint>;
         propose_upgrade: (json: string) => AssembledTransaction<null>;
         request_deposit: (json: string) => AssembledTransaction<bigint>;
         request_withdrawal: (json: string) => AssembledTransaction<bigint>;
+        lp_payout_claimable: (json: string) => AssembledTransaction<bigint>;
         next_request_to_resolve: (json: string) => AssembledTransaction<bigint>;
     };
 }