@typus/typus-perp-sdk 1.1.32 → 1.1.33

package/dist/src/fetch.d.ts

@@ -1,43 +1,431 @@
-import { Markets, SymbolMarket } from "./typus_perp/trading/structs";
-import { DeactivatingShares, LiquidityPool } from "./typus_perp/lp-pool/structs";
-import { TradingOrder, Position } from "./typus_perp/position/structs";
-import { LpUserShare, StakePool } from "./typus_stake_pool/stake-pool/structs";
 import { TOKEN } from "@typus/typus-sdk/dist/src/constants";
-import { PythClient, TypusConfig } from "@typus/typus-sdk/dist/src/utils";
-import { TLP_TOKEN } from ".";
-import { TypusBidReceipt } from "./_dependencies/source/0xb4f25230ba74837d8299e92951306100c4a532e8c48cc3d8828abe9b91c8b274/vault/structs";
-export declare function getLpPools(config: TypusConfig): Promise<LiquidityPool[]>;
-export declare function getLpPool(config: TypusConfig, objectId?: string): Promise<LiquidityPool>;
-export declare function getStakePools(config: TypusConfig): Promise<StakePool[]>;
-export declare function getStakePool(config: TypusConfig, objectId?: string): Promise<StakePool>;
-export interface MarketsData {
-    markets: Markets;
-    symbolMarkets: SymbolMarket[];
-}
-export declare function getMarkets(config: TypusConfig, input: {
-    indexes: string[];
-}): Promise<MarketsData[]>;
-export declare function getUserOrders(config: TypusConfig, user: string): Promise<TradingOrder[]>;
-export declare function getUserPositions(config: TypusConfig, user: string): Promise<Position[]>;
-export declare function parseOptionBidReceipts(positions: Position[]): (TypusBidReceipt | null)[];
+import { TradingOrder, Position } from "./generated/typus_perp/position";
+import { TypusClient } from "../src/client";
+export declare function getLpPools(client: TypusClient): Promise<{
+    id: {
+        id: string;
+    };
+    index: string;
+    lp_token_type: {
+        name: string;
+    };
+    liquidity_tokens: {
+        name: string;
+    }[];
+    token_pools: {
+        token_type: {
+            name: string;
+        };
+        config: {
+            oracle_id: string;
+            liquidity_token_decimal: string;
+            spot_config: {
+                min_deposit: string;
+                max_capacity: string;
+                target_weight_bp: string;
+                basic_mint_fee_bp: string;
+                additional_mint_fee_bp: string;
+                basic_burn_fee_bp: string;
+                additional_burn_fee_bp: string;
+                swap_fee_bp: string;
+                swap_fee_protocol_share_bp: string;
+                lending_protocol_share_bp: string;
+                u64_padding: string[];
+            };
+            margin_config: {
+                basic_borrow_rate_0: string;
+                basic_borrow_rate_1: string;
+                basic_borrow_rate_2: string;
+                utilization_threshold_bp_0: string;
+                utilization_threshold_bp_1: string;
+                borrow_interval_ts_ms: string;
+                max_order_reserve_ratio_bp: string;
+                u64_padding: string[];
+            };
+            u64_padding: string[];
+        };
+        state: {
+            liquidity_amount: string;
+            value_in_usd: string;
+            reserved_amount: string;
+            update_ts_ms: string;
+            is_active: boolean;
+            last_borrow_rate_ts_ms: string;
+            cumulative_borrow_rate: string;
+            previous_last_borrow_rate_ts_ms: string;
+            previous_cumulative_borrow_rate: string;
+            current_lending_amount: string[];
+            u64_padding: string[];
+        };
+    }[];
+    pool_info: {
+        lp_token_decimal: string;
+        total_share_supply: string;
+        tvl_usd: string;
+        is_active: boolean;
+    };
+    liquidated_unsettled_receipts: {
+        receipt: {
+            id: {
+                id: string;
+            };
+            vid: string;
+            index: string;
+            metadata: string;
+            u64_padding: string[];
+        }[];
+        position_id: string;
+        user: string;
+        token_types: {
+            name: string;
+        }[];
+        unrealized_pnl_sign: boolean;
+        unrealized_pnl: string;
+        unrealized_trading_fee: string;
+        unrealized_borrow_fee: string;
+        unrealized_funding_fee_sign: boolean;
+        unrealized_funding_fee: string;
+        unrealized_liquidator_fee: string;
+    }[];
+    u64_padding: string[];
+    bcs_padding: number[];
+}[]>;
+export declare function getLpPool(client: TypusClient, objectId: string): Promise<{
+    id: {
+        id: string;
+    };
+    index: string;
+    lp_token_type: {
+        name: string;
+    };
+    liquidity_tokens: {
+        name: string;
+    }[];
+    token_pools: {
+        token_type: {
+            name: string;
+        };
+        config: {
+            oracle_id: string;
+            liquidity_token_decimal: string;
+            spot_config: {
+                min_deposit: string;
+                max_capacity: string;
+                target_weight_bp: string;
+                basic_mint_fee_bp: string;
+                additional_mint_fee_bp: string;
+                basic_burn_fee_bp: string;
+                additional_burn_fee_bp: string;
+                swap_fee_bp: string;
+                swap_fee_protocol_share_bp: string;
+                lending_protocol_share_bp: string;
+                u64_padding: string[];
+            };
+            margin_config: {
+                basic_borrow_rate_0: string;
+                basic_borrow_rate_1: string;
+                basic_borrow_rate_2: string;
+                utilization_threshold_bp_0: string;
+                utilization_threshold_bp_1: string;
+                borrow_interval_ts_ms: string;
+                max_order_reserve_ratio_bp: string;
+                u64_padding: string[];
+            };
+            u64_padding: string[];
+        };
+        state: {
+            liquidity_amount: string;
+            value_in_usd: string;
+            reserved_amount: string;
+            update_ts_ms: string;
+            is_active: boolean;
+            last_borrow_rate_ts_ms: string;
+            cumulative_borrow_rate: string;
+            previous_last_borrow_rate_ts_ms: string;
+            previous_cumulative_borrow_rate: string;
+            current_lending_amount: string[];
+            u64_padding: string[];
+        };
+    }[];
+    pool_info: {
+        lp_token_decimal: string;
+        total_share_supply: string;
+        tvl_usd: string;
+        is_active: boolean;
+    };
+    liquidated_unsettled_receipts: {
+        receipt: {
+            id: {
+                id: string;
+            };
+            vid: string;
+            index: string;
+            metadata: string;
+            u64_padding: string[];
+        }[];
+        position_id: string;
+        user: string;
+        token_types: {
+            name: string;
+        }[];
+        unrealized_pnl_sign: boolean;
+        unrealized_pnl: string;
+        unrealized_trading_fee: string;
+        unrealized_borrow_fee: string;
+        unrealized_funding_fee_sign: boolean;
+        unrealized_funding_fee: string;
+        unrealized_liquidator_fee: string;
+    }[];
+    u64_padding: string[];
+    bcs_padding: number[];
+}>;
+export declare function getStakePools(client: TypusClient): Promise<{
+    id: {
+        id: string;
+    };
+    pool_info: {
+        stake_token: {
+            name: string;
+        };
+        index: string;
+        next_user_share_id: string;
+        total_share: string;
+        active: boolean;
+        new_tlp_price: string;
+        depositors_count: string;
+        u64_padding: string[];
+    };
+    config: {
+        unlock_countdown_ts_ms: string;
+        usd_per_exp: string;
+        u64_padding: string[];
+    };
+    incentives: {
+        token_type: {
+            name: string;
+        };
+        config: {
+            period_incentive_amount: string;
+            incentive_interval_ts_ms: string;
+            u64_padding: string[];
+        };
+        info: {
+            active: boolean;
+            last_allocate_ts_ms: string;
+            incentive_price_index: string;
+            unallocated_amount: string;
+            u64_padding: string[];
+        };
+    }[];
+    u64_padding: string[];
+}[]>;
+export declare function getStakePool(client: TypusClient, objectId: string): Promise<{
+    id: {
+        id: string;
+    };
+    pool_info: {
+        stake_token: {
+            name: string;
+        };
+        index: string;
+        next_user_share_id: string;
+        total_share: string;
+        active: boolean;
+        new_tlp_price: string;
+        depositors_count: string;
+        u64_padding: string[];
+    };
+    config: {
+        unlock_countdown_ts_ms: string;
+        usd_per_exp: string;
+        u64_padding: string[];
+    };
+    incentives: {
+        token_type: {
+            name: string;
+        };
+        config: {
+            period_incentive_amount: string;
+            incentive_interval_ts_ms: string;
+            u64_padding: string[];
+        };
+        info: {
+            active: boolean;
+            last_allocate_ts_ms: string;
+            incentive_price_index: string;
+            unallocated_amount: string;
+            u64_padding: string[];
+        };
+    }[];
+    u64_padding: string[];
+}>;
 /**
- * @returns [lpShare, incentives]
+ * @returns [Markets, SymbolMarket[]][]
  */
-export declare function getUserStake(config: TypusConfig, user: string): Promise<[LpUserShare, string[]] | null>;
+export declare function getMarkets(client: TypusClient, input: {
+    indexes: string[];
+}): Promise<[{
+    id: {
+        id: string;
+    };
+    index: string;
+    lp_token_type: {
+        name: string;
+    };
+    quote_token_type: {
+        name: string;
+    };
+    is_active: boolean;
+    protocol_fee_share_bp: string;
+    symbols: {
+        name: string;
+    }[];
+    symbol_markets: {
+        id: {
+            id: string;
+        };
+        size: string;
+    };
+    u64_padding: string[];
+}, {
+    id: {
+        id: string;
+    };
+    user_positions: {
+        id: {
+            id: string;
+        };
+        key_type: {
+            name: string;
+        };
+        value_type: {
+            name: string;
+        };
+        slice_idx: number;
+        slice_size: number;
+        length: string;
+    };
+    token_collateral_orders: {
+        id: string;
+    };
+    option_collateral_orders: {
+        id: string;
+    };
+    market_info: {
+        is_active: boolean;
+        size_decimal: string;
+        user_long_position_size: string;
+        user_short_position_size: string;
+        next_position_id: string;
+        user_long_order_size: string;
+        user_short_order_size: string;
+        next_order_id: string;
+        last_funding_ts_ms: string;
+        cumulative_funding_rate_index_sign: boolean;
+        cumulative_funding_rate_index: string;
+        previous_last_funding_ts_ms: string;
+        previous_cumulative_funding_rate_index_sign: boolean;
+        previous_cumulative_funding_rate_index: string;
+        u64_padding: string[];
+    };
+    market_config: {
+        oracle_id: string;
+        max_leverage_mbp: string;
+        option_collateral_max_leverage_mbp: string;
+        min_size: string;
+        lot_size: string;
+        trading_fee_config: string[];
+        basic_funding_rate: string;
+        funding_interval_ts_ms: string;
+        exp_multiplier: string;
+        cool_down_threshold_ts_ms: string;
+        u64_padding: string[];
+    };
+}[]][]>;
+export type TradingOrder = typeof TradingOrder.$inferType;
+export type TradingOrderWithMarketIndex = TradingOrder & {
+    marketIndex: number;
+};
+export declare function getUserOrders(client: TypusClient, input: {
+    user: string;
+    indexes: string[];
+}): Promise<TradingOrderWithMarketIndex[]>;
+export type Position = typeof Position.$inferType;
+export type PositionWithMarketIndex = Position & {
+    marketIndex: number;
+};
+export declare function getUserPositions(client: TypusClient, input: {
+    user: string;
+    indexes: string[];
+}): Promise<PositionWithMarketIndex[]>;
+export declare function parseOptionBidReceipts(positions: (typeof Position.$inferType)[]): ({
+    id: {
+        id: string;
+    };
+    vid: string;
+    index: string;
+    metadata: string;
+    u64_padding: string[];
+} | null)[];
 /**
- * @returns [lpShare, incentives]
+ * @returns [lpShare, incentives][]
  */
-export declare function getUserStakeById(config: TypusConfig, userShareId: string): Promise<[LpUserShare, string[]] | null>;
+export declare function getUserStake(client: TypusClient, input: {
+    user: string;
+    indexes: string[];
+}): Promise<[{
+    user: string;
+    user_share_id: string;
+    stake_ts_ms: string;
+    total_shares: string;
+    active_shares: string;
+    deactivating_shares: {
+        shares: string;
+        unsubscribed_ts_ms: string;
+        unlocked_ts_ms: string;
+        unsubscribed_incentive_price_index: {
+            contents: {
+                key: {
+                    name: string;
+                };
+                value: string;
+            }[];
+        };
+        u64_padding: string[];
+    }[];
+    last_incentive_price_index: {
+        contents: {
+            key: {
+                name: string;
+            };
+            value: string;
+        }[];
+    };
+    snapshot_ts_ms: string;
+    tlp_price: string;
+    harvested_amount: string;
+    u64_padding: string[];
+} | null, string[]][]>;
 /**
  * @returns deactivatingShares[]
  */
-export declare function getDeactivatingShares(config: TypusConfig, user: string): Promise<DeactivatingShares<typeof TLP_TOKEN>[]>;
+export declare function getDeactivatingShares(client: TypusClient, input: {
+    user: string;
+    indexes: string[];
+}): Promise<{
+    balance: {
+        value: string;
+    };
+    redeem_ts_ms: string;
+    unlock_ts_ms: string;
+    u64_padding: string[];
+}[]>;
 /**
  * @returns [liquidationPrice, pnl(in USD)]
  */
-export declare function getLiquidationPriceAndPnl(config: TypusConfig, pythClient: PythClient, input: {
-    positions: Position[];
-    user: string;
+export declare function getLiquidationPriceAndPnl(client: TypusClient, input: {
+    oracle?: string;
+    positions: (typeof Position.$inferType)[];
 }): Promise<PositionInfo[]>;
 interface PositionInfo {
     liquidationPrice: number;
@@ -47,15 +435,145 @@ interface PositionInfo {
     closeFee: number;
     pnlAfterFee: number;
 }
-export declare function getPositionCount(config: TypusConfig, input: {
-    baseToken: TOKEN;
-}): Promise<number>;
-export declare function getAllPositions(config: TypusConfig, input: {
+export declare function getAllPositions(client: TypusClient, input: {
     baseToken: TOKEN;
     slice: string;
     page: string;
-}): Promise<Position[]>;
-export declare function getAllPositionsWithTradingSymbol(config: TypusConfig, input: {
+    marketIndex: string;
+}): Promise<{
+    positions: {
+        id: {
+            id: string;
+        };
+        create_ts_ms: string;
+        update_ts_ms: string;
+        position_id: string;
+        linked_order_ids: string[];
+        linked_order_prices: string[];
+        user: string;
+        is_long: boolean;
+        size: string;
+        size_decimal: string;
+        collateral_token: {
+            name: string;
+        };
+        collateral_token_decimal: string;
+        symbol: {
+            base_token: {
+                name: string;
+            };
+            quote_token: {
+                name: string;
+            };
+        };
+        collateral_amount: string;
+        reserve_amount: string;
+        average_price: string;
+        entry_borrow_index: string;
+        entry_funding_rate_index_sign: boolean;
+        entry_funding_rate_index: string;
+        unrealized_loss: string;
+        unrealized_funding_sign: boolean;
+        unrealized_funding_fee: string;
+        unrealized_trading_fee: string;
+        unrealized_borrow_fee: string;
+        unrealized_rebate: string;
+        option_collateral_info: {
+            index: string;
+            bid_token: {
+                name: string;
+            };
+            bid_receipts_bcs: number[][];
+        } | null;
+        u64_padding: string[];
+    }[];
+    maxPage: number;
+}>;
+export declare function getAllPositionsWithTradingSymbol(client: TypusClient, input: {
     baseToken: TOKEN;
-}): Promise<Position[]>;
+    marketIndex: string;
+}): Promise<{
+    id: {
+        id: string;
+    };
+    create_ts_ms: string;
+    update_ts_ms: string;
+    position_id: string;
+    linked_order_ids: string[];
+    linked_order_prices: string[];
+    user: string;
+    is_long: boolean;
+    size: string;
+    size_decimal: string;
+    collateral_token: {
+        name: string;
+    };
+    collateral_token_decimal: string;
+    symbol: {
+        base_token: {
+            name: string;
+        };
+        quote_token: {
+            name: string;
+        };
+    };
+    collateral_amount: string;
+    reserve_amount: string;
+    average_price: string;
+    entry_borrow_index: string;
+    entry_funding_rate_index_sign: boolean;
+    entry_funding_rate_index: string;
+    unrealized_loss: string;
+    unrealized_funding_sign: boolean;
+    unrealized_funding_fee: string;
+    unrealized_trading_fee: string;
+    unrealized_borrow_fee: string;
+    unrealized_rebate: string;
+    option_collateral_info: {
+        index: string;
+        bid_token: {
+            name: string;
+        };
+        bid_receipts_bcs: number[][];
+    } | null;
+    u64_padding: string[];
+}[]>;
+export type UserProfit = {
+    collateral_token: {
+        name: string;
+    };
+    base_token: {
+        name: string;
+    };
+    position_id: string;
+    order_id: string;
+    amount: string;
+    create_ts_ms: string;
+};
+export type LockedUserProfit = {
+    user_profit: UserProfit;
+    create_ts_ms: string;
+};
+export declare function fetchUserProfits(client: TypusClient, input: {
+    profitVault: string;
+    version: string;
+    user: string;
+}): Promise<UserProfit[]>;
+export declare function fetchLockedUserProfits(client: TypusClient, input: {
+    lockVault: string;
+    version: string;
+    user: string;
+}): Promise<LockedUserProfit[]>;
+export declare function fetchAllUserProfits(client: TypusClient, input?: {
+    profitVault?: string;
+}): Promise<{
+    user: string;
+    profits: UserProfit[];
+}[]>;
+export declare function fetchAllLockedUserProfits(client: TypusClient, input?: {
+    lockVault?: string;
+}): Promise<{
+    user: string;
+    lockedUserProfits: LockedUserProfit[];
+}[]>;
 export {};