@rabbitio/ui-kit 1.0.0-beta.32 → 1.0.0-beta.34

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@rabbitio/ui-kit",
-    "version": "1.0.0-beta.32",
+    "version": "1.0.0-beta.34",
     "description": "Rabbit.io react.js components kit",
     "type": "module",
     "main": "./dist/index.cjs",

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

@@ -130,6 +130,8 @@ export class SwapProvider {
      * @param refundAddress {string}
      * @param rawSwapData {Object|null}
      * @param clientIpAddress {string}
+     * @param [toCurrencyExtraId=""] {string} optional extra ID
+     * @param [refundExtraId=""] {string} optional extra ID for refund address
      * @return {Promise<({
      *                     result: true,
      *                     swapId: string,
@@ -139,7 +141,8 @@ export class SwapProvider {
      *                     toCoin: Coin,
      *                     toAmount: string,
      *                     toAddress: string,
-     *                     rate: string
+     *                     rate: string,
+     *                     fromCurrencyExtraId: string|undefined
      *                 }|{
      *                     result: false,
      *                     reason: string,
@@ -153,7 +156,9 @@ export class SwapProvider {
         toAddress,
         refundAddress,
         rawSwapData = null,
-        clientIpAddress
+        clientIpAddress,
+        toCurrencyExtraId = "",
+        refundExtraId = ""
     ) {
         throw new Error("Not implemented in base");
     }
@@ -185,4 +190,12 @@ export class SwapProvider {
     isAddressValidForAsset(asset, address) {
         throw new Error("Not implemented in base");
     }
+
+    /**
+     * @param asset {Coin}
+     * @return {string|null}
+     */
+    getExtraIdNameIfPresent(asset) {
+        throw new Error("Not implemented in base");
+    }
 }

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

@@ -22,7 +22,7 @@ export class SwapspaceSwapProvider extends SwapProvider {
     ) {
         super();
         this._supportedCoins = [];
-        this._URL = `${apiKeysProxyUrl}`;
+        this._URL = `${apiKeysProxyUrl}/swapspace`;
         this._maxRateDigits = 20;
         this.useRestrictedCoinsSet = useRestrictedCoinsSet;
         this._customCoinBuilder = customCoinBuilder;
@@ -148,10 +148,6 @@ export class SwapspaceSwapProvider extends SwapProvider {
                     loggerSource
                 );
                 let allowedCoins = rawResponse?.data ?? [];
-                // TODO: [feature, critical] add support for extra ID. task_id=7219d65d41c242a292dfa47479b8d63f
-                allowedCoins = allowedCoins.filter(
-                    (c) => c.hasExtraId !== true && c.hasExtraId !== "true"
-                );
                 Logger.log(`Allowed cnt ${allowedCoins.length}`, loggerSource);
 
                 this._supportedCoins = allowedCoins
@@ -201,7 +197,8 @@ export class SwapspaceSwapProvider extends SwapProvider {
                                 coin: coin,
                                 code: item.code,
                                 network: item.network,
-                                extraId: item.extraIdName,
+                                hasExtraId: item.hasExtraId,
+                                extraIdName: item.extraIdName,
                                 isPopular: !!item?.popular,
                                 iconURL: item.icon
                                     ? `https://storage.swapspace.co${item.icon}`
@@ -537,7 +534,9 @@ export class SwapspaceSwapProvider extends SwapProvider {
         toAddress,
         refundAddress,
         rawSwapData,
-        clientIpAddress
+        clientIpAddress,
+        toCurrencyExtraId = "",
+        refundExtraId = ""
     ) {
         const loggerSource = "createSwap";
         const partner = rawSwapData?.partner;
@@ -567,10 +566,6 @@ export class SwapspaceSwapProvider extends SwapProvider {
             }
 
             await this._fetchSupportedCurrenciesIfNeeded();
-            const toCurrencyExtraId =
-                this._supportedCoins.find(
-                    (item) => item.coin?.ticker === toCoin?.ticker
-                )?.extraId ?? "";
             const requestData = {
                 partner: partner,
                 fromCurrency: rawSwapData?.fromCurrency,
@@ -581,6 +576,7 @@ export class SwapspaceSwapProvider extends SwapProvider {
                 amount: amount,
                 fixed: false,
                 extraId: toCurrencyExtraId ?? "",
+                refundExtraId: refundExtraId ?? "", // This param is not documented. But the refund is usually manual so this is not critical.
                 rateId: rawSwapData?.id,
                 userIp: clientIpAddress,
                 refund: refundAddress,
@@ -634,6 +630,7 @@ export class SwapspaceSwapProvider extends SwapProvider {
                         toCoin.digits
                     ),
                     toAddress: result?.to?.address,
+                    fromCurrencyExtraId: result?.from?.extraId ?? "",
                     rate: AmountUtils.trim(rate, this._maxRateDigits),
                 };
             }
@@ -799,7 +796,10 @@ export class SwapspaceSwapProvider extends SwapProvider {
                         swap.to.transactionHash,
                         swap.blockExplorerTransactionUrl.to,
                         swap.to.address,
-                        swap.partner
+                        swap.partner,
+                        swap.from.extraId ?? null,
+                        swap.to.extraId ?? null,
+                        swap.refundExtraId ?? null
                     );
                 })
                 .flat();
@@ -853,4 +853,15 @@ export class SwapspaceSwapProvider extends SwapProvider {
         }
         return false;
     }
+
+    getExtraIdNameIfPresent(asset) {
+        try {
+            const assetData = this._supportedCoins.find(
+                (i) => i.coin?.ticker === asset?.ticker
+            );
+            return assetData?.hasExtraId ? assetData?.extraIdName : null;
+        } catch (e) {
+            improveAndRethrow(e, "getExtraIdNameIfPresent");
+        }
+    }
 }

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

@@ -7,14 +7,20 @@ export class ExistingSwap {
      * @param confirmations {number}
      * @param rate {string}
      * @param refundAddress {string}
+     * @param payToAddress {string}
      * @param fromCoin {Coin}
      * @param fromAmount {string}
      * @param fromTransactionId {string}
+     * @param fromTransactionLink {string}
      * @param toCoin {Coin}
      * @param toAmount {string}
      * @param toTransactionId {string|null}
+     * @param toTransactionLink {string}
      * @param toAddress {string}
      * @param partner {string}
+     * @param fromExtraId {string}
+     * @param toExtraId {string}
+     * @param refundExtraId {string}
      */
     constructor(
         swapId,
@@ -34,7 +40,10 @@ export class ExistingSwap {
         toTransactionId,
         toTransactionLink,
         toAddress, // TODO: [refactoring, moderate] toAddress is not quite clear. How about recipientAddress? task_id=0815a111c99543b78d374217eadbde4f
-        partner
+        partner,
+        fromExtraId,
+        toExtraId,
+        refundExtraId
     ) {
         this.swapId = swapId;
         this.status = status;
@@ -54,5 +63,8 @@ export class ExistingSwap {
         this.toAmount = toAmount;
         this.toAddress = toAddress;
         this.partner = partner;
+        this.fromExtraId = fromExtraId;
+        this.toExtraId = toExtraId;
+        this.refundExtraId = refundExtraId;
     }
 }

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

@@ -9,14 +9,20 @@ export class ExistingSwapWithFiatData extends ExistingSwap {
      * @param confirmations {number}
      * @param rate {string}
      * @param refundAddress {string}
+     * @param payToAddress {string}
      * @param fromCoin {Coin}
      * @param fromAmount {string}
      * @param fromTransactionId {string}
+     * @param fromTransactionLink {string}
      * @param toCoin {Coin}
      * @param toAmount {string}
      * @param toTransactionId {string|null}
+     * @param toTransactionLink
      * @param toAddress {string}
      * @param partner {string}
+     * @param fromExtraId {string}
+     * @param toExtraId {string}
+     * @param refundExtraId {string}
      * @param fromAmountFiat {number}
      * @param toAmountFiat {number}
      * @param fiatCurrencyCode {string}
@@ -41,6 +47,9 @@ export class ExistingSwapWithFiatData extends ExistingSwap {
         toTransactionLink,
         toAddress,
         partner,
+        fromExtraId,
+        toExtraId,
+        refundExtraId,
         fromAmountFiat,
         toAmountFiat,
         fiatCurrencyCode,
@@ -64,7 +73,10 @@ export class ExistingSwapWithFiatData extends ExistingSwap {
             toTransactionId,
             toTransactionLink,
             toAddress,
-            partner
+            partner,
+            fromExtraId,
+            toExtraId,
+            refundExtraId
         );
         this.fromAmountFiat = fromAmountFiat;
         this.toAmountFiat = toAmountFiat;
@@ -106,6 +118,9 @@ export class ExistingSwapWithFiatData extends ExistingSwap {
             existingSwap.toTransactionLink,
             existingSwap.toAddress,
             existingSwap.partner,
+            existingSwap.fromExtraId,
+            existingSwap.toExtraId,
+            existingSwap.refundExtraId,
             fromAmountFiat,
             toAmountFiat,
             fiatCurrencyCode,

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

@@ -173,6 +173,7 @@ export class PublicSwapService {
      * @param fromCoin {Coin}
      * @param toCoin {Coin}
      * @param fromAmountCoins {string}
+     * @param [withoutFiat=false] {boolean} pass true if you don't need the fiat equivalent - this will diminish requests count
      * @return {Promise<{
      *             result: false,
      *             reason: string,
@@ -186,12 +187,18 @@ export class PublicSwapService {
      *             swapCreationInfo: BaseSwapCreationInfo
      *         }>}
      */
-    async getPublicSwapDetails(fromCoin, toCoin, fromAmountCoins) {
+    async getPublicSwapDetails(
+        fromCoin,
+        toCoin,
+        fromAmountCoins,
+        withoutFiat = false
+    ) {
         const loggerSource = "getPublicSwapDetails";
         try {
-            const coinUsdtRate =
-                (await this._swapProvider.getCoinToUSDTRate(fromCoin))?.rate ??
-                null;
+            const coinUsdtRate = withoutFiat
+                ? null
+                : (await this._swapProvider.getCoinToUSDTRate(fromCoin))
+                      ?.rate ?? null;
             const details = await this._swapProvider.getSwapInfo(
                 fromCoin,
                 toCoin,
@@ -307,6 +314,8 @@ export class PublicSwapService {
      * @param toAddress {string}
      * @param refundAddress {string}
      * @param clientIp {string}
+     * @param [toCurrencyExtraId] {string}
+     * @param [refundExtraId] {string}
      * @return {Promise<{
      *             result: true,
      *             fiatCurrencyCode: string,
@@ -320,7 +329,8 @@ export class PublicSwapService {
      *             fiatCurrencyDecimals: number,
      *             fromCoin: Coin,
      *             rate: string,
-     *             swapId: string
+     *             swapId: string,
+     *             fromCurrencyExtraId: string
      *         }|{
      *             result: false,
      *             reason: string
@@ -333,7 +343,9 @@ export class PublicSwapService {
         swapCreationInfo,
         toAddress,
         refundAddress,
-        clientIp
+        clientIp,
+        toCurrencyExtraId,
+        refundExtraId
     ) {
         const loggerSource = "createPublicSwap";
         try {
@@ -367,7 +379,9 @@ export class PublicSwapService {
                 toAddress,
                 refundAddress,
                 swapCreationInfo.rawSwapData,
-                clientIp
+                clientIp,
+                toCurrencyExtraId,
+                refundExtraId
             );
             Logger.log(
                 `Created:${safeStringify({
@@ -450,6 +464,7 @@ export class PublicSwapService {
                     rate: result.rate,
                     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
                 };
 
                 this._savePublicSwapIdLocally(result.swapId);
@@ -644,4 +659,16 @@ export class PublicSwapService {
         }
         return null;
     }
+
+    /**
+     * @param asset {Coin}
+     * @return {string|null}
+     */
+    getExtraIdNameIfPresentForAsset(asset) {
+        try {
+            return this._swapProvider.getExtraIdNameIfPresent(asset);
+        } catch (e) {
+            improveAndRethrow(e, "getExtraIdNameIfPresentForAsset");
+        }
+    }
 }