@lifi/sdk 2.3.1 → 3.0.0-alpha.10

package/dist/cjs/execution/stepComparison.d.ts

@@ -1,14 +0,0 @@
-import { StatusManager } from '.';
-import { InternalExecutionSettings, LifiStep } from '../types';
-/**
- * This method checks whether the new and updated Step meets the required exchange rate conditions.
- * If yes it returns the updated Step.
- * If no and if user interaction is allowed it triggers the acceptExchangeRateUpdateHook. If no user interaction is allowed it aborts.
- *
- * @param statusManager
- * @param oldStep
- * @param newStep
- * @param settings
- * @param allowUserInteraction
- */
-export declare const stepComparison: (statusManager: StatusManager, oldStep: LifiStep, newStep: LifiStep, settings: InternalExecutionSettings, allowUserInteraction: boolean) => Promise<LifiStep>;

package/dist/cjs/execution/switchChain.d.ts

@@ -1,16 +0,0 @@
-import { LifiStep } from '@lifi/types';
-import { Signer } from 'ethers';
-import { SwitchChainHook } from '../types';
-import { StatusManager } from './StatusManager';
-/**
- * This method checks whether the signer is configured for the correct chain.
- * If yes it returns the signer.
- * If no and if user interaction is allowed it triggers the switchChainHook. If no user interaction is allowed it aborts.
- *
- * @param signer
- * @param statusManager
- * @param step
- * @param switchChainHook
- * @param allowUserInteraction
- */
-export declare const switchChain: (signer: Signer, statusManager: StatusManager, step: LifiStep, switchChainHook: SwitchChainHook, allowUserInteraction: boolean) => Promise<Signer | undefined>;

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

@@ -1,6 +0,0 @@
-import { LifiStep, ProcessType, Status, StatusMessage, StatusResponse, Substatus } from '@lifi/types';
-import { StatusManager } from '..';
-export declare function waitForReceivingTransaction(txHash: string, statusManager: StatusManager, processType: ProcessType, step: LifiStep): Promise<StatusResponse>;
-export declare function getProcessMessage(type: ProcessType, status: Status): string | undefined;
-export declare function getSubstatusMessage(status: StatusMessage, substatus?: Substatus): string | undefined;
-export declare function checkStepSlippageThreshold(oldStep: LifiStep, newStep: LifiStep): boolean;

package/dist/cjs/helpers.d.ts

@@ -1,28 +0,0 @@
-import { LifiStep, Route, Token } from '@lifi/types';
-import { TenderlyResponse } from './types';
-/**
- * Predefined hook that decrypts calldata using EIP-1193 compliant wallet functions.
- * @param {string} walletAddress - The wallet address of the user that should decrypt the calldata.
- * @return {(encryptedData: string) => Promise<any>} A function that decrypts data using EIP-1193 compliant wallet functions.
- */
-export declare const getEthereumDecryptionHook: (walletAddress: string) => (encryptedData: string) => Promise<string>;
-/**
- * Predefined hook that get the public encryption key of a user using EIP-1193 compliant wallet functions.
- * @param {string} walletAddress - The wallet address of the user.
- * @return {(walletAddress: string) => () => Promise<any>} A function that return the public encryption key using EIP-1193 compliant wallet functions.
- */
-export declare const getEthereumPublicKeyHook: (walletAddress: string) => () => Promise<string>;
-/**
- * Returns a random number between min (inclusive) and max (inclusive)
- */
-export declare const getRandomNumber: (min: number, max: number) => number;
-export declare const isSameToken: (tokenA: Token, tokenB: Token) => boolean;
-export declare const checkPackageUpdates: (packageName?: string, packageVersion?: string, disableCheck?: boolean) => Promise<void>;
-/**
- * Converts a quote to Route
- * @param {LifiStep} step - Step returned from the quote endpoint.
- * @return {Route} - The route to be executed.
- * @throws {ValidationError} Throws a ValidationError if the step has missing values.
- */
-export declare const convertQuoteToRoute: (step: LifiStep) => Route;
-export declare const fetchTxErrorDetails: (txHash: string, chainId: number) => Promise<TenderlyResponse>;

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/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/services/ChainsService.d.ts

@@ -1,11 +0,0 @@
-import { 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/ConfigService.d.ts

@@ -1,23 +0,0 @@
-import { 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/types/ERC20.d.ts

@@ -1,22 +0,0 @@
-import { BaseContract, BigNumber, BigNumberish, CallOverrides, ContractTransaction, Overrides } from 'ethers';
-export declare const ERC20_ABI: {
-    name: string;
-    inputs: {
-        internalType: string;
-        name: string;
-        type: string;
-    }[];
-    outputs: {
-        internalType: string;
-        name: string;
-        type: string;
-    }[];
-    stateMutability: string;
-    type: string;
-}[];
-export interface ERC20Contract extends BaseContract {
-    allowance(owner: string, spender: string, overrides?: CallOverrides): Promise<BigNumber>;
-    approve(spender: string, amount: BigNumberish, overrides?: Overrides & {
-        from?: string | Promise<string>;
-    }): Promise<ContractTransaction>;
-}

package/dist/cjs/types/ERC20.js

@@ -1,53 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ERC20_ABI = void 0;
-exports.ERC20_ABI = [
-    {
-        name: 'approve',
-        inputs: [
-            {
-                internalType: 'address',
-                name: 'spender',
-                type: 'address',
-            },
-            {
-                internalType: 'uint256',
-                name: 'amount',
-                type: 'uint256',
-            },
-        ],
-        outputs: [
-            {
-                internalType: 'bool',
-                name: '',
-                type: 'bool',
-            },
-        ],
-        stateMutability: 'nonpayable',
-        type: 'function',
-    },
-    {
-        name: 'allowance',
-        inputs: [
-            {
-                internalType: 'address',
-                name: 'owner',
-                type: 'address',
-            },
-            {
-                internalType: 'address',
-                name: 'spender',
-                type: 'address',
-            },
-        ],
-        outputs: [
-            {
-                internalType: 'uint256',
-                name: '',
-                type: 'uint256',
-            },
-        ],
-        stateMutability: 'view',
-        type: 'function',
-    },
-];

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

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

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

@@ -1,151 +0,0 @@
-import { TransactionRequest } from '@ethersproject/abstract-provider';
-import { LifiStep, Route, RouteOptions, Token } from '@lifi/types';
-import BigNumber from 'bignumber.js';
-import { Signer } from 'ethers';
-import { ChainId } from '.';
-import { StatusManager } from '../execution/StatusManager';
-import { StepExecutor } from '../execution/StepExecutor';
-export interface TokenWithAmounts extends Token {
-    amount?: BigNumber;
-    amountRendered?: string;
-}
-export type ParsedReceipt = {
-    fromAmount?: string;
-    toAmount: string;
-    gasUsed: string;
-    gasPrice: string;
-    gasFee: string;
-    toTokenAddress?: string;
-};
-export interface ExecutionParams {
-    signer: Signer;
-    step: LifiStep;
-    statusManager: StatusManager;
-    settings: InternalExecutionSettings;
-}
-export type UpdateRouteHook = (updatedRoute: Route) => void;
-export type TransactionRequestUpdateHook = (updatedTxRequest: TransactionRequest) => Promise<TransactionRequest>;
-export type Config = {
-    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;
-    multisigConfig?: MultisigConfig;
-};
-export interface MultisigTxDetails {
-    status: 'DONE' | 'FAILED' | 'PENDING' | 'CANCELLED';
-    txHash?: string;
-}
-export interface MultisigTransactionResponse {
-    hash: string;
-}
-export interface BaseTransaction {
-    to: string;
-    value: string;
-    data: string;
-}
-export interface MultisigConfig {
-    isMultisigSigner?: boolean;
-    getMultisigTransactionDetails?: (txHash: string, fromChainId: number, updateIntermediateStatus?: () => void) => Promise<MultisigTxDetails>;
-    sendBatchTransaction?: (batchTransactions: BaseTransaction[]) => Promise<MultisigTransactionResponse>;
-    shouldBatchTransactions?: boolean;
-}
-export type ConfigUpdate = {
-    apiUrl?: string;
-    apiKey?: 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<Signer | 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 type RevokeTokenData = {
-    token: Token;
-    approvalAddress: string;
-};
-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;
-}

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

@@ -1,3 +0,0 @@
-import { Provider } from '@ethersproject/abstract-provider';
-import { Signer } from 'ethers';
-export declare const getProvider: (signer: Signer) => Provider;

package/dist/cjs/utils/getProvider.js

@@ -1,11 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getProvider = void 0;
-const errors_1 = require("./errors");
-const getProvider = (signer) => {
-    if (!signer.provider) {
-        throw new errors_1.ProviderError(errors_1.LifiErrorCode.ProviderUnavailable, 'No provider available in signer.');
-    }
-    return signer.provider;
-};
-exports.getProvider = getProvider;

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

@@ -1,10 +0,0 @@
-import { Fragment, JsonFragment } from '@ethersproject/abi';
-export type MultiCallData = {
-    address: string;
-    name: string;
-    params?: any[];
-};
-export declare const fetchDataUsingMulticall: (calls: Array<MultiCallData>, abi: ReadonlyArray<Fragment | JsonFragment | string>, chainId: number, multicallAddress: string, requireSuccess?: boolean) => Promise<{
-    data: unknown;
-    blockNumber: number;
-}[]>;

package/dist/cjs/utils/multicall.js

@@ -1,68 +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.fetchDataUsingMulticall = void 0;
-const abi_1 = require("@ethersproject/abi");
-const contracts_1 = require("@ethersproject/contracts");
-const connectors_1 = require("../connectors");
-const utils_1 = require("./utils");
-const multicallAbi_json_1 = __importDefault(require("./multicallAbi.json"));
-const MAX_MULTICALL_SIZE = 100;
-const fetchDataUsingMulticall = async (calls, abi, chainId, multicallAddress, requireSuccess = false) => {
-    // 1. create contract using multicall contract address and abi...
-    const provider = await (0, connectors_1.getRpcProvider)(chainId);
-    const multicallContract = new contracts_1.Contract(multicallAddress, multicallAbi_json_1.default, provider);
-    const abiInterface = new abi_1.Interface(abi);
-    // split up lists into chunks to stay below multicall limit
-    const chunkedList = (0, utils_1.splitListIntoChunks)(calls, MAX_MULTICALL_SIZE);
-    const chunkedResults = await Promise.all(chunkedList.map(async (chunkedCalls) => {
-        const callData = chunkedCalls.map((call) => [
-            call.address.toLowerCase(),
-            abiInterface.encodeFunctionData(call.name, call.params),
-        ]);
-        try {
-            // 3. get bytes array from multicall contract by process aggregate method...
-            const { blockNumber, returnData } = await multicallContract.tryBlockAndAggregate(requireSuccess, callData);
-            // 4. decode bytes array to useful data array...
-            return returnData
-                .map(({ success, returnData }, i) => {
-                if (!success) {
-                    // requested function failed
-                    console.error(`Multicall unsuccessful for address "${chunkedCalls[i].address}", ` +
-                        `function "${chunkedCalls[i].name}", chainId "${chainId}"`);
-                    return [];
-                }
-                if (returnData.toString() === '0x') {
-                    // requested function does probably not exist
-                    console.error(`Multicall no response for address "${chunkedCalls[i].address}", ` +
-                        `function "${chunkedCalls[i].name}", chainId "${chainId}"`);
-                    return [];
-                }
-                try {
-                    return abiInterface.decodeFunctionResult(chunkedCalls[i].name, returnData);
-                }
-                catch (e) {
-                    // requested function returns other data than expected
-                    console.error(`Multicall parsing unsuccessful for address "${chunkedCalls[i].address}", ` +
-                        `function "${chunkedCalls[i].name}", chainId "${chainId}"`);
-                    return [];
-                }
-            })
-                .map((data) => {
-                return {
-                    data: data[0],
-                    blockNumber: blockNumber.toNumber(),
-                };
-            });
-        }
-        catch (e) {
-            // whole rpc call failed, probably an rpc issue
-            console.error(`Multicall failed on chainId "${chainId}"`, chunkedList, e);
-            return [];
-        }
-    }));
-    return chunkedResults.flat();
-};
-exports.fetchDataUsingMulticall = fetchDataUsingMulticall;