@rabbitio/ui-kit 1.0.0-beta.71 → 1.0.0-beta.73

package/src/swaps-lib/external-apis/swapspaceSwapProvider.js

@@ -1,27 +1,24 @@
 import axios from "axios";
 import { BigNumber } from "bignumber.js";
 
-import { AmountUtils } from "../../common/amountUtils.js";
-import { improveAndRethrow } from "../../common/errorUtils.js";
+import { AmountUtils } from "../../common-apis/amountUtils.js";
+import { improveAndRethrow } from "../../common-apis/errorUtils.js";
 import { SwapProvider } from "./swapProvider.js";
 import { ExistingSwap } from "../models/existingSwap.js";
-import { Coin } from "../../common/models/coin.js";
-import { Protocol } from "../../common/models/protocol.js";
-import { safeStringify } from "../../common/utils/safeStringify.js";
-import { Logger } from "../../common/utils/logging/logger.js";
-import { FALLBACK_ASSET_ICON_URL } from "../../constants/globalConstants.jsx";
+import { Coin } from "../../common-apis/models/coin.js";
+import { Protocol } from "../../common-apis/models/protocol.js";
+import { safeStringify } from "../../common-apis/utils/safeStringify.js";
+import { Logger } from "../../common-apis/utils/logging/logger.js";
+import { FALLBACK_ASSET_ICON_URL } from "../../common-apis/globalConstants.jsx";
 
 export const BANNED_PARTNERS = ["stealthex", "changee", "coincraddle"];
 
 export class SwapspaceSwapProvider extends SwapProvider {
     constructor(apiKeysProxyUrl, cache, customCoinBuilder = (coin, network) => null, useRestrictedCoinsSet = true) {
-        super();
-        this._supportedCoins = [];
-        this._URL = `${apiKeysProxyUrl}`;
-        this._maxRateDigits = 20;
-        this.useRestrictedCoinsSet = useRestrictedCoinsSet;
-        this._customCoinBuilder = customCoinBuilder;
-        this._cache = cache;
+        super(cache, customCoinBuilder, useRestrictedCoinsSet);
+        this._partners = [];
+        this._URL = `${apiKeysProxyUrl}/swapspace`;
+        this.isAggregator = true;
     }
 
     getSwapCreationInfoTtlMs() {
@@ -30,90 +27,6 @@ export class SwapspaceSwapProvider extends SwapProvider {
         return 110000;
     }
 
-    async getDepositCurrencies() {
-        const loggerSource = "getDepositCurrencies";
-        try {
-            await this._fetchSupportedCurrenciesIfNeeded();
-            Logger.log(`We have ${this._supportedCoins?.length} supported coins, getting depositable`, loggerSource);
-            return {
-                result: true,
-                coins: this._supportedCoins.filter(item => item.deposit).map(item => item.coin),
-            };
-        } catch (e) {
-            if (e?.response?.status === 429) {
-                return {
-                    result: false,
-                    reason: SwapProvider.COMMON_ERRORS.REQUESTS_LIMIT_EXCEEDED,
-                };
-            }
-            improveAndRethrow(e, loggerSource);
-        }
-    }
-
-    async getAllSupportedCurrencies() {
-        const loggerSource = "getAllSupportedCurrencies";
-        try {
-            await this._fetchSupportedCurrenciesIfNeeded();
-            Logger.log(`We have ${this._supportedCoins?.length} supported coins returning`, loggerSource);
-            return {
-                result: true,
-                coins: this._supportedCoins.map(item => item.coin),
-            };
-        } catch (e) {
-            if (e?.response?.status === 429) {
-                return {
-                    result: false,
-                    reason: SwapProvider.COMMON_ERRORS.REQUESTS_LIMIT_EXCEEDED,
-                };
-            }
-            improveAndRethrow(e, loggerSource);
-        }
-    }
-
-    async getWithdrawalCurrencies(exceptCurrency = null) {
-        const loggerSource = "getWithdrawalCurrencies";
-        try {
-            await this._fetchSupportedCurrenciesIfNeeded();
-            Logger.log(`We have ${this._supportedCoins?.length} supported coins, getting withdrawable`, loggerSource);
-            return {
-                result: true,
-                coins: this._supportedCoins
-                    .filter(
-                        item => item.withdrawal && (!exceptCurrency || item.coin?.ticker !== exceptCurrency?.ticker)
-                    )
-                    .map(item => item.coin),
-            };
-        } catch (e) {
-            if (e?.response?.status === 429) {
-                return {
-                    result: false,
-                    reason: SwapProvider.COMMON_ERRORS.REQUESTS_LIMIT_EXCEEDED,
-                };
-            }
-            improveAndRethrow(e, loggerSource);
-        }
-    }
-
-    async initialize() {
-        await this._fetchSupportedCurrenciesIfNeeded();
-    }
-
-    getIconUrl(coinOrTicker) {
-        const loggerSource = "getIconUrl";
-        try {
-            let coin = coinOrTicker;
-            if (!(coinOrTicker instanceof Coin)) {
-                coin = this._supportedCoins.find(i => i.coin.ticker === coinOrTicker)?.coin;
-            }
-            return (
-                this._supportedCoins.find(item => item.coin?.ticker === coin?.ticker)?.iconURL ??
-                FALLBACK_ASSET_ICON_URL
-            );
-        } catch (e) {
-            improveAndRethrow(e, loggerSource);
-        }
-    }
-
     async _fetchSupportedCurrenciesIfNeeded() {
         const loggerSource = "_fetchSupportedCurrenciesIfNeeded";
         try {
@@ -140,15 +53,7 @@ export class SwapspaceSwapProvider extends SwapProvider {
                             /** Removing ticker and protocol name from coin name as we usually use them explicitly
                              * from coin object rather than counting on having it in the coin name itself.
                              * This processing is needed due to poor quality of swapspace coins names. */
-                            let name = (item.name ?? "")
-                                .replaceAll(`(${code})`, "")
-                                .replaceAll(`(${network})`, "")
-                                .replaceAll(/ +/g, " ")
-                                .trim();
-                            if (name === "") {
-                                // Rolling back to original name if our processing leads in empty name
-                                name = item.name;
-                            }
+                            let name = this.removeProtocolNameFromCoinName(item.name, code, network);
                             const ticker = `${code}${code === network ? "" : network}`;
                             const defaultDecimalPlacesForCoinNotSupportedOOB = 8;
                             const defaultMinConfirmationsForCoinNotSupportedOOB = 1;
@@ -178,13 +83,14 @@ export class SwapspaceSwapProvider extends SwapProvider {
                                 network: item.network,
                                 hasExtraId: item.hasExtraId,
                                 extraIdName: item.extraIdName,
-                                isPopular: !!item.popular,
+                                isPopular: item.popular ? 1 : 0,
                                 iconURL: item.icon
                                     ? `https://storage.swapspace.co${item.icon}`
                                     : FALLBACK_ASSET_ICON_URL,
                                 deposit: item.deposit ?? false,
                                 withdrawal: item.withdrawal ?? false,
                                 validationRegexp: item.validationRegexp ?? null,
+                                isAvailable: true,
                             };
                         }
 
@@ -198,74 +104,31 @@ export class SwapspaceSwapProvider extends SwapProvider {
         }
     }
 
-    /**
-     * This method sort internal list putting popular (as swapspace thinks) coins to the top.
-     * This is just for users of this API if they don't care about the sorting - we just improve a list a bit this way.
-     * @private
-     */
-    _putPopularCoinsFirst() {
-        this._supportedCoins.sort((i1, i2) => {
-            if (i1.isPopular && !i2.isPopular) return -1;
-            if (i2.isPopular && !i1.isPopular) return 1;
-            return i1.coin.ticker > i2.coin.ticker ? 1 : i1.coin.ticker < i2.coin.ticker ? -1 : 0;
-        });
-    }
-
-    async getCoinToUSDTRate(coin) {
-        const loggerSource = "getCoinToUSDTRate";
+    async _fetchPartnersListIfNeeded() {
+        const loggerSource = "_fetchPartnersListIfNeeded";
         try {
-            if (!coin) return null;
-
-            await this._fetchSupportedCurrenciesIfNeeded();
-
-            // Using USDT TRC20 as usually fee in this network is smaller than ERC20 and this network is widely used for USDT
-            const usdtTrc20 = this._supportedCoins.find(i => i.coin.ticker === "USDTTRC20")?.coin;
-            if (!usdtTrc20) {
-                return { result: false };
-            }
-            const cached = this._cache.get("swapspace_usdt_rate_" + coin.ticker);
-            if (cached != null) {
-                return {
-                    result: true,
-                    rate: cached,
-                };
+            if (this._partners?.length === 0) {
+                const rawResponse = await axios.get(`${this._URL}/api/v2/partners`);
+                Logger.log(`Retrieved ${rawResponse?.data?.length} partners`, loggerSource);
+                this._partners = Array.isArray(rawResponse?.data) ? rawResponse?.data : [];
             }
-
-            Logger.log("Loading USDT->coin rate as not found in cache:", coin?.ticker);
-            const result = await this.getSwapInfo(usdtTrc20, coin, "5000", false);
-            if (!result.result) {
-                return { result: false };
-            }
-
-            // This calculation is not precise as we cannot recognize the actual fee and network fee. Just approximate.
-            const standardSwapspaceFeeMultiplier = 1.004; // fee is usually 0.4%
-            const rate = BigNumber(1).div(BigNumber(result.rate).times(standardSwapspaceFeeMultiplier)).toString();
-            this._cache.put(
-                "swapspace_usdt_rate_" + coin.ticker,
-                rate,
-                15 * 60000 // 15 minutes
-            );
-            return {
-                result: true,
-                rate: rate,
-            };
-        } catch (e) {
-            improveAndRethrow(e, loggerSource);
-        }
-    }
-
-    getCoinByTickerIfPresent(ticker) {
-        try {
-            const item = this._supportedCoins.find(i => i.coin.ticker === ticker);
-            return item?.coin ?? null;
         } catch (e) {
-            improveAndRethrow(e, "getCoinByTickerIfPresent");
+            Logger.logError(e, loggerSource, "Failed to fetch partners list from swapspace");
         }
     }
 
-    async getSwapInfo(fromCoin, toCoin, amountCoins, fixed = false, fromCoinToUsdRate = null) {
+    async getSwapInfo(
+        fromCoin,
+        toCoin,
+        amountCoins,
+        fixed = false,
+        fromCoinToUsdRate = null,
+        amountIsToReceive = false
+    ) {
         const loggerSource = "getSwapInfo";
         try {
+            if (amountIsToReceive)
+                throw new Error("Swapspace doesn't support exchanging to get the exact receiving amount");
             if (
                 !(fromCoin instanceof Coin) ||
                 !(toCoin instanceof Coin) ||
@@ -387,6 +250,11 @@ export class SwapspaceSwapProvider extends SwapProvider {
 
                 const rate =
                     bestOpt.toAmount && bestOpt.fromAmount ? BigNumber(bestOpt.toAmount).div(bestOpt.fromAmount) : null;
+
+                await this._fetchPartnersListIfNeeded();
+                const partner = this._partners.find(p => bestOpt?.partner?.toLowerCase() === p.path.toLowerCase());
+                const isRefundAddressRequired =
+                    partner == null ? true : bestOpt.fixed ? partner.reqFixedRefund : partner.reqFloatRefund;
                 return {
                     result: true,
                     min: min,
@@ -397,6 +265,7 @@ export class SwapspaceSwapProvider extends SwapProvider {
                     durationMinutesRange: bestOpt.duration ?? null,
                     fixed: bestOpt.fixed,
                     rawSwapData: bestOpt,
+                    isRefundAddressRequired: !!isRefundAddressRequired,
                 };
             }
             const result = {
@@ -434,11 +303,14 @@ export class SwapspaceSwapProvider extends SwapProvider {
         clientIpAddress,
         fixed,
         toCurrencyExtraId = "",
-        refundExtraId = ""
+        refundExtraId = "",
+        amountIsToReceive = false
     ) {
         const loggerSource = "createSwap";
         const partner = rawSwapData?.partner;
         try {
+            if (amountIsToReceive)
+                throw new Error("Swapspace doesn't support exchanging to get the exact receiving amount");
             if (
                 !(fromCoin instanceof Coin) ||
                 !(toCoin instanceof Coin) ||
@@ -669,36 +541,4 @@ export class SwapspaceSwapProvider extends SwapProvider {
             improveAndRethrow(e, loggerSource);
         }
     }
-
-    isAddressValidForAsset(asset, address) {
-        try {
-            const assetData = this._supportedCoins.find(i => i.coin?.ticker === asset?.ticker);
-            if (assetData) {
-                let corrected = assetData.validationRegexp.trim();
-                corrected = corrected[0] === "/" ? corrected.slice(1) : corrected;
-                corrected =
-                    corrected[corrected.length - 1] === "/" ? corrected.slice(0, corrected.length - 1) : corrected;
-                return address.match(corrected) != null;
-            }
-        } catch (e) {
-            Logger.logError(e, "isAddressValidForAsset");
-        }
-        return false;
-    }
-
-    getExtraIdNameIfPresent(asset) {
-        try {
-            const assetData = this._supportedCoins.find(i => i.coin?.ticker === asset?.ticker);
-            if (assetData?.hasExtraId) {
-                if (assetData?.extraIdName == null || assetData?.extraIdName === "") {
-                    // We return some default name if the extraIdName is empty
-                    return "ID";
-                }
-                return assetData?.extraIdName;
-            }
-            return null;
-        } catch (e) {
-            improveAndRethrow(e, "getExtraIdNameIfPresent");
-        }
-    }
 }

package/src/swaps-lib/models/baseSwapCreationInfo.js

@@ -12,6 +12,7 @@ export class BaseSwapCreationInfo {
      * @param fiatMax {number}
      * @param durationMinutesRange {string}
      * @param fixed {boolean}
+     * @param [isRefundAddressRequired=false] {boolean}
      */
     constructor(
         fromCoin,
@@ -25,7 +26,8 @@ export class BaseSwapCreationInfo {
         max,
         fiatMax,
         durationMinutesRange,
-        fixed
+        fixed,
+        isRefundAddressRequired = false
     ) {
         this.fromCoin = fromCoin;
         this.toCoin = toCoin;
@@ -39,5 +41,6 @@ export class BaseSwapCreationInfo {
         this.fiatMax = fiatMax;
         this.durationMinutesRange = durationMinutesRange;
         this.fixed = fixed;
+        this.isRefundAddressRequired = isRefundAddressRequired;
     }
 }