@rabbitio/ui-kit 1.0.0-beta.7 → 1.0.0-beta.70

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

@@ -0,0 +1,208 @@
+export class SwapProvider {
+    static COMMON_ERRORS = {
+        REQUESTS_LIMIT_EXCEEDED: "requestsLimitExceeded",
+    };
+
+    static NO_SWAPS_REASONS = {
+        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 = {
+        RETRIABLE_FAIL: "retriableFail",
+    };
+
+    static SWAP_STATUSES = {
+        WAITING_FOR_PAYMENT: "waiting_for_payment", // public +
+        CONFIRMING: "confirming",
+        PAYMENT_RECEIVED: "payment_received", // public +
+        EXCHANGING: "exchanging", // session full // public +
+        COMPLETED: "completed", // session full  // public +
+        REFUNDED: "refunded", // session full  // public +
+        EXPIRED: "expired", // public +
+        FAILED: "failed", // public +
+    };
+
+    /**
+     * @return {Promise<void>}
+     */
+    async initialize() {
+        throw new Error("Not implemented in base");
+    }
+
+    /**
+     * @return {number} milliseconds TTL
+     */
+    getSwapCreationInfoTtlMs() {
+        throw new Error("Not implemented in base");
+    }
+
+    /**
+     * Retrieves all currencies supported by this swap provider.
+     * Returns one of SwapProvider.COMMON_ERRORS in case of processable fail.
+     *
+     * @return {Promise<({ result: true, coins: Coin[] }|{ result: false, reason: string })>}
+     */
+    async getAllSupportedCurrencies() {
+        throw new Error("Not implemented in base");
+    }
+
+    /**
+     * Retrieves all deposit currencies supported by this swap provider.
+     * Returns one of SwapProvider.COMMON_ERRORS in case of processable fail.
+     *
+     * @return {Promise<({ result: true, coins: Coin[] }|{ result: false, reason: string })>}
+     */
+    async getDepositCurrencies() {
+        throw new Error("Not implemented in base");
+    }
+
+    /**
+     * Retrieves all withdrawable currencies supported by this swap provider.
+     * Returns one of SwapProvider.COMMON_ERRORS in case of processable fail.
+     *
+     * @param [exceptCurrency=null] {Coin|null}
+     * @return {Promise<({ result: true, coins: Coin[] }|{ result: false, reason: string })>}
+     */
+    async getWithdrawalCurrencies(exceptCurrency = null) {
+        throw new Error("Not implemented in base");
+    }
+
+    /**
+     * Retrieves URL for coin icon or fallback if not found.
+     *
+     * @param coin {Coin|string} coin or rabbit-format of coin ticker
+     * @return {string}
+     */
+    getIconUrl(coin) {
+        throw new Error("Not implemented in base");
+    }
+
+    /**
+     * Retrieves coin to USDT rate.
+     *
+     * @param coin {Coin}
+     * @return {{result: true, rate: string}|{result: false}}
+     */
+    async getCoinToUSDTRate(coin) {
+        throw new Error("Not implemented in base");
+    }
+
+    /**
+     * Retrieves estimation for swapping giving coins amount.
+     * null min or max signals there is no corresponding limitation. undefined means that the limits were not retrieved.
+     * For fail result on of SwapProvider.NO_SWAPS_REASONS or SwapProvider.COMMON_ERRORS reasons will be returned.
+     *
+     * WARNING: MUST return NOT_SUPPORTED error code for any case when pair is not available/supported (Should not throw random errors for this case)
+     * @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<({
+     *            result: false,
+     *            reason: string,
+     *            smallestMin: (string|null|undefined),
+     *            greatestMax: (string|null|undefined),
+     *         }|{
+     *            result: true,
+     *            min: (string|null),
+     *            max: (string|null),
+     *            smallestMin: (string|null),
+     *            greatestMax: (string|null),
+     *            rate: (string|null),
+     *            durationMinutesRange: string,
+     *            fixed: boolean,
+     *            [rawSwapData]: Object
+     *         })>}
+     */
+    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.*
+     *
+     * @param fromCoin {Coin}
+     * @param toCoin {Coin}
+     * @param amount {string}
+     * @param toAddress {string}
+     * @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<({
+     *                     result: true,
+     *                     swapId: string,
+     *                     fromCoin: Coin,
+     *                     fromAmount: string,
+     *                     fromAddress: string,
+     *                     toCoin: Coin,
+     *                     toAmount: string,
+     *                     toAddress: string,
+     *                     rate: string,
+     *                     fromCurrencyExtraId: string|undefined,
+     *                     fixed: boolean
+     *                 }|{
+     *                     result: false,
+     *                     reason: string,
+     *                     partner: string
+     *                 })>}
+     */
+    async createSwap(
+        fromCoin,
+        toCoin,
+        amount,
+        toAddress,
+        refundAddress,
+        rawSwapData,
+        clientIpAddress,
+        fixed,
+        toCurrencyExtraId = "",
+        refundExtraId = ""
+    ) {
+        throw new Error("Not implemented in base");
+    }
+
+    /**
+     * Retrieves details and status for swaps by given ids.
+     * If some swap is not found by id then there is no item in return list.
+     *
+     * @param swapIds {string[]}
+     * @return {Promise<{result: false, reason: string}|{result:true, swaps: ExistingSwap[]}>}
+     */
+    async getExistingSwapsDetailsAndStatus(swapIds) {
+        throw new Error("Not implemented in base");
+    }
+
+    /**
+     * @param ticker {string}
+     * @return {Coin|null}
+     */
+    getCoinByTickerIfPresent(ticker) {
+        throw new Error("Not implemented in base");
+    }
+
+    /**
+     * @param asset {Coin}
+     * @param address {string}
+     * @return {boolean}
+     */
+    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");
+    }
+}