@xchainjs/xchain-thorchain-query 0.1.0-alpha → 0.1.0-alpha1

package/README.md

@@ -1,8 +1,6 @@
 # `@xchainjs/xchain-thorchain-query`
 
-Thorchain-query module to query thorchain for
-
-## Modules
+Thorchain-query module to query thorchain for estimation of swaps. Returns a TxDetail object with all the information needed to conduct a swap.
 
 ## Installation
 
@@ -10,10 +8,46 @@ Thorchain-query module to query thorchain for
 yarn add @xchainjs/xchain-thorchain-query
 ```
 
+Following peer dependencies have to be installed into your project. These are not included in `@xchainjs/xchain-thorchain-query`.
+
+```
+yarn add @xchainjs/xchain-client @xchainjs/xchain-util @xchainjs/xchain-midgard @xchainjs/xchain-thornode axios
+
+```
+
 ## Examples
 
+Estimation example from a swap of 2 BTC to RUNE
+
+```ts
+{
+  memo: '=:THOR.RUNE::2071168559999',
+  expiry: 2022-09-07T02:16:45.732Z,
+  toAddress: '',
+  txEstimate: {
+    input: '₿ 2',
+    totalFees: {
+      inboundFee: 'ᚱ 0.02',
+      swapFee: 'ᚱ 52.85380999',
+      outboundFee: 'ᚱ 0.06',
+      affiliateFee: 'ᚱ 0'
+    },
+    slipPercentage: '0.00246920801878638026',
+    netOutput: 'ᚱ 21,352.25318742',
+    waitTimeSeconds: '1248',
+    canSwap: true,
+    errors: []
+  }
+}
 ```
 
 ## Documentation
 
+For bash exmples, see example folder at the base of this repository xchainjs/xchainjs-lib.
+
+```
+### [`xchain-thorchain-query`](http://docs.xchainjs.org/xchain-thorchain-query/)
+
+[`How xchain-thorchain-query works`](http://docs.xchainjs.org/xchain-thorchain-query/how-it-works.html)\
+[`How to use xchain-thorchain-query`](http://docs.xchainjs.org/xchain-thorchain-query/how-to-use.html)
 ```

package/lib/index.esm.js

@@ -431,23 +431,47 @@ class ThorchainQuery {
   
      * @returns The SwapEstimate
      */
-    estimateSwap(params, destinationAddress = '', affiliateAddress = '', interfaceID = 999) {
+    estimateSwap({ input, destinationAsset, destinationAddress, affiliateAddress = '', interfaceID = 999, affiliateFeePercent = 0, slipLimit, }) {
         return __awaiter(this, void 0, void 0, function* () {
-            this.isValidSwap(params);
+            this.isValidSwap({
+                input,
+                destinationAsset,
+                destinationAddress,
+                affiliateAddress,
+                interfaceID,
+                affiliateFeePercent,
+                slipLimit,
+            });
             const inboundDetails = yield this.thorchainCache.getInboundDetails();
-            const sourceInboundDetails = inboundDetails[params.input.asset.chain];
+            const sourceInboundDetails = inboundDetails[input.asset.chain];
             // console.log(JSON.stringify(sourceInboundDetails, null, 2))
-            const destinationInboundDetails = inboundDetails[params.destinationAsset.chain];
+            const destinationInboundDetails = inboundDetails[destinationAsset.chain];
             // console.log(JSON.stringify(destinationInboundDetails, null, 2))
-            const swapEstimate = yield this.calcSwapEstimate(params, sourceInboundDetails, destinationInboundDetails);
+            const swapEstimate = yield this.calcSwapEstimate({
+                input,
+                destinationAsset,
+                destinationAddress,
+                affiliateAddress,
+                interfaceID,
+                affiliateFeePercent,
+                slipLimit,
+            }, sourceInboundDetails, destinationInboundDetails);
             // Remove any affiliateFee. netInput * affiliateFee (%age) of the destination asset type
-            const affiliateFee = params.input.baseAmount.times(params.affiliateFeePercent || 0);
+            const affiliateFee = input.baseAmount.times(affiliateFeePercent || 0);
             // Calculate expiry time
             const currentDatetime = new Date();
             const minutesToAdd = 15;
             const expiryDatetime = new Date(currentDatetime.getTime() + minutesToAdd * 60000);
             // Check for errors
-            const errors = yield this.getSwapEstimateErrors(params, swapEstimate, sourceInboundDetails, destinationInboundDetails);
+            const errors = yield this.getSwapEstimateErrors({
+                input,
+                destinationAsset,
+                destinationAddress,
+                affiliateAddress,
+                interfaceID,
+                affiliateFeePercent,
+                slipLimit,
+            }, swapEstimate, sourceInboundDetails, destinationInboundDetails);
             const txDetails = {
                 memo: '',
                 toAddress: '',
@@ -461,26 +485,26 @@ class ThorchainQuery {
             else {
                 txDetails.txEstimate.canSwap = true;
                 // Retrieve inbound Asgard address.
-                const inboundAsgard = (yield this.thorchainCache.getInboundAddressesItems())[params.input.asset.chain];
+                const inboundAsgard = (yield this.thorchainCache.getInboundAddressesItems())[input.asset.chain];
                 txDetails.toAddress = (inboundAsgard === null || inboundAsgard === void 0 ? void 0 : inboundAsgard.address) || '';
                 // Work out LIM from the slip percentage
                 let limPercentage = BN_1;
-                if (params.slipLimit) {
-                    limPercentage = BN_1.minus(params.slipLimit || 1);
+                if (slipLimit) {
+                    limPercentage = BN_1.minus(slipLimit || 1);
                 } // else allowed slip is 100%
                 const limAssetAmount = swapEstimate.netOutput.times(limPercentage);
-                const inboundDelay = yield this.confCounting(params.input);
+                const inboundDelay = yield this.confCounting(input);
                 const outboundDelay = yield this.outboundDelay(limAssetAmount);
                 txDetails.txEstimate.waitTimeSeconds = outboundDelay + inboundDelay;
                 // Construct memo
                 txDetails.memo = this.constructSwapMemo({
-                    input: params.input,
-                    destinationAsset: params.destinationAsset,
+                    input: input,
+                    destinationAsset: destinationAsset,
                     limit: limAssetAmount.baseAmount,
-                    destinationAddress,
-                    affiliateAddress,
+                    destinationAddress: destinationAddress,
+                    affiliateAddress: affiliateAddress,
                     affiliateFee,
-                    interfaceID,
+                    interfaceID: interfaceID,
                 });
             }
             return txDetails;

package/lib/index.js

@@ -440,23 +440,47 @@ class ThorchainQuery {
   
      * @returns The SwapEstimate
      */
-    estimateSwap(params, destinationAddress = '', affiliateAddress = '', interfaceID = 999) {
+    estimateSwap({ input, destinationAsset, destinationAddress, affiliateAddress = '', interfaceID = 999, affiliateFeePercent = 0, slipLimit, }) {
         return __awaiter(this, void 0, void 0, function* () {
-            this.isValidSwap(params);
+            this.isValidSwap({
+                input,
+                destinationAsset,
+                destinationAddress,
+                affiliateAddress,
+                interfaceID,
+                affiliateFeePercent,
+                slipLimit,
+            });
             const inboundDetails = yield this.thorchainCache.getInboundDetails();
-            const sourceInboundDetails = inboundDetails[params.input.asset.chain];
+            const sourceInboundDetails = inboundDetails[input.asset.chain];
             // console.log(JSON.stringify(sourceInboundDetails, null, 2))
-            const destinationInboundDetails = inboundDetails[params.destinationAsset.chain];
+            const destinationInboundDetails = inboundDetails[destinationAsset.chain];
             // console.log(JSON.stringify(destinationInboundDetails, null, 2))
-            const swapEstimate = yield this.calcSwapEstimate(params, sourceInboundDetails, destinationInboundDetails);
+            const swapEstimate = yield this.calcSwapEstimate({
+                input,
+                destinationAsset,
+                destinationAddress,
+                affiliateAddress,
+                interfaceID,
+                affiliateFeePercent,
+                slipLimit,
+            }, sourceInboundDetails, destinationInboundDetails);
             // Remove any affiliateFee. netInput * affiliateFee (%age) of the destination asset type
-            const affiliateFee = params.input.baseAmount.times(params.affiliateFeePercent || 0);
+            const affiliateFee = input.baseAmount.times(affiliateFeePercent || 0);
             // Calculate expiry time
             const currentDatetime = new Date();
             const minutesToAdd = 15;
             const expiryDatetime = new Date(currentDatetime.getTime() + minutesToAdd * 60000);
             // Check for errors
-            const errors = yield this.getSwapEstimateErrors(params, swapEstimate, sourceInboundDetails, destinationInboundDetails);
+            const errors = yield this.getSwapEstimateErrors({
+                input,
+                destinationAsset,
+                destinationAddress,
+                affiliateAddress,
+                interfaceID,
+                affiliateFeePercent,
+                slipLimit,
+            }, swapEstimate, sourceInboundDetails, destinationInboundDetails);
             const txDetails = {
                 memo: '',
                 toAddress: '',
@@ -470,26 +494,26 @@ class ThorchainQuery {
             else {
                 txDetails.txEstimate.canSwap = true;
                 // Retrieve inbound Asgard address.
-                const inboundAsgard = (yield this.thorchainCache.getInboundAddressesItems())[params.input.asset.chain];
+                const inboundAsgard = (yield this.thorchainCache.getInboundAddressesItems())[input.asset.chain];
                 txDetails.toAddress = (inboundAsgard === null || inboundAsgard === void 0 ? void 0 : inboundAsgard.address) || '';
                 // Work out LIM from the slip percentage
                 let limPercentage = BN_1;
-                if (params.slipLimit) {
-                    limPercentage = BN_1.minus(params.slipLimit || 1);
+                if (slipLimit) {
+                    limPercentage = BN_1.minus(slipLimit || 1);
                 } // else allowed slip is 100%
                 const limAssetAmount = swapEstimate.netOutput.times(limPercentage);
-                const inboundDelay = yield this.confCounting(params.input);
+                const inboundDelay = yield this.confCounting(input);
                 const outboundDelay = yield this.outboundDelay(limAssetAmount);
                 txDetails.txEstimate.waitTimeSeconds = outboundDelay + inboundDelay;
                 // Construct memo
                 txDetails.memo = this.constructSwapMemo({
-                    input: params.input,
-                    destinationAsset: params.destinationAsset,
+                    input: input,
+                    destinationAsset: destinationAsset,
                     limit: limAssetAmount.baseAmount,
-                    destinationAddress,
-                    affiliateAddress,
+                    destinationAddress: destinationAddress,
+                    affiliateAddress: affiliateAddress,
                     affiliateFee,
-                    interfaceID,
+                    interfaceID: interfaceID,
                 });
             }
             return txDetails;

package/lib/thorchain-query.d.ts

@@ -26,7 +26,7 @@ export declare class ThorchainQuery {
   
      * @returns The SwapEstimate
      */
-    estimateSwap(params: EstimateSwapParams, destinationAddress?: string, affiliateAddress?: string, interfaceID?: number): Promise<TxDetails>;
+    estimateSwap({ input, destinationAsset, destinationAddress, affiliateAddress, interfaceID, affiliateFeePercent, slipLimit, }: EstimateSwapParams): Promise<TxDetails>;
     /**
      * Basic Checks for swap information
      * @param params

package/lib/types.d.ts

@@ -41,6 +41,9 @@ export declare type MidgardConfig = {
 export declare type EstimateSwapParams = {
     input: CryptoAmount;
     destinationAsset: Asset;
+    destinationAddress: Address;
+    affiliateAddress?: Address;
+    interfaceID?: number;
     affiliateFeePercent?: number;
     slipLimit?: BigNumber;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xchainjs/xchain-thorchain-query",
-  "version": "0.1.0-alpha",
+  "version": "0.1.0-alpha1",
   "license": "MIT",
   "description": "Thorchain query module that is resposible for estimating swap calculations and add/remove liquidity for thorchain ",
   "keywords": [