@xchainjs/xchain-aggregator 2.0.28 → 2.0.30

package/lib/index.esm.js

@@ -1,12 +1,12 @@
 import { Network } from '@xchainjs/xchain-client';
 import { CachedValue, isSynthAsset, isTradeAsset, CryptoAmount, baseAmount, isSecuredAsset, assetToString, eqAsset, assetFromStringEx, assetFromString, isTokenAsset } from '@xchainjs/xchain-util';
 import { SwapSDK } from '@chainflip/sdk/swap';
+import { assetUSDC, ThorchainCache, Thornode, ThorchainQuery } from '@xchainjs/xchain-thorchain-query';
 import { AssetCacao, MAYAChain } from '@xchainjs/xchain-mayachain';
 import { MayachainAMM } from '@xchainjs/xchain-mayachain-amm';
 import { MayachainCache, Mayanode, MayachainQuery } from '@xchainjs/xchain-mayachain-query';
 import { AssetRuneNative as AssetRuneNative$1, THORChain } from '@xchainjs/xchain-thorchain';
 import { ThorchainAMM } from '@xchainjs/xchain-thorchain-amm';
-import { ThorchainCache, Thornode, ThorchainQuery } from '@xchainjs/xchain-thorchain-query';
 
 /******************************************************************************
 Copyright (c) Microsoft Corporation.
@@ -141,11 +141,25 @@ class ChainflipProtocol {
                     amount: params.amount.baseAmount.amount().toString(),
                     affiliateBrokers: this.affiliateBrokers,
                 });
-                // Find either DCA or REGULAR quote, prioritizing DCA
-                const selectedQuote = quotes.find((quote) => quote.type === 'DCA') || quotes.find((quote) => quote.type === 'REGULAR');
+                // Find quote based on user preference for boost
+                let selectedQuote;
+                if (params.enableBoost) {
+                    // User wants boost - prioritize DCA with boost > REGULAR with boost > DCA > REGULAR
+                    selectedQuote =
+                        quotes.find((quote) => quote.type === 'DCA' && quote.boostQuote) ||
+                            quotes.find((quote) => quote.type === 'REGULAR' && quote.boostQuote) ||
+                            quotes.find((quote) => quote.type === 'DCA') ||
+                            quotes.find((quote) => quote.type === 'REGULAR');
+                }
+                else {
+                    // User wants regular quotes - prioritize DCA > REGULAR (ignore boost quotes)
+                    selectedQuote = quotes.find((quote) => quote.type === 'DCA') || quotes.find((quote) => quote.type === 'REGULAR');
+                }
                 if (params.destinationAddress && (selectedQuote === null || selectedQuote === void 0 ? void 0 : selectedQuote.type) === 'DCA' && params.fromAddress) {
+                    // Use boost quote only if user enabled boost and it's available
+                    const quoteToUse = params.enableBoost && selectedQuote.boostQuote ? selectedQuote.boostQuote : selectedQuote;
                     const resp = yield this.sdk.requestDepositAddressV2({
-                        quote: selectedQuote,
+                        quote: quoteToUse,
                         destAddress: params.destinationAddress,
                         srcAddress: params.fromAddress,
                         fillOrKillParams: {
@@ -159,8 +173,10 @@ class ChainflipProtocol {
                     depositChannelId = resp.depositChannelId;
                 }
                 else if (params.destinationAddress && (selectedQuote === null || selectedQuote === void 0 ? void 0 : selectedQuote.type) === 'REGULAR' && params.fromAddress) {
+                    // Use boost quote only if user enabled boost and it's available
+                    const quoteToUse = params.enableBoost && selectedQuote.boostQuote ? selectedQuote.boostQuote : selectedQuote;
                     const resp = yield this.sdk.requestDepositAddressV2({
-                        quote: selectedQuote,
+                        quote: quoteToUse,
                         destAddress: params.destinationAddress,
                         srcAddress: params.fromAddress,
                         fillOrKillParams: {
@@ -176,26 +192,38 @@ class ChainflipProtocol {
                 else {
                     console.error('No suitable quote found or destination/refund address missing');
                 }
-                const outboundFee = selectedQuote === null || selectedQuote === void 0 ? void 0 : selectedQuote.includedFees.find((fee) => fee.type === 'EGRESS');
-                const brokerFee = selectedQuote === null || selectedQuote === void 0 ? void 0 : selectedQuote.includedFees.find((fee) => fee.type === 'BROKER');
+                // Determine which quote to use for fee calculations
+                const actualQuote = params.enableBoost && (selectedQuote === null || selectedQuote === void 0 ? void 0 : selectedQuote.boostQuote) ? selectedQuote.boostQuote : selectedQuote;
+                const outboundFee = actualQuote === null || actualQuote === void 0 ? void 0 : actualQuote.includedFees.find((fee) => fee.type === 'EGRESS');
+                const brokerFee = actualQuote === null || actualQuote === void 0 ? void 0 : actualQuote.includedFees.find((fee) => fee.type === 'BROKER');
+                const networkFee = actualQuote === null || actualQuote === void 0 ? void 0 : actualQuote.includedFees.find((fee) => fee.type === 'NETWORK');
+                const boostFee = actualQuote === null || actualQuote === void 0 ? void 0 : actualQuote.includedFees.find((fee) => fee.type === 'BOOST');
+                // Check if boost is actually being used
+                const isUsingBoost = params.enableBoost && (selectedQuote === null || selectedQuote === void 0 ? void 0 : selectedQuote.boostQuote) && actualQuote === selectedQuote.boostQuote;
                 return {
                     protocol: this.name,
                     toAddress,
                     memo: '',
-                    expectedAmount: new CryptoAmount(baseAmount(selectedQuote === null || selectedQuote === void 0 ? void 0 : selectedQuote.egressAmount, destAssetData.decimals), params.destinationAsset),
+                    expectedAmount: new CryptoAmount(baseAmount(actualQuote === null || actualQuote === void 0 ? void 0 : actualQuote.egressAmount, destAssetData.decimals), params.destinationAsset),
                     dustThreshold: new CryptoAmount(baseAmount(srcAssetData.minimumSwapAmount, srcAssetData.decimals), params.fromAsset),
-                    totalSwapSeconds: (selectedQuote === null || selectedQuote === void 0 ? void 0 : selectedQuote.estimatedDurationSeconds) ? selectedQuote.estimatedDurationSeconds : 0,
+                    totalSwapSeconds: (actualQuote === null || actualQuote === void 0 ? void 0 : actualQuote.estimatedDurationSeconds) ? actualQuote.estimatedDurationSeconds : 0,
                     maxStreamingQuantity: undefined,
                     canSwap: toAddress !== '',
-                    warning: (selectedQuote === null || selectedQuote === void 0 ? void 0 : selectedQuote.lowLiquidityWarning)
+                    warning: (actualQuote === null || actualQuote === void 0 ? void 0 : actualQuote.lowLiquidityWarning)
                         ? 'Do not cache this response. Do not send funds after the expiry. The difference in the chainflip swap rate (excluding fees) is lower than the global index rate of the swap by more than a certain threshold (currently set to 5%)'
-                        : 'Do not cache this response. Do not send funds after the expiry.',
+                        : isUsingBoost
+                            ? 'Do not cache this response. Do not send funds after the expiry. Boost enabled for faster processing.'
+                            : 'Do not cache this response. Do not send funds after the expiry.',
                     errors: [],
-                    slipBasisPoints: 0,
+                    slipBasisPoints: (actualQuote === null || actualQuote === void 0 ? void 0 : actualQuote.recommendedSlippageTolerancePercent)
+                        ? (actualQuote === null || actualQuote === void 0 ? void 0 : actualQuote.recommendedSlippageTolerancePercent) * 100
+                        : 0,
                     fees: {
-                        asset: params.destinationAsset,
+                        asset: assetUSDC, // networkFee & broker fee paid in usdc
+                        networkFee: new CryptoAmount(baseAmount((networkFee ? parseInt(networkFee.amount) : 0) +
+                            (isUsingBoost && boostFee ? parseInt(boostFee.amount) : 0), isUsingBoost && boostFee ? srcAssetData.decimals : 6), isUsingBoost && boostFee ? params.fromAsset : assetUSDC),
                         outboundFee: new CryptoAmount(baseAmount(outboundFee ? outboundFee.amount : 0, destAssetData.decimals), params.destinationAsset),
-                        affiliateFee: new CryptoAmount(baseAmount(brokerFee ? brokerFee.amount : 0, destAssetData.decimals), params.destinationAsset),
+                        affiliateFee: new CryptoAmount(baseAmount(brokerFee ? brokerFee.amount : 0, 6), assetUSDC),
                     },
                     depositChannelId,
                 };
@@ -216,7 +244,8 @@ class ChainflipProtocol {
                     fees: {
                         asset: params.destinationAsset,
                         outboundFee: new CryptoAmount(baseAmount(0, destAssetData.decimals), params.destinationAsset),
-                        affiliateFee: new CryptoAmount(baseAmount(0, destAssetData.decimals), params.destinationAsset),
+                        networkFee: new CryptoAmount(baseAmount(0, 6), assetUSDC),
+                        affiliateFee: new CryptoAmount(baseAmount(0, 6), assetUSDC),
                     },
                     depositChannelId: undefined,
                 };
@@ -225,7 +254,7 @@ class ChainflipProtocol {
     }
     /**
      * Perform a swap operation between assets.
-     * @param {QuoteSwapParams} quoteSwapParams Swap parameters
+     * @param {QuoteSwapParams} params Swap parameters
      * @returns {TxSubmitted} Transaction hash and URL of the swap
      */
     doSwap(params) {

package/lib/index.js

@@ -3,12 +3,12 @@
 var xchainClient = require('@xchainjs/xchain-client');
 var xchainUtil = require('@xchainjs/xchain-util');
 var swap = require('@chainflip/sdk/swap');
+var xchainThorchainQuery = require('@xchainjs/xchain-thorchain-query');
 var xchainMayachain = require('@xchainjs/xchain-mayachain');
 var xchainMayachainAmm = require('@xchainjs/xchain-mayachain-amm');
 var xchainMayachainQuery = require('@xchainjs/xchain-mayachain-query');
 var xchainThorchain = require('@xchainjs/xchain-thorchain');
 var xchainThorchainAmm = require('@xchainjs/xchain-thorchain-amm');
-var xchainThorchainQuery = require('@xchainjs/xchain-thorchain-query');
 
 /******************************************************************************
 Copyright (c) Microsoft Corporation.
@@ -143,11 +143,25 @@ class ChainflipProtocol {
                     amount: params.amount.baseAmount.amount().toString(),
                     affiliateBrokers: this.affiliateBrokers,
                 });
-                // Find either DCA or REGULAR quote, prioritizing DCA
-                const selectedQuote = quotes.find((quote) => quote.type === 'DCA') || quotes.find((quote) => quote.type === 'REGULAR');
+                // Find quote based on user preference for boost
+                let selectedQuote;
+                if (params.enableBoost) {
+                    // User wants boost - prioritize DCA with boost > REGULAR with boost > DCA > REGULAR
+                    selectedQuote =
+                        quotes.find((quote) => quote.type === 'DCA' && quote.boostQuote) ||
+                            quotes.find((quote) => quote.type === 'REGULAR' && quote.boostQuote) ||
+                            quotes.find((quote) => quote.type === 'DCA') ||
+                            quotes.find((quote) => quote.type === 'REGULAR');
+                }
+                else {
+                    // User wants regular quotes - prioritize DCA > REGULAR (ignore boost quotes)
+                    selectedQuote = quotes.find((quote) => quote.type === 'DCA') || quotes.find((quote) => quote.type === 'REGULAR');
+                }
                 if (params.destinationAddress && (selectedQuote === null || selectedQuote === void 0 ? void 0 : selectedQuote.type) === 'DCA' && params.fromAddress) {
+                    // Use boost quote only if user enabled boost and it's available
+                    const quoteToUse = params.enableBoost && selectedQuote.boostQuote ? selectedQuote.boostQuote : selectedQuote;
                     const resp = yield this.sdk.requestDepositAddressV2({
-                        quote: selectedQuote,
+                        quote: quoteToUse,
                         destAddress: params.destinationAddress,
                         srcAddress: params.fromAddress,
                         fillOrKillParams: {
@@ -161,8 +175,10 @@ class ChainflipProtocol {
                     depositChannelId = resp.depositChannelId;
                 }
                 else if (params.destinationAddress && (selectedQuote === null || selectedQuote === void 0 ? void 0 : selectedQuote.type) === 'REGULAR' && params.fromAddress) {
+                    // Use boost quote only if user enabled boost and it's available
+                    const quoteToUse = params.enableBoost && selectedQuote.boostQuote ? selectedQuote.boostQuote : selectedQuote;
                     const resp = yield this.sdk.requestDepositAddressV2({
-                        quote: selectedQuote,
+                        quote: quoteToUse,
                         destAddress: params.destinationAddress,
                         srcAddress: params.fromAddress,
                         fillOrKillParams: {
@@ -178,26 +194,38 @@ class ChainflipProtocol {
                 else {
                     console.error('No suitable quote found or destination/refund address missing');
                 }
-                const outboundFee = selectedQuote === null || selectedQuote === void 0 ? void 0 : selectedQuote.includedFees.find((fee) => fee.type === 'EGRESS');
-                const brokerFee = selectedQuote === null || selectedQuote === void 0 ? void 0 : selectedQuote.includedFees.find((fee) => fee.type === 'BROKER');
+                // Determine which quote to use for fee calculations
+                const actualQuote = params.enableBoost && (selectedQuote === null || selectedQuote === void 0 ? void 0 : selectedQuote.boostQuote) ? selectedQuote.boostQuote : selectedQuote;
+                const outboundFee = actualQuote === null || actualQuote === void 0 ? void 0 : actualQuote.includedFees.find((fee) => fee.type === 'EGRESS');
+                const brokerFee = actualQuote === null || actualQuote === void 0 ? void 0 : actualQuote.includedFees.find((fee) => fee.type === 'BROKER');
+                const networkFee = actualQuote === null || actualQuote === void 0 ? void 0 : actualQuote.includedFees.find((fee) => fee.type === 'NETWORK');
+                const boostFee = actualQuote === null || actualQuote === void 0 ? void 0 : actualQuote.includedFees.find((fee) => fee.type === 'BOOST');
+                // Check if boost is actually being used
+                const isUsingBoost = params.enableBoost && (selectedQuote === null || selectedQuote === void 0 ? void 0 : selectedQuote.boostQuote) && actualQuote === selectedQuote.boostQuote;
                 return {
                     protocol: this.name,
                     toAddress,
                     memo: '',
-                    expectedAmount: new xchainUtil.CryptoAmount(xchainUtil.baseAmount(selectedQuote === null || selectedQuote === void 0 ? void 0 : selectedQuote.egressAmount, destAssetData.decimals), params.destinationAsset),
+                    expectedAmount: new xchainUtil.CryptoAmount(xchainUtil.baseAmount(actualQuote === null || actualQuote === void 0 ? void 0 : actualQuote.egressAmount, destAssetData.decimals), params.destinationAsset),
                     dustThreshold: new xchainUtil.CryptoAmount(xchainUtil.baseAmount(srcAssetData.minimumSwapAmount, srcAssetData.decimals), params.fromAsset),
-                    totalSwapSeconds: (selectedQuote === null || selectedQuote === void 0 ? void 0 : selectedQuote.estimatedDurationSeconds) ? selectedQuote.estimatedDurationSeconds : 0,
+                    totalSwapSeconds: (actualQuote === null || actualQuote === void 0 ? void 0 : actualQuote.estimatedDurationSeconds) ? actualQuote.estimatedDurationSeconds : 0,
                     maxStreamingQuantity: undefined,
                     canSwap: toAddress !== '',
-                    warning: (selectedQuote === null || selectedQuote === void 0 ? void 0 : selectedQuote.lowLiquidityWarning)
+                    warning: (actualQuote === null || actualQuote === void 0 ? void 0 : actualQuote.lowLiquidityWarning)
                         ? 'Do not cache this response. Do not send funds after the expiry. The difference in the chainflip swap rate (excluding fees) is lower than the global index rate of the swap by more than a certain threshold (currently set to 5%)'
-                        : 'Do not cache this response. Do not send funds after the expiry.',
+                        : isUsingBoost
+                            ? 'Do not cache this response. Do not send funds after the expiry. Boost enabled for faster processing.'
+                            : 'Do not cache this response. Do not send funds after the expiry.',
                     errors: [],
-                    slipBasisPoints: 0,
+                    slipBasisPoints: (actualQuote === null || actualQuote === void 0 ? void 0 : actualQuote.recommendedSlippageTolerancePercent)
+                        ? (actualQuote === null || actualQuote === void 0 ? void 0 : actualQuote.recommendedSlippageTolerancePercent) * 100
+                        : 0,
                     fees: {
-                        asset: params.destinationAsset,
+                        asset: xchainThorchainQuery.assetUSDC, // networkFee & broker fee paid in usdc
+                        networkFee: new xchainUtil.CryptoAmount(xchainUtil.baseAmount((networkFee ? parseInt(networkFee.amount) : 0) +
+                            (isUsingBoost && boostFee ? parseInt(boostFee.amount) : 0), isUsingBoost && boostFee ? srcAssetData.decimals : 6), isUsingBoost && boostFee ? params.fromAsset : xchainThorchainQuery.assetUSDC),
                         outboundFee: new xchainUtil.CryptoAmount(xchainUtil.baseAmount(outboundFee ? outboundFee.amount : 0, destAssetData.decimals), params.destinationAsset),
-                        affiliateFee: new xchainUtil.CryptoAmount(xchainUtil.baseAmount(brokerFee ? brokerFee.amount : 0, destAssetData.decimals), params.destinationAsset),
+                        affiliateFee: new xchainUtil.CryptoAmount(xchainUtil.baseAmount(brokerFee ? brokerFee.amount : 0, 6), xchainThorchainQuery.assetUSDC),
                     },
                     depositChannelId,
                 };
@@ -218,7 +246,8 @@ class ChainflipProtocol {
                     fees: {
                         asset: params.destinationAsset,
                         outboundFee: new xchainUtil.CryptoAmount(xchainUtil.baseAmount(0, destAssetData.decimals), params.destinationAsset),
-                        affiliateFee: new xchainUtil.CryptoAmount(xchainUtil.baseAmount(0, destAssetData.decimals), params.destinationAsset),
+                        networkFee: new xchainUtil.CryptoAmount(xchainUtil.baseAmount(0, 6), xchainThorchainQuery.assetUSDC),
+                        affiliateFee: new xchainUtil.CryptoAmount(xchainUtil.baseAmount(0, 6), xchainThorchainQuery.assetUSDC),
                     },
                     depositChannelId: undefined,
                 };
@@ -227,7 +256,7 @@ class ChainflipProtocol {
     }
     /**
      * Perform a swap operation between assets.
-     * @param {QuoteSwapParams} quoteSwapParams Swap parameters
+     * @param {QuoteSwapParams} params Swap parameters
      * @returns {TxSubmitted} Transaction hash and URL of the swap
      */
     doSwap(params) {

package/lib/protocols/chainflip/chainflipProtocol.d.ts

@@ -39,7 +39,7 @@ export declare class ChainflipProtocol implements IProtocol {
     estimateSwap(params: QuoteSwapParams): Promise<QuoteSwap>;
     /**
      * Perform a swap operation between assets.
-     * @param {QuoteSwapParams} quoteSwapParams Swap parameters
+     * @param {QuoteSwapParams} params Swap parameters
      * @returns {TxSubmitted} Transaction hash and URL of the swap
      */
     doSwap(params: QuoteSwapParams): Promise<TxSubmitted>;

package/lib/types.d.ts

@@ -15,6 +15,7 @@ type Fees = {
     asset: Asset | TokenAsset | SynthAsset | TradeAsset | SecuredAsset;
     affiliateFee: CryptoAmount<Asset | TokenAsset | SynthAsset | TradeAsset | SecuredAsset>;
     outboundFee: CryptoAmount<Asset | TokenAsset | SynthAsset | TradeAsset | SecuredAsset>;
+    networkFee?: CryptoAmount<Asset | TokenAsset | SynthAsset | TradeAsset | SecuredAsset>;
 };
 /**
  * Protocols supported by the Aggregator
@@ -111,6 +112,7 @@ type QuoteSwapParams = {
     liquidityToleranceBps?: number;
     streamingQuantity?: number;
     streamingInterval?: number;
+    enableBoost?: boolean;
 };
 type SwapHistoryParams = {
     chainAddresses: {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@xchainjs/xchain-aggregator",
   "description": "Protocol aggregator to make actions in different protocols",
-  "version": "2.0.28",
+  "version": "2.0.30",
   "license": "MIT",
   "main": "lib/index.js",
   "module": "lib/index.esm.js",
@@ -29,7 +29,7 @@
     "directory": "release/package"
   },
   "dependencies": {
-    "@chainflip/sdk": "1.11.0",
+    "@chainflip/sdk": "1.11.2",
     "@trpc/server": "^10.45.2",
     "@xchainjs/xchain-client": "2.0.9",
     "@xchainjs/xchain-mayachain": "4.1.0",