carbon-js-sdk 0.2.17 → 0.2.18-dev.0

package/lib/modules/cdp.d.ts

@@ -1,27 +1,166 @@
+import { AssetParams, DebtInfo, RateStrategyParams, StablecoinDebtInfo } from '../codec';
 import { CarbonTx } from "../util";
-import BaseModule from "./base";
 import { BigNumber } from "bignumber.js";
+import { Debt } from './../codec/cdp/query';
+import BaseModule from "./base";
+import { Params } from '../codec/cdp/params';
 export declare class CDPModule extends BaseModule {
-    addCollateral(params: CDPModule.AddCollateralParams, opts?: CarbonTx.SignTxOpts): Promise<import("@cosmjs/stargate").DeliverTxResponse>;
-    removeCollateral(params: CDPModule.RemoveCollateralParams, opts?: CarbonTx.SignTxOpts): Promise<import("@cosmjs/stargate").DeliverTxResponse>;
-    addDebt(params: CDPModule.AddDebtParams, opts?: CarbonTx.SignTxOpts): Promise<import("@cosmjs/stargate").DeliverTxResponse>;
-    removeDebt(params: CDPModule.RemoveDebtParams, opts?: CarbonTx.SignTxOpts): Promise<import("@cosmjs/stargate").DeliverTxResponse>;
+    private cdpModuleAddress;
+    supplyAsset(params: CDPModule.SupplyAssetParams, opts?: CarbonTx.SignTxOpts): Promise<import("@cosmjs/stargate").DeliverTxResponse>;
+    withdrawAsset(params: CDPModule.WithdrawAssetParams, opts?: CarbonTx.SignTxOpts): Promise<import("@cosmjs/stargate").DeliverTxResponse>;
+    lockCollateral(params: CDPModule.LockCollateralParams, opts?: CarbonTx.SignTxOpts): Promise<import("@cosmjs/stargate").DeliverTxResponse>;
+    unlockCollateral(params: CDPModule.UnlockCollateralParams, opts?: CarbonTx.SignTxOpts): Promise<import("@cosmjs/stargate").DeliverTxResponse>;
+    borrowAsset(params: CDPModule.BorrowAssetParams, opts?: CarbonTx.SignTxOpts): Promise<import("@cosmjs/stargate").DeliverTxResponse>;
+    repayAsset(params: CDPModule.RepayAssetParams, opts?: CarbonTx.SignTxOpts): Promise<import("@cosmjs/stargate").DeliverTxResponse>;
+    supplyAssetAndLockCollateral(params: CDPModule.SupplyAssetAndLockCollateralParams, opts?: CarbonTx.SignTxOpts): Promise<import("@cosmjs/stargate").DeliverTxResponse>;
+    unlockCollateralAndWithdrawAsset(params: CDPModule.UnlockCollateralAndWithdrawAssetParams, opts?: CarbonTx.SignTxOpts): Promise<import("@cosmjs/stargate").DeliverTxResponse>;
+    liquidateCollateral(params: CDPModule.LiquidateCollateralParams, opts?: CarbonTx.SignTxOpts): Promise<import("@cosmjs/stargate").DeliverTxResponse>;
+    liquidateCollateralWithCdpTokens(params: CDPModule.LiquidateCollateralWithCdpTokensParams, opts?: CarbonTx.SignTxOpts): Promise<import("@cosmjs/stargate").DeliverTxResponse>;
+    liquidateCollateralWithCollateral(params: CDPModule.LiquidateCollateralWithCollateralParams, opts?: CarbonTx.SignTxOpts): Promise<import("@cosmjs/stargate").DeliverTxResponse>;
+    liquidateCollateralWithStablecoin(params: CDPModule.LiquidateCollateralWithStablecoinParams, opts?: CarbonTx.SignTxOpts): Promise<import("@cosmjs/stargate").DeliverTxResponse>;
+    repayAssetWithCdpTokens(params: CDPModule.RepayAssetWithCdpTokensParams, opts?: CarbonTx.SignTxOpts): Promise<import("@cosmjs/stargate").DeliverTxResponse>;
+    repayAssetWithCollateral(params: CDPModule.RepayAssetWithCollateralParams, opts?: CarbonTx.SignTxOpts): Promise<import("@cosmjs/stargate").DeliverTxResponse>;
+    mintStablecoin(params: CDPModule.MintStablecoinParams, opts?: CarbonTx.SignTxOpts): Promise<import("@cosmjs/stargate").DeliverTxResponse>;
+    returnStablecoin(params: CDPModule.ReturnStablecoinParams, opts?: CarbonTx.SignTxOpts): Promise<import("@cosmjs/stargate").DeliverTxResponse>;
+    updateRateStrategy(params: CDPModule.UpdateRateStrategyParams, opts?: CarbonTx.SignTxOpts): Promise<import("@cosmjs/stargate").DeliverTxResponse>;
+    claimRewards(opts?: CarbonTx.SignTxOpts): Promise<import("@cosmjs/stargate").DeliverTxResponse>;
+    createRewardScheme(params: CDPModule.CreateRewardSchemeParams, opts?: CarbonTx.SignTxOpts): Promise<import("@cosmjs/stargate").DeliverTxResponse>;
+    getAccountData(account: string): Promise<{
+        TotalCollateralsUsd: BigNumber;
+        AvailableBorrowsUsd: BigNumber;
+        CurrLiquidationThreshold: BigNumber;
+        TotalDebtsUsd: BigNumber;
+        TotalStablecoinDebtsUsd: BigNumber;
+        HealthFactor: BigNumber;
+    }>;
+    getAssetBorrowableSupply(denom: string): Promise<BigNumber>;
+    getCdpToActualRatio(cdpDenom: string): Promise<BigNumber>;
+    getTotalAccountTokenDebtUsdVal(account: string, denom: string, debt?: Debt, debtInfo?: DebtInfo): Promise<BigNumber>;
+    getModuleTotalDebtUsdVal(): Promise<BigNumber | undefined>;
+    getModuleTotalCollateralUsdVal(): Promise<BigNumber>;
+    getCdpTokenUsdVal(cdpDenom: string, amount: BigNumber): Promise<BigNumber>;
+    getTokenUsdVal(denom: string, amount: BigNumber): Promise<BigNumber>;
+    getTotalTokenDebt(denom: string, debtInfo?: DebtInfo): Promise<BigNumber>;
+    getTotalAccountTokenDebt(account: string, denom: string, debt?: Debt, debtInfo?: DebtInfo): Promise<BigNumber>;
+    getTotalAccountStablecoinDebt(account: string, debt?: CDPModule.StablecoinDebt, debtInfo?: StablecoinDebtInfo): Promise<BigNumber>;
+    static calculateInterestAPY: (debtInfo: DebtInfo, rateStrategy: RateStrategyParams) => BigNumber;
+    calculateAPY(denom: string, debtInfo?: DebtInfo, assetParams?: AssetParams, rateStrategyParams?: RateStrategyParams): Promise<BigNumber>;
+    static calculateInterestForTimePeriod(apy: BigNumber, start: Date, end: Date): BigNumber;
+    calculateLendAPY(denom: string, borrowInterest?: BigNumber, debtInfo?: DebtInfo, params?: Params): Promise<BigNumber>;
+    recalculateCIM(denom: string, debtInfo?: DebtInfo): Promise<BigNumber>;
+    recalculateStablecoinCIM(debtInfo?: StablecoinDebtInfo): Promise<BigNumber>;
+    getMaxCollateralForUnlock(account: string, cdpDenom: string): Promise<BigNumber | undefined>;
+    getCdpModuleAddress(): string;
+    getCdpTokenPrice(cdpDenom: string): Promise<BigNumber>;
+    getUnderlyingDenom(cdpDenom: string): string;
+    getMaxCollateralForLiquidator(debtor: string, cdpDenom: string, debtDenom: string, debtRepaymentAmount: BigNumber): Promise<BigNumber>;
+    computeCloseFactor(borrowedValue: BigNumber, collateralValue: BigNumber, liquidationThreshold: BigNumber, smallLiquidationSize: BigNumber, minimumCloseFactor: BigNumber, completeLiquidationThreshold: BigNumber): BigNumber;
+    calculateCollateralRequiredForDebt(debtPrice: BigNumber, collateralPrice: BigNumber, debtAmount: BigNumber, collateralTokenDecimals: BigNumber, debtTokenDecimals: BigNumber): BigNumber;
+    calculateDebtCoveredByCollateral(debtPrice: BigNumber, collateralPrice: BigNumber, collateralAmount: BigNumber, collateralTokenDecimals: BigNumber, debtTokenDecimals: BigNumber): BigNumber;
+    getDecimalMultiplier(n: BigNumber): BigNumber;
 }
 export declare namespace CDPModule {
-    interface AddCollateralParams {
-        vaultTypeId: number;
+    interface SupplyAssetParams {
+        denom: string;
+        amount: BigNumber;
+    }
+    interface WithdrawAssetParams {
+        cdpDenom: string;
+        amount: BigNumber;
+    }
+    interface LockCollateralParams {
+        cdpDenom: string;
+        amount: BigNumber;
+    }
+    interface UnlockCollateralParams {
+        cdpDenom: string;
         amount: BigNumber;
     }
-    interface RemoveCollateralParams {
-        vaultTypeId: number;
+    interface BorrowAssetParams {
+        denom: string;
         amount: BigNumber;
     }
-    interface AddDebtParams {
-        vaultTypeId: number;
+    interface RepayAssetParams {
+        denom: string;
         amount: BigNumber;
     }
-    interface RemoveDebtParams {
-        vaultTypeId: number;
+    interface SupplyAssetAndLockCollateralParams {
+        denom: string;
+        supplyAmount: BigNumber;
+        lockAmount: BigNumber;
+    }
+    interface UnlockCollateralAndWithdrawAssetParams {
+        cdpDenom: string;
+        unlockAmount: BigNumber;
+        withdrawAmount: BigNumber;
+    }
+    interface LiquidateCollateralParams {
+        debtor: string;
+        collateralDenom: string;
+        minCollateralAmount: BigNumber;
+        debtDenom: string;
+        debtAmount: BigNumber;
+    }
+    interface LiquidateCollateralWithCdpTokensParams {
+        debtor: string;
+        collateralDenom: string;
+        minCollateralAmount: BigNumber;
+        debtDenom: string;
+        debtAmount: BigNumber;
+        debtCollateralDenom: string;
+        debtCollateralAmount: BigNumber;
+    }
+    interface LiquidateCollateralWithCollateralParams {
+        debtor: string;
+        collateralDenom: string;
+        minCollateralAmount: BigNumber;
+        debtDenom: string;
+        debtAmount: BigNumber;
+        debtCollateralDenom: string;
+        debtCollateralAmount: BigNumber;
+    }
+    interface LiquidateCollateralWithStablecoinParams {
+        debtor: string;
+        collateralDenom: string;
+        minCollateralAmount: BigNumber;
+        debtDenom: string;
+        debtAmount: BigNumber;
+        interestDenom: string;
+        interestAmount: BigNumber;
+    }
+    interface RepayAssetWithCdpTokensParams {
+        debtor?: string;
+        debtDenom: string;
+        cdpDenom: string;
+        cdpAmount: BigNumber;
+    }
+    interface RepayAssetWithCollateralParams {
+        debtor?: string;
+        debtDenom: string;
+        cdpDenom: string;
+        cdpAmount: BigNumber;
+    }
+    interface MintStablecoinParams {
         amount: BigNumber;
     }
+    interface ReturnStablecoinParams {
+        principalAmount: BigNumber;
+        interestDenom: string;
+        interestAmount: BigNumber;
+    }
+    interface UpdateRateStrategyParams {
+        rateStrategyParams: RateStrategyParams;
+    }
+    interface StablecoinDebt {
+        principalDebt: string;
+        initialCumulativeInterestMultiplier: string;
+    }
+    interface CreateRewardSchemeParams {
+        rewardDenom: string;
+        assetDenom: string;
+        rewardType: string;
+        rewardAmountPerSecond: BigNumber;
+        startTime: Date;
+        endTime: Date;
+    }
 }