@lifi/sdk 3.0.0-alpha.4 → 3.0.0-alpha.40

package/dist/cjs/helpers.js

@@ -1,84 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.fetchTxErrorDetails = exports.convertQuoteToRoute = exports.checkPackageUpdates = exports.getRandomNumber = void 0;
-const request_1 = require("./request");
-const errors_1 = require("./utils/errors");
-const version_1 = require("./version");
-/**
- * Returns a random number between min (inclusive) and max (inclusive)
- * @param min - minimum number.
- * @param max - maximum number.
- * @returns - random number.
- */
-const getRandomNumber = (min, max) => {
-    return Math.floor(Math.random() * (max - min + 1) + min);
-};
-exports.getRandomNumber = getRandomNumber;
-function semverCompare(a, b) {
-    if (a.startsWith(b + '-')) {
-        return -1;
-    }
-    if (b.startsWith(a + '-')) {
-        return 1;
-    }
-    return a.localeCompare(b, undefined, {
-        numeric: true,
-        sensitivity: 'case',
-        caseFirst: 'upper',
-    });
-}
-const checkPackageUpdates = async (packageName, packageVersion, disableCheck) => {
-    if (disableCheck || process.env.NODE_ENV !== 'development') {
-        return;
-    }
-    try {
-        const pkgName = packageName ?? version_1.name;
-        const response = await (0, request_1.request)(`https://registry.npmjs.org/${pkgName}/latest`, { skipTrackingHeaders: true });
-        const latestVersion = response.version;
-        const currentVersion = packageVersion ?? version_1.version;
-        if (semverCompare(latestVersion, currentVersion)) {
-            console.warn(
-            // eslint-disable-next-line max-len
-            `${pkgName}: new package version is available. Please update as soon as possible to enjoy the newest features. Current version: ${currentVersion}. Latest version: ${latestVersion}.`);
-        }
-    }
-    catch (error) {
-        // Cannot verify version, might be network error etc. We don't bother showing anything in that case
-    }
-};
-exports.checkPackageUpdates = checkPackageUpdates;
-/**
- * Converts a quote to Route
- * @param step - Step returned from the quote endpoint.
- * @returns - The route to be executed.
- * @throws {ValidationError} Throws a ValidationError if the step has missing values.
- */
-const convertQuoteToRoute = (step) => {
-    if (!step.estimate.fromAmountUSD) {
-        throw new errors_1.ValidationError("Missing 'fromAmountUSD' in step estimate.");
-    }
-    if (!step.estimate.toAmountUSD) {
-        throw new errors_1.ValidationError("Missing 'toAmountUSD' in step estimate.");
-    }
-    const route = {
-        fromToken: step.action.fromToken,
-        toToken: step.action.toToken,
-        fromAmount: step.action.fromAmount,
-        toAmount: step.estimate.toAmount,
-        id: step.id,
-        fromChainId: step.action.fromToken.chainId,
-        toChainId: step.action.toToken.chainId,
-        fromAmountUSD: step.estimate.fromAmountUSD,
-        toAmountUSD: step.estimate.toAmountUSD,
-        steps: [step],
-        toAmountMin: step.estimate.toAmountMin,
-        insurance: { state: 'NOT_INSURABLE', feeAmountUsd: '0' },
-    };
-    return route;
-};
-exports.convertQuoteToRoute = convertQuoteToRoute;
-const fetchTxErrorDetails = async (txHash, chainId) => {
-    const response = await (0, request_1.request)(`https://api.tenderly.co/api/v1/public-contract/${chainId}/tx/${txHash}`);
-    return response;
-};
-exports.fetchTxErrorDetails = fetchTxErrorDetails;

package/dist/cjs/index.d.ts

@@ -1,5 +0,0 @@
-export * from './execution';
-export * from './helpers';
-export { LiFi } from './LiFi';
-export * from './types';
-export * from './utils/errors';

package/dist/cjs/index.js

@@ -1,24 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.LiFi = void 0;
-// expose types and helpers
-__exportStar(require("./execution"), exports);
-__exportStar(require("./helpers"), exports);
-var LiFi_1 = require("./LiFi");
-Object.defineProperty(exports, "LiFi", { enumerable: true, get: function () { return LiFi_1.LiFi; } });
-__exportStar(require("./types"), exports);
-__exportStar(require("./utils/errors"), exports);

package/dist/cjs/request.d.ts

@@ -1,9 +0,0 @@
-export declare const requestSettings: {
-    retries: number;
-};
-interface ExtendedRequestInit extends RequestInit {
-    retries?: number;
-    skipTrackingHeaders?: boolean;
-}
-export declare const request: <T = Response>(url: RequestInfo | URL, options?: ExtendedRequestInit) => Promise<T>;
-export {};

package/dist/cjs/request.js

@@ -1,60 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.request = exports.requestSettings = void 0;
-const ConfigService_1 = __importDefault(require("./services/ConfigService"));
-const errors_1 = require("./utils/errors");
-const utils_1 = require("./utils/utils");
-const version_1 = require("./version");
-exports.requestSettings = {
-    retries: 1,
-};
-const request = async (url, options = {
-    retries: exports.requestSettings.retries,
-}) => {
-    const { userId, integrator, widgetVersion } = ConfigService_1.default.getInstance().getConfig();
-    options.retries = options.retries ?? exports.requestSettings.retries;
-    try {
-        if (!options.skipTrackingHeaders) {
-            if (userId) {
-                options.headers = {
-                    ...options?.headers,
-                    'X-LIFI-UserId': userId,
-                };
-            }
-            if (widgetVersion) {
-                options.headers = {
-                    ...options?.headers,
-                    'X-LIFI-Widget': widgetVersion,
-                };
-            }
-            if (version_1.version) {
-                options.headers = {
-                    ...options?.headers,
-                    'X-LIFI-SDK': version_1.version,
-                };
-            }
-            // integrator is mandatory during SDK initialization
-            options.headers = {
-                ...options?.headers,
-                'X-LIFI-Integrator': integrator,
-            };
-        }
-        const response = await fetch(url, options);
-        if (!response.ok) {
-            throw new errors_1.HTTPError(response);
-        }
-        const data = await response.json();
-        return data;
-    }
-    catch (error) {
-        if (options.retries > 0 && error?.status === 500) {
-            await (0, utils_1.wait)(500);
-            return (0, exports.request)(url, { ...options, retries: options.retries - 1 });
-        }
-        throw error;
-    }
-};
-exports.request = request;

package/dist/cjs/services/ApiService.d.ts

@@ -1,17 +0,0 @@
-import type { ConnectionsRequest, ConnectionsResponse, ContractCallQuoteRequest, GasRecommendationRequest, GasRecommendationResponse, GetStatusRequest, LifiStep, QuoteRequest, RequestOptions, TokensRequest, TokensResponse } from '@lifi/types';
-import type { ChainId, ChainKey, ExtendedChain, PossibilitiesRequest, PossibilitiesResponse, RoutesRequest, RoutesResponse, StatusResponse, Token, ToolsRequest, ToolsResponse } from '../types';
-declare const _default: {
-    getChains: (options?: RequestOptions | undefined) => Promise<ExtendedChain[]>;
-    getContractCallQuote: (requestConfig: ContractCallQuoteRequest, options?: RequestOptions | undefined) => Promise<LifiStep>;
-    getGasRecommendation: ({ chainId, fromChain, fromToken }: GasRecommendationRequest, options?: RequestOptions | undefined) => Promise<GasRecommendationResponse>;
-    getPossibilities: (requestConfig?: PossibilitiesRequest | undefined, options?: RequestOptions | undefined) => Promise<PossibilitiesResponse>;
-    getQuote: (requestConfig: QuoteRequest, options?: RequestOptions | undefined) => Promise<LifiStep>;
-    getRoutes: (requestConfig: RoutesRequest, options?: RequestOptions | undefined) => Promise<RoutesResponse>;
-    getStatus: (requestConfig: GetStatusRequest, options?: RequestOptions | undefined) => Promise<StatusResponse>;
-    getStepTransaction: (step: LifiStep, options?: RequestOptions | undefined) => Promise<LifiStep>;
-    getToken: (chain: ChainId | ChainKey, token: string, options?: RequestOptions | undefined) => Promise<Token>;
-    getTokens: (requestConfig?: TokensRequest | undefined, options?: RequestOptions | undefined) => Promise<TokensResponse>;
-    getTools: (requestConfig?: ToolsRequest | undefined, options?: RequestOptions | undefined) => Promise<ToolsResponse>;
-    getAvailableConnections: (connectionRequest: ConnectionsRequest) => Promise<ConnectionsResponse>;
-};
-export default _default;

package/dist/cjs/services/ApiService.js

@@ -1,326 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const request_1 = require("../request");
-const typeguards_1 = require("../typeguards");
-const errors_1 = require("../utils/errors");
-const parseError_1 = require("../utils/parseError");
-const ConfigService_1 = __importDefault(require("./ConfigService"));
-/**
- * @param requestConfig
- * @param options
- * @deprecated We don't want to support this endpoint anymore in the future. /chains, /tools, /connections, and /tokens should be used instead
- */
-const getPossibilities = async (requestConfig, options) => {
-    if (!requestConfig) {
-        requestConfig = {};
-    }
-    const config = ConfigService_1.default.getInstance().getConfig();
-    // apply defaults
-    if (requestConfig.bridges || config.defaultRouteOptions.bridges) {
-        requestConfig.bridges =
-            requestConfig.bridges || config.defaultRouteOptions.bridges;
-    }
-    if (requestConfig.exchanges || config.defaultRouteOptions.exchanges) {
-        requestConfig.exchanges =
-            requestConfig.exchanges || config.defaultRouteOptions.exchanges;
-    }
-    // send request
-    try {
-        const response = await (0, request_1.request)(`${config.apiUrl}/advanced/possibilities`, {
-            method: 'POST',
-            headers: {
-                'Content-Type': 'application/json',
-            },
-            body: JSON.stringify(requestConfig),
-            signal: options?.signal,
-        });
-        return response;
-    }
-    catch (e) {
-        throw await (0, parseError_1.parseBackendError)(e);
-    }
-};
-const getToken = async (chain, token, options) => {
-    if (!chain) {
-        throw new errors_1.ValidationError('Required parameter "chain" is missing.');
-    }
-    if (!token) {
-        throw new errors_1.ValidationError('Required parameter "token" is missing.');
-    }
-    const config = ConfigService_1.default.getInstance().getConfig();
-    try {
-        const response = await (0, request_1.request)(`${config.apiUrl}/token?${new URLSearchParams({
-            chain,
-            token,
-        })}`, {
-            signal: options?.signal,
-        });
-        return response;
-    }
-    catch (e) {
-        throw await (0, parseError_1.parseBackendError)(e);
-    }
-};
-const getQuote = async (requestConfig, options) => {
-    const config = ConfigService_1.default.getInstance().getConfig();
-    const requiredParameters = [
-        'fromChain',
-        'fromToken',
-        'fromAddress',
-        'fromAmount',
-        'toChain',
-        'toToken',
-    ];
-    requiredParameters.forEach((requiredParameter) => {
-        if (!requestConfig[requiredParameter]) {
-            throw new errors_1.ValidationError(`Required parameter "${requiredParameter}" is missing.`);
-        }
-    });
-    // apply defaults
-    requestConfig.order || (requestConfig.order = config.defaultRouteOptions.order);
-    requestConfig.slippage || (requestConfig.slippage = config.defaultRouteOptions.slippage);
-    requestConfig.integrator || (requestConfig.integrator = config.defaultRouteOptions.integrator);
-    requestConfig.referrer || (requestConfig.referrer = config.defaultRouteOptions.referrer);
-    requestConfig.fee || (requestConfig.fee = config.defaultRouteOptions.fee);
-    requestConfig.allowBridges || (requestConfig.allowBridges = config.defaultRouteOptions.bridges?.allow);
-    requestConfig.denyBridges || (requestConfig.denyBridges = config.defaultRouteOptions.bridges?.deny);
-    requestConfig.preferBridges || (requestConfig.preferBridges = config.defaultRouteOptions.bridges?.prefer);
-    requestConfig.allowExchanges || (requestConfig.allowExchanges = config.defaultRouteOptions.exchanges?.allow);
-    requestConfig.denyExchanges || (requestConfig.denyExchanges = config.defaultRouteOptions.exchanges?.deny);
-    requestConfig.preferExchanges || (requestConfig.preferExchanges = config.defaultRouteOptions.exchanges?.prefer);
-    Object.keys(requestConfig).forEach((key) => !requestConfig[key] &&
-        delete requestConfig[key]);
-    try {
-        const response = await (0, request_1.request)(`${config.apiUrl}/quote?${new URLSearchParams(requestConfig)}`, {
-            signal: options?.signal,
-        });
-        return response;
-    }
-    catch (e) {
-        throw await (0, parseError_1.parseBackendError)(e);
-    }
-};
-const getContractCallQuote = async (requestConfig, options) => {
-    const config = ConfigService_1.default.getInstance().getConfig();
-    // validation
-    const requiredParameters = [
-        'fromChain',
-        'fromToken',
-        'fromAddress',
-        'toChain',
-        'toToken',
-        'toAmount',
-        'toContractAddress',
-        'toContractCallData',
-        'toContractGasLimit',
-    ];
-    requiredParameters.forEach((requiredParameter) => {
-        if (!requestConfig[requiredParameter]) {
-            throw new errors_1.ValidationError(`Required parameter "${requiredParameter}" is missing.`);
-        }
-    });
-    // apply defaults
-    // option.order is not used in this endpoint
-    requestConfig.slippage || (requestConfig.slippage = config.defaultRouteOptions.slippage);
-    requestConfig.integrator || (requestConfig.integrator = config.defaultRouteOptions.integrator);
-    requestConfig.referrer || (requestConfig.referrer = config.defaultRouteOptions.referrer);
-    requestConfig.fee || (requestConfig.fee = config.defaultRouteOptions.fee);
-    requestConfig.allowBridges || (requestConfig.allowBridges = config.defaultRouteOptions.bridges?.allow);
-    requestConfig.denyBridges || (requestConfig.denyBridges = config.defaultRouteOptions.bridges?.deny);
-    requestConfig.preferBridges || (requestConfig.preferBridges = config.defaultRouteOptions.bridges?.prefer);
-    requestConfig.allowExchanges || (requestConfig.allowExchanges = config.defaultRouteOptions.exchanges?.allow);
-    requestConfig.denyExchanges || (requestConfig.denyExchanges = config.defaultRouteOptions.exchanges?.deny);
-    requestConfig.preferExchanges || (requestConfig.preferExchanges = config.defaultRouteOptions.exchanges?.prefer);
-    // send request
-    try {
-        const response = await (0, request_1.request)(`${config.apiUrl}/quote/contractCall`, {
-            method: 'POST',
-            headers: {
-                'Content-Type': 'application/json',
-            },
-            body: JSON.stringify(requestConfig),
-            signal: options?.signal,
-        });
-        return response;
-    }
-    catch (e) {
-        throw await (0, parseError_1.parseBackendError)(e);
-    }
-};
-const getStatus = async (requestConfig, options) => {
-    if (!requestConfig.txHash) {
-        throw new errors_1.ValidationError('Required parameter "txHash" is missing.');
-    }
-    const config = ConfigService_1.default.getInstance().getConfig();
-    const queryParams = new URLSearchParams(requestConfig);
-    try {
-        const response = await (0, request_1.request)(`${config.apiUrl}/status?${queryParams}`, {
-            signal: options?.signal,
-        });
-        return response;
-    }
-    catch (e) {
-        throw await (0, parseError_1.parseBackendError)(e);
-    }
-};
-const getChains = async (options) => {
-    const config = ConfigService_1.default.getInstance().getConfig();
-    try {
-        const response = await (0, request_1.request)(`${config.apiUrl}/chains`, {
-            signal: options?.signal,
-        });
-        return response.chains;
-    }
-    catch (e) {
-        throw await (0, parseError_1.parseBackendError)(e);
-    }
-};
-const getRoutes = async (requestConfig, options) => {
-    if (!(0, typeguards_1.isRoutesRequest)(requestConfig)) {
-        throw new errors_1.ValidationError('Invalid routes request.');
-    }
-    const config = ConfigService_1.default.getInstance().getConfig();
-    // apply defaults
-    requestConfig.options = {
-        ...config.defaultRouteOptions,
-        ...requestConfig.options,
-    };
-    // send request
-    try {
-        const response = await (0, request_1.request)(`${config.apiUrl}/advanced/routes`, {
-            method: 'POST',
-            headers: {
-                'Content-Type': 'application/json',
-            },
-            body: JSON.stringify(requestConfig),
-            signal: options?.signal,
-        });
-        return response;
-    }
-    catch (e) {
-        throw await (0, parseError_1.parseBackendError)(e);
-    }
-};
-const getStepTransaction = async (step, options) => {
-    if (!(0, typeguards_1.isStep)(step)) {
-        // While the validation fails for some users we should not enforce it
-        // eslint-disable-next-line no-console
-        console.warn('SDK Validation: Invalid Step', step);
-    }
-    const config = ConfigService_1.default.getInstance().getConfig();
-    try {
-        const response = await (0, request_1.request)(`${config.apiUrl}/advanced/stepTransaction`, {
-            method: 'POST',
-            headers: {
-                'Content-Type': 'application/json',
-            },
-            body: JSON.stringify(step),
-            signal: options?.signal,
-        });
-        return response;
-    }
-    catch (e) {
-        throw await (0, parseError_1.parseBackendError)(e);
-    }
-};
-const getTools = async (requestConfig, options) => {
-    const config = ConfigService_1.default.getInstance().getConfig();
-    if (requestConfig) {
-        Object.keys(requestConfig).forEach((key) => !requestConfig[key] &&
-            delete requestConfig[key]);
-    }
-    const response = await (0, request_1.request)(`${config.apiUrl}/tools?${new URLSearchParams(requestConfig)}`, {
-        signal: options?.signal,
-    });
-    return response;
-};
-const getTokens = async (requestConfig, options) => {
-    const config = ConfigService_1.default.getInstance().getConfig();
-    if (requestConfig) {
-        Object.keys(requestConfig).forEach((key) => !requestConfig[key] &&
-            delete requestConfig[key]);
-    }
-    const response = await (0, request_1.request)(`${config.apiUrl}/tokens?${new URLSearchParams(requestConfig)}`, {
-        signal: options?.signal,
-    });
-    return response;
-};
-const getGasRecommendation = async ({ chainId, fromChain, fromToken }, options) => {
-    const config = ConfigService_1.default.getInstance().getConfig();
-    if (!chainId) {
-        throw new errors_1.ValidationError('Required parameter "chainId" is missing.');
-    }
-    const url = new URL(`${config.apiUrl}/gas/suggestion/${chainId}`);
-    if (fromChain) {
-        url.searchParams.append('fromChain', fromChain);
-    }
-    if (fromToken) {
-        url.searchParams.append('fromToken', fromToken);
-    }
-    try {
-        const response = await (0, request_1.request)(url, {
-            signal: options?.signal,
-        });
-        return response;
-    }
-    catch (e) {
-        throw await (0, parseError_1.parseBackendError)(e);
-    }
-};
-const getAvailableConnections = async (connectionRequest) => {
-    const config = ConfigService_1.default.getInstance().getConfig();
-    const url = new URL(`${config.apiUrl}/connections`);
-    const { fromChain, fromToken, toChain, toToken } = connectionRequest;
-    if (fromChain) {
-        url.searchParams.append('fromChain', fromChain);
-    }
-    if (fromToken) {
-        url.searchParams.append('fromToken', fromToken);
-    }
-    if (toChain) {
-        url.searchParams.append('fromToken', toChain);
-    }
-    if (toToken) {
-        url.searchParams.append('fromToken', toToken);
-    }
-    const connectionRequestArrayParams = [
-        'allowBridges',
-        'denyBridges',
-        'preferBridges',
-        'allowExchanges',
-        'denyExchanges',
-        'preferExchanges',
-    ];
-    connectionRequestArrayParams.forEach((parameter) => {
-        const connectionRequestArrayParam = connectionRequest[parameter];
-        if (connectionRequestArrayParam?.length) {
-            connectionRequestArrayParam?.forEach((value) => {
-                url.searchParams.append(parameter, value);
-            });
-        }
-    });
-    try {
-        const response = await (0, request_1.request)(url);
-        return response;
-    }
-    catch (e) {
-        throw await (0, parseError_1.parseBackendError)(e);
-    }
-};
-exports.default = {
-    getChains,
-    getContractCallQuote,
-    getGasRecommendation,
-    getPossibilities,
-    getQuote,
-    getRoutes,
-    getStatus,
-    getStepTransaction,
-    getToken,
-    getTokens,
-    getTools,
-    getAvailableConnections,
-};

package/dist/cjs/services/ChainsService.d.ts

@@ -1,11 +0,0 @@
-import type { ChainId, ExtendedChain } from '@lifi/types';
-export default class ChainsService {
-    private static instance;
-    private readonly loadingPromise;
-    private chains;
-    constructor();
-    private loadAvailableChains;
-    static getInstance(): ChainsService;
-    getChainById(chainId: ChainId): Promise<ExtendedChain>;
-    getChains(): Promise<ExtendedChain[]>;
-}

package/dist/cjs/services/ChainsService.js

@@ -1,39 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const errors_1 = require("../utils/errors");
-const ApiService_1 = __importDefault(require("./ApiService"));
-class ChainsService {
-    constructor() {
-        this.chains = [];
-        this.loadingPromise = this.loadAvailableChains();
-    }
-    async loadAvailableChains() {
-        this.chains = await ApiService_1.default.getChains();
-    }
-    static getInstance() {
-        if (!this.instance) {
-            this.instance = new ChainsService();
-        }
-        return this.instance;
-    }
-    async getChainById(chainId) {
-        if (this.loadingPromise) {
-            await this.loadingPromise;
-        }
-        const chain = this.chains.find((chain) => chain.id === chainId);
-        if (!chain) {
-            throw new errors_1.ValidationError(`Unknown chainId passed: ${chainId}.`);
-        }
-        return chain;
-    }
-    async getChains() {
-        if (this.loadingPromise) {
-            await this.loadingPromise;
-        }
-        return this.chains;
-    }
-}
-exports.default = ChainsService;

package/dist/cjs/services/ConfigService.d.ts

@@ -1,23 +0,0 @@
-import type { Chain, Config, ConfigUpdate } from '../types';
-export default class ConfigService {
-    private static instance;
-    private readonly config;
-    private readonly setupPromise;
-    private resolveSetupPromise;
-    constructor();
-    private static chainIdToObject;
-    private static getDefaultConfig;
-    static getInstance(): ConfigService;
-    /**
-     * This call immediately returns the current config. It does not make sure that all chain data is already loaded
-     * Use this if you need access to basic information like API urls or settings
-     */
-    getConfig: () => Config;
-    /**
-     * This call waits for all setup promises to be done.
-     * Use this if you need access to chain data (RPCs or multicalls)
-     */
-    getConfigAsync: () => Promise<Config>;
-    updateConfig: (configUpdate: Partial<ConfigUpdate>) => Config;
-    updateChains: (chains: Chain[]) => Config;
-}