@xchainjs/xchain-thorchain-query 0.1.0-beta → 0.1.0-beta2

package/lib/thorchain-cache.d.ts

@@ -105,8 +105,20 @@ export declare class ThorchainCache {
     convert(input: CryptoAmount, outAsset: Asset): Promise<CryptoAmount>;
     private getDecimalForAsset;
     getRouterAddressForChain(chain: Chain): Promise<Address>;
+    /**
+     *
+     * @returns - inbound adresses item
+     */
     getInboundAddressesItems(): Promise<Record<string, InboundAddressesItem>>;
+    /**
+     *
+     * @returns - inbound details
+     */
     getInboundDetails(): Promise<Record<string, InboundDetail>>;
+    /**
+     *
+     * @returns - network values
+     */
     getNetworkValues(): Promise<Record<string, number>>;
     getDeepestUSDPool(): Promise<LiquidityPool>;
 }

package/lib/thorchain-query.d.ts

@@ -1,7 +1,7 @@
 import { Asset, Chain } from '@xchainjs/xchain-util';
 import { CryptoAmount } from './crypto-amount';
 import { ThorchainCache } from './thorchain-cache';
-import { ChainAttributes, EstimateSwapParams, TotalFees, TxDetails, TxStatus } from './types';
+import { AddliquidityPosition, ChainAttributes, EstimateAddLP, EstimateSwapParams, EstimateWithdrawLP, LiquidityPosition, PoolRatios, RemoveLiquidityPosition, TotalFees, TxDetails, TxStatus } from './types';
 /**
  * THORChain Class for interacting with THORChain.
  * Recommended main class to use for swapping with THORChain
@@ -101,7 +101,7 @@ export declare class ThorchainQuery {
      * @returns time in seconds before a Tx is confirmed by THORChain
      * @see https://docs.thorchain.org/chain-clients/overview
      */
-    private confCounting;
+    confCounting(inbound: CryptoAmount): Promise<number>;
     /**
      * Works out how long an outbound Tx will be held by THORChain before sending.
      *
@@ -135,4 +135,33 @@ export declare class ThorchainQuery {
     private checkOutboundQueue;
     /** Stage 4 */
     private checkOutboundTx;
+    /**
+     * Estimates a liquidity position for given crypto amount value, both asymmetrical and symetrical
+     * @param params - parameters needed for a estimated liquidity position
+     * @returns - type object EstimateLP
+     */
+    estimateAddLP(params: AddliquidityPosition): Promise<EstimateAddLP>;
+    /**
+     * @param - Asset for lp
+     * @param address - address used for Lp
+     * @returns - Type Object liquidityPosition
+     */
+    checkLiquidityPosition(asset: Asset, assetOrRuneAddress: string): Promise<LiquidityPosition>;
+    /**
+     * Do not send assetNativeRune, There is no pool for it.
+     * @param asset - asset required to find the pool
+     * @returns - object type ratios
+     */
+    getPoolRatios(asset: Asset): Promise<PoolRatios>;
+    /**
+     *
+     * @param params
+     */
+    estimateWithdrawLP(params: RemoveLiquidityPosition): Promise<EstimateWithdrawLP>;
+    /**
+     * // can this become a quried constant? added to inbound_addresses or something
+     * @param asset - asset needed to retrieve dust values
+     * @returns - object type dust values
+     */
+    private getDustValues;
 }

package/lib/types.d.ts

@@ -1,5 +1,6 @@
 import { FeeOption } from '@xchainjs/xchain-client';
 import { InboundAddressesItem } from '@xchainjs/xchain-midgard';
+import { LiquidityProvider } from '@xchainjs/xchain-thornode';
 import { Address, Asset, BaseAmount } from '@xchainjs/xchain-util';
 import { BigNumber } from 'bignumber.js';
 import { CryptoAmount } from './crypto-amount';
@@ -53,20 +54,21 @@ export declare type SwapOutput = {
     slip: BigNumber;
 };
 export declare type UnitData = {
-    liquidityUnits: BigNumber;
-    totalUnits: BigNumber;
+    liquidityUnits: BaseAmount;
+    totalUnits: BaseAmount;
 };
 export declare type LiquidityData = {
-    rune: BigNumber;
-    asset: BigNumber;
+    rune: CryptoAmount;
+    asset: CryptoAmount;
 };
 export declare type Block = {
     current: number;
-    lastAdded: number;
+    lastAdded?: number;
     fullProtection: number;
 };
-export declare type Coverage = {
-    poolRatio: BaseAmount;
+export declare type ILProtectionData = {
+    ILProtection: CryptoAmount;
+    totalDays: string;
 };
 export declare type InboundDetail = {
     vault: string;
@@ -108,3 +110,61 @@ export declare type TxStatus = {
     stage: TxStage;
     seconds: number;
 };
+export declare type LiquidityToAdd = {
+    asset: BaseAmount;
+    rune: BaseAmount;
+};
+export declare type PostionDepositValue = {
+    asset: BaseAmount;
+    rune: BaseAmount;
+};
+export declare type PoolShareDetail = {
+    assetShare: CryptoAmount;
+    runeShare: CryptoAmount;
+};
+export declare type EstimateAddLP = {
+    slipPercent: BigNumber;
+    poolShare: PoolShareDetail;
+    lpUnits: BaseAmount;
+    transactionFee: LPFees;
+    runeToAssetRatio: BigNumber;
+    estimatedWaitSeconds: number;
+    errors: string[];
+    canAdd: boolean;
+};
+export declare type EstimateWithdrawLP = {
+    slipPercent: BigNumber;
+    transactionFee: LPFees;
+    assetAmount: CryptoAmount;
+    runeAmount: CryptoAmount;
+    impermanentLossProtection: ILProtectionData;
+    estimatedWaitSeconds: number;
+};
+export declare type LPFees = {
+    runeFee: CryptoAmount;
+    assetFee: CryptoAmount;
+    totalFees: CryptoAmount;
+};
+export declare type DustValues = {
+    asset: CryptoAmount;
+    rune: CryptoAmount;
+};
+export declare type AddliquidityPosition = {
+    asset: CryptoAmount;
+    rune: CryptoAmount;
+};
+export declare type RemoveLiquidityPosition = {
+    asset: Asset;
+    percentage: number;
+    assetAddress?: string;
+    runeAddress?: string;
+};
+export declare type LiquidityPosition = {
+    poolShare: PoolShareDetail;
+    position: LiquidityProvider;
+    impermanentLossProtection: ILProtectionData;
+};
+export declare type PoolRatios = {
+    assetToRune: BigNumber;
+    runeToAsset: BigNumber;
+};

package/lib/utils/liquidity.d.ts

@@ -1,32 +1,39 @@
 import { BigNumber } from 'bignumber.js';
 import { LiquidityPool } from '../liquidity-pool';
-import { Block, LiquidityData, UnitData } from '../types';
+import { Block, ILProtectionData, LiquidityToAdd, PoolShareDetail, PostionDepositValue, UnitData } from '../types';
 /**
- *
+ * https://dev.thorchain.org/thorchain-dev/interface-guide/math#lp-units-add
  * @param liquidity - asset amount added
  * @param pool  - pool depths
- * @returns liquidity units
+ * @returns liquidity units - ownership of pool
  */
-export declare const getLiquidityUnits: (liquidity: LiquidityData, pool: LiquidityPool) => BigNumber;
+export declare const getLiquidityUnits: (liquidity: LiquidityToAdd, pool: LiquidityPool) => BigNumber;
 /**
  *
- * @param unitData
- * @param pool
- * @returns
+ * @param unitData - units for both asset and rune
+ * @param pool - pool that the asset is bound to
+ * @returns - pool share of both asset and rune in percentage
  */
-export declare const getPoolShare: (unitData: UnitData, pool: LiquidityPool) => LiquidityData;
+export declare const getPoolShare: (unitData: UnitData, pool: LiquidityPool) => PoolShareDetail;
 /**
  *
- * @param liquidity
- * @param pool
- * @returns
+ * @param poolShare - the share of asset and rune added to the pool
+ * @param pool - Pool that the asset is attached to
+ * @returns - returns bignumber representing a slip percentage
  */
-export declare const getSlipOnLiquidity: (liquidity: LiquidityData, pool: LiquidityPool) => BigNumber;
+export declare const getSlipOnLiquidity: (stake: LiquidityToAdd, pool: LiquidityPool) => BigNumber;
 /**
- *
- * @param liquidity
- * @param pool
- * @param block
+ * https://docs.thorchain.org/thorchain-finance/continuous-liquidity-pools#impermanent-loss-protection
+ * @param poolShare - the share of asset and rune added to the pool
+ * @param pool - Pool that the asset is attached to
+ * @param block - blockl object with current, last added and the constant blocksforlossProtection
  * @returns
  */
-export declare const getLiquidityProtectionData: (liquidity: LiquidityData, pool: LiquidityPool, block: Block) => number;
+export declare const getLiquidityProtectionData: (depositValue: PostionDepositValue, poolShare: PoolShareDetail, block: Block) => ILProtectionData;
+/**
+ * https://docs.thorchain.org/thorchain-finance/continuous-liquidity-pools#calculating-pool-ownership
+ * @param liquidity - asset amount added
+ * @param pool  - pool depths
+ * @returns liquidity units - % ownership of pool
+ */
+export declare const getPoolOwnership: (liquidity: LiquidityToAdd, pool: LiquidityPool) => number;

package/lib/utils/midgard.d.ts

@@ -1,5 +1,5 @@
 import { Network } from '@xchainjs/xchain-client';
-import { Action, InboundAddressesItem, PoolDetail } from '@xchainjs/xchain-midgard';
+import { Action, InboundAddressesItem, MemberDetails, PoolDetail, PoolStatsDetail } from '@xchainjs/xchain-midgard';
 import { CryptoAmount } from '../crypto-amount';
 import { InboundDetail, MidgardConfig } from '../types';
 export declare class Midgard {
@@ -19,6 +19,10 @@ export declare class Midgard {
      * @returns inbound details
      */
     getInboundDetails(): Promise<Record<string, InboundDetail>>;
+    /**
+     *
+     * @returns - constants
+     */
     private getConstantsDetails;
     /**
      *
@@ -39,9 +43,21 @@ export declare class Midgard {
      */
     getLatestBlockHeight(): Promise<number>;
     /**
-     * Gets actions related to a txID
+     * Gets actions object for any of the parameters
      * @param txHash transaction id
      * @returns Type Action array of objects
      */
-    getActions(txHash: string): Promise<Action[]>;
+    getActions(address?: string, txid?: string, asset?: string, type?: string, affiliate?: string, limit?: number, offset?: number): Promise<Action[]>;
+    /**
+     * Function to return member details based on valid liquidity position
+     * @param address - needed to query for Lp details
+     * @returns - object type of Member Detail
+     */
+    getMember(address: string): Promise<MemberDetails>;
+    /**
+     * Function to return pool statistics for a particular asset
+     * @param asset - asset string to query its pool stats
+     * @returns - type object poolstatsDetail
+     */
+    getPoolStats(asset: string): Promise<PoolStatsDetail>;
 }

package/lib/utils/thornode.d.ts

@@ -1,5 +1,5 @@
 import { Network } from '@xchainjs/xchain-client';
-import { LastBlock, Pool, TxOutItem, TxResponse } from '@xchainjs/xchain-thornode';
+import { LastBlock, LiquidityProvider, Pool, TxOutItem, TxResponse } from '@xchainjs/xchain-thornode';
 export declare type ThornodeConfig = {
     apiRetries: number;
     thornodeBaseUrls: string[];
@@ -11,6 +11,7 @@ export declare class Thornode {
     private queueApi;
     private networkApi;
     private poolsApi;
+    private liquidityProvidersApi;
     constructor(network?: Network, config?: ThornodeConfig);
     /**
      * Returns the oubound transactions held by THORChain due to outbound delay
@@ -20,7 +21,29 @@ export declare class Thornode {
      *
      */
     getscheduledQueue(): Promise<TxOutItem[]>;
+    /**
+     *
+     * @param txHash - transaction hash
+     * @returns - transaction object
+     */
     getTxData(txHash: string): Promise<TxResponse>;
+    /**
+     *
+     * @param height - optional thorchain height only
+     * @returns - last block data || or block data pertaining to that height number
+     */
     getLastBlock(height?: number): Promise<LastBlock[]>;
+    /**
+     *
+     * @returns - thorchain pool
+     */
     getPools(): Promise<Pool[]>;
+    /**
+     *
+     * @param asset - asset string
+     * @param address - address
+     * @param height - optional block height, defaults to current tip
+     * @returns
+     */
+    getLiquidityProvider(asset: string, address: string, height?: number): Promise<LiquidityProvider | undefined>;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xchainjs/xchain-thorchain-query",
-  "version": "0.1.0-beta",
+  "version": "0.1.0-beta2",
   "license": "MIT",
   "description": "Thorchain query module that is resposible for estimating swap calculations and add/remove liquidity for thorchain ",
   "keywords": [
@@ -33,20 +33,20 @@
     "postversion": "git push --follow-tags"
   },
   "devDependencies": {
-    "@xchainjs/xchain-client": "^0.13.0",
+    "@xchainjs/xchain-client": "^0.13.1",
     "@xchainjs/xchain-midgard": "^0.1.0-alpha2",
     "@xchainjs/xchain-thornode": "^0.1.0-alpha4",
-    "@xchainjs/xchain-util": "^0.9.0",
+    "@xchainjs/xchain-util": "^0.10.0",
     "axios": "^0.25.0",
     "axios-retry": "^3.2.5",
     "bignumber.js": "^9.0.0",
     "rimraf": "~3.0.2"
   },
   "peerDependencies": {
-    "@xchainjs/xchain-client": "^0.13.0",
+    "@xchainjs/xchain-client": "^0.13.1",
     "@xchainjs/xchain-midgard": "^0.1.0-alpha2",
     "@xchainjs/xchain-thornode": "^0.1.0-alpha4",
-    "@xchainjs/xchain-util": "^0.9.0",
+    "@xchainjs/xchain-util": "^0.10.0",
     "axios": "^0.25.0",
     "axios-retry": "^3.2.5",
     "bignumber.js": "^9.0.0",