@xchainjs/xchain-thorchain-query 3.0.4 → 3.1.0

package/README.md

@@ -138,15 +138,4 @@ If you plan on using the publicly accessible endpoints listed below, ensure that
 - https://api.haskoin.com (BTC/BCH/LTC)
 - https://gateway.liquify.com/chain/thorchain_api
 
-## Example
-
-```typescript
-import cosmosclient from '@cosmos-client/core'
-import axios from 'axios'
-import { register9Rheader } from '@xchainjs/xchain-util'
-
-register9Rheader(axios)
-register9Rheader(cosmosclient.config.globalAxios)
-```
-
 For a complete example please see this [test](https://github.com/xchainjs/xchainjs-lib/blob/master/packages/xchain-thorchain-amm/__e2e__/wallet.e2e.ts)

package/lib/index.esm.js

@@ -757,11 +757,17 @@ class Thornode {
      * @param height - block height
      * @returns quotes swap object response
      */
-    getSwapQuote(fromAsset, toAsset, amount, destinationAddress, streamingInterval, streamingQuantity, toleranceBps, liquidityToleranceBps, affiliateBps, affiliate, height, refundAddress) {
+    getSwapQuote(fromAsset, toAsset, amount, destinationAddress, streamingInterval, streamingQuantity, toleranceBps, liquidityToleranceBps, 
+    // `string` is accepted to carry the slash-delimited per-affiliate form (e.g. "10/20/30")
+    // used when multiple affiliates are passed. Single-affiliate callers pass a number as before.
+    affiliateBps, affiliate, height, refundAddress) {
         return __awaiter(this, void 0, void 0, function* () {
             for (const api of this.quoteApi) {
                 try {
-                    const resp = (yield api.quoteswap(height, fromAsset, toAsset, amount, destinationAddress, refundAddress, streamingInterval, streamingQuantity, toleranceBps, liquidityToleranceBps, affiliateBps, affiliate)).data;
+                    const resp = (yield api.quoteswap(height, fromAsset, toAsset, amount, destinationAddress, refundAddress, streamingInterval, streamingQuantity, toleranceBps, liquidityToleranceBps, 
+                    // Generated client types this as `number`; axios serializes either number or string
+                    // identically into the query string, so the runtime accepts both.
+                    affiliateBps, affiliate)).data;
                     return resp;
                 }
                 catch (e) {
@@ -1190,7 +1196,7 @@ class ThorchainQuery {
      * @returns Transaction details including memo, address, fees, etc.
      */
     quoteSwap(_a) {
-        return __awaiter(this, arguments, void 0, function* ({ fromAsset, destinationAsset, amount, destinationAddress, streamingInterval, streamingQuantity, liquidityToleranceBps, toleranceBps, affiliateBps, affiliateAddress, height, }) {
+        return __awaiter(this, arguments, void 0, function* ({ fromAsset, destinationAsset, amount, destinationAddress, streamingInterval, streamingQuantity, liquidityToleranceBps, toleranceBps, affiliateBps, affiliateAddress, affiliates, height, }) {
             // Validates swap and pushes error if there is one
             const errors = [];
             const error = yield this.validateAmount(amount);
@@ -1199,8 +1205,14 @@ class ThorchainQuery {
             const fromAssetString = assetToString(fromAsset);
             const toAssetString = assetToString(destinationAsset);
             const inputAmount = getBaseAmountWithDiffDecimals(amount, 8);
+            // If the caller passed a multi-affiliate array, collapse it into the slash-delimited
+            // form the protocol's /quote/swap endpoint accepts. The endpoint requires per-affiliate bps
+            // (it does not auto-expand a single shared bps), so both fields are joined in parallel.
+            const hasAffiliates = Boolean(affiliates === null || affiliates === void 0 ? void 0 : affiliates.length);
+            const quoteAffiliateAddress = hasAffiliates ? affiliates.map((a) => a.address).join('/') : affiliateAddress;
+            const quoteAffiliateBps = hasAffiliates ? affiliates.map((a) => a.bps).join('/') : affiliateBps;
             // Fetch quote
-            const swapQuote = yield this.thorchainCache.thornode.getSwapQuote(fromAssetString, toAssetString, inputAmount.toNumber(), destinationAddress, streamingInterval, streamingQuantity, toleranceBps, liquidityToleranceBps, affiliateBps, affiliateAddress, height);
+            const swapQuote = yield this.thorchainCache.thornode.getSwapQuote(fromAssetString, toAssetString, inputAmount.toNumber(), destinationAddress, streamingInterval, streamingQuantity, toleranceBps, liquidityToleranceBps, quoteAffiliateBps, quoteAffiliateAddress, height);
             let response;
             // Check if swapQuote is a string, which we assume indicates an error message
             if (typeof swapQuote === 'string') {

package/lib/index.js

@@ -765,11 +765,17 @@ class Thornode {
      * @param height - block height
      * @returns quotes swap object response
      */
-    getSwapQuote(fromAsset, toAsset, amount, destinationAddress, streamingInterval, streamingQuantity, toleranceBps, liquidityToleranceBps, affiliateBps, affiliate, height, refundAddress) {
+    getSwapQuote(fromAsset, toAsset, amount, destinationAddress, streamingInterval, streamingQuantity, toleranceBps, liquidityToleranceBps, 
+    // `string` is accepted to carry the slash-delimited per-affiliate form (e.g. "10/20/30")
+    // used when multiple affiliates are passed. Single-affiliate callers pass a number as before.
+    affiliateBps, affiliate, height, refundAddress) {
         return __awaiter(this, void 0, void 0, function* () {
             for (const api of this.quoteApi) {
                 try {
-                    const resp = (yield api.quoteswap(height, fromAsset, toAsset, amount, destinationAddress, refundAddress, streamingInterval, streamingQuantity, toleranceBps, liquidityToleranceBps, affiliateBps, affiliate)).data;
+                    const resp = (yield api.quoteswap(height, fromAsset, toAsset, amount, destinationAddress, refundAddress, streamingInterval, streamingQuantity, toleranceBps, liquidityToleranceBps, 
+                    // Generated client types this as `number`; axios serializes either number or string
+                    // identically into the query string, so the runtime accepts both.
+                    affiliateBps, affiliate)).data;
                     return resp;
                 }
                 catch (e) {
@@ -1198,7 +1204,7 @@ class ThorchainQuery {
      * @returns Transaction details including memo, address, fees, etc.
      */
     quoteSwap(_a) {
-        return __awaiter(this, arguments, void 0, function* ({ fromAsset, destinationAsset, amount, destinationAddress, streamingInterval, streamingQuantity, liquidityToleranceBps, toleranceBps, affiliateBps, affiliateAddress, height, }) {
+        return __awaiter(this, arguments, void 0, function* ({ fromAsset, destinationAsset, amount, destinationAddress, streamingInterval, streamingQuantity, liquidityToleranceBps, toleranceBps, affiliateBps, affiliateAddress, affiliates, height, }) {
             // Validates swap and pushes error if there is one
             const errors = [];
             const error = yield this.validateAmount(amount);
@@ -1207,8 +1213,14 @@ class ThorchainQuery {
             const fromAssetString = xchainUtil.assetToString(fromAsset);
             const toAssetString = xchainUtil.assetToString(destinationAsset);
             const inputAmount = getBaseAmountWithDiffDecimals(amount, 8);
+            // If the caller passed a multi-affiliate array, collapse it into the slash-delimited
+            // form the protocol's /quote/swap endpoint accepts. The endpoint requires per-affiliate bps
+            // (it does not auto-expand a single shared bps), so both fields are joined in parallel.
+            const hasAffiliates = Boolean(affiliates === null || affiliates === void 0 ? void 0 : affiliates.length);
+            const quoteAffiliateAddress = hasAffiliates ? affiliates.map((a) => a.address).join('/') : affiliateAddress;
+            const quoteAffiliateBps = hasAffiliates ? affiliates.map((a) => a.bps).join('/') : affiliateBps;
             // Fetch quote
-            const swapQuote = yield this.thorchainCache.thornode.getSwapQuote(fromAssetString, toAssetString, inputAmount.toNumber(), destinationAddress, streamingInterval, streamingQuantity, toleranceBps, liquidityToleranceBps, affiliateBps, affiliateAddress, height);
+            const swapQuote = yield this.thorchainCache.thornode.getSwapQuote(fromAssetString, toAssetString, inputAmount.toNumber(), destinationAddress, streamingInterval, streamingQuantity, toleranceBps, liquidityToleranceBps, quoteAffiliateBps, quoteAffiliateAddress, height);
             let response;
             // Check if swapQuote is a string, which we assume indicates an error message
             if (typeof swapQuote === 'string') {

package/lib/thorchain-query.d.ts

@@ -22,7 +22,7 @@ export declare class ThorchainQuery {
      * @param quoteSwapParams - Input parameters for the swap quote.
      * @returns Transaction details including memo, address, fees, etc.
      */
-    quoteSwap({ fromAsset, destinationAsset, amount, destinationAddress, streamingInterval, streamingQuantity, liquidityToleranceBps, toleranceBps, affiliateBps, affiliateAddress, height, }: QuoteSwapParams): Promise<TxDetails>;
+    quoteSwap({ fromAsset, destinationAsset, amount, destinationAddress, streamingInterval, streamingQuantity, liquidityToleranceBps, toleranceBps, affiliateBps, affiliateAddress, affiliates, height, }: QuoteSwapParams): Promise<TxDetails>;
     /**
      * Validate a cryptoAmount is well formed
      * @param {CryptoAmount} cryptoAmount - CryptoAmount to validate

package/lib/types.d.ts

@@ -35,6 +35,13 @@ export type SwapEstimate = {
     errors: string[];
     warning: string;
 };
+/**
+ * A single affiliate entry. Used by the multi-affiliate `affiliates` field on QuoteSwapParams.
+ */
+export type Affiliate = {
+    address: string;
+    bps: number;
+};
 /**
  * Represents parameters for requesting a swap quote.
  */
@@ -50,6 +57,7 @@ export type QuoteSwapParams = {
     liquidityToleranceBps?: number;
     affiliateAddress?: string;
     affiliateBps?: number;
+    affiliates?: Affiliate[];
     height?: number;
     interfaceID?: string;
     feeOption?: FeeOption;

package/lib/utils/thornode.d.ts

@@ -129,7 +129,7 @@ export declare class Thornode {
      * @param height - block height
      * @returns quotes swap object response
      */
-    getSwapQuote(fromAsset: string, toAsset: string, amount: number, destinationAddress?: string, streamingInterval?: number, streamingQuantity?: number, toleranceBps?: number, liquidityToleranceBps?: number, affiliateBps?: number, affiliate?: string, height?: number, refundAddress?: string): Promise<QuoteSwapResponse>;
+    getSwapQuote(fromAsset: string, toAsset: string, amount: number, destinationAddress?: string, streamingInterval?: number, streamingQuantity?: number, toleranceBps?: number, liquidityToleranceBps?: number, affiliateBps?: number | string, affiliate?: string, height?: number, refundAddress?: string): Promise<QuoteSwapResponse>;
     getThornameDetails(thorname: string, height?: number): Promise<Thorname>;
     getTradeAssetUnits(asset: string, height?: number): Promise<TradeUnitResponse>;
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xchainjs/xchain-thorchain-query",
-  "version": "3.0.4",
+  "version": "3.1.0",
   "license": "MIT",
   "description": "Thorchain query module that is responsible for estimating swap calculations and add/remove liquidity for thorchain ",
   "keywords": [
@@ -33,11 +33,11 @@
     "postversion": "git push --follow-tags"
   },
   "dependencies": {
-    "@xchainjs/xchain-client": "2.0.13",
-    "@xchainjs/xchain-midgard-query": "2.0.16",
-    "@xchainjs/xchain-thornode": "1.2.0",
+    "@xchainjs/xchain-client": "2.0.14",
+    "@xchainjs/xchain-midgard-query": "2.0.17",
+    "@xchainjs/xchain-thornode": "1.2.1",
     "@xchainjs/xchain-util": "2.0.7",
-    "axios": "1.15.2",
+    "axios": "1.16.1",
     "axios-retry": "3.2.5",
     "bignumber.js": "^11.0.0"
   },