@typus/typus-sdk 1.4.84 → 1.5.0

package/dist/src/typus-perp/typus_perp/position/functions.d.ts

@@ -0,0 +1,343 @@
+import { Transaction, TransactionArgument, TransactionObjectInput } from "@mysten/sui/transactions";
+export interface SplitBidReceiptArgs {
+    dovRegistry: TransactionObjectInput;
+    position: TransactionObjectInput;
+    size: bigint | TransactionArgument;
+}
+export declare function splitBidReceipt(tx: Transaction, args: SplitBidReceiptArgs): import("@mysten/sui/transactions").TransactionResult;
+export interface OrderFilledArgs {
+    version: TransactionObjectInput;
+    order: TransactionObjectInput;
+    originalPosition: TransactionObjectInput | TransactionArgument | null;
+    nextPositionId: bigint | TransactionArgument;
+    collateralOraclePrice: bigint | TransactionArgument;
+    collateralOraclePriceDecimal: bigint | TransactionArgument;
+    tradingPairOraclePrice: bigint | TransactionArgument;
+    tradingPairOraclePriceDecimal: bigint | TransactionArgument;
+    cumulativeBorrowRate: bigint | TransactionArgument;
+    cumulativeFundingRateIndexSign: boolean | TransactionArgument;
+    cumulativeFundingRateIndex: bigint | TransactionArgument;
+    tradingFeeRate: bigint | TransactionArgument;
+    tradingFeeDecimal: bigint | TransactionArgument;
+    clock: TransactionObjectInput;
+}
+export declare function orderFilled(tx: Transaction, typeArg: string, args: OrderFilledArgs): import("@mysten/sui/transactions").TransactionResult;
+export interface AddPositionLinkedOrderInfoArgs {
+    position: TransactionObjectInput;
+    linkedOrderId: bigint | TransactionArgument;
+    linkedOrderPrice: bigint | TransactionArgument;
+}
+export declare function addPositionLinkedOrderInfo(tx: Transaction, args: AddPositionLinkedOrderInfoArgs): import("@mysten/sui/transactions").TransactionResult;
+export interface CalculateFilled_Args {
+    position: TransactionObjectInput;
+    reduceOnly: boolean | TransactionArgument;
+    orderSide: boolean | TransactionArgument;
+    orderSize: bigint | TransactionArgument;
+    tradingPairOraclePrice: bigint | TransactionArgument;
+    tradingPairOraclePriceDecimal: bigint | TransactionArgument;
+}
+export declare function calculateFilled_(tx: Transaction, args: CalculateFilled_Args): import("@mysten/sui/transactions").TransactionResult;
+export interface CalculateIntrinsicValueArgs {
+    dovRegistry: TransactionObjectInput;
+    typusOracle: TransactionObjectInput;
+    receipts: Array<TransactionObjectInput> | TransactionArgument;
+    clock: TransactionObjectInput;
+}
+export declare function calculateIntrinsicValue(tx: Transaction, typeArg: string, args: CalculateIntrinsicValueArgs): import("@mysten/sui/transactions").TransactionResult;
+export interface CalculatePositionFundingRateArgs {
+    position: TransactionObjectInput;
+    collateralOraclePrice: bigint | TransactionArgument;
+    collateralOraclePriceDecimal: bigint | TransactionArgument;
+    tradingPairOraclePrice: bigint | TransactionArgument;
+    tradingPairOraclePriceDecimal: bigint | TransactionArgument;
+    cumulativeFundingRateIndexSign: boolean | TransactionArgument;
+    cumulativeFundingRateIndex: bigint | TransactionArgument;
+}
+export declare function calculatePositionFundingRate(tx: Transaction, args: CalculatePositionFundingRateArgs): import("@mysten/sui/transactions").TransactionResult;
+export interface CalculateRealizedPnlUsdArgs {
+    side: boolean | TransactionArgument;
+    size: bigint | TransactionArgument;
+    entryPrice: bigint | TransactionArgument;
+    exitPrice: bigint | TransactionArgument;
+    sizeDecimal: bigint | TransactionArgument;
+    priceDecimal: bigint | TransactionArgument;
+}
+export declare function calculateRealizedPnlUsd(tx: Transaction, args: CalculateRealizedPnlUsdArgs): import("@mysten/sui/transactions").TransactionResult;
+export interface CalculateTradingFeeArgs {
+    size: bigint | TransactionArgument;
+    sizeDecimal: bigint | TransactionArgument;
+    collateralOraclePrice: bigint | TransactionArgument;
+    collateralOraclePriceDecimal: bigint | TransactionArgument;
+    tradingPairOraclePrice: bigint | TransactionArgument;
+    tradingPairOraclePriceDecimal: bigint | TransactionArgument;
+    tradingFeeRate: bigint | TransactionArgument;
+    tradingFeeDecimal: bigint | TransactionArgument;
+    collateralTokenDecimal: bigint | TransactionArgument;
+}
+export declare function calculateTradingFee(tx: Transaction, args: CalculateTradingFeeArgs): import("@mysten/sui/transactions").TransactionResult;
+export interface CalculateUnrealizedPnlArgs {
+    position: TransactionObjectInput;
+    tradingPairOraclePrice: bigint | TransactionArgument;
+    tradingPairOraclePriceDecimal: bigint | TransactionArgument;
+    tradingFeeRate: bigint | TransactionArgument;
+    tradingFeeDecimal: bigint | TransactionArgument;
+}
+export declare function calculateUnrealizedPnl(tx: Transaction, args: CalculateUnrealizedPnlArgs): import("@mysten/sui/transactions").TransactionResult;
+export interface CheckOptionCollateralPositionLiquidatedArgs {
+    dovRegistry: TransactionObjectInput;
+    typusOracle: TransactionObjectInput;
+    position: TransactionObjectInput;
+    collateralOraclePrice: bigint | TransactionArgument;
+    collateralOraclePriceDecimal: bigint | TransactionArgument;
+    tradingPairOraclePrice: bigint | TransactionArgument;
+    tradingPairOraclePriceDecimal: bigint | TransactionArgument;
+    tradingFeeRate: bigint | TransactionArgument;
+    tradingFeeDecimal: bigint | TransactionArgument;
+    maintenanceMarginRateBp: bigint | TransactionArgument;
+    cumulativeBorrowRate: bigint | TransactionArgument;
+    clock: TransactionObjectInput;
+}
+export declare function checkOptionCollateralPositionLiquidated(tx: Transaction, typeArg: string, args: CheckOptionCollateralPositionLiquidatedArgs): import("@mysten/sui/transactions").TransactionResult;
+export interface CheckOrderFilledArgs {
+    order: TransactionObjectInput;
+    oraclePrice: bigint | TransactionArgument;
+}
+export declare function checkOrderFilled(tx: Transaction, args: CheckOrderFilledArgs): import("@mysten/sui/transactions").TransactionResult;
+export interface CheckPositionLiquidatedArgs {
+    position: TransactionObjectInput;
+    collateralOraclePrice: bigint | TransactionArgument;
+    collateralOraclePriceDecimal: bigint | TransactionArgument;
+    tradingPairOraclePrice: bigint | TransactionArgument;
+    tradingPairOraclePriceDecimal: bigint | TransactionArgument;
+    tradingFeeRate: bigint | TransactionArgument;
+    tradingFeeDecimal: bigint | TransactionArgument;
+    maintenanceMarginRateBp: bigint | TransactionArgument;
+    cumulativeBorrowRate: bigint | TransactionArgument;
+    cumulativeFundingRateIndexSign: boolean | TransactionArgument;
+    cumulativeFundingRateIndex: bigint | TransactionArgument;
+}
+export declare function checkPositionLiquidated(tx: Transaction, args: CheckPositionLiquidatedArgs): import("@mysten/sui/transactions").TransactionResult;
+export interface CollateralWithPnlArgs {
+    position: TransactionObjectInput;
+    collateralOraclePrice: bigint | TransactionArgument;
+    collateralOraclePriceDecimal: bigint | TransactionArgument;
+    tradingPairOraclePrice: bigint | TransactionArgument;
+    tradingPairOraclePriceDecimal: bigint | TransactionArgument;
+    tradingFeeRate: bigint | TransactionArgument;
+    tradingFeeDecimal: bigint | TransactionArgument;
+}
+export declare function collateralWithPnl(tx: Transaction, args: CollateralWithPnlArgs): import("@mysten/sui/transactions").TransactionResult;
+export interface CreateOrderArgs {
+    version: TransactionObjectInput;
+    symbol: TransactionObjectInput;
+    leverageMbp: bigint | TransactionArgument;
+    reduceOnly: boolean | TransactionArgument;
+    isLong: boolean | TransactionArgument;
+    isStopOrder: boolean | TransactionArgument;
+    size: bigint | TransactionArgument;
+    sizeDecimal: bigint | TransactionArgument;
+    triggerPrice: bigint | TransactionArgument;
+    collateral: TransactionObjectInput;
+    collateralTokenDecimal: bigint | TransactionArgument;
+    linkedPositionId: bigint | TransactionArgument | TransactionArgument | null;
+    orderId: bigint | TransactionArgument;
+    oraclePrice: bigint | TransactionArgument;
+    clock: TransactionObjectInput;
+}
+export declare function createOrder(tx: Transaction, typeArg: string, args: CreateOrderArgs): import("@mysten/sui/transactions").TransactionResult;
+export interface CreateOrderWithBidReceiptsArgs {
+    version: TransactionObjectInput;
+    symbol: TransactionObjectInput;
+    portfolioIndex: bigint | TransactionArgument;
+    depositToken: TransactionObjectInput;
+    leverageMbp: bigint | TransactionArgument;
+    reduceOnly: boolean | TransactionArgument;
+    isLong: boolean | TransactionArgument;
+    isStopOrder: boolean | TransactionArgument;
+    size: bigint | TransactionArgument;
+    sizeDecimal: bigint | TransactionArgument;
+    triggerPrice: bigint | TransactionArgument;
+    collateralBidReceipts: Array<TransactionObjectInput> | TransactionArgument;
+    depositTokenDecimal: bigint | TransactionArgument;
+    linkedPositionId: bigint | TransactionArgument | TransactionArgument | null;
+    orderId: bigint | TransactionArgument;
+    oraclePrice: bigint | TransactionArgument;
+    user: string | TransactionArgument;
+    clock: TransactionObjectInput;
+}
+export declare function createOrderWithBidReceipts(tx: Transaction, args: CreateOrderWithBidReceiptsArgs): import("@mysten/sui/transactions").TransactionResult;
+export interface EmitRealizedFundingEventArgs {
+    user: string | TransactionArgument;
+    collateralToken: TransactionObjectInput;
+    symbol: TransactionObjectInput;
+    positionId: bigint | TransactionArgument;
+    realizedFundingSign: boolean | TransactionArgument;
+    realizedFundingFee: bigint | TransactionArgument;
+    u64Padding: Array<bigint | TransactionArgument> | TransactionArgument;
+}
+export declare function emitRealizedFundingEvent(tx: Transaction, args: EmitRealizedFundingEventArgs): import("@mysten/sui/transactions").TransactionResult;
+export interface GetEstimatedLiquidationPriceArgs {
+    position: TransactionObjectInput;
+    collateralOraclePrice: bigint | TransactionArgument;
+    collateralOraclePriceDecimal: bigint | TransactionArgument;
+    tradingPairOraclePrice: bigint | TransactionArgument;
+    tradingPairOraclePriceDecimal: bigint | TransactionArgument;
+    tradingFeeRate: bigint | TransactionArgument;
+    tradingFeeDecimal: bigint | TransactionArgument;
+    cumulativeBorrowRate: bigint | TransactionArgument;
+}
+export declare function getEstimatedLiquidationPrice(tx: Transaction, args: GetEstimatedLiquidationPriceArgs): import("@mysten/sui/transactions").TransactionResult;
+export declare function getMaxOrderTypeTag(tx: Transaction): import("@mysten/sui/transactions").TransactionResult;
+export interface GetOptionCollateralOrderCollateralAmountArgs {
+    dovRegistry: TransactionObjectInput;
+    typusOracle: TransactionObjectInput;
+    order: TransactionObjectInput;
+    clock: TransactionObjectInput;
+}
+export declare function getOptionCollateralOrderCollateralAmount(tx: Transaction, typeArg: string, args: GetOptionCollateralOrderCollateralAmountArgs): import("@mysten/sui/transactions").TransactionResult;
+export interface GetOptionPositionCollateralAmountArgs {
+    dovRegistry: TransactionObjectInput;
+    typusOracle: TransactionObjectInput;
+    position: TransactionObjectInput;
+    clock: TransactionObjectInput;
+}
+export declare function getOptionPositionCollateralAmount(tx: Transaction, typeArg: string, args: GetOptionPositionCollateralAmountArgs): import("@mysten/sui/transactions").TransactionResult;
+export declare function getOptionPositionPortfolioIndex(tx: Transaction, position: TransactionObjectInput): import("@mysten/sui/transactions").TransactionResult;
+export declare function getOrderCollateralAmount(tx: Transaction, typeArg: string, order: TransactionObjectInput): import("@mysten/sui/transactions").TransactionResult;
+export declare function getOrderCollateralToken(tx: Transaction, order: TransactionObjectInput): import("@mysten/sui/transactions").TransactionResult;
+export declare function getOrderCollateralTokenDecimal(tx: Transaction, order: TransactionObjectInput): import("@mysten/sui/transactions").TransactionResult;
+export interface GetOrderFilledFeeArgs {
+    order: TransactionObjectInput;
+    collateralOraclePrice: bigint | TransactionArgument;
+    collateralOraclePriceDecimal: bigint | TransactionArgument;
+    tradingPairOraclePrice: bigint | TransactionArgument;
+    tradingPairOraclePriceDecimal: bigint | TransactionArgument;
+    tradingFeeRate: bigint | TransactionArgument;
+    tradingFeeDecimal: bigint | TransactionArgument;
+}
+export declare function getOrderFilledFee(tx: Transaction, args: GetOrderFilledFeeArgs): import("@mysten/sui/transactions").TransactionResult;
+export declare function getOrderId(tx: Transaction, order: TransactionObjectInput): import("@mysten/sui/transactions").TransactionResult;
+export declare function getOrderLinkedPositionId(tx: Transaction, order: TransactionObjectInput): import("@mysten/sui/transactions").TransactionResult;
+export declare function getOrderPortfolioIndex(tx: Transaction, order: TransactionObjectInput): import("@mysten/sui/transactions").TransactionResult;
+export declare function getOrderPrice(tx: Transaction, order: TransactionObjectInput): import("@mysten/sui/transactions").TransactionResult;
+export declare function getOrderReduceOnly(tx: Transaction, order: TransactionObjectInput): import("@mysten/sui/transactions").TransactionResult;
+export declare function getOrderSide(tx: Transaction, order: TransactionObjectInput): import("@mysten/sui/transactions").TransactionResult;
+export declare function getOrderSize(tx: Transaction, order: TransactionObjectInput): import("@mysten/sui/transactions").TransactionResult;
+export declare function getOrderTradingSymbol(tx: Transaction, order: TransactionObjectInput): import("@mysten/sui/transactions").TransactionResult;
+export declare function getOrderTypeTag(tx: Transaction, order: TransactionObjectInput): import("@mysten/sui/transactions").TransactionResult;
+export declare function getOrderUser(tx: Transaction, order: TransactionObjectInput): import("@mysten/sui/transactions").TransactionResult;
+export declare function getPositionCollateralAmount(tx: Transaction, typeArg: string, position: TransactionObjectInput): import("@mysten/sui/transactions").TransactionResult;
+export declare function getPositionCollateralTokenDecimal(tx: Transaction, position: TransactionObjectInput): import("@mysten/sui/transactions").TransactionResult;
+export declare function getPositionCollateralTokenType(tx: Transaction, position: TransactionObjectInput): import("@mysten/sui/transactions").TransactionResult;
+export declare function getPositionId(tx: Transaction, position: TransactionObjectInput): import("@mysten/sui/transactions").TransactionResult;
+export declare function getPositionOptionCollateralInfo(tx: Transaction, position: TransactionObjectInput): import("@mysten/sui/transactions").TransactionResult;
+export declare function getPositionSide(tx: Transaction, position: TransactionObjectInput): import("@mysten/sui/transactions").TransactionResult;
+export declare function getPositionSize(tx: Transaction, position: TransactionObjectInput): import("@mysten/sui/transactions").TransactionResult;
+export declare function getPositionSizeDecimal(tx: Transaction, position: TransactionObjectInput): import("@mysten/sui/transactions").TransactionResult;
+export declare function getPositionSymbol(tx: Transaction, position: TransactionObjectInput): import("@mysten/sui/transactions").TransactionResult;
+export declare function getPositionUnrealizedCost(tx: Transaction, position: TransactionObjectInput): import("@mysten/sui/transactions").TransactionResult;
+export declare function getPositionUnrealizedFundingSign(tx: Transaction, position: TransactionObjectInput): import("@mysten/sui/transactions").TransactionResult;
+export declare function getPositionUser(tx: Transaction, position: TransactionObjectInput): import("@mysten/sui/transactions").TransactionResult;
+export declare function getReserveAmount(tx: Transaction, position: TransactionObjectInput): import("@mysten/sui/transactions").TransactionResult;
+export interface IncreaseCollateralArgs {
+    position: TransactionObjectInput;
+    collateral: TransactionObjectInput;
+}
+export declare function increaseCollateral(tx: Transaction, typeArg: string, args: IncreaseCollateralArgs): import("@mysten/sui/transactions").TransactionResult;
+export declare function isOptionCollateralOrder(tx: Transaction, order: TransactionObjectInput): import("@mysten/sui/transactions").TransactionResult;
+export declare function isOptionCollateralPosition(tx: Transaction, position: TransactionObjectInput): import("@mysten/sui/transactions").TransactionResult;
+export interface ManagerCreateReduceOnlyOrderArgs {
+    version: TransactionObjectInput;
+    symbol: TransactionObjectInput;
+    isLong: boolean | TransactionArgument;
+    size: bigint | TransactionArgument;
+    sizeDecimal: bigint | TransactionArgument;
+    triggerPrice: bigint | TransactionArgument;
+    collateral: TransactionObjectInput;
+    collateralTokenDecimal: bigint | TransactionArgument;
+    linkedPositionId: bigint | TransactionArgument;
+    user: string | TransactionArgument;
+    orderId: bigint | TransactionArgument;
+    oraclePrice: bigint | TransactionArgument;
+    clock: TransactionObjectInput;
+}
+export declare function managerCreateReduceOnlyOrder(tx: Transaction, typeArg: string, args: ManagerCreateReduceOnlyOrderArgs): import("@mysten/sui/transactions").TransactionResult;
+export interface MaxReleasingCollateralAmountArgs {
+    position: TransactionObjectInput;
+    collateralOraclePrice: bigint | TransactionArgument;
+    collateralOraclePriceDecimal: bigint | TransactionArgument;
+    tradingPairOraclePrice: bigint | TransactionArgument;
+    tradingPairOraclePriceDecimal: bigint | TransactionArgument;
+    tradingFeeRate: bigint | TransactionArgument;
+    tradingFeeDecimal: bigint | TransactionArgument;
+    cumulativeBorrowRate: bigint | TransactionArgument;
+    maxEntryLeverageMbp: bigint | TransactionArgument;
+}
+export declare function maxReleasingCollateralAmount(tx: Transaction, args: MaxReleasingCollateralAmountArgs): import("@mysten/sui/transactions").TransactionResult;
+export interface OrderFilledWithBidReceiptsCollateralArgs {
+    version: TransactionObjectInput;
+    liquidityPool: TransactionObjectInput;
+    dovRegistry: TransactionObjectInput;
+    typusOracle: TransactionObjectInput;
+    order: TransactionObjectInput;
+    originalPosition: TransactionObjectInput | TransactionArgument | null;
+    nextPositionId: bigint | TransactionArgument;
+    collateralOraclePrice: bigint | TransactionArgument;
+    collateralOraclePriceDecimal: bigint | TransactionArgument;
+    tradingPairOraclePrice: bigint | TransactionArgument;
+    tradingPairOraclePriceDecimal: bigint | TransactionArgument;
+    cumulativeBorrowRate: bigint | TransactionArgument;
+    cumulativeFundingRateIndexSign: boolean | TransactionArgument;
+    cumulativeFundingRateIndex: bigint | TransactionArgument;
+    tradingFeeRate: bigint | TransactionArgument;
+    tradingFeeDecimal: bigint | TransactionArgument;
+    referralFeeRebateBp: bigint | TransactionArgument;
+    clock: TransactionObjectInput;
+}
+export declare function orderFilledWithBidReceiptsCollateral(tx: Transaction, typeArgs: [string, string], args: OrderFilledWithBidReceiptsCollateralArgs): import("@mysten/sui/transactions").TransactionResult;
+export interface RealizeFundingArgs {
+    position: TransactionObjectInput;
+    fundingIncome: TransactionObjectInput;
+}
+export declare function realizeFunding(tx: Transaction, typeArg: string, args: RealizeFundingArgs): import("@mysten/sui/transactions").TransactionResult;
+export interface ReleaseCollateralArgs {
+    position: TransactionObjectInput;
+    releaseAmount: bigint | TransactionArgument;
+}
+export declare function releaseCollateral(tx: Transaction, typeArg: string, args: ReleaseCollateralArgs): import("@mysten/sui/transactions").TransactionResult;
+export interface RemoveOrderArgs {
+    version: TransactionObjectInput;
+    order: TransactionObjectInput;
+}
+export declare function removeOrder(tx: Transaction, typeArg: string, args: RemoveOrderArgs): import("@mysten/sui/transactions").TransactionResult;
+export interface RemoveOrderWithBidReceiptsArgs {
+    version: TransactionObjectInput;
+    order: TransactionObjectInput;
+}
+export declare function removeOrderWithBidReceipts(tx: Transaction, args: RemoveOrderWithBidReceiptsArgs): import("@mysten/sui/transactions").TransactionResult;
+export interface RemovePositionArgs {
+    version: TransactionObjectInput;
+    position: TransactionObjectInput;
+}
+export declare function removePosition(tx: Transaction, typeArg: string, args: RemovePositionArgs): import("@mysten/sui/transactions").TransactionResult;
+export interface RemovePositionLinkedOrderInfoArgs {
+    position: TransactionObjectInput;
+    linkedOrderId: bigint | TransactionArgument;
+}
+export declare function removePositionLinkedOrderInfo(tx: Transaction, args: RemovePositionLinkedOrderInfoArgs): import("@mysten/sui/transactions").TransactionResult;
+export interface RemovePositionWithBidReceiptsArgs {
+    version: TransactionObjectInput;
+    position: TransactionObjectInput;
+}
+export declare function removePositionWithBidReceipts(tx: Transaction, args: RemovePositionWithBidReceiptsArgs): import("@mysten/sui/transactions").TransactionResult;
+export interface UpdatePositionBorrowRateAndFundingRateArgs {
+    position: TransactionObjectInput;
+    collateralOraclePrice: bigint | TransactionArgument;
+    collateralOraclePriceDecimal: bigint | TransactionArgument;
+    tradingPairOraclePrice: bigint | TransactionArgument;
+    tradingPairOraclePriceDecimal: bigint | TransactionArgument;
+    cumulativeBorrowRate: bigint | TransactionArgument;
+    cumulativeFundingRateIndexSign: boolean | TransactionArgument;
+    cumulativeFundingRateIndex: bigint | TransactionArgument;
+}
+export declare function updatePositionBorrowRateAndFundingRate(tx: Transaction, args: UpdatePositionBorrowRateAndFundingRateArgs): import("@mysten/sui/transactions").TransactionResult;