@lifi/sdk 3.0.0-alpha.2 → 3.0.0-alpha.20

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;
-}

package/dist/cjs/services/ConfigService.js

@@ -1,101 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const types_1 = require("../types");
-const DefaultExecutionSettings = {
-    /* eslint-disable-next-line @typescript-eslint/no-empty-function */
-    updateRouteHook: () => { },
-    switchChainHook: () => Promise.resolve(undefined),
-    acceptExchangeRateUpdateHook: () => Promise.resolve(undefined),
-    infiniteApproval: false,
-    executeInBackground: false,
-};
-class ConfigService {
-    constructor() {
-        this.resolveSetupPromise = undefined;
-        /**
-         * 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
-         */
-        this.getConfig = () => {
-            return this.config;
-        };
-        /**
-         * This call waits for all setup promises to be done.
-         * Use this if you need access to chain data (RPCs or multicalls)
-         */
-        this.getConfigAsync = async () => {
-            await this.setupPromise;
-            return this.config;
-        };
-        this.updateConfig = (configUpdate) => {
-            // API
-            this.config.apiUrl = configUpdate.apiUrl || this.config.apiUrl;
-            // RPCS
-            this.config.rpcs = Object.assign(this.config.rpcs, configUpdate.rpcs);
-            // MULTICALL
-            this.config.multicallAddresses = Object.assign(this.config.multicallAddresses, configUpdate.multicallAddresses);
-            // SETTINGS
-            this.config.defaultExecutionSettings = Object.assign(this.config.defaultExecutionSettings, configUpdate.defaultExecutionSettings);
-            // OPTIONS
-            this.config.defaultRouteOptions = Object.assign(this.config.defaultRouteOptions, configUpdate.defaultRouteOptions);
-            this.config.userId = configUpdate.userId || this.config.userId;
-            this.config.integrator = configUpdate.integrator || this.config.integrator;
-            this.config.defaultRouteOptions.integrator =
-                configUpdate.integrator ||
-                    configUpdate.defaultRouteOptions?.integrator ||
-                    this.config.integrator;
-            this.config.widgetVersion =
-                configUpdate.widgetVersion || this.config.widgetVersion;
-            this.config.multisig = configUpdate.multisigConfig || this.config.multisig;
-            return this.config;
-        };
-        this.updateChains = (chains) => {
-            for (const chain of chains) {
-                const chainId = chain.id;
-                // set RPCs if they were not configured by the user before
-                if (!this.config.rpcs[chainId]?.length) {
-                    this.config.rpcs[chainId] = chain.metamask.rpcUrls;
-                }
-                // set multicall addresses if they exist and were not configured by the user before
-                if (chain.multicallAddress && !this.config.multicallAddresses[chainId]) {
-                    this.config.multicallAddresses[chainId] = chain.multicallAddress;
-                }
-            }
-            this.resolveSetupPromise?.();
-            return this.config;
-        };
-        this.config = ConfigService.getDefaultConfig();
-        this.setupPromise = new Promise((resolve) => {
-            this.resolveSetupPromise = resolve;
-        });
-    }
-    static chainIdToObject(val) {
-        const result = {};
-        const values = Object.values(types_1.ChainId);
-        values.forEach((chainId) => {
-            if (typeof chainId !== 'string') {
-                result[chainId] = val ? JSON.parse(JSON.stringify(val)) : val;
-            }
-        });
-        return result;
-    }
-    static getInstance() {
-        if (!this.instance) {
-            this.instance = new ConfigService();
-        }
-        return this.instance;
-    }
-}
-ConfigService.getDefaultConfig = () => {
-    return {
-        apiUrl: 'https://li.quest/v1',
-        rpcs: ConfigService.chainIdToObject([]),
-        multicallAddresses: ConfigService.chainIdToObject(undefined),
-        defaultExecutionSettings: DefaultExecutionSettings,
-        defaultRouteOptions: {
-            integrator: 'lifi-sdk',
-        },
-        integrator: 'lifi-sdk',
-    };
-};
-exports.default = ConfigService;

package/dist/cjs/types/index.d.ts

@@ -1,4 +0,0 @@
-export * from '@lifi/types';
-export { ErrorCode, LiFiError } from '../utils/errors';
-export * from './abi';
-export * from './internal.types';

package/dist/cjs/types/internal.types.d.ts

@@ -1,142 +0,0 @@
-import type { ChainId, LifiStep, Route, RouteOptions, Token } from '@lifi/types';
-import type { Hash, Hex, WalletClient } from 'viem';
-import type { StatusManager } from '../execution/StatusManager';
-import type { StepExecutor } from '../execution/StepExecutor';
-export type TransactionParameters = {
-    chainId?: number;
-    to?: string;
-    from?: string;
-    nonce?: number;
-    data?: Hex;
-    value?: bigint;
-    gas?: bigint;
-    gasPrice?: bigint;
-    maxFeePerGas?: bigint;
-    maxPriorityFeePerGas?: bigint;
-};
-export interface ExecutionParams {
-    walletClient: WalletClient;
-    step: LifiStep;
-    statusManager: StatusManager;
-    settings: InternalExecutionSettings;
-}
-export type UpdateRouteHook = (updatedRoute: Route) => void;
-export type TransactionRequestUpdateHook = (updatedTxRequest: TransactionParameters) => Promise<TransactionParameters>;
-export type Config = {
-    apiUrl: string;
-    rpcs: Record<ChainId, string[]>;
-    multicallAddresses: Record<ChainId, string | undefined>;
-    defaultExecutionSettings: InternalExecutionSettings;
-    defaultRouteOptions: RouteOptions;
-    disableVersionCheck?: boolean;
-    userId?: string;
-    integrator: string;
-    widgetVersion?: string;
-    multisig?: MultisigConfig;
-};
-export interface MultisigTxDetails {
-    status: 'DONE' | 'FAILED' | 'PENDING' | 'CANCELLED';
-    txHash?: Hash;
-}
-export interface MultisigTransactionResponse {
-    hash: string;
-}
-export interface BaseTransaction {
-    to: string;
-    value?: bigint;
-    data: string;
-}
-export interface MultisigConfig {
-    isMultisigWalletClient: boolean;
-    getMultisigTransactionDetails: (txHash: Hash, fromChainId: number, updateIntermediateStatus?: () => void) => Promise<MultisigTxDetails>;
-    sendBatchTransaction?: (batchTransactions: BaseTransaction[]) => Promise<Hash>;
-    shouldBatchTransactions?: boolean;
-}
-export type ConfigUpdate = {
-    apiUrl?: string;
-    rpcs?: Record<number, string[]>;
-    multicallAddresses?: Record<number, string | undefined>;
-    defaultExecutionSettings?: ExecutionSettings;
-    defaultRouteOptions?: RouteOptions;
-    disableVersionCheck?: boolean;
-    userId?: string;
-    integrator: string;
-    widgetVersion?: string;
-    multisigConfig?: MultisigConfig;
-};
-export type SwitchChainHook = (requiredChainId: number) => Promise<WalletClient | undefined>;
-export interface AcceptSlippageUpdateHookParams {
-    toToken: Token;
-    oldToAmount: string;
-    newToAmount: string;
-    oldSlippage: number;
-    newSlippage: number;
-}
-export type AcceptSlippageUpdateHook = (params: AcceptSlippageUpdateHookParams) => Promise<boolean | undefined>;
-export interface ExchangeRateUpdateParams {
-    toToken: Token;
-    oldToAmount: string;
-    newToAmount: string;
-}
-export type AcceptExchangeRateUpdateHook = (params: ExchangeRateUpdateParams) => Promise<boolean | undefined>;
-export interface RouteExecutionData {
-    route: Route;
-    executors: StepExecutor[];
-    settings: InternalExecutionSettings;
-}
-export type ExecutionSettings = Partial<InternalExecutionSettings>;
-export interface InternalExecutionSettings {
-    acceptExchangeRateUpdateHook: AcceptExchangeRateUpdateHook;
-    switchChainHook: SwitchChainHook;
-    updateRouteHook: UpdateRouteHook;
-    updateTransactionRequestHook?: TransactionRequestUpdateHook;
-    executeInBackground: boolean;
-    infiniteApproval: boolean;
-}
-export type RouteExecutionDictionary = Partial<Record<string, RouteExecutionData>>;
-export type RouteExecutionPromiseDictionary = Partial<Record<string, Promise<Route>>>;
-export interface InteractionSettings {
-    allowInteraction?: boolean;
-    allowUpdates?: boolean;
-    stopExecution?: boolean;
-}
-export interface TenderlyResponse {
-    hash: string;
-    block_hash: string;
-    block_number: number;
-    from: string;
-    gas: number;
-    gas_price: number;
-    gas_fee_cap: number;
-    gas_tip_cap: number;
-    cumulative_gas_used: number;
-    gas_used: number;
-    effective_gas_price: number;
-    input: string;
-    nonce: number;
-    to: string;
-    index: number;
-    value: string;
-    access_list: any;
-    status: boolean;
-    addresses: string[];
-    contract_ids: string[];
-    network_id: string;
-    timestamp: string;
-    function_selector: string;
-    l1_block_number: number;
-    l1_timestamp: number;
-    deposit_tx: boolean;
-    system_tx: boolean;
-    mint: number;
-    sig: Signature;
-    error_message: string;
-    method: string;
-    decoded_input: any;
-    call_trace: any;
-}
-export interface Signature {
-    v: string;
-    r: string;
-    s: string;
-}