@rabbitio/ui-kit 1.0.0-beta.11 → 1.0.0-beta.111

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

@@ -0,0 +1,78 @@
+export class BaseSwapCreationInfo {
+    /** @type {Coin} */
+    fromCoin;
+    /** @type {Coin} */
+    toCoin;
+    /** @type {string} */
+    fromAmountCoins;
+    /** @type {string} */
+    toAmountCoins;
+    /** @type {string} */
+    rate;
+    /** @type {Object} */
+    rawSwapData;
+    /** @type {string} */
+    min;
+    /** @type {number} */
+    fiatMin;
+    /** @type {string} */
+    max;
+    /** @type {number} */
+    fiatMax;
+    /** @type {string} */
+    durationMinutesRange;
+    /** @type {boolean} */
+    fixed;
+    /** @type {string|null} */
+    partner;
+    /** @type {boolean} */
+    isRefundAddressRequired;
+
+    /**
+     * @param fromCoin {Coin}
+     * @param toCoin {Coin}
+     * @param fromAmountCoins {string}
+     * @param toAmountCoins {string}
+     * @param rate {string}
+     * @param rawSwapData {Object}
+     * @param min {string}
+     * @param fiatMin {number}
+     * @param max {string}
+     * @param fiatMax {number}
+     * @param durationMinutesRange {string}
+     * @param fixed {boolean}
+     * @param partner {string|null} rabbit partner id
+     * @param [isRefundAddressRequired=false] {boolean}
+     */
+    constructor(
+        fromCoin,
+        toCoin,
+        fromAmountCoins,
+        toAmountCoins,
+        rate,
+        rawSwapData,
+        min,
+        fiatMin,
+        max,
+        fiatMax,
+        durationMinutesRange,
+        fixed,
+        partner = null,
+        isRefundAddressRequired = false
+    ) {
+        this.fromCoin = fromCoin;
+        this.toCoin = toCoin;
+        this.fromAmountCoins = fromAmountCoins;
+        this.toAmountCoins = toAmountCoins;
+        this.rate = rate;
+        this.rawSwapData = rawSwapData;
+        this.min = min;
+        this.fiatMin = fiatMin;
+        this.max = max;
+        this.fiatMax = fiatMax;
+        this.durationMinutesRange = durationMinutesRange;
+        this.fixed = fixed;
+        this.partner = partner;
+        this.isRefundAddressRequired = isRefundAddressRequired;
+    }
+}

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

@@ -1,20 +1,97 @@
+/**
+ * Represents an existing swap.
+ */
 export class ExistingSwap {
+    /** @type {string} The ID of the swap. */
+    swapId;
+
+    /** @type {SwapProvider.SWAP_STATUSES} The status of the swap. */
+    status;
+
+    /** @type {number} The timestamp when the swap was created. */
+    createdAt;
+
+    /** @type {number} The timestamp when the swap expires. */
+    expiresAt;
+
+    /** @type {number|null} The number of confirmations the swap has received, or null if not applicable. */
+    confirmations;
+
+    /** @type {string} The exchange rate for the swap. */
+    rate;
+
+    /** @type {boolean} Whether the rate is fixed. */
+    fixed;
+
+    /** @type {string|null} The refund address in case the swap fails, or null if not applicable. */
+    refundAddress;
+
+    /** @type {string} The address to send the payment to. */
+    payToAddress;
+
+    /** @type {Coin} The coin from which the swap is made. */
+    fromCoin;
+
+    /** @type {string} The amount of the fromCoin being swapped. */
+    fromAmount;
+
+    /** @type {string|null} The transaction ID for the fromCoin, or null if not applicable. */
+    fromTransactionId;
+
+    /** @type {string|null} The link to view the fromCoin transaction, or null if not applicable. */
+    fromTransactionLink;
+
+    /** @type {Coin} The coin to which the swap is made. */
+    toCoin;
+
+    /** @type {string} The amount of the toCoin received. */
+    toAmount;
+
+    /** @type {string|null} The transaction ID for the toCoin, or null if not applicable. */
+    toTransactionId;
+
+    /** @type {string|null} The link to view the toCoin transaction, or null if not applicable. */
+    toTransactionLink;
+
+    /** @type {string} The address to send the swapped toCoin to. */
+    toAddress;
+
+    /** @type {string|null} The partner associated with the swap, or null if not applicable. */
+    partner;
+
+    /** @type {string|null} Extra identifier for the fromCoin, or null if not applicable. */
+    fromExtraId;
+
+    /** @type {string|null} Extra identifier for the toCoin, or null if not applicable. */
+    toExtraId;
+
+    /** @type {string|null} Extra identifier for refund, or null if not applicable. */
+    refundExtraId;
+
     /**
-     * @param swapId {string}
-     * @param status {SwapProvider.SWAP_STATUSES}
-     * @param createdAt {number}
-     * @param expiresAt {number}
-     * @param confirmations {number}
-     * @param rate {string}
-     * @param refundAddress {string}
-     * @param fromCoin {Coin}
-     * @param fromAmount {string}
-     * @param fromTransactionId {string}
-     * @param toCoin {Coin}
-     * @param toAmount {string}
-     * @param toTransactionId {string|null}
-     * @param toAddress {string}
-     * @param partner {string}
+     * @constructor
+     * @param {string} swapId - The ID of the swap.
+     * @param {SwapProvider.SWAP_STATUSES} status - The status of the swap.
+     * @param {number} createdAt - The timestamp when the swap was created.
+     * @param {number} expiresAt - The timestamp when the swap expires.
+     * @param {number|null} confirmations - The number of confirmations the swap has received, or null.
+     * @param {string} rate - The exchange rate for the swap.
+     * @param {null} fixed - Indicates if the rate is fixed.
+     * @param {string|null} refundAddress - The address to refund to in case of failure, or null.
+     * @param {string} payToAddress - The address to send the funds to.
+     * @param {Coin} fromCoin - The coin that is being swapped from.
+     * @param {string} fromAmount - The amount of the coin being swapped from.
+     * @param {string|null} fromTransactionId - The transaction ID for the fromCoin, or null.
+     * @param {string|null} fromTransactionLink - The link to view the fromCoin transaction, or null.
+     * @param {Coin} toCoin - The coin that is being swapped to.
+     * @param {string} toAmount - The amount of the coin being swapped to.
+     * @param {string|null} toTransactionId - The transaction ID for the toCoin, or null.
+     * @param {string|null} toTransactionLink - The link to view the toCoin transaction, or null.
+     * @param {string} toAddress - The address to send the swapped coin to.
+     * @param {string|null} partner - The partner associated with the swap, or null.
+     * @param {string|null} fromExtraId - Any extra ID related to the fromCoin, or null.
+     * @param {string|null} toExtraId - Any extra ID related to the toCoin, or null.
+     * @param {string|null} refundExtraId - Any extra ID related to the refund, or null.
      */
     constructor(
         swapId,
@@ -23,6 +100,7 @@ export class ExistingSwap {
         expiresAt,
         confirmations,
         rate,
+        fixed,
         refundAddress,
         payToAddress,
         fromCoin,
@@ -34,7 +112,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;
@@ -42,6 +123,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;
@@ -54,5 +136,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

@@ -0,0 +1,148 @@
+import { ExistingSwap } from "./existingSwap.js";
+
+/**
+ * @class ExistingSwapWithFiatData
+ * @extends {ExistingSwap}
+ * @description Represents a swap with additional fiat currency data.
+ */
+export class ExistingSwapWithFiatData extends ExistingSwap {
+    /** @type {number|null} The fiat equivalent of the fromAmount. */
+    fromAmountFiat;
+
+    /** @type {number|null} The fiat equivalent of the toAmount. */
+    toAmountFiat;
+
+    /** @type {string} The fiat currency code (e.g., USD, EUR). */
+    fiatCurrencyCode;
+
+    /** @type {number} The number of decimals for the fiat currency. */
+    fiatCurrencyDecimals;
+
+    /**
+     * @constructor
+     * @param {string} swapId - The ID of the swap.
+     * @param {SwapProvider.SWAP_STATUSES} status - The status of the swap.
+     * @param {number} createdAt - The timestamp when the swap was created.
+     * @param {number} expiresAt - The timestamp when the swap expires.
+     * @param {number|null} confirmations - The number of confirmations the swap has received.
+     * @param {string} rate - The exchange rate for the swap.
+     * @param {boolean} fixed - Indicates if the rate is fixed.
+     * @param {string|null} refundAddress - The address to refund to in case of failure.
+     * @param {string} payToAddress - The address to send the funds to.
+     * @param {Coin} fromCoin - The coin that is being swapped from.
+     * @param {string} fromAmount - The amount of the coin being swapped from.
+     * @param {string|null} fromTransactionId - The transaction ID for the fromCoin.
+     * @param {string|null} fromTransactionLink - The link to view the fromCoin transaction.
+     * @param {Coin} toCoin - The coin that is being swapped to.
+     * @param {string} toAmount - The amount of the coin being swapped to.
+     * @param {string|null} toTransactionId - The transaction ID for the toCoin.
+     * @param {string|null} toTransactionLink - The link to view the toCoin transaction.
+     * @param {string} toAddress - The address to send the swapped coin to.
+     * @param {string|null} partner - The partner id associated with the swap.
+     * @param {string|null} fromExtraId - Any extra ID related to the fromCoin.
+     * @param {string|null} toExtraId - Any extra ID related to the toCoin.
+     * @param {string|null} refundExtraId - Any extra ID related to the refund.
+     * @param {number|null} fromAmountFiat - The fiat equivalent of the fromAmount.
+     * @param {number|null} toAmountFiat - The fiat equivalent of the toAmount.
+     * @param {string} fiatCurrencyCode - The fiat currency code (e.g., USD, EUR).
+     * @param {number} fiatCurrencyDecimals - The number of decimals for the fiat currency.
+     */
+    constructor(
+        swapId,
+        status,
+        createdAt,
+        expiresAt,
+        confirmations,
+        rate,
+        fixed,
+        refundAddress,
+        payToAddress,
+        fromCoin,
+        fromAmount,
+        fromTransactionId,
+        fromTransactionLink,
+        toCoin,
+        toAmount,
+        toTransactionId,
+        toTransactionLink,
+        toAddress,
+        partner,
+        fromExtraId,
+        toExtraId,
+        refundExtraId,
+        fromAmountFiat,
+        toAmountFiat,
+        fiatCurrencyCode,
+        fiatCurrencyDecimals
+    ) {
+        super(
+            swapId,
+            status,
+            createdAt,
+            expiresAt,
+            confirmations,
+            rate,
+            fixed,
+            refundAddress,
+            payToAddress,
+            fromCoin,
+            fromAmount,
+            fromTransactionId,
+            fromTransactionLink,
+            toCoin,
+            toAmount,
+            toTransactionId,
+            toTransactionLink,
+            toAddress,
+            partner,
+            fromExtraId,
+            toExtraId,
+            refundExtraId
+        );
+        this.fromAmountFiat = fromAmountFiat;
+        this.toAmountFiat = toAmountFiat;
+        this.fiatCurrencyCode = fiatCurrencyCode;
+        this.fiatCurrencyDecimals = fiatCurrencyDecimals;
+    }
+
+    /**
+     * Creates an instance of ExistingSwapWithFiatData from an ExistingSwap.
+     * @static
+     * @param {ExistingSwap} existingSwap - The existing swap data.
+     * @param {number|null} fromAmountFiat - The fiat equivalent of the fromAmount.
+     * @param {number|null} toAmountFiat - The fiat equivalent of the toAmount.
+     * @param {string} fiatCurrencyCode - The fiat currency code (e.g., USD, EUR).
+     * @param {number} fiatCurrencyDecimals - The number of decimals for the fiat currency.
+     * @returns {ExistingSwapWithFiatData} A new instance of ExistingSwapWithFiatData.
+     */
+    static fromExistingSwap(existingSwap, fromAmountFiat, toAmountFiat, fiatCurrencyCode, fiatCurrencyDecimals) {
+        return new ExistingSwapWithFiatData(
+            existingSwap.swapId,
+            existingSwap.status,
+            existingSwap.createdAt,
+            existingSwap.expiresAt,
+            existingSwap.confirmations,
+            existingSwap.rate,
+            existingSwap.fixed,
+            existingSwap.refundAddress,
+            existingSwap.payToAddress,
+            existingSwap.fromCoin,
+            existingSwap.fromAmount,
+            existingSwap.fromTransactionId,
+            existingSwap.fromTransactionLink,
+            existingSwap.toCoin,
+            existingSwap.toAmount,
+            existingSwap.toTransactionId,
+            existingSwap.toTransactionLink,
+            existingSwap.toAddress,
+            existingSwap.partner,
+            existingSwap.fromExtraId,
+            existingSwap.toExtraId,
+            existingSwap.refundExtraId,
+            fromAmountFiat,
+            toAmountFiat,
+            fiatCurrencyCode,
+            fiatCurrencyDecimals
+        );
+    }
+}

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

@@ -0,0 +1,27 @@
+export class Partner {
+    /**
+     * Rabbit id for partner.
+     *
+     * @type {string}
+     * */
+    id;
+    /** @type {string} */
+    name;
+    /** @type {string|undefined|null} */
+    logoUrl;
+    /** @type {string|null} */
+    kycLevel;
+
+    constructor(id, name, logoUrl, kycLevel = null) {
+        this.id = id;
+        this.name = name;
+        this.logoUrl = logoUrl;
+        this.kycLevel = Object.values(KYC_LEVELS).find(level => level === (kycLevel ?? "").toLowerCase()) ?? null;
+    }
+}
+
+export const KYC_LEVELS = {
+    LOW: "low",
+    MEDIUM: "medium",
+    HIGH: "high",
+};

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

@@ -0,0 +1,82 @@
+import { FALLBACK_ASSET_ICON_URL } from "../../common-apis/globalConstants.jsx";
+
+/**
+ * construction rules:
+ * 1. Coin class ticker should be built using toRabbitTicker function
+ * 2. name should not contain (PROTOCOL_CODE) or just PROTOCOL_CODe
+ * 3. protocol should be null for coins major for their blockchains like BTC, ETH
+ * 4. isPopular should be a number - the higher -> the more popular
+ */
+export class SwapProviderCoinInfo {
+    /** @type {Coin} */
+    coin;
+
+    /** @type {string} */
+    code;
+
+    /** @type {string} */
+    network;
+
+    /** @type {boolean} */
+    hasExtraId;
+
+    /** @type {string|null} */
+    extraIdName;
+
+    /** @type {number} */
+    isPopular;
+
+    /** @type {string} */
+    iconURL;
+
+    /** @type {boolean} */
+    deposit;
+
+    /** @type {boolean} */
+    withdrawal;
+
+    /** @type {string|null} */
+    validationRegexp;
+
+    /** @type {boolean} */
+    isAvailable;
+
+    /**
+     * @param {Coin} coin
+     * @param {string} code - The ticker code raw as in the provider
+     * @param {string} network - The network raw as in the provider
+     * @param {boolean} hasExtraId - Whether the coin requires an extra ID for transactions.
+     * @param {string|null} extraIdName - The name of the extra ID, if applicable.
+     * @param {number} popularity - A number indicating the popularity of the coin.
+     * @param {string} iconURL - The URL of the coin's icon.
+     * @param {boolean} [deposit=false] - Indicates whether deposits are supported. Defaults to `false`.
+     * @param {boolean} [withdrawal=false] - Indicates whether withdrawals are supported. Defaults to `false`.
+     * @param {string|null} [validationRegexp=null] - A regular expression for validating addresses, if applicable.
+     * @param {boolean} [isAvailable=true] - Whether the coin is available for transactions. Defaults to `true`.
+     */
+    constructor(
+        coin,
+        code,
+        network,
+        hasExtraId,
+        extraIdName,
+        popularity,
+        iconURL,
+        deposit,
+        withdrawal,
+        validationRegexp,
+        isAvailable
+    ) {
+        this.coin = coin;
+        this.code = code;
+        this.network = network;
+        this.hasExtraId = hasExtraId;
+        this.extraIdName = extraIdName;
+        this.isPopular = popularity;
+        this.iconURL = iconURL ?? FALLBACK_ASSET_ICON_URL;
+        this.deposit = deposit ?? false;
+        this.withdrawal = withdrawal ?? false;
+        this.validationRegexp = validationRegexp ?? null;
+        this.isAvailable = isAvailable ?? true;
+    }
+}