@rabbitio/ui-kit 1.0.0-beta.42 → 1.0.0-beta.45

package/src/robustExteranlApiCallerService/tests/robustExternalAPICallerService/robustExternalAPICallerService/constructor.test.js

@@ -0,0 +1,31 @@
+import should from "should";
+
+import { describe, it } from "vitest";
+
+import { ExternalApiProvider } from "../../../externalApiProvider.js";
+import { RobustExternalAPICallerService } from "../../../robustExternalAPICallerService.js";
+import { ApiGroup } from "../../../../common/external-apis/apiGroups.js";
+
+describe("RobustExternalAPICallerService", function () {
+    describe("#constructor", function () {
+        const someProviders = [
+            new ExternalApiProvider(
+                "ggee.com",
+                "get",
+                10000,
+                new ApiGroup("aaa2141r1f", 1)
+            ),
+        ];
+
+        it("Should set niceFactor field to 1 for given providers Array", async function () {
+            const instance = new RobustExternalAPICallerService(
+                "someBio",
+                someProviders
+            );
+
+            instance.providers.forEach((provider) =>
+                provider.niceFactor.should.be.equal(1)
+            );
+        });
+    });
+});

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

@@ -7,6 +7,8 @@ export class SwapProvider {
         TOO_LOW: "tooLow",
         TOO_HIGH: "tooHigh",
         NOT_SUPPORTED: "notSupported",
+        NO_FIXED_BUT_HAVE_FLOATING: "noFixedButHaveFloating",
+        NO_FLOATING_BUT_HAVE_FIXED: "noFloatingButHaveFixed",
     };
 
     static CREATION_FAIL_REASONS = {
@@ -98,6 +100,7 @@ export class SwapProvider {
      * @param fromCoin {Coin}
      * @param toCoin {Coin}
      * @param amountCoins {string}
+     * @param [fixed=false] {boolean|null} null means fixed or float doesn't matter
      * @param [fromCoinToUsdRate=null] pass if you want to increase the min amount returned
      *        by provider with some fixed "insurance" amount to cover min amount fluctuations.
      * @return {Promise<({
@@ -113,15 +116,22 @@ export class SwapProvider {
      *            greatestMax: (string|null),
      *            rate: (string|null),
      *            durationMinutesRange: string,
+     *            fixed: boolean,
      *            [rawSwapData]: Object
      *         })>}
      */
-    async getSwapInfo(fromCoin, toCoin, amountCoins, fromCoinToUsdRate = null) {
+    async getSwapInfo(
+        fromCoin,
+        toCoin,
+        amountCoins,
+        fixed = false,
+        fromCoinToUsdRate = null
+    ) {
         throw new Error("Not implemented in base");
     }
 
     /**
-     * For fail result we return one of SwapProvider.CREATION_FAIL_REASONS or SwapProvider.COMMON_ERRORS.
+     * For fail result we return one of SwapProvider.CREATION_FAIL_REASONS or SwapProvider.COMMON_ERRORS.*
      *
      * @param fromCoin {Coin}
      * @param toCoin {Coin}
@@ -130,6 +140,7 @@ export class SwapProvider {
      * @param refundAddress {string}
      * @param rawSwapData {Object|null}
      * @param clientIpAddress {string}
+     * @param fixed {boolean}
      * @param [toCurrencyExtraId=""] {string} optional extra ID
      * @param [refundExtraId=""] {string} optional extra ID for refund address
      * @return {Promise<({
@@ -142,7 +153,8 @@ export class SwapProvider {
      *                     toAmount: string,
      *                     toAddress: string,
      *                     rate: string,
-     *                     fromCurrencyExtraId: string|undefined
+     *                     fromCurrencyExtraId: string|undefined,
+     *                     fixed: boolean
      *                 }|{
      *                     result: false,
      *                     reason: string,
@@ -155,8 +167,9 @@ export class SwapProvider {
         amount,
         toAddress,
         refundAddress,
-        rawSwapData = null,
+        rawSwapData,
         clientIpAddress,
+        fixed,
         toCurrencyExtraId = "",
         refundExtraId = ""
     ) {

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

@@ -172,7 +172,6 @@ export class SwapspaceSwapProvider extends SwapProvider {
                             }`;
                             const defaultDecimalPlacesForCoinNotSupportedOOB = 8;
                             const defaultMinConfirmationsForCoinNotSupportedOOB = 1;
-                            // TODO: [dev] maybe we should recognize standard protocols?
                             coin = new Coin(
                                 item.name,
                                 ticker,
@@ -199,7 +198,7 @@ export class SwapspaceSwapProvider extends SwapProvider {
                                 network: item.network,
                                 hasExtraId: item.hasExtraId,
                                 extraIdName: item.extraIdName,
-                                isPopular: !!item?.popular,
+                                isPopular: !!item.popular,
                                 iconURL: item.icon
                                     ? `https://storage.swapspace.co${item.icon}`
                                     : FALLBACK_ICON_URL,
@@ -264,13 +263,18 @@ export class SwapspaceSwapProvider extends SwapProvider {
                 "Loading USDT->coin rate as not found in cache:",
                 coin?.ticker
             );
-            const result = await this.getSwapInfo(usdtTrc20, coin, "5000");
+            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; // usually 0.2%
+            const standardSwapspaceFeeMultiplier = 1.004; // fee is usually 0.4%
             const rate = BigNumber(1)
                 .div(
                     BigNumber(result.rate).times(standardSwapspaceFeeMultiplier)
@@ -301,19 +305,28 @@ export class SwapspaceSwapProvider extends SwapProvider {
         }
     }
 
-    async getSwapInfo(fromCoin, toCoin, amountCoins, fromCoinToUsdRate = null) {
+    async getSwapInfo(
+        fromCoin,
+        toCoin,
+        amountCoins,
+        fixed = false,
+        fromCoinToUsdRate = null
+    ) {
         const loggerSource = "getSwapInfo";
         try {
             if (
                 !(fromCoin instanceof Coin) ||
                 !(toCoin instanceof Coin) ||
                 typeof amountCoins !== "string" ||
-                BigNumber(amountCoins).lt("0")
+                BigNumber(amountCoins).lt("0") ||
+                (fixed !== null && typeof fixed !== "boolean")
             ) {
                 throw new Error(
-                    `Wrong input params: ${amountCoins} ${fromCoin.ticker} -> ${toCoin.ticker}` +
-                        (fromCoin instanceof Coin) +
-                        (toCoin instanceof Coin)
+                    `Wrong input params: ${amountCoins} ${fromCoin.ticker} -> ${
+                        toCoin.ticker
+                    }, ${fromCoin instanceof Coin}, ${
+                        toCoin instanceof Coin
+                    }, ${typeof fixed} ${fixed}`
                 );
             }
             const fromCoinSwapspaceDetails = this._supportedCoins.find(
@@ -344,32 +357,57 @@ export class SwapspaceSwapProvider extends SwapProvider {
              * But we are better off using the most actual rates.
              */
             const response = await axios.get(
-                `${this._URL}/api/v2/amounts?fromCurrency=${fromCoinSwapspaceDetails.code}&fromNetwork=${fromCoinSwapspaceDetails.network}&toNetwork=${toCoinSwapspaceDetails.network}&toCurrency=${toCoinSwapspaceDetails.code}&amount=${amountCoins}&float=true&estimated=false`
+                `${this._URL}/api/v2/amounts?fromCurrency=${fromCoinSwapspaceDetails.code}&fromNetwork=${fromCoinSwapspaceDetails.network}&toNetwork=${toCoinSwapspaceDetails.network}&toCurrency=${toCoinSwapspaceDetails.code}&amount=${amountCoins}&estimated=false`
             );
             Logger.log(
                 `Retrieved ${response?.data?.length} options`,
                 loggerSource
             );
             const options = Array.isArray(response.data) ? response.data : [];
-            const exchangesSupportingThePair = options.filter(
-                (exchange) =>
-                    exchange?.exists &&
-                    !BANNED_PARTNERS.find(
-                        (bannedPartner) => bannedPartner === exchange?.partner
-                    ) &&
-                    exchange?.fixed === false &&
-                    (exchange.min === 0 ||
-                        exchange.max === 0 ||
-                        exchange.max > exchange.min ||
-                        ((typeof exchange.min !== "number" ||
-                            typeof exchange.max !== "number") &&
-                            exchange.toAmount > 0))
-            );
+            let exchangesSupportingThePairDespiteFixedOrFloating =
+                options.filter(
+                    (exchange) =>
+                        exchange?.exists &&
+                        !BANNED_PARTNERS.find(
+                            (bannedPartner) =>
+                                bannedPartner === exchange?.partner
+                        ) &&
+                        (exchange?.fixed === false ||
+                            exchange?.fixed === true) &&
+                        (exchange.min === 0 ||
+                            exchange.max === 0 ||
+                            exchange.max > exchange.min ||
+                            ((typeof exchange.min !== "number" ||
+                                typeof exchange.max !== "number") &&
+                                exchange.toAmount > 0))
+                );
+            let exchangesSupportingThePair =
+                exchangesSupportingThePairDespiteFixedOrFloating;
+            if (fixed != null) {
+                exchangesSupportingThePair =
+                    exchangesSupportingThePairDespiteFixedOrFloating.filter(
+                        (option) => option.fixed === fixed
+                    );
+            }
             Logger.log(
                 `${exchangesSupportingThePair?.length} of them have exist=true`,
                 loggerSource
             );
-            if (!exchangesSupportingThePair.length) {
+            if (exchangesSupportingThePair.length === 0) {
+                if (
+                    exchangesSupportingThePairDespiteFixedOrFloating.length >
+                        0 &&
+                    fixed !== null
+                ) {
+                    return {
+                        result: false,
+                        reason: fixed
+                            ? SwapProvider.NO_SWAPS_REASONS
+                                  .NO_FIXED_BUT_HAVE_FLOATING
+                            : SwapProvider.NO_SWAPS_REASONS
+                                  .NO_FLOATING_BUT_HAVE_FIXED,
+                    };
+                }
                 return {
                     result: false,
                     reason: SwapProvider.NO_SWAPS_REASONS.NOT_SUPPORTED,
@@ -491,6 +529,7 @@ export class SwapspaceSwapProvider extends SwapProvider {
                             ? AmountUtils.trim(rate, this._maxRateDigits)
                             : null,
                     durationMinutesRange: bestOpt.duration ?? null,
+                    fixed: bestOpt.fixed,
                     rawSwapData: bestOpt,
                 };
             }
@@ -535,6 +574,7 @@ export class SwapspaceSwapProvider extends SwapProvider {
         refundAddress,
         rawSwapData,
         clientIpAddress,
+        fixed,
         toCurrencyExtraId = "",
         refundExtraId = ""
     ) {
@@ -546,10 +586,13 @@ export class SwapspaceSwapProvider extends SwapProvider {
                 !(toCoin instanceof Coin) ||
                 typeof amount !== "string" ||
                 typeof toAddress !== "string" ||
-                typeof refundAddress !== "string"
+                typeof refundAddress !== "string" ||
+                typeof clientIpAddress != "string" ||
+                typeof fixed != "boolean" ||
+                clientIpAddress.length === 0
             ) {
                 throw new Error(
-                    `Invalid input: ${fromCoin} ${toCoin} ${amount} ${toAddress} ${refundAddress}`
+                    `Invalid input: ${fromCoin} ${toCoin} ${amount} ${toAddress} ${refundAddress} ${clientIpAddress?.length} ${fixed}`
                 );
             }
             if (
@@ -565,6 +608,18 @@ export class SwapspaceSwapProvider extends SwapProvider {
                 );
             }
 
+            const [fromCurrencyHasExtraId, toCurrencyHasExtraId] =
+                this._supportedCoins.reduce(
+                    (prev, coinData) => [
+                        coinData.coin.ticker === fromCoin.ticker
+                            ? coinData.hasExtraId
+                            : prev[0],
+                        coinData.coin.ticker === toCoin.ticker
+                            ? coinData.hasExtraId
+                            : prev[1],
+                    ],
+                    [false, false]
+                );
             await this._fetchSupportedCurrenciesIfNeeded();
             const requestData = {
                 partner: partner,
@@ -574,9 +629,12 @@ export class SwapspaceSwapProvider extends SwapProvider {
                 toNetwork: rawSwapData?.toNetwork,
                 address: toAddress,
                 amount: amount,
-                fixed: false,
-                extraId: toCurrencyExtraId ?? "",
-                refundExtraId: refundExtraId ?? "", // This param is not documented. But the refund is usually manual so this is not critical.
+                fixed: fixed,
+                extraId: toCurrencyHasExtraId ? toCurrencyExtraId ?? "" : "",
+                // This param is not documented. But the refund is usually manual so this is not critical.
+                refundExtraId: fromCurrencyHasExtraId
+                    ? refundExtraId ?? ""
+                    : "",
                 rateId: rawSwapData?.id,
                 userIp: clientIpAddress,
                 refund: refundAddress,
@@ -600,6 +658,7 @@ export class SwapspaceSwapProvider extends SwapProvider {
                 if (
                     typeof result?.from?.amount !== "number" ||
                     typeof result?.from?.address !== "string" ||
+                    typeof result?.fixed !== "boolean" ||
                     typeof result?.to?.amount !== "number" ||
                     typeof result?.to?.address !== "string"
                 )
@@ -632,6 +691,7 @@ export class SwapspaceSwapProvider extends SwapProvider {
                     toAddress: result?.to?.address,
                     fromCurrencyExtraId: result?.from?.extraId ?? "",
                     rate: AmountUtils.trim(rate, this._maxRateDigits),
+                    fixed: result.fixed,
                 };
             }
             const errorMessage = `Swap creation succeeded but the response is wrong: ${safeStringify(
@@ -785,6 +845,7 @@ export class SwapspaceSwapProvider extends SwapProvider {
                         expiresAt,
                         swap.confirmations,
                         AmountUtils.trim(swap.rate, this._maxRateDigits),
+                        swap.fixed,
                         swap.refundAddress,
                         addressToSendCoinsToSwapspace,
                         fromCoin,

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

@@ -11,6 +11,7 @@ export class BaseSwapCreationInfo {
      * @param max {string}
      * @param fiatMax {number}
      * @param durationMinutesRange {string}
+     * @param fixed {boolean}
      */
     constructor(
         fromCoin,
@@ -23,7 +24,8 @@ export class BaseSwapCreationInfo {
         fiatMin,
         max,
         fiatMax,
-        durationMinutesRange
+        durationMinutesRange,
+        fixed
     ) {
         this.fromCoin = fromCoin;
         this.toCoin = toCoin;
@@ -36,5 +38,6 @@ export class BaseSwapCreationInfo {
         this.max = max;
         this.fiatMax = fiatMax;
         this.durationMinutesRange = durationMinutesRange;
+        this.fixed = fixed;
     }
 }

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

@@ -6,6 +6,7 @@ export class ExistingSwap {
      * @param expiresAt {number}
      * @param confirmations {number}
      * @param rate {string}
+     * @param fixed {boolean}
      * @param refundAddress {string}
      * @param payToAddress {string}
      * @param fromCoin {Coin}
@@ -29,6 +30,7 @@ export class ExistingSwap {
         expiresAt,
         confirmations,
         rate,
+        fixed,
         refundAddress,
         payToAddress,
         fromCoin,
@@ -51,6 +53,7 @@ export class ExistingSwap {
         this.expiresAt = expiresAt;
         this.confirmations = confirmations;
         this.rate = rate;
+        this.fixed = fixed;
         this.refundAddress = refundAddress;
         this.payToAddress = payToAddress;
         this.fromCoin = fromCoin;

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

@@ -8,6 +8,7 @@ export class ExistingSwapWithFiatData extends ExistingSwap {
      * @param expiresAt {number}
      * @param confirmations {number}
      * @param rate {string}
+     * @param fixed {boolean}
      * @param refundAddress {string}
      * @param payToAddress {string}
      * @param fromCoin {Coin}
@@ -35,6 +36,7 @@ export class ExistingSwapWithFiatData extends ExistingSwap {
         expiresAt,
         confirmations,
         rate,
+        fixed,
         refundAddress,
         payToAddress,
         fromCoin,
@@ -62,6 +64,7 @@ export class ExistingSwapWithFiatData extends ExistingSwap {
             expiresAt,
             confirmations,
             rate,
+            fixed,
             refundAddress,
             payToAddress,
             fromCoin,
@@ -106,6 +109,7 @@ export class ExistingSwapWithFiatData extends ExistingSwap {
             existingSwap.expiresAt,
             existingSwap.confirmations,
             existingSwap.rate,
+            existingSwap.fixed,
             existingSwap.refundAddress,
             existingSwap.payToAddress,
             existingSwap.fromCoin,

package/src/swaps-lib/services/publicSwapService.js

@@ -23,6 +23,10 @@ export class PublicSwapService {
         AMOUNT_LESS_THAN_MIN_SWAPPABLE: "amountLessThanMinSwappable",
         AMOUNT_HIGHER_THAN_MAX_SWAPPABLE: "amountHigherThanMaxSwappable",
         PAIR_NOT_SUPPORTED: "pairNotSupported",
+        NO_FIXED_BUT_HAVE_FLOATING_PUBLIC_SWAP_OPTION:
+            "noFixedButHaveFloatingPublicSwapOption",
+        NO_FLOATING_BUT_HAVE_FIXED_PUBLIC_SWAP_OPTION:
+            "noFloatingButHaveFixedPublicSwapOption",
     };
 
     static _fiatDecimalsCount =
@@ -173,6 +177,7 @@ export class PublicSwapService {
      * @param fromCoin {Coin}
      * @param toCoin {Coin}
      * @param fromAmountCoins {string}
+     * @param [fixed=false] {boolean|null} null means fixed or float doesn't matter
      * @param [withoutFiat=false] {boolean} pass true if you don't need the fiat equivalent - this will diminish requests count
      * @return {Promise<{
      *             result: false,
@@ -191,6 +196,7 @@ export class PublicSwapService {
         fromCoin,
         toCoin,
         fromAmountCoins,
+        fixed = false,
         withoutFiat = false
     ) {
         const loggerSource = "getPublicSwapDetails";
@@ -203,6 +209,7 @@ export class PublicSwapService {
                 fromCoin,
                 toCoin,
                 fromAmountCoins,
+                fixed,
                 coinUsdtRate
             );
             const min = details.result ? details.min : details.smallestMin;
@@ -236,12 +243,12 @@ export class PublicSwapService {
                 if (
                     details?.reason ===
                     SwapProvider.NO_SWAPS_REASONS.NOT_SUPPORTED
-                )
+                ) {
                     return composeFailResult(
                         PublicSwapService.PUBLIC_SWAP_DETAILS_FAIL_REASONS
                             .PAIR_NOT_SUPPORTED
                     );
-                else if (
+                } else if (
                     details?.reason ===
                     SwapProvider.COMMON_ERRORS.REQUESTS_LIMIT_EXCEEDED
                 ) {
@@ -250,6 +257,22 @@ export class PublicSwapService {
                         PublicSwapService.PUBLIC_SWAPS_COMMON_ERRORS
                             .REQUESTS_LIMIT_EXCEEDED
                     );
+                } else if (
+                    details?.reason ===
+                    SwapProvider.NO_SWAPS_REASONS.NO_FLOATING_BUT_HAVE_FIXED
+                ) {
+                    return composeFailResult(
+                        PublicSwapService.PUBLIC_SWAP_DETAILS_FAIL_REASONS
+                            .NO_FLOATING_BUT_HAVE_FIXED_PUBLIC_SWAP_OPTION
+                    );
+                } else if (
+                    details?.reason ===
+                    SwapProvider.NO_SWAPS_REASONS.NO_FIXED_BUT_HAVE_FLOATING
+                ) {
+                    return composeFailResult(
+                        PublicSwapService.PUBLIC_SWAP_DETAILS_FAIL_REASONS
+                            .NO_FIXED_BUT_HAVE_FLOATING_PUBLIC_SWAP_OPTION
+                    );
                 }
             }
 
@@ -283,7 +306,8 @@ export class PublicSwapService {
                     fiatMin,
                     max,
                     fiatMax,
-                    details.durationMinutesRange
+                    details.durationMinutesRange,
+                    details.fixed
                 ),
             };
             Logger.log(
@@ -330,7 +354,8 @@ export class PublicSwapService {
      *             fromCoin: Coin,
      *             rate: string,
      *             swapId: string,
-     *             fromCurrencyExtraId: string
+     *             fromCurrencyExtraId: string,
+     *             fixed: boolean
      *         }|{
      *             result: false,
      *             reason: string
@@ -380,6 +405,7 @@ export class PublicSwapService {
                 refundAddress,
                 swapCreationInfo.rawSwapData,
                 clientIp,
+                swapCreationInfo.fixed,
                 toCurrencyExtraId,
                 refundExtraId
             );
@@ -442,6 +468,7 @@ export class PublicSwapService {
                     );
                 }
 
+                // TODO: feature, cirtical] add GA event. task_id=tbd
                 EventBusInstance.dispatch(
                     PublicSwapService.PUBLIC_SWAP_CREATED_EVENT,
                     null,
@@ -465,6 +492,7 @@ export class PublicSwapService {
                     durationMinutesRange: swapCreationInfo.durationMinutesRange,
                     address: result.fromAddress, // CRITICAL: this is the address to send coins to swaps provider
                     fromCurrencyExtraId: result.fromCurrencyExtraId ?? "", // CRITICAL: this is the extra ID for address to send coins to swaps provider
+                    fixed: result.fixed,
                 };
 
                 this._savePublicSwapIdLocally(result.swapId);