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

package/src/utils/utils.ts

@@ -0,0 +1,48 @@
+import { AddressZero, AlternativeAddressZero } from '../constants.js'
+
+export const wait = (ms: number): Promise<undefined> => {
+  return new Promise((resolve) => {
+    setTimeout(resolve, ms)
+  })
+}
+
+/**
+ * Repeatedly calls a given asynchronous function until it resolves with a value
+ * @param toRepeat The function that should be repeated
+ * @param timeout The timeout in milliseconds between retries, defaults to 5000
+ * @returns The result of the toRepeat function
+ */
+export const repeatUntilDone = async <T>(
+  toRepeat: () => Promise<T | undefined>,
+  timeout = 5000
+): Promise<T> => {
+  let result: T | undefined
+
+  while (!result) {
+    result = await toRepeat()
+    if (!result) {
+      await wait(timeout)
+    }
+  }
+
+  return result
+}
+
+export const isZeroAddress = (address: string): boolean => {
+  if (address === AddressZero || address === AlternativeAddressZero) {
+    return true
+  }
+  return false
+}
+
+export const isNativeTokenAddress = (address: string): boolean => {
+  if (
+    address === AddressZero ||
+    address === AlternativeAddressZero ||
+    // CELO native token
+    address === '0x471ece3750da237f93b8e339c536989b8978a438'
+  ) {
+    return true
+  }
+  return false
+}

package/src/version.ts

@@ -0,0 +1,2 @@
+export const name = '@lifi/sdk'
+export const version = '3.0.0-alpha.60'

package/dist/LiFi.d.ts

@@ -1,175 +0,0 @@
-import type { ChainId, ChainKey, ConnectionsRequest, ConnectionsResponse, ContractCallQuoteRequest, ExtendedChain, GasRecommendationRequest, GasRecommendationResponse, GetStatusRequest, LifiStep, PossibilitiesRequest, PossibilitiesResponse, QuoteRequest, RequestOptions, RoutesRequest, RoutesResponse, StatusResponse, Token, TokenAmount, TokensRequest, TokensResponse, ToolsRequest, ToolsResponse } from '@lifi/types';
-import type { Hash, PublicClient } from 'viem';
-import type { ApproveTokenRequest, RevokeApprovalRequest, TokenAllowance, TokenSpender } from './allowance';
-import { RouteExecutionManager } from './execution/RouteExecutionManager';
-import type { Config, ConfigUpdate } from './types';
-export declare class LiFi extends RouteExecutionManager {
-    private chainsService;
-    constructor(configUpdate: ConfigUpdate);
-    /**
-     * Get the current configuration of the SDK
-     * @returns - The config object
-     */
-    getConfig: () => Config;
-    /**
-     * Get the SDK configuration after all setup calls are finished
-     * @returns - The config object
-     */
-    getConfigAsync: () => Promise<Config>;
-    /**
-     * Get an instance of a provider for a specific chain
-     * @param chainId - Id of the chain the provider is for
-     * @returns The public client for the given chain
-     */
-    getPublicClient: (chainId: number) => Promise<PublicClient>;
-    /**
-     * Set a new confuration for the SDK
-     * @param configUpdate - An object containing the configuration fields that should be updated.
-     * @returns The renewed config object
-     */
-    setConfig: (configUpdate: Partial<ConfigUpdate>) => Config;
-    /**
-     * Get a set of current possibilities based on a request that specifies which chains, exchanges and bridges are preferred or unwanted.
-     * @param request - Object defining preferences regarding chain, exchanges and bridges
-     * @param options
-     * @returns Object listing current possibilities for any-to-any cross-chain-swaps based on the provided preferences.
-     * @throws {LiFiError} Throws a LiFiError if request fails.
-     * @deprecated We don't want to support this endpoint anymore in the future. /chains, /tools, /connections, and /tokens should be used instead
-     */
-    getPossibilities: (request?: PossibilitiesRequest, options?: RequestOptions) => Promise<PossibilitiesResponse>;
-    /**
-     * Fetch information about a Token
-     * @param chain - Id or key of the chain that contains the token
-     * @param token - Address or symbol of the token on the requested chain
-     * @param options
-     * @throws {LiFiError} - Throws a LiFiError if request fails
-     */
-    getToken: (chain: ChainKey | ChainId, token: string, options?: RequestOptions) => Promise<Token>;
-    /**
-     * Get a quote for a token transfer
-     * @param request - The configuration of the requested quote
-     * @param options
-     * @throws {LiFiError} - Throws a LiFiError if request fails
-     */
-    getQuote: (request: QuoteRequest, options?: RequestOptions) => Promise<LifiStep>;
-    /**
-     * Get a quote for a destination contract call
-     * @param request - The configuration of the requested destination call
-     * @param options
-     * @throws {LiFiError} - Throws a LiFiError if request fails
-     * @returns - Returns step.
-     */
-    getContractCallQuote: (request: ContractCallQuoteRequest, options?: RequestOptions) => Promise<LifiStep>;
-    /**
-     * Check the status of a transfer. For cross chain transfers, the "bridge" parameter is required.
-     * @param request - Configuration of the requested status
-     * @param options - Rrquest options.
-     * @throws {LiFiError} - Throws a LiFiError if request fails
-     * @returns Returns status response.
-     */
-    getStatus: (request: GetStatusRequest, options?: RequestOptions) => Promise<StatusResponse>;
-    /**
-     * Get the available tools to bridge and swap tokens.
-     * @param request - The configuration of the requested tools
-     * @param options
-     * @returns The tools that are available on the requested chains
-     */
-    getTools: (request?: ToolsRequest, options?: RequestOptions) => Promise<ToolsResponse>;
-    /**
-     * Get all known tokens.
-     * @param request - The configuration of the requested tokens
-     * @param options
-     * @returns The tokens that are available on the requested chains
-     */
-    getTokens: (request?: TokensRequest, options?: RequestOptions) => Promise<TokensResponse>;
-    /**
-     * Get all available chains
-     * @returns A list of all available chains
-     * @throws {LiFiError} Throws a LiFiError if request fails.
-     */
-    getChains: () => Promise<ExtendedChain[]>;
-    /**
-     * Get a set of routes for a request that describes a transfer of tokens.
-     * @param request - A description of the transfer.
-     * @param options
-     * @returns The resulting routes that can be used to realize the described transfer of tokens.
-     * @throws {LiFiError} Throws a LiFiError if request fails.
-     */
-    getRoutes: (request: RoutesRequest, options?: RequestOptions) => Promise<RoutesResponse>;
-    /**
-     * Get the transaction data for a single step of a route
-     * @param step - The step object.
-     * @param options
-     * @returns The step populated with the transaction data.
-     * @throws {LiFiError} Throws a LiFiError if request fails.
-     */
-    getStepTransaction: (step: LifiStep, options?: RequestOptions) => Promise<LifiStep>;
-    /**
-     * Get gas recommendation for a certain chain
-     * @param request - Configuration of the requested recommendation.
-     * @param options
-     * @throws {LiFiError} Throws a LiFiError if request fails.
-     */
-    getGasRecommendation: (request: GasRecommendationRequest, options?: RequestOptions) => Promise<GasRecommendationResponse>;
-    /**
-     * Returns the balances of a specific token a wallet holds across all aggregated chains.
-     * @param walletAddress - A wallet address.
-     * @param token - A Token object.
-     * @returns An object containing the token and the amounts on different chains.
-     * @throws {ValidationError} Throws a ValidationError if parameters are invalid.
-     */
-    getTokenBalance: (walletAddress: string, token: Token) => Promise<TokenAmount | null>;
-    /**
-     * Returns the balances for a list tokens a wallet holds  across all aggregated chains.
-     * @param walletAddress - A wallet address.
-     * @param tokens - A list of Token objects.
-     * @returns A list of objects containing the tokens and the amounts on different chains.
-     * @throws {ValidationError} Throws a ValidationError if parameters are invalid.
-     */
-    getTokenBalances: (walletAddress: string, tokens: Token[]) => Promise<TokenAmount[]>;
-    /**
-     * This method queries the balances of tokens for a specific list of chains for a given wallet.
-     * @param walletAddress - A walletaddress.
-     * @param tokensByChain - A list of Token objects organized by chain ids.
-     * @returns A list of objects containing the tokens and the amounts on different chains organized by the chosen chains.
-     * @throws {ValidationError} Throws a ValidationError if parameters are invalid.
-     */
-    getTokenBalancesByChain: (walletAddress: string, tokensByChain: {
-        [chainId: number]: Token[];
-    }) => Promise<{
-        [chainId: number]: TokenAmount[];
-    }>;
-    /**
-     * Get the current allowance for a certain token.
-     * @param token - The token that should be checked
-     * @param ownerAddress - The owner of the token
-     * @param spenderAddress - The spender address that has to be approved
-     * @returns Returns allowance
-     */
-    getTokenAllowance: (token: Token, ownerAddress: string, spenderAddress: string) => Promise<bigint | undefined>;
-    /**
-     * Get the current allowance for a list of token/spender address pairs.
-     * @param ownerAddress - The owner of the tokens
-     * @param tokens - A list of token and spender address pairs
-     * @returns Returns array of tokens and their allowance
-     */
-    getTokenAllowanceMulticall: (ownerAddress: string, tokens: TokenSpender[]) => Promise<TokenAllowance[]>;
-    /**
-     * Set approval for a certain token and amount.
-     * @param request - The approval request
-     * @returns Returns Hash or nothing
-     */
-    setTokenApproval: (request: ApproveTokenRequest) => Promise<Hash | undefined>;
-    /**
-     * Revoke approval for a certain token.
-     * @param request - The revoke request
-     * @returns Returns Hash or nothing
-     */
-    revokeTokenApproval: (request: RevokeApprovalRequest) => Promise<Hash | undefined>;
-    /**
-     * Get all the available connections for swap/bridging tokens
-     * @param connectionRequest ConnectionsRequest
-     * @returns ConnectionsResponse
-     */
-    getConnections: (connectionRequest: ConnectionsRequest) => Promise<ConnectionsResponse>;
-}

package/dist/LiFi.js

@@ -1,250 +0,0 @@
-import { getTokenAllowance, getTokenAllowanceMulticall, revokeTokenApproval, setTokenAllowance, } from './allowance';
-import * as balance from './balance';
-import { getPublicClient } from './connectors';
-import { RouteExecutionManager } from './execution/RouteExecutionManager';
-import { checkPackageUpdates } from './helpers';
-import ApiService from './services/ApiService';
-import ChainsService from './services/ChainsService';
-import { isToken } from './typeguards';
-import { ValidationError } from './utils/errors';
-import { name, version } from './version';
-export class LiFi extends RouteExecutionManager {
-    constructor(configUpdate) {
-        super(configUpdate);
-        /**
-         * Get the current configuration of the SDK
-         * @returns - The config object
-         */
-        this.getConfig = () => {
-            return this.configService.getConfig();
-        };
-        /**
-         * Get the SDK configuration after all setup calls are finished
-         * @returns - The config object
-         */
-        this.getConfigAsync = () => {
-            return this.configService.getConfigAsync();
-        };
-        /**
-         * Get an instance of a provider for a specific chain
-         * @param chainId - Id of the chain the provider is for
-         * @returns The public client for the given chain
-         */
-        this.getPublicClient = (chainId) => {
-            return getPublicClient(chainId);
-        };
-        /**
-         * Set a new confuration for the SDK
-         * @param configUpdate - An object containing the configuration fields that should be updated.
-         * @returns The renewed config object
-         */
-        this.setConfig = (configUpdate) => {
-            return this.configService.updateConfig(configUpdate);
-        };
-        /**
-         * Get a set of current possibilities based on a request that specifies which chains, exchanges and bridges are preferred or unwanted.
-         * @param request - Object defining preferences regarding chain, exchanges and bridges
-         * @param options
-         * @returns Object listing current possibilities for any-to-any cross-chain-swaps based on the provided preferences.
-         * @throws {LiFiError} Throws a LiFiError if request fails.
-         * @deprecated We don't want to support this endpoint anymore in the future. /chains, /tools, /connections, and /tokens should be used instead
-         */
-        this.getPossibilities = async (request, options) => {
-            return ApiService.getPossibilities(request, options);
-        };
-        /**
-         * Fetch information about a Token
-         * @param chain - Id or key of the chain that contains the token
-         * @param token - Address or symbol of the token on the requested chain
-         * @param options
-         * @throws {LiFiError} - Throws a LiFiError if request fails
-         */
-        this.getToken = async (chain, token, options) => {
-            return ApiService.getToken(chain, token, options);
-        };
-        /**
-         * Get a quote for a token transfer
-         * @param request - The configuration of the requested quote
-         * @param options
-         * @throws {LiFiError} - Throws a LiFiError if request fails
-         */
-        this.getQuote = async (request, options) => {
-            return ApiService.getQuote(request, options);
-        };
-        /**
-         * Get a quote for a destination contract call
-         * @param request - The configuration of the requested destination call
-         * @param options
-         * @throws {LiFiError} - Throws a LiFiError if request fails
-         * @returns - Returns step.
-         */
-        this.getContractCallQuote = async (request, options) => {
-            return ApiService.getContractCallQuote(request, options);
-        };
-        /**
-         * Check the status of a transfer. For cross chain transfers, the "bridge" parameter is required.
-         * @param request - Configuration of the requested status
-         * @param options - Rrquest options.
-         * @throws {LiFiError} - Throws a LiFiError if request fails
-         * @returns Returns status response.
-         */
-        this.getStatus = async (request, options) => {
-            return ApiService.getStatus(request, options);
-        };
-        /**
-         * Get the available tools to bridge and swap tokens.
-         * @param request - The configuration of the requested tools
-         * @param options
-         * @returns The tools that are available on the requested chains
-         */
-        this.getTools = async (request, options) => {
-            return ApiService.getTools(request || {}, options);
-        };
-        /**
-         * Get all known tokens.
-         * @param request - The configuration of the requested tokens
-         * @param options
-         * @returns The tokens that are available on the requested chains
-         */
-        this.getTokens = async (request, options) => {
-            return ApiService.getTokens(request || {}, options);
-        };
-        /**
-         * Get all available chains
-         * @returns A list of all available chains
-         * @throws {LiFiError} Throws a LiFiError if request fails.
-         */
-        this.getChains = async () => {
-            return this.chainsService.getChains();
-        };
-        /**
-         * Get a set of routes for a request that describes a transfer of tokens.
-         * @param request - A description of the transfer.
-         * @param options
-         * @returns The resulting routes that can be used to realize the described transfer of tokens.
-         * @throws {LiFiError} Throws a LiFiError if request fails.
-         */
-        this.getRoutes = async (request, options) => {
-            return ApiService.getRoutes(request, options);
-        };
-        /**
-         * Get the transaction data for a single step of a route
-         * @param step - The step object.
-         * @param options
-         * @returns The step populated with the transaction data.
-         * @throws {LiFiError} Throws a LiFiError if request fails.
-         */
-        this.getStepTransaction = async (step, options) => {
-            return ApiService.getStepTransaction(step, options);
-        };
-        /**
-         * Get gas recommendation for a certain chain
-         * @param request - Configuration of the requested recommendation.
-         * @param options
-         * @throws {LiFiError} Throws a LiFiError if request fails.
-         */
-        this.getGasRecommendation = async (request, options) => {
-            return ApiService.getGasRecommendation(request, options);
-        };
-        /**
-         * Returns the balances of a specific token a wallet holds across all aggregated chains.
-         * @param walletAddress - A wallet address.
-         * @param token - A Token object.
-         * @returns An object containing the token and the amounts on different chains.
-         * @throws {ValidationError} Throws a ValidationError if parameters are invalid.
-         */
-        this.getTokenBalance = async (walletAddress, token) => {
-            if (!walletAddress) {
-                throw new ValidationError('Missing walletAddress.');
-            }
-            if (!isToken(token)) {
-                throw new ValidationError(`Invalid token passed: address "${token.address}" on chainId "${token.chainId}"`);
-            }
-            return balance.getTokenBalance(walletAddress, token);
-        };
-        /**
-         * Returns the balances for a list tokens a wallet holds  across all aggregated chains.
-         * @param walletAddress - A wallet address.
-         * @param tokens - A list of Token objects.
-         * @returns A list of objects containing the tokens and the amounts on different chains.
-         * @throws {ValidationError} Throws a ValidationError if parameters are invalid.
-         */
-        this.getTokenBalances = async (walletAddress, tokens) => {
-            if (!walletAddress) {
-                throw new ValidationError('Missing walletAddress.');
-            }
-            const invalidTokens = tokens.filter((token) => !isToken(token));
-            if (invalidTokens.length) {
-                throw new ValidationError(`Invalid token passed: address "${invalidTokens[0].address}" on chainId "${invalidTokens[0].chainId}"`);
-            }
-            return balance.getTokenBalances(walletAddress, tokens);
-        };
-        /**
-         * This method queries the balances of tokens for a specific list of chains for a given wallet.
-         * @param walletAddress - A walletaddress.
-         * @param tokensByChain - A list of Token objects organized by chain ids.
-         * @returns A list of objects containing the tokens and the amounts on different chains organized by the chosen chains.
-         * @throws {ValidationError} Throws a ValidationError if parameters are invalid.
-         */
-        this.getTokenBalancesByChain = async (walletAddress, tokensByChain) => {
-            if (!walletAddress) {
-                throw new ValidationError('Missing walletAddress.');
-            }
-            const tokenList = Object.values(tokensByChain).flat();
-            const invalidTokens = tokenList.filter((token) => !isToken(token));
-            if (invalidTokens.length) {
-                throw new ValidationError(`Invalid token passed: address "${invalidTokens[0].address}" on chainId "${invalidTokens[0].chainId}"`);
-            }
-            return balance.getTokenBalancesByChain(walletAddress, tokensByChain);
-        };
-        /**
-         * Get the current allowance for a certain token.
-         * @param token - The token that should be checked
-         * @param ownerAddress - The owner of the token
-         * @param spenderAddress - The spender address that has to be approved
-         * @returns Returns allowance
-         */
-        this.getTokenAllowance = async (token, ownerAddress, spenderAddress) => {
-            return getTokenAllowance(token, ownerAddress, spenderAddress);
-        };
-        /**
-         * Get the current allowance for a list of token/spender address pairs.
-         * @param ownerAddress - The owner of the tokens
-         * @param tokens - A list of token and spender address pairs
-         * @returns Returns array of tokens and their allowance
-         */
-        this.getTokenAllowanceMulticall = async (ownerAddress, tokens) => {
-            return getTokenAllowanceMulticall(ownerAddress, tokens);
-        };
-        /**
-         * Set approval for a certain token and amount.
-         * @param request - The approval request
-         * @returns Returns Hash or nothing
-         */
-        this.setTokenApproval = (request) => {
-            return setTokenAllowance(request);
-        };
-        /**
-         * Revoke approval for a certain token.
-         * @param request - The revoke request
-         * @returns Returns Hash or nothing
-         */
-        this.revokeTokenApproval = (request) => {
-            return revokeTokenApproval(request);
-        };
-        /**
-         * Get all the available connections for swap/bridging tokens
-         * @param connectionRequest ConnectionsRequest
-         * @returns ConnectionsResponse
-         */
-        this.getConnections = async (connectionRequest) => {
-            const connections = await ApiService.getAvailableConnections(connectionRequest);
-            return connections;
-        };
-        this.chainsService = ChainsService.getInstance();
-        this.chainsService.getChains().then((chains) => {
-            this.configService.updateChains(chains);
-        });
-        checkPackageUpdates(name, version, configUpdate.disableVersionCheck);
-    }
-}

package/dist/allowance/getAllowance.d.ts

@@ -1,6 +0,0 @@
-import type { ChainId, Token } from '@lifi/types';
-import type { TokenAllowance, TokenSpender, TokenSpenderAllowance } from './types';
-export declare const getAllowance: (chainId: ChainId, tokenAddress: string, ownerAddress: string, spenderAddress: string) => Promise<bigint>;
-export declare const getAllowanceMulticall: (chainId: ChainId, tokens: TokenSpender[], ownerAddress: string) => Promise<TokenSpenderAllowance[]>;
-export declare const getTokenAllowance: (token: Token, ownerAddress: string, spenderAddress: string) => Promise<bigint | undefined>;
-export declare const getTokenAllowanceMulticall: (ownerAddress: string, tokens: TokenSpender[]) => Promise<TokenAllowance[]>;

package/dist/allowance/index.d.ts

@@ -1,3 +0,0 @@
-export * from './getAllowance';
-export * from './setAllowance';
-export * from './types';

package/dist/allowance/index.js

@@ -1,3 +0,0 @@
-export * from './getAllowance';
-export * from './setAllowance';
-export * from './types';

package/dist/allowance/setAllowance.d.ts

@@ -1,6 +0,0 @@
-import type { Hash, WalletClient } from 'viem';
-import type { InternalExecutionSettings } from '../types';
-import type { ApproveTokenRequest, RevokeApprovalRequest } from './types';
-export declare const setAllowance: (walletClient: WalletClient, tokenAddress: string, contractAddress: string, amount: bigint, settings?: InternalExecutionSettings, returnPopulatedTransaction?: boolean) => Promise<Hash>;
-export declare const setTokenAllowance: ({ walletClient, token, spenderAddress, amount, infiniteApproval, }: ApproveTokenRequest) => Promise<Hash | undefined>;
-export declare const revokeTokenApproval: ({ walletClient, token, spenderAddress, }: RevokeApprovalRequest) => Promise<Hash | undefined>;

package/dist/allowance/types.d.ts

@@ -1,27 +0,0 @@
-import type { Token } from '@lifi/types';
-import type { WalletClient } from 'viem';
-export type TokenSpender = {
-    token: Token;
-    spenderAddress: string;
-};
-export type TokenAllowance = {
-    token: Token;
-    allowance?: bigint;
-};
-export type TokenSpenderAllowance = {
-    token: Token;
-    spenderAddress: string;
-    allowance?: bigint;
-};
-export interface ApproveTokenRequest {
-    walletClient: WalletClient;
-    token: Token;
-    spenderAddress: string;
-    amount: bigint;
-    infiniteApproval?: boolean;
-}
-export interface RevokeApprovalRequest {
-    walletClient: WalletClient;
-    token: Token;
-    spenderAddress: string;
-}

package/dist/allowance/types.js

@@ -1 +0,0 @@
-export {};

package/dist/balance/getBalance.d.ts

@@ -1,2 +0,0 @@
-import type { Token, TokenAmount } from '@lifi/types';
-export declare const getBalance: (walletAddress: string, tokens: Token[]) => Promise<TokenAmount[]>;

package/dist/balance/getTokenBalance.d.ts

@@ -1,8 +0,0 @@
-import type { Token, TokenAmount } from '@lifi/types';
-export declare const getTokenBalance: (walletAddress: string, token: Token) => Promise<TokenAmount | null>;
-export declare const getTokenBalances: (walletAddress: string, tokens: Token[]) => Promise<TokenAmount[]>;
-export declare const getTokenBalancesByChain: (walletAddress: string, tokensByChain: {
-    [chainId: number]: Token[];
-}) => Promise<{
-    [chainId: number]: TokenAmount[];
-}>;

package/dist/balance/getTokenBalance.js

@@ -1,27 +0,0 @@
-import { getBalance } from './getBalance';
-export const getTokenBalance = async (walletAddress, token) => {
-    const tokenAmounts = await getTokenBalances(walletAddress, [token]);
-    return tokenAmounts.length ? tokenAmounts[0] : null;
-};
-export const getTokenBalances = async (walletAddress, tokens) => {
-    // split by chain
-    const tokensByChain = {};
-    tokens.forEach((token) => {
-        if (!tokensByChain[token.chainId]) {
-            tokensByChain[token.chainId] = [];
-        }
-        tokensByChain[token.chainId].push(token);
-    });
-    const tokenAmountsByChain = await getTokenBalancesByChain(walletAddress, tokensByChain);
-    return Object.values(tokenAmountsByChain).flat();
-};
-export const getTokenBalancesByChain = async (walletAddress, tokensByChain) => {
-    const tokenAmountsByChain = {};
-    const promises = Object.keys(tokensByChain).map(async (chainIdStr) => {
-        const chainId = parseInt(chainIdStr);
-        const tokenAmounts = await getBalance(walletAddress, tokensByChain[chainId]);
-        tokenAmountsByChain[chainId] = tokenAmounts;
-    });
-    await Promise.allSettled(promises);
-    return tokenAmountsByChain;
-};

package/dist/balance/index.d.ts

@@ -1,2 +0,0 @@
-export * from './getBalance';
-export * from './getTokenBalance';

package/dist/balance/index.js

@@ -1,2 +0,0 @@
-export * from './getBalance';
-export * from './getTokenBalance';