@lifi/sdk 3.0.0-alpha.6 → 3.0.0-alpha.8

package/dist/cjs/services/ApiService.js

@@ -1,13 +1,10 @@
 "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"));
+const ConfigService_1 = require("./ConfigService");
 /**
  * @param requestConfig
  * @param options
@@ -17,7 +14,7 @@ const getPossibilities = async (requestConfig, options) => {
     if (!requestConfig) {
         requestConfig = {};
     }
-    const config = ConfigService_1.default.getInstance().getConfig();
+    const config = ConfigService_1.ConfigService.getInstance().getConfig();
     // apply defaults
     if (requestConfig.bridges || config.defaultRouteOptions.bridges) {
         requestConfig.bridges =
@@ -50,7 +47,7 @@ const getToken = async (chain, token, options) => {
     if (!token) {
         throw new errors_1.ValidationError('Required parameter "token" is missing.');
     }
-    const config = ConfigService_1.default.getInstance().getConfig();
+    const config = ConfigService_1.ConfigService.getInstance().getConfig();
     try {
         const response = await (0, request_1.request)(`${config.apiUrl}/token?${new URLSearchParams({
             chain,
@@ -65,7 +62,7 @@ const getToken = async (chain, token, options) => {
     }
 };
 const getQuote = async (requestConfig, options) => {
-    const config = ConfigService_1.default.getInstance().getConfig();
+    const config = ConfigService_1.ConfigService.getInstance().getConfig();
     const requiredParameters = [
         'fromChain',
         'fromToken',
@@ -104,7 +101,7 @@ const getQuote = async (requestConfig, options) => {
     }
 };
 const getContractCallQuote = async (requestConfig, options) => {
-    const config = ConfigService_1.default.getInstance().getConfig();
+    const config = ConfigService_1.ConfigService.getInstance().getConfig();
     // validation
     const requiredParameters = [
         'fromChain',
@@ -154,7 +151,7 @@ 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 config = ConfigService_1.ConfigService.getInstance().getConfig();
     const queryParams = new URLSearchParams(requestConfig);
     try {
         const response = await (0, request_1.request)(`${config.apiUrl}/status?${queryParams}`, {
@@ -167,7 +164,7 @@ const getStatus = async (requestConfig, options) => {
     }
 };
 const getChains = async (options) => {
-    const config = ConfigService_1.default.getInstance().getConfig();
+    const config = ConfigService_1.ConfigService.getInstance().getConfig();
     try {
         const response = await (0, request_1.request)(`${config.apiUrl}/chains`, {
             signal: options?.signal,
@@ -182,7 +179,7 @@ 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();
+    const config = ConfigService_1.ConfigService.getInstance().getConfig();
     // apply defaults
     requestConfig.options = {
         ...config.defaultRouteOptions,
@@ -210,7 +207,7 @@ const getStepTransaction = async (step, options) => {
         // eslint-disable-next-line no-console
         console.warn('SDK Validation: Invalid Step', step);
     }
-    const config = ConfigService_1.default.getInstance().getConfig();
+    const config = ConfigService_1.ConfigService.getInstance().getConfig();
     try {
         const response = await (0, request_1.request)(`${config.apiUrl}/advanced/stepTransaction`, {
             method: 'POST',
@@ -227,7 +224,7 @@ const getStepTransaction = async (step, options) => {
     }
 };
 const getTools = async (requestConfig, options) => {
-    const config = ConfigService_1.default.getInstance().getConfig();
+    const config = ConfigService_1.ConfigService.getInstance().getConfig();
     if (requestConfig) {
         Object.keys(requestConfig).forEach((key) => !requestConfig[key] &&
             delete requestConfig[key]);
@@ -238,7 +235,7 @@ const getTools = async (requestConfig, options) => {
     return response;
 };
 const getTokens = async (requestConfig, options) => {
-    const config = ConfigService_1.default.getInstance().getConfig();
+    const config = ConfigService_1.ConfigService.getInstance().getConfig();
     if (requestConfig) {
         Object.keys(requestConfig).forEach((key) => !requestConfig[key] &&
             delete requestConfig[key]);
@@ -249,7 +246,7 @@ const getTokens = async (requestConfig, options) => {
     return response;
 };
 const getGasRecommendation = async ({ chainId, fromChain, fromToken }, options) => {
-    const config = ConfigService_1.default.getInstance().getConfig();
+    const config = ConfigService_1.ConfigService.getInstance().getConfig();
     if (!chainId) {
         throw new errors_1.ValidationError('Required parameter "chainId" is missing.');
     }
@@ -271,7 +268,7 @@ const getGasRecommendation = async ({ chainId, fromChain, fromToken }, options)
     }
 };
 const getAvailableConnections = async (connectionRequest) => {
-    const config = ConfigService_1.default.getInstance().getConfig();
+    const config = ConfigService_1.ConfigService.getInstance().getConfig();
     const url = new URL(`${config.apiUrl}/connections`);
     const { fromChain, fromToken, toChain, toToken } = connectionRequest;
     if (fromChain) {
@@ -281,10 +278,10 @@ const getAvailableConnections = async (connectionRequest) => {
         url.searchParams.append('fromToken', fromToken);
     }
     if (toChain) {
-        url.searchParams.append('fromToken', toChain);
+        url.searchParams.append('toChain', toChain);
     }
     if (toToken) {
-        url.searchParams.append('fromToken', toToken);
+        url.searchParams.append('toToken', toToken);
     }
     const connectionRequestArrayParams = [
         'allowBridges',

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

@@ -1,5 +1,5 @@
 import type { ChainId, ExtendedChain } from '@lifi/types';
-export default class ChainsService {
+export declare class ChainsService {
     private static instance;
     private readonly loadingPromise;
     private chains;

package/dist/cjs/services/ChainsService.js

@@ -3,6 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.ChainsService = void 0;
 const errors_1 = require("../utils/errors");
 const ApiService_1 = __importDefault(require("./ApiService"));
 class ChainsService {
@@ -36,4 +37,4 @@ class ChainsService {
         return this.chains;
     }
 }
-exports.default = ChainsService;
+exports.ChainsService = ChainsService;

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

@@ -1,5 +1,6 @@
-import type { Chain, Config, ConfigUpdate } from '../types';
-export default class ConfigService {
+import type { Chain } from '@lifi/types';
+import type { SDKConfig, SDKOptions } from '../types';
+export declare class ConfigService {
     private static instance;
     private readonly config;
     private readonly setupPromise;
@@ -11,13 +12,15 @@ export default class 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
+     * @returns SDKConfig
      */
-    getConfig: () => Config;
+    getConfig: () => SDKConfig;
     /**
      * This call waits for all setup promises to be done.
      * Use this if you need access to chain data (RPCs or multicalls)
+     * @returns SDKConfig
      */
-    getConfigAsync: () => Promise<Config>;
-    updateConfig: (configUpdate: Partial<ConfigUpdate>) => Config;
-    updateChains: (chains: Chain[]) => Config;
+    getConfigAsync: () => Promise<SDKConfig>;
+    updateConfig: (configUpdate: Partial<SDKOptions>) => SDKConfig;
+    updateChains: (chains: Chain[]) => SDKConfig;
 }

package/dist/cjs/services/ConfigService.js

@@ -1,8 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-const types_1 = require("../types");
+exports.ConfigService = void 0;
+const types_1 = require("@lifi/types");
 const DefaultExecutionSettings = {
-    /* eslint-disable-next-line @typescript-eslint/no-empty-function */
     updateRouteHook: () => { },
     switchChainHook: () => Promise.resolve(undefined),
     acceptExchangeRateUpdateHook: () => Promise.resolve(undefined),
@@ -15,6 +15,7 @@ class 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
+         * @returns SDKConfig
          */
         this.getConfig = () => {
             return this.config;
@@ -22,6 +23,7 @@ class ConfigService {
         /**
          * This call waits for all setup promises to be done.
          * Use this if you need access to chain data (RPCs or multicalls)
+         * @returns SDKConfig
          */
         this.getConfigAsync = async () => {
             await this.setupPromise;
@@ -38,6 +40,7 @@ class ConfigService {
             this.config.defaultExecutionSettings = Object.assign(this.config.defaultExecutionSettings, configUpdate.defaultExecutionSettings);
             // OPTIONS
             this.config.defaultRouteOptions = Object.assign(this.config.defaultRouteOptions, configUpdate.defaultRouteOptions);
+            this.config.apiKey = configUpdate.apiKey || this.config.apiKey;
             this.config.userId = configUpdate.userId || this.config.userId;
             this.config.integrator = configUpdate.integrator || this.config.integrator;
             this.config.defaultRouteOptions.integrator =
@@ -46,7 +49,7 @@ class ConfigService {
                     this.config.integrator;
             this.config.widgetVersion =
                 configUpdate.widgetVersion || this.config.widgetVersion;
-            this.config.multisig = configUpdate.multisigConfig || this.config.multisig;
+            this.config.multisig = configUpdate.multisig || this.config.multisig;
             return this.config;
         };
         this.updateChains = (chains) => {
@@ -86,6 +89,7 @@ class ConfigService {
         return this.instance;
     }
 }
+exports.ConfigService = ConfigService;
 ConfigService.getDefaultConfig = () => {
     return {
         apiUrl: 'https://li.quest/v1',
@@ -98,4 +102,3 @@ ConfigService.getDefaultConfig = () => {
         integrator: 'lifi-sdk',
     };
 };
-exports.default = ConfigService;

package/dist/cjs/typeguards.d.ts

@@ -1,4 +1,4 @@
-import type { LifiStep, RoutesRequest, StaticToken } from './types';
+import type { LiFiStep, RoutesRequest, StaticToken } from '@lifi/types';
 export declare const isRoutesRequest: (routesRequest: RoutesRequest) => routesRequest is RoutesRequest;
-export declare const isStep: (step: LifiStep) => step is LifiStep;
+export declare const isStep: (step: LiFiStep) => step is LiFiStep;
 export declare const isToken: (token: StaticToken) => token is StaticToken;

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

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

package/dist/cjs/types/index.js

@@ -14,9 +14,5 @@ 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.LiFiError = void 0;
-__exportStar(require("@lifi/types"), exports);
-var errors_1 = require("../utils/errors");
-Object.defineProperty(exports, "LiFiError", { enumerable: true, get: function () { return errors_1.LiFiError; } });
 __exportStar(require("./abi"), exports);
-__exportStar(require("./internal.types"), exports);
+__exportStar(require("./internal"), exports);

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

@@ -0,0 +1,60 @@
+import type { ChainId, RouteOptions } from '@lifi/types';
+import type { ExecutionSettings, InternalExecutionSettings, MultisigConfig } from '../execution/types';
+import type { SDKProvider } from '../providers';
+export interface SDKConfig {
+    apiUrl: string;
+    apiKey?: string;
+    rpcs: Record<ChainId, string[]>;
+    multicallAddresses: Record<ChainId, string | undefined>;
+    defaultExecutionSettings: InternalExecutionSettings;
+    defaultRouteOptions: RouteOptions;
+    disableVersionCheck?: boolean;
+    userId?: string;
+    integrator: string;
+    widgetVersion?: string;
+    multisig?: MultisigConfig;
+    providers?: SDKProvider[];
+}
+export interface SDKOptions extends Partial<Omit<SDKConfig, 'defaultExecutionSettings' | 'integrator'>> {
+    defaultExecutionSettings?: ExecutionSettings;
+    integrator: string;
+}
+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: unknown;
+    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: {
+        v: string;
+        r: string;
+        s: string;
+    };
+    error_message: string;
+    method: string;
+    decoded_input: unknown;
+    call_trace: unknown;
+}

package/dist/cjs/types/internal.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/utils/parseError.d.ts

@@ -1,4 +1,4 @@
-import type { LifiStep, Process } from '@lifi/types';
+import type { LiFiStep, Process } from '@lifi/types';
 import { LiFiError } from './errors';
 /**
  * Available MetaMask error codes:
@@ -31,7 +31,7 @@ import { LiFiError } from './errors';
  * https://eips.ethereum.org/EIPS/eip-1474#error-codes
  * https://eips.ethereum.org/EIPS/eip-1193#provider-errors
  */
-export declare const getTransactionNotSentMessage: (step?: LifiStep, process?: Process) => Promise<string>;
-export declare const getTransactionFailedMessage: (step: LifiStep, txLink?: string) => Promise<string>;
-export declare const parseError: (e: any, step?: LifiStep, process?: Process) => Promise<LiFiError>;
+export declare const getTransactionNotSentMessage: (step?: LiFiStep, process?: Process) => Promise<string>;
+export declare const getTransactionFailedMessage: (step: LiFiStep, txLink?: string) => Promise<string>;
+export declare const parseError: (e: any, step?: LiFiStep, process?: Process) => Promise<LiFiError>;
 export declare const parseBackendError: (e: any) => Promise<LiFiError>;

package/dist/cjs/utils/parseError.js

@@ -1,13 +1,10 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.parseBackendError = exports.parseError = exports.getTransactionFailedMessage = exports.getTransactionNotSentMessage = void 0;
 const eth_rpc_errors_1 = require("eth-rpc-errors");
 const viem_1 = require("viem");
 const helpers_1 = require("../helpers");
-const ChainsService_1 = __importDefault(require("../services/ChainsService"));
+const ChainsService_1 = require("../services/ChainsService");
 const errors_1 = require("./errors");
 /**
  * Available MetaMask error codes:
@@ -44,7 +41,7 @@ const getTransactionNotSentMessage = async (step, process) => {
     let transactionNotSend = 'Transaction was not sent, your funds are still in your wallet';
     // add information about funds if available
     if (step) {
-        const chainService = ChainsService_1.default.getInstance();
+        const chainService = ChainsService_1.ChainsService.getInstance();
         const chain = await chainService.getChainById(step.action.fromChainId);
         transactionNotSend += ` (${(0, viem_1.formatUnits)(BigInt(step.action.fromAmount), step.action.fromToken.decimals)} ${step.action.fromToken.symbol} on ${chain.name})`;
     }
@@ -59,7 +56,7 @@ const getTransactionNotSentMessage = async (step, process) => {
 };
 exports.getTransactionNotSentMessage = getTransactionNotSentMessage;
 const getTransactionFailedMessage = async (step, txLink) => {
-    const chainsService = ChainsService_1.default.getInstance();
+    const chainsService = ChainsService_1.ChainsService.getInstance();
     const chain = await chainsService.getChainById(step.action.toChainId);
     const baseString = `It appears that your transaction may not have been successful.
   However, to confirm this, please check your ${chain.name} wallet for ${step.action.toToken.symbol}.`;

package/dist/cjs/version.d.ts

@@ -1,2 +1,2 @@
 export declare const name = "@lifi/sdk";
-export declare const version = "3.0.0-alpha.6";
+export declare const version = "3.0.0-alpha.8";

package/dist/cjs/version.js

@@ -2,4 +2,4 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.version = exports.name = void 0;
 exports.name = '@lifi/sdk';
-exports.version = '3.0.0-alpha.6';
+exports.version = '3.0.0-alpha.8';

package/dist/connectors.d.ts

@@ -1,6 +1,6 @@
+import type { ChainId } from '@lifi/types';
 import type { PublicClient } from 'viem';
 import type { Chain } from 'viem/chains';
-import type { ChainId } from './types';
 export declare const getChainById: (chainId: ChainId) => Chain | undefined;
 export declare const getRpcUrl: (chainId: ChainId) => Promise<string>;
 export declare const getRpcUrls: (chainId: ChainId) => Promise<string[]>;

package/dist/connectors.js

@@ -1,6 +1,6 @@
 import { createPublicClient, fallback, http } from 'viem';
 import * as chains from 'viem/chains'; // TODO: optimize using BE chains
-import ConfigService from './services/ConfigService';
+import { ConfigService } from './services/ConfigService';
 import { ServerError } from './utils/errors';
 // cached providers
 const publicClients = {};

package/dist/execution/BaseStepExecutor.d.ts

@@ -0,0 +1,12 @@
+import type { LiFiStep } from '@lifi/types';
+import type { StatusManager } from './StatusManager';
+import type { InteractionSettings, InternalExecutionSettings, StepExecutorOptions } from './types';
+export declare abstract class BaseStepExecutor {
+    settings: InternalExecutionSettings;
+    statusManager: StatusManager;
+    allowUserInteraction: boolean;
+    allowExecution: boolean;
+    constructor(options: StepExecutorOptions);
+    setInteraction: (settings?: InteractionSettings) => void;
+    abstract executeStep(step: LiFiStep): Promise<LiFiStep>;
+}

package/dist/execution/BaseStepExecutor.js

@@ -0,0 +1,23 @@
+// Please be careful when changing the defaults as it may break the behavior (e.g., background execution)
+const defaultInteractionSettings = {
+    allowInteraction: true,
+    allowUpdates: true,
+    allowExecution: true,
+};
+export class BaseStepExecutor {
+    constructor(options) {
+        this.allowUserInteraction = true;
+        this.allowExecution = true;
+        this.setInteraction = (settings) => {
+            const interactionSettings = {
+                ...defaultInteractionSettings,
+                ...settings,
+            };
+            this.allowUserInteraction = interactionSettings.allowInteraction;
+            this.statusManager.allowUpdates(interactionSettings.allowUpdates);
+            this.allowExecution = interactionSettings.allowExecution;
+        };
+        this.statusManager = options.statusManager;
+        this.settings = options.settings;
+    }
+}

package/dist/execution/EVMStepExecutor.d.ts

@@ -0,0 +1,13 @@
+import type { LiFiStep } from '@lifi/types';
+import type { WalletClient } from 'viem';
+import { BaseStepExecutor } from './BaseStepExecutor';
+import type { StepExecutorOptions } from './types';
+export interface EVMStepExecutorOptions extends StepExecutorOptions {
+    walletClient: WalletClient;
+}
+export declare class EVMStepExecutor extends BaseStepExecutor {
+    walletClient: WalletClient;
+    constructor(options: EVMStepExecutorOptions);
+    checkChain: () => never;
+    executeStep: (step: LiFiStep) => Promise<LiFiStep>;
+}