@typus/typus-perp-sdk 1.0.0

package/dist/src/typus_perp/lp-pool/functions.d.ts

@@ -0,0 +1,356 @@
+import { Transaction, TransactionArgument, TransactionObjectInput } from "@mysten/sui/transactions";
+export interface SwapArgs {
+    version: TransactionObjectInput;
+    registry: TransactionObjectInput;
+    index: bigint | TransactionArgument;
+    pythState: TransactionObjectInput;
+    oracleFromToken: TransactionObjectInput;
+    oracleToToken: TransactionObjectInput;
+    fromCoin: TransactionObjectInput;
+    minToAmount: bigint | TransactionArgument;
+    clock: TransactionObjectInput;
+}
+export declare function swap(tx: Transaction, typeArgs: [string, string], args: SwapArgs): import("@mysten/sui/transactions").TransactionResult;
+export declare function init(tx: Transaction): import("@mysten/sui/transactions").TransactionResult;
+export declare function safetyCheck(tx: Transaction, liquidityPool: TransactionObjectInput): import("@mysten/sui/transactions").TransactionResult;
+export interface AddLiquidityTokenArgs {
+    version: TransactionObjectInput;
+    registry: TransactionObjectInput;
+    index: bigint | TransactionArgument;
+    oracle: TransactionObjectInput;
+    tokenDecimal: bigint | TransactionArgument;
+    targetWeightBp: bigint | TransactionArgument;
+    minDeposit: bigint | TransactionArgument;
+    maxCapacity: bigint | TransactionArgument;
+    basicMintFeeBp: bigint | TransactionArgument;
+    additionalMintFeeBp: bigint | TransactionArgument;
+    basicBurnFeeBp: bigint | TransactionArgument;
+    additionalBurnFeeBp: bigint | TransactionArgument;
+    swapFeeBp: bigint | TransactionArgument;
+    swapFeeProtocolShareBp: bigint | TransactionArgument;
+    basicBorrowRate0: bigint | TransactionArgument;
+    basicBorrowRate1: bigint | TransactionArgument;
+    basicBorrowRate2: bigint | TransactionArgument;
+    utilizationThresholdBp0: bigint | TransactionArgument;
+    utilizationThresholdBp1: bigint | TransactionArgument;
+    borrowIntervalTsMs: bigint | TransactionArgument;
+    maxOrderReserveRatioBp: bigint | TransactionArgument;
+    clock: TransactionObjectInput;
+}
+export declare function addLiquidityToken(tx: Transaction, typeArg: string, args: AddLiquidityTokenArgs): import("@mysten/sui/transactions").TransactionResult;
+export interface BurnLpArgs {
+    version: TransactionObjectInput;
+    registry: TransactionObjectInput;
+    index: bigint | TransactionArgument;
+    treasuryCaps: TransactionObjectInput;
+    pythState: TransactionObjectInput;
+    oracle: TransactionObjectInput;
+    coin: TransactionObjectInput;
+    clock: TransactionObjectInput;
+}
+export declare function burnLp(tx: Transaction, typeArgs: [string, string], args: BurnLpArgs): import("@mysten/sui/transactions").TransactionResult;
+export interface CalculateBurnLpArgs {
+    registry: TransactionObjectInput;
+    index: bigint | TransactionArgument;
+    tokenType: TransactionObjectInput;
+    price: bigint | TransactionArgument;
+    priceDecimal: bigint | TransactionArgument;
+    burnAmount: bigint | TransactionArgument;
+}
+export declare function calculateBurnLp(tx: Transaction, args: CalculateBurnLpArgs): import("@mysten/sui/transactions").TransactionResult;
+export interface CalculateLpFeeArgs {
+    liquidityPool: TransactionObjectInput;
+    tokenType: TransactionObjectInput;
+    depositAmount: bigint | TransactionArgument;
+    depositAmountUsd: bigint | TransactionArgument;
+    isMint: boolean | TransactionArgument;
+}
+export declare function calculateLpFee(tx: Transaction, args: CalculateLpFeeArgs): import("@mysten/sui/transactions").TransactionResult;
+export interface CalculateMintLpArgs {
+    registry: TransactionObjectInput;
+    index: bigint | TransactionArgument;
+    tokenType: TransactionObjectInput;
+    price: bigint | TransactionArgument;
+    priceDecimal: bigint | TransactionArgument;
+    depositAmount: bigint | TransactionArgument;
+}
+export declare function calculateMintLp(tx: Transaction, args: CalculateMintLpArgs): import("@mysten/sui/transactions").TransactionResult;
+export interface CalculateSwapFeeArgs {
+    liquidityPool: TransactionObjectInput;
+    tokenType: TransactionObjectInput;
+    amount: bigint | TransactionArgument;
+    amountUsd: bigint | TransactionArgument;
+    swapIn: boolean | TransactionArgument;
+}
+export declare function calculateSwapFee(tx: Transaction, args: CalculateSwapFeeArgs): import("@mysten/sui/transactions").TransactionResult;
+export interface CheckRemoveLiquidityTokenProcessStatusArgs {
+    process: TransactionObjectInput;
+    statusCode: bigint | TransactionArgument;
+}
+export declare function checkRemoveLiquidityTokenProcessStatus(tx: Transaction, args: CheckRemoveLiquidityTokenProcessStatusArgs): import("@mysten/sui/transactions").TransactionResult;
+export interface CheckTokenPoolStatusArgs {
+    registry: TransactionObjectInput;
+    index: bigint | TransactionArgument;
+    assertActive: boolean | TransactionArgument;
+}
+export declare function checkTokenPoolStatus(tx: Transaction, typeArg: string, args: CheckTokenPoolStatusArgs): import("@mysten/sui/transactions").TransactionResult;
+export interface CheckTradingOrderSizeValidArgs {
+    liquidityPool: TransactionObjectInput;
+    liquidityToken: TransactionObjectInput;
+    reserveAmount: bigint | TransactionArgument;
+}
+export declare function checkTradingOrderSizeValid(tx: Transaction, args: CheckTradingOrderSizeValidArgs): import("@mysten/sui/transactions").TransactionResult;
+export interface CheckTvlUpdatedArgs {
+    liquidityPool: TransactionObjectInput;
+    clock: TransactionObjectInput;
+}
+export declare function checkTvlUpdated(tx: Transaction, args: CheckTvlUpdatedArgs): import("@mysten/sui/transactions").TransactionResult;
+export interface CompleteRemoveLiquidityTokenProcessArgs {
+    version: TransactionObjectInput;
+    registry: TransactionObjectInput;
+    index: bigint | TransactionArgument;
+    process: TransactionObjectInput;
+}
+export declare function completeRemoveLiquidityTokenProcess(tx: Transaction, typeArg: string, args: CompleteRemoveLiquidityTokenProcessArgs): import("@mysten/sui/transactions").TransactionResult;
+export declare function getBorrowRateDecimal(tx: Transaction): import("@mysten/sui/transactions").TransactionResult;
+export interface GetCumulativeBorrowRateArgs {
+    liquidityPool: TransactionObjectInput;
+    liquidityToken: TransactionObjectInput;
+}
+export declare function getCumulativeBorrowRate(tx: Transaction, args: GetCumulativeBorrowRateArgs): import("@mysten/sui/transactions").TransactionResult;
+export interface GetExpiredReceiptCollateralBcsArgs {
+    registry: TransactionObjectInput;
+    dovRegistry: TransactionObjectInput;
+    index: bigint | TransactionArgument;
+}
+export declare function getExpiredReceiptCollateralBcs(tx: Transaction, args: GetExpiredReceiptCollateralBcsArgs): import("@mysten/sui/transactions").TransactionResult;
+export interface GetLiquidityAmountArgs {
+    registry: TransactionObjectInput;
+    index: bigint | TransactionArgument;
+    liquidityToken: TransactionObjectInput;
+}
+export declare function getLiquidityAmount(tx: Transaction, args: GetLiquidityAmountArgs): import("@mysten/sui/transactions").TransactionResult;
+export interface GetLiquidityPoolArgs {
+    registry: TransactionObjectInput;
+    index: bigint | TransactionArgument;
+}
+export declare function getLiquidityPool(tx: Transaction, args: GetLiquidityPoolArgs): import("@mysten/sui/transactions").TransactionResult;
+export interface GetLiquidityTokenDecimalArgs {
+    registry: TransactionObjectInput;
+    index: bigint | TransactionArgument;
+    liquidityToken: TransactionObjectInput;
+}
+export declare function getLiquidityTokenDecimal(tx: Transaction, args: GetLiquidityTokenDecimalArgs): import("@mysten/sui/transactions").TransactionResult;
+export interface GetLpTokenTypeArgs {
+    registry: TransactionObjectInput;
+    index: bigint | TransactionArgument;
+}
+export declare function getLpTokenType(tx: Transaction, args: GetLpTokenTypeArgs): import("@mysten/sui/transactions").TransactionResult;
+export interface GetMutLiquidityPoolArgs {
+    registry: TransactionObjectInput;
+    index: bigint | TransactionArgument;
+}
+export declare function getMutLiquidityPool(tx: Transaction, args: GetMutLiquidityPoolArgs): import("@mysten/sui/transactions").TransactionResult;
+export interface GetMutTokenPoolArgs {
+    liquidityPool: TransactionObjectInput;
+    tokenType: TransactionObjectInput;
+}
+export declare function getMutTokenPool(tx: Transaction, args: GetMutTokenPoolArgs): import("@mysten/sui/transactions").TransactionResult;
+export declare function getReceiptCollateral(tx: Transaction, liquidityPool: TransactionObjectInput): import("@mysten/sui/transactions").TransactionResult;
+export interface GetReceiptCollateralBcsArgs {
+    registry: TransactionObjectInput;
+    index: bigint | TransactionArgument;
+}
+export declare function getReceiptCollateralBcs(tx: Transaction, args: GetReceiptCollateralBcsArgs): import("@mysten/sui/transactions").TransactionResult;
+export interface GetRemoveLiquidityTokenProcessTokenArgs {
+    process: TransactionObjectInput;
+    updatePositionToken: boolean | TransactionArgument;
+}
+export declare function getRemoveLiquidityTokenProcessToken(tx: Transaction, args: GetRemoveLiquidityTokenProcessTokenArgs): import("@mysten/sui/transactions").TransactionResult;
+export interface GetTokenPoolArgs {
+    liquidityPool: TransactionObjectInput;
+    tokenType: TransactionObjectInput;
+}
+export declare function getTokenPool(tx: Transaction, args: GetTokenPoolArgs): import("@mysten/sui/transactions").TransactionResult;
+export interface GetTokenPoolStateArgs {
+    liquidityPool: TransactionObjectInput;
+    liquidityToken: TransactionObjectInput;
+}
+export declare function getTokenPoolState(tx: Transaction, args: GetTokenPoolStateArgs): import("@mysten/sui/transactions").TransactionResult;
+export declare function getTvlUsd(tx: Transaction, liquidityPool: TransactionObjectInput): import("@mysten/sui/transactions").TransactionResult;
+export interface ManagerFlashRemoveLiquidityArgs {
+    version: TransactionObjectInput;
+    registry: TransactionObjectInput;
+    index: bigint | TransactionArgument;
+    pythState: TransactionObjectInput;
+    oracle: TransactionObjectInput;
+    process: TransactionObjectInput;
+    clock: TransactionObjectInput;
+}
+export declare function managerFlashRemoveLiquidity(tx: Transaction, typeArg: string, args: ManagerFlashRemoveLiquidityArgs): import("@mysten/sui/transactions").TransactionResult;
+export interface ManagerFlashRepayLiquidityArgs {
+    version: TransactionObjectInput;
+    registry: TransactionObjectInput;
+    index: bigint | TransactionArgument;
+    pythState: TransactionObjectInput;
+    oracle: TransactionObjectInput;
+    process: TransactionObjectInput;
+    balance: TransactionObjectInput;
+    clock: TransactionObjectInput;
+}
+export declare function managerFlashRepayLiquidity(tx: Transaction, typeArg: string, args: ManagerFlashRepayLiquidityArgs): import("@mysten/sui/transactions").TransactionResult;
+export interface MintLpArgs {
+    version: TransactionObjectInput;
+    registry: TransactionObjectInput;
+    treasuryCaps: TransactionObjectInput;
+    index: bigint | TransactionArgument;
+    pythState: TransactionObjectInput;
+    oracle: TransactionObjectInput;
+    coin: TransactionObjectInput;
+    clock: TransactionObjectInput;
+}
+export declare function mintLp(tx: Transaction, typeArgs: [string, string], args: MintLpArgs): import("@mysten/sui/transactions").TransactionResult;
+export interface NewLiquidityPoolArgs {
+    version: TransactionObjectInput;
+    registry: TransactionObjectInput;
+    lpTokenDecimal: bigint | TransactionArgument;
+}
+export declare function newLiquidityPool(tx: Transaction, typeArg: string, args: NewLiquidityPoolArgs): import("@mysten/sui/transactions").TransactionResult;
+export interface OracleMatchedArgs {
+    liquidityPool: TransactionObjectInput;
+    tokenType: TransactionObjectInput;
+    oracleId: string | TransactionArgument;
+}
+export declare function oracleMatched(tx: Transaction, args: OracleMatchedArgs): import("@mysten/sui/transactions").TransactionResult;
+export interface OrderFilledArgs {
+    liquidityPool: TransactionObjectInput;
+    addReserve: boolean | TransactionArgument;
+    dReserve: bigint | TransactionArgument;
+    feeBalance: TransactionObjectInput;
+}
+export declare function orderFilled(tx: Transaction, typeArg: string, args: OrderFilledArgs): import("@mysten/sui/transactions").TransactionResult;
+export interface PutCollateralArgs {
+    liquidityPool: TransactionObjectInput;
+    collateral: TransactionObjectInput;
+    collateralOraclePrice: bigint | TransactionArgument;
+    collateralOraclePriceDecimal: bigint | TransactionArgument;
+}
+export declare function putCollateral(tx: Transaction, typeArg: string, args: PutCollateralArgs): import("@mysten/sui/transactions").TransactionResult;
+export interface PutReceiptCollateralsArgs {
+    liquidityPool: TransactionObjectInput;
+    unsettledBidReceipts: Array<TransactionObjectInput> | TransactionArgument;
+}
+export declare function putReceiptCollaterals(tx: Transaction, args: PutReceiptCollateralsArgs): import("@mysten/sui/transactions").TransactionResult;
+export interface RequestCollateralArgs {
+    liquidityPool: TransactionObjectInput;
+    collateralAmount: bigint | TransactionArgument;
+    collateralOraclePrice: bigint | TransactionArgument;
+    collateralOraclePriceDecimal: bigint | TransactionArgument;
+}
+export declare function requestCollateral(tx: Transaction, typeArg: string, args: RequestCollateralArgs): import("@mysten/sui/transactions").TransactionResult;
+export interface ResumePoolArgs {
+    version: TransactionObjectInput;
+    registry: TransactionObjectInput;
+    index: bigint | TransactionArgument;
+}
+export declare function resumePool(tx: Transaction, args: ResumePoolArgs): import("@mysten/sui/transactions").TransactionResult;
+export interface ResumeTokenPoolArgs {
+    version: TransactionObjectInput;
+    registry: TransactionObjectInput;
+    index: bigint | TransactionArgument;
+}
+export declare function resumeTokenPool(tx: Transaction, typeArg: string, args: ResumeTokenPoolArgs): import("@mysten/sui/transactions").TransactionResult;
+export interface StartRemoveLiquidityTokenProcessArgs {
+    version: TransactionObjectInput;
+    registry: TransactionObjectInput;
+    index: bigint | TransactionArgument;
+    oracle: TransactionObjectInput;
+}
+export declare function startRemoveLiquidityTokenProcess(tx: Transaction, typeArg: string, args: StartRemoveLiquidityTokenProcessArgs): import("@mysten/sui/transactions").TransactionResult;
+export interface SuspendPoolArgs {
+    version: TransactionObjectInput;
+    registry: TransactionObjectInput;
+    index: bigint | TransactionArgument;
+}
+export declare function suspendPool(tx: Transaction, args: SuspendPoolArgs): import("@mysten/sui/transactions").TransactionResult;
+export interface SuspendTokenPoolArgs {
+    version: TransactionObjectInput;
+    registry: TransactionObjectInput;
+    index: bigint | TransactionArgument;
+}
+export declare function suspendTokenPool(tx: Transaction, typeArg: string, args: SuspendTokenPoolArgs): import("@mysten/sui/transactions").TransactionResult;
+export declare function tokenPoolIsActive(tx: Transaction, tokenPool: TransactionObjectInput): import("@mysten/sui/transactions").TransactionResult;
+export interface UpdateBorrowInfoArgs {
+    version: TransactionObjectInput;
+    registry: TransactionObjectInput;
+    index: bigint | TransactionArgument;
+    clock: TransactionObjectInput;
+}
+export declare function updateBorrowInfo(tx: Transaction, args: UpdateBorrowInfoArgs): import("@mysten/sui/transactions").TransactionResult;
+export interface UpdateLiquidityValueArgs {
+    version: TransactionObjectInput;
+    registry: TransactionObjectInput;
+    index: bigint | TransactionArgument;
+    pythState: TransactionObjectInput;
+    oracle: TransactionObjectInput;
+    clock: TransactionObjectInput;
+}
+export declare function updateLiquidityValue(tx: Transaction, typeArg: string, args: UpdateLiquidityValueArgs): import("@mysten/sui/transactions").TransactionResult;
+export interface UpdateMarginConfigArgs {
+    version: TransactionObjectInput;
+    registry: TransactionObjectInput;
+    index: bigint | TransactionArgument;
+    basicBorrowRate0: bigint | TransactionArgument | TransactionArgument | null;
+    basicBorrowRate1: bigint | TransactionArgument | TransactionArgument | null;
+    basicBorrowRate2: bigint | TransactionArgument | TransactionArgument | null;
+    utilizationThresholdBp0: bigint | TransactionArgument | TransactionArgument | null;
+    utilizationThresholdBp1: bigint | TransactionArgument | TransactionArgument | null;
+    borrowIntervalTsMs: bigint | TransactionArgument | TransactionArgument | null;
+    maxOrderReserveRatioBp: bigint | TransactionArgument | TransactionArgument | null;
+}
+export declare function updateMarginConfig(tx: Transaction, typeArg: string, args: UpdateMarginConfigArgs): import("@mysten/sui/transactions").TransactionResult;
+export interface UpdateRemoveLiquidityTokenProcessStatusArgs {
+    process: TransactionObjectInput;
+    targetStatusCode: bigint | TransactionArgument;
+}
+export declare function updateRemoveLiquidityTokenProcessStatus(tx: Transaction, args: UpdateRemoveLiquidityTokenProcessStatusArgs): import("@mysten/sui/transactions").TransactionResult;
+export interface UpdateRemoveLiquidityTokenProcessTokenArgs {
+    process: TransactionObjectInput;
+    updatePositionToken: boolean | TransactionArgument;
+}
+export declare function updateRemoveLiquidityTokenProcessToken(tx: Transaction, typeArg: string, args: UpdateRemoveLiquidityTokenProcessTokenArgs): import("@mysten/sui/transactions").TransactionResult;
+export interface UpdateSpotConfigArgs {
+    version: TransactionObjectInput;
+    registry: TransactionObjectInput;
+    index: bigint | TransactionArgument;
+    targetWeightBp: bigint | TransactionArgument | TransactionArgument | null;
+    minDeposit: bigint | TransactionArgument | TransactionArgument | null;
+    maxCapacity: bigint | TransactionArgument | TransactionArgument | null;
+    basicMintFeeBp: bigint | TransactionArgument | TransactionArgument | null;
+    additionalMintFeeBp: bigint | TransactionArgument | TransactionArgument | null;
+    basicBurnFeeBp: bigint | TransactionArgument | TransactionArgument | null;
+    additionalBurnFeeBp: bigint | TransactionArgument | TransactionArgument | null;
+    swapFeeBp: bigint | TransactionArgument | TransactionArgument | null;
+    swapFeeProtocolShareBp: bigint | TransactionArgument | TransactionArgument | null;
+}
+export declare function updateSpotConfig(tx: Transaction, typeArg: string, args: UpdateSpotConfigArgs): import("@mysten/sui/transactions").TransactionResult;
+export interface UpdateTvlArgs {
+    version: TransactionObjectInput;
+    liquidityPool: TransactionObjectInput;
+    tokenType: TransactionObjectInput;
+    pythState: TransactionObjectInput;
+    oracle: TransactionObjectInput;
+    clock: TransactionObjectInput;
+}
+export declare function updateTvl(tx: Transaction, args: UpdateTvlArgs): import("@mysten/sui/transactions").TransactionResult;
+export interface ViewSwapResultArgs {
+    version: TransactionObjectInput;
+    registry: TransactionObjectInput;
+    index: bigint | TransactionArgument;
+    pythState: TransactionObjectInput;
+    oracleFromToken: TransactionObjectInput;
+    oracleToToken: TransactionObjectInput;
+    fromAmount: bigint | TransactionArgument;
+    clock: TransactionObjectInput;
+}
+export declare function viewSwapResult(tx: Transaction, typeArgs: [string, string], args: ViewSwapResultArgs): import("@mysten/sui/transactions").TransactionResult;