@xchainjs/xchain-thorchain-query 0.4.2 → 0.4.3

package/lib/thorchain-query.d.ts

@@ -1,7 +1,7 @@
 import { Asset } from '@xchainjs/xchain-util';
 import { CryptoAmount } from './crypto-amount';
 import { ThorchainCache } from './thorchain-cache';
-import { AddliquidityPosition, ChainAttributes, EstimateAddLP, EstimateAddSaver, EstimateWithdrawLP, EstimateWithdrawSaver, LiquidityPosition, PoolRatios, QuoteSwapParams, SaversPosition, SaversWithdraw, TotalFees, TxDetails, WithdrawLiquidityPosition, getSaver } from './types';
+import { AddliquidityPosition, ChainAttributes, EstimateAddLP, EstimateAddSaver, EstimateWithdrawLP, EstimateWithdrawSaver, LiquidityPosition, LoanCloseParams, LoanCloseQuote, LoanOpenParams, LoanOpenQuote, PoolRatios, QuoteSwapParams, SaversPosition, SaversWithdraw, TotalFees, TxDetails, WithdrawLiquidityPosition, getSaver } from './types';
 /**
  * THORChain Class for interacting with THORChain.
  * Recommended main class to use for swapping with THORChain
@@ -113,4 +113,16 @@ export declare class ThorchainQuery {
      */
     getSaverPosition(params: getSaver): Promise<SaversPosition>;
     private getAddSaversEstimateErrors;
+    /**
+     *
+     * @param loanOpenParams - params needed for the end Point
+     * @returns
+     */
+    getLoanQuoteOpen({ asset, amount, targetAsset, destination, minOut, affiliateBps, affiliate, height, }: LoanOpenParams): Promise<LoanOpenQuote>;
+    /**
+     *
+     * @param loanOpenParams - params needed for the end Point
+     * @returns
+     */
+    getLoanQuoteClose({ asset, amount, fromAddress, loanAsset, loanOwner, minOut, height, }: LoanCloseParams): Promise<LoanCloseQuote>;
 }

package/lib/types.d.ts

@@ -214,6 +214,12 @@ export type SaverFees = {
     asset: Asset;
     outbound: CryptoAmount;
 };
+export type QuoteFees = {
+    asset: string;
+    liquidity?: string;
+    outbound?: string;
+    total_bps?: string;
+};
 export type SaversPosition = {
     depositValue: CryptoAmount;
     redeemableValue: CryptoAmount;
@@ -229,3 +235,61 @@ export type SaversWithdraw = {
     address: Address;
     withdrawBps: number;
 };
+export type LoanOpenParams = {
+    asset: Asset;
+    amount: CryptoAmount;
+    targetAsset: Asset;
+    destination: string;
+    height?: number;
+    minOut?: string;
+    affiliateBps?: number;
+    affiliate?: string;
+};
+export type LoanCloseParams = {
+    asset: Asset;
+    amount: CryptoAmount;
+    loanAsset: Asset;
+    loanOwner: Address;
+    fromAddress: Address;
+    minOut?: string;
+    height?: number;
+};
+export type LoanOpenQuote = {
+    inboundAddress: string;
+    expectedWaitTime: BlockInformation;
+    fees: QuoteFees;
+    slippageBps?: number;
+    router?: string;
+    expiry: number;
+    warning: string;
+    notes: string;
+    dustThreshold?: string;
+    memo?: string;
+    expectedAmountOut: string;
+    expectedCollateralizationRation: string;
+    expectedCollateralUp: string;
+    expectedDebtUp: string;
+    errors: string[];
+};
+export type LoanCloseQuote = {
+    inboundAddress: string;
+    expectedWaitTime: BlockInformation;
+    fees: QuoteFees;
+    slippageBps?: number;
+    router?: string;
+    expiry: number;
+    warning: string;
+    notes: string;
+    dustThreshold?: string;
+    memo?: string;
+    expectedAmountOut: string;
+    expectedCollateralDown: string;
+    expectedDebtDown: string;
+    errors: string[];
+};
+export type BlockInformation = {
+    inboundConfirmationBlocks?: number;
+    inboundConfirmationSeconds?: number;
+    outboundDelayBlocks?: number;
+    outbondDelaySeconds?: number;
+};

package/lib/utils/thornode.d.ts

@@ -1,5 +1,5 @@
 import { Network } from '@xchainjs/xchain-client';
-import { InboundAddress, LastBlock, LiquidityProviderSummary, MimirResponse, Pool, QueueResponse, QuoteSaverDepositResponse, QuoteSaverWithdrawResponse, QuoteSwapResponse, Saver, SaversResponse, TxDetailsResponse, TxOutItem, TxResponse } from '@xchainjs/xchain-thornode';
+import { InboundAddress, LastBlock, LiquidityProviderSummary, MimirResponse, Pool, QueueResponse, QuoteLoanCloseResponse, QuoteLoanOpenResponse, QuoteSaverDepositResponse, QuoteSaverWithdrawResponse, QuoteSwapResponse, Saver, SaversResponse, TxDetailsResponse, TxOutItem, TxResponse } from '@xchainjs/xchain-thornode';
 import { SaversWithdraw } from '../types';
 export type ThornodeConfig = {
     apiRetries: number;
@@ -141,4 +141,30 @@ export declare class Thornode {
      * @returns quotes swap object response
      */
     getSwapQuote(fromAsset: string, toAsset: string, amount: number, destinationAddress?: string, fromAddress?: string, toleranceBps?: number, affiliateBps?: number, affiliate?: string, height?: number): Promise<QuoteSwapResponse>;
+    /**
+     *
+     * @param height
+     * @param asset
+     * @param amount
+     * @param targetAsset
+     * @param destination
+     * @param minOut
+     * @param affiliateBps
+     * @param affiliate
+     * @returns
+     */
+    getLoanQuoteOpen(asset: string, amount: number, targetAsset: string, destination: string, minOut?: string, affiliateBps?: number, affiliate?: string, height?: number): Promise<QuoteLoanOpenResponse>;
+    /**
+     *
+     * @param height
+     * @param asset
+     * @param amount
+     * @param targetAsset
+     * @param destination
+     * @param minOut
+     * @param affiliateBps
+     * @param affiliate
+     * @returns
+     */
+    getLoanQuoteClose(asset: string, amount: number, fromAddress: string, loanAsset: string, loanOwner: string, minOut?: string, height?: number): Promise<QuoteLoanCloseResponse>;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xchainjs/xchain-thorchain-query",
-  "version": "0.4.2",
+  "version": "0.4.3",
   "license": "MIT",
   "description": "Thorchain query module that is resposible for estimating swap calculations and add/remove liquidity for thorchain ",
   "keywords": [
@@ -35,7 +35,7 @@
   "devDependencies": {
     "@xchainjs/xchain-client": "^0.14.1",
     "@xchainjs/xchain-midgard": "^0.5.0",
-    "@xchainjs/xchain-thornode": "^0.3.1",
+    "@xchainjs/xchain-thornode": "^0.3.2",
     "@xchainjs/xchain-util": "^0.13.0",
     "axios": "^1.3.6",
     "axios-retry": "^3.2.5",
@@ -44,7 +44,7 @@
   "peerDependencies": {
     "@xchainjs/xchain-client": "^0.14.1",
     "@xchainjs/xchain-midgard": "^0.5.0",
-    "@xchainjs/xchain-thornode": "^0.3.1",
+    "@xchainjs/xchain-thornode": "^0.3.2",
     "@xchainjs/xchain-util": "^0.13.0",
     "axios": "^1.3.6",
     "axios-retry": "^3.2.5",
@@ -53,4 +53,4 @@
   "publishConfig": {
     "access": "public"
   }
-}
+}