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

package/dist/LiFi.d.ts

@@ -1,21 +1,21 @@
-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 { 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';
+import type { SDKConfig, SDKOptions } from './types';
 export declare class LiFi extends RouteExecutionManager {
     private chainsService;
-    constructor(configUpdate: ConfigUpdate);
+    constructor(options: SDKOptions);
     /**
      * Get the current configuration of the SDK
      * @returns - The config object
      */
-    getConfig: () => Config;
+    getConfig: () => SDKConfig;
     /**
      * Get the SDK configuration after all setup calls are finished
      * @returns - The config object
      */
-    getConfigAsync: () => Promise<Config>;
+    getConfigAsync: () => Promise<SDKConfig>;
     /**
      * Get an instance of a provider for a specific chain
      * @param chainId - Id of the chain the provider is for
@@ -27,11 +27,11 @@ export declare class LiFi extends RouteExecutionManager {
      * @param configUpdate - An object containing the configuration fields that should be updated.
      * @returns The renewed config object
      */
-    setConfig: (configUpdate: Partial<ConfigUpdate>) => Config;
+    setConfig: (configUpdate: Partial<SDKOptions>) => SDKConfig;
     /**
      * 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
+     * @param options - Request 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
@@ -41,25 +41,27 @@ export declare class LiFi extends RouteExecutionManager {
      * 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
+     * @param options - Request options
      * @throws {LiFiError} - Throws a LiFiError if request fails
+     * @returns Token information
      */
     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
+     * @param options - Request options
      * @throws {LiFiError} - Throws a LiFiError if request fails
+     * @returns Quote for a token transfer
      */
-    getQuote: (request: QuoteRequest, options?: RequestOptions) => Promise<LifiStep>;
+    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
+     * @param options - Request options
      * @throws {LiFiError} - Throws a LiFiError if request fails
      * @returns - Returns step.
      */
-    getContractCallQuote: (request: ContractCallQuoteRequest, options?: RequestOptions) => Promise<LifiStep>;
+    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
@@ -71,14 +73,14 @@ export declare class LiFi extends RouteExecutionManager {
     /**
      * Get the available tools to bridge and swap tokens.
      * @param request - The configuration of the requested tools
-     * @param options
+     * @param options - Request 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
+     * @param options - Request options
      * @returns The tokens that are available on the requested chains
      */
     getTokens: (request?: TokensRequest, options?: RequestOptions) => Promise<TokensResponse>;
@@ -91,7 +93,7 @@ export declare class LiFi extends RouteExecutionManager {
     /**
      * Get a set of routes for a request that describes a transfer of tokens.
      * @param request - A description of the transfer.
-     * @param options
+     * @param options - Request options
      * @returns The resulting routes that can be used to realize the described transfer of tokens.
      * @throws {LiFiError} Throws a LiFiError if request fails.
      */
@@ -99,16 +101,17 @@ export declare class LiFi extends RouteExecutionManager {
     /**
      * Get the transaction data for a single step of a route
      * @param step - The step object.
-     * @param options
+     * @param options - Request options
      * @returns The step populated with the transaction data.
      * @throws {LiFiError} Throws a LiFiError if request fails.
      */
-    getStepTransaction: (step: LifiStep, options?: RequestOptions) => Promise<LifiStep>;
+    getStepTransaction: (step: LiFiStep, options?: RequestOptions) => Promise<LiFiStep>;
     /**
      * Get gas recommendation for a certain chain
      * @param request - Configuration of the requested recommendation.
-     * @param options
+     * @param options - Request options
      * @throws {LiFiError} Throws a LiFiError if request fails.
+     * @returns Gas recommendation response.
      */
     getGasRecommendation: (request: GasRecommendationRequest, options?: RequestOptions) => Promise<GasRecommendationResponse>;
     /**
@@ -144,24 +147,28 @@ export declare class LiFi extends RouteExecutionManager {
      * @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.
+     * 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 | void>;
+    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 | void>;
+    revokeTokenApproval: (request: RevokeApprovalRequest) => Promise<Hash | undefined>;
     /**
      * Get all the available connections for swap/bridging tokens
      * @param connectionRequest ConnectionsRequest

package/dist/LiFi.js

@@ -9,8 +9,8 @@ import { isToken } from './typeguards';
 import { ValidationError } from './utils/errors';
 import { name, version } from './version';
 export class LiFi extends RouteExecutionManager {
-    constructor(configUpdate) {
-        super(configUpdate);
+    constructor(options) {
+        super(options);
         /**
          * Get the current configuration of the SDK
          * @returns - The config object
@@ -44,7 +44,7 @@ export class LiFi extends RouteExecutionManager {
         /**
          * 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
+         * @param options - Request 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
@@ -56,8 +56,9 @@ export class LiFi extends RouteExecutionManager {
          * 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
+         * @param options - Request options
          * @throws {LiFiError} - Throws a LiFiError if request fails
+         * @returns Token information
          */
         this.getToken = async (chain, token, options) => {
             return ApiService.getToken(chain, token, options);
@@ -65,8 +66,9 @@ export class LiFi extends RouteExecutionManager {
         /**
          * Get a quote for a token transfer
          * @param request - The configuration of the requested quote
-         * @param options
+         * @param options - Request options
          * @throws {LiFiError} - Throws a LiFiError if request fails
+         * @returns Quote for a token transfer
          */
         this.getQuote = async (request, options) => {
             return ApiService.getQuote(request, options);
@@ -74,7 +76,7 @@ export class LiFi extends RouteExecutionManager {
         /**
          * Get a quote for a destination contract call
          * @param request - The configuration of the requested destination call
-         * @param options
+         * @param options - Request options
          * @throws {LiFiError} - Throws a LiFiError if request fails
          * @returns - Returns step.
          */
@@ -94,7 +96,7 @@ export class LiFi extends RouteExecutionManager {
         /**
          * Get the available tools to bridge and swap tokens.
          * @param request - The configuration of the requested tools
-         * @param options
+         * @param options - Request options
          * @returns The tools that are available on the requested chains
          */
         this.getTools = async (request, options) => {
@@ -103,7 +105,7 @@ export class LiFi extends RouteExecutionManager {
         /**
          * Get all known tokens.
          * @param request - The configuration of the requested tokens
-         * @param options
+         * @param options - Request options
          * @returns The tokens that are available on the requested chains
          */
         this.getTokens = async (request, options) => {
@@ -120,7 +122,7 @@ export class LiFi extends RouteExecutionManager {
         /**
          * Get a set of routes for a request that describes a transfer of tokens.
          * @param request - A description of the transfer.
-         * @param options
+         * @param options - Request options
          * @returns The resulting routes that can be used to realize the described transfer of tokens.
          * @throws {LiFiError} Throws a LiFiError if request fails.
          */
@@ -130,7 +132,7 @@ export class LiFi extends RouteExecutionManager {
         /**
          * Get the transaction data for a single step of a route
          * @param step - The step object.
-         * @param options
+         * @param options - Request options
          * @returns The step populated with the transaction data.
          * @throws {LiFiError} Throws a LiFiError if request fails.
          */
@@ -140,8 +142,9 @@ export class LiFi extends RouteExecutionManager {
         /**
          * Get gas recommendation for a certain chain
          * @param request - Configuration of the requested recommendation.
-         * @param options
+         * @param options - Request options
          * @throws {LiFiError} Throws a LiFiError if request fails.
+         * @returns Gas recommendation response.
          */
         this.getGasRecommendation = async (request, options) => {
             return ApiService.getGasRecommendation(request, options);
@@ -202,14 +205,16 @@ export class LiFi extends RouteExecutionManager {
          * @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.
+         * 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);
@@ -217,6 +222,7 @@ export class LiFi extends RouteExecutionManager {
         /**
          * Set approval for a certain token and amount.
          * @param request - The approval request
+         * @returns Returns Hash or nothing
          */
         this.setTokenApproval = (request) => {
             return setTokenAllowance(request);
@@ -224,6 +230,7 @@ export class LiFi extends RouteExecutionManager {
         /**
          * Revoke approval for a certain token.
          * @param request - The revoke request
+         * @returns Returns Hash or nothing
          */
         this.revokeTokenApproval = (request) => {
             return revokeTokenApproval(request);
@@ -241,6 +248,6 @@ export class LiFi extends RouteExecutionManager {
         this.chainsService.getChains().then((chains) => {
             this.configService.updateChains(chains);
         });
-        checkPackageUpdates(name, version, configUpdate.disableVersionCheck);
+        checkPackageUpdates(name, version, options.disableVersionCheck);
     }
 }

package/dist/allowance/setAllowance.d.ts

@@ -1,5 +1,6 @@
 import type { Hash, WalletClient } from 'viem';
+import type { InternalExecutionSettings } from '../execution/types';
 import type { ApproveTokenRequest, RevokeApprovalRequest } from './types';
-export declare const setAllowance: (walletClient: WalletClient, tokenAddress: string, contractAddress: string, amount: bigint, returnPopulatedTransaction?: boolean) => Promise<Hash>;
+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/setAllowance.js

@@ -3,7 +3,7 @@ import { approveAbi } from '../types';
 import { getMaxPriorityFeePerGas } from '../utils';
 import { isNativeTokenAddress } from '../utils/utils';
 import { getAllowance } from './getAllowance';
-export const setAllowance = async (walletClient, tokenAddress, contractAddress, amount, returnPopulatedTransaction) => {
+export const setAllowance = async (walletClient, tokenAddress, contractAddress, amount, settings, returnPopulatedTransaction) => {
     const data = encodeFunctionData({
         abi: approveAbi,
         functionName: 'approve',
@@ -13,15 +13,31 @@ export const setAllowance = async (walletClient, tokenAddress, contractAddress,
         return data;
     }
     const client = walletClient.extend(publicActions);
-    let maxPriorityFeePerGas;
-    if (walletClient.account?.type === 'local') {
-        maxPriorityFeePerGas = await getMaxPriorityFeePerGas(client);
+    let transactionRequest = {
+        to: tokenAddress,
+        data,
+        maxPriorityFeePerGas: walletClient.account?.type === 'local'
+            ? await getMaxPriorityFeePerGas(client)
+            : undefined,
+    };
+    if (settings?.updateTransactionRequestHook) {
+        const customizedTransactionRequest = await settings.updateTransactionRequestHook({
+            requestType: 'approve',
+            ...transactionRequest,
+        });
+        transactionRequest = {
+            ...transactionRequest,
+            ...customizedTransactionRequest,
+        };
     }
     return client.sendTransaction({
-        to: tokenAddress,
+        to: transactionRequest.to,
         account: walletClient.account,
-        data,
-        maxPriorityFeePerGas,
+        data: transactionRequest.data,
+        gas: transactionRequest.gas,
+        gasPrice: transactionRequest.gasPrice,
+        maxFeePerGas: transactionRequest.maxFeePerGas,
+        maxPriorityFeePerGas: transactionRequest.maxPriorityFeePerGas,
         chain: null,
     });
 };

package/dist/cjs/LiFi.d.ts

@@ -1,21 +1,21 @@
-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 { 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';
+import type { SDKConfig, SDKOptions } from './types';
 export declare class LiFi extends RouteExecutionManager {
     private chainsService;
-    constructor(configUpdate: ConfigUpdate);
+    constructor(options: SDKOptions);
     /**
      * Get the current configuration of the SDK
      * @returns - The config object
      */
-    getConfig: () => Config;
+    getConfig: () => SDKConfig;
     /**
      * Get the SDK configuration after all setup calls are finished
      * @returns - The config object
      */
-    getConfigAsync: () => Promise<Config>;
+    getConfigAsync: () => Promise<SDKConfig>;
     /**
      * Get an instance of a provider for a specific chain
      * @param chainId - Id of the chain the provider is for
@@ -27,11 +27,11 @@ export declare class LiFi extends RouteExecutionManager {
      * @param configUpdate - An object containing the configuration fields that should be updated.
      * @returns The renewed config object
      */
-    setConfig: (configUpdate: Partial<ConfigUpdate>) => Config;
+    setConfig: (configUpdate: Partial<SDKOptions>) => SDKConfig;
     /**
      * 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
+     * @param options - Request 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
@@ -41,25 +41,27 @@ export declare class LiFi extends RouteExecutionManager {
      * 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
+     * @param options - Request options
      * @throws {LiFiError} - Throws a LiFiError if request fails
+     * @returns Token information
      */
     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
+     * @param options - Request options
      * @throws {LiFiError} - Throws a LiFiError if request fails
+     * @returns Quote for a token transfer
      */
-    getQuote: (request: QuoteRequest, options?: RequestOptions) => Promise<LifiStep>;
+    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
+     * @param options - Request options
      * @throws {LiFiError} - Throws a LiFiError if request fails
      * @returns - Returns step.
      */
-    getContractCallQuote: (request: ContractCallQuoteRequest, options?: RequestOptions) => Promise<LifiStep>;
+    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
@@ -71,14 +73,14 @@ export declare class LiFi extends RouteExecutionManager {
     /**
      * Get the available tools to bridge and swap tokens.
      * @param request - The configuration of the requested tools
-     * @param options
+     * @param options - Request 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
+     * @param options - Request options
      * @returns The tokens that are available on the requested chains
      */
     getTokens: (request?: TokensRequest, options?: RequestOptions) => Promise<TokensResponse>;
@@ -91,7 +93,7 @@ export declare class LiFi extends RouteExecutionManager {
     /**
      * Get a set of routes for a request that describes a transfer of tokens.
      * @param request - A description of the transfer.
-     * @param options
+     * @param options - Request options
      * @returns The resulting routes that can be used to realize the described transfer of tokens.
      * @throws {LiFiError} Throws a LiFiError if request fails.
      */
@@ -99,16 +101,17 @@ export declare class LiFi extends RouteExecutionManager {
     /**
      * Get the transaction data for a single step of a route
      * @param step - The step object.
-     * @param options
+     * @param options - Request options
      * @returns The step populated with the transaction data.
      * @throws {LiFiError} Throws a LiFiError if request fails.
      */
-    getStepTransaction: (step: LifiStep, options?: RequestOptions) => Promise<LifiStep>;
+    getStepTransaction: (step: LiFiStep, options?: RequestOptions) => Promise<LiFiStep>;
     /**
      * Get gas recommendation for a certain chain
      * @param request - Configuration of the requested recommendation.
-     * @param options
+     * @param options - Request options
      * @throws {LiFiError} Throws a LiFiError if request fails.
+     * @returns Gas recommendation response.
      */
     getGasRecommendation: (request: GasRecommendationRequest, options?: RequestOptions) => Promise<GasRecommendationResponse>;
     /**
@@ -144,24 +147,28 @@ export declare class LiFi extends RouteExecutionManager {
      * @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.
+     * 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 | void>;
+    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 | void>;
+    revokeTokenApproval: (request: RevokeApprovalRequest) => Promise<Hash | undefined>;
     /**
      * Get all the available connections for swap/bridging tokens
      * @param connectionRequest ConnectionsRequest

package/dist/cjs/LiFi.js

@@ -38,8 +38,8 @@ const typeguards_1 = require("./typeguards");
 const errors_1 = require("./utils/errors");
 const version_1 = require("./version");
 class LiFi extends RouteExecutionManager_1.RouteExecutionManager {
-    constructor(configUpdate) {
-        super(configUpdate);
+    constructor(options) {
+        super(options);
         /**
          * Get the current configuration of the SDK
          * @returns - The config object
@@ -73,7 +73,7 @@ class LiFi extends RouteExecutionManager_1.RouteExecutionManager {
         /**
          * 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
+         * @param options - Request 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
@@ -85,8 +85,9 @@ class LiFi extends RouteExecutionManager_1.RouteExecutionManager {
          * 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
+         * @param options - Request options
          * @throws {LiFiError} - Throws a LiFiError if request fails
+         * @returns Token information
          */
         this.getToken = async (chain, token, options) => {
             return ApiService_1.default.getToken(chain, token, options);
@@ -94,8 +95,9 @@ class LiFi extends RouteExecutionManager_1.RouteExecutionManager {
         /**
          * Get a quote for a token transfer
          * @param request - The configuration of the requested quote
-         * @param options
+         * @param options - Request options
          * @throws {LiFiError} - Throws a LiFiError if request fails
+         * @returns Quote for a token transfer
          */
         this.getQuote = async (request, options) => {
             return ApiService_1.default.getQuote(request, options);
@@ -103,7 +105,7 @@ class LiFi extends RouteExecutionManager_1.RouteExecutionManager {
         /**
          * Get a quote for a destination contract call
          * @param request - The configuration of the requested destination call
-         * @param options
+         * @param options - Request options
          * @throws {LiFiError} - Throws a LiFiError if request fails
          * @returns - Returns step.
          */
@@ -123,7 +125,7 @@ class LiFi extends RouteExecutionManager_1.RouteExecutionManager {
         /**
          * Get the available tools to bridge and swap tokens.
          * @param request - The configuration of the requested tools
-         * @param options
+         * @param options - Request options
          * @returns The tools that are available on the requested chains
          */
         this.getTools = async (request, options) => {
@@ -132,7 +134,7 @@ class LiFi extends RouteExecutionManager_1.RouteExecutionManager {
         /**
          * Get all known tokens.
          * @param request - The configuration of the requested tokens
-         * @param options
+         * @param options - Request options
          * @returns The tokens that are available on the requested chains
          */
         this.getTokens = async (request, options) => {
@@ -149,7 +151,7 @@ class LiFi extends RouteExecutionManager_1.RouteExecutionManager {
         /**
          * Get a set of routes for a request that describes a transfer of tokens.
          * @param request - A description of the transfer.
-         * @param options
+         * @param options - Request options
          * @returns The resulting routes that can be used to realize the described transfer of tokens.
          * @throws {LiFiError} Throws a LiFiError if request fails.
          */
@@ -159,7 +161,7 @@ class LiFi extends RouteExecutionManager_1.RouteExecutionManager {
         /**
          * Get the transaction data for a single step of a route
          * @param step - The step object.
-         * @param options
+         * @param options - Request options
          * @returns The step populated with the transaction data.
          * @throws {LiFiError} Throws a LiFiError if request fails.
          */
@@ -169,8 +171,9 @@ class LiFi extends RouteExecutionManager_1.RouteExecutionManager {
         /**
          * Get gas recommendation for a certain chain
          * @param request - Configuration of the requested recommendation.
-         * @param options
+         * @param options - Request options
          * @throws {LiFiError} Throws a LiFiError if request fails.
+         * @returns Gas recommendation response.
          */
         this.getGasRecommendation = async (request, options) => {
             return ApiService_1.default.getGasRecommendation(request, options);
@@ -231,14 +234,16 @@ class LiFi extends RouteExecutionManager_1.RouteExecutionManager {
          * @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 (0, allowance_1.getTokenAllowance)(token, ownerAddress, spenderAddress);
         };
         /**
-         * Get the current allowance for a list of token / spender address pairs.
+         * 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 (0, allowance_1.getTokenAllowanceMulticall)(ownerAddress, tokens);
@@ -246,6 +251,7 @@ class LiFi extends RouteExecutionManager_1.RouteExecutionManager {
         /**
          * Set approval for a certain token and amount.
          * @param request - The approval request
+         * @returns Returns Hash or nothing
          */
         this.setTokenApproval = (request) => {
             return (0, allowance_1.setTokenAllowance)(request);
@@ -253,6 +259,7 @@ class LiFi extends RouteExecutionManager_1.RouteExecutionManager {
         /**
          * Revoke approval for a certain token.
          * @param request - The revoke request
+         * @returns Returns Hash or nothing
          */
         this.revokeTokenApproval = (request) => {
             return (0, allowance_1.revokeTokenApproval)(request);
@@ -270,7 +277,7 @@ class LiFi extends RouteExecutionManager_1.RouteExecutionManager {
         this.chainsService.getChains().then((chains) => {
             this.configService.updateChains(chains);
         });
-        (0, helpers_1.checkPackageUpdates)(version_1.name, version_1.version, configUpdate.disableVersionCheck);
+        (0, helpers_1.checkPackageUpdates)(version_1.name, version_1.version, options.disableVersionCheck);
     }
 }
 exports.LiFi = LiFi;

package/dist/cjs/allowance/setAllowance.d.ts

@@ -1,5 +1,6 @@
 import type { Hash, WalletClient } from 'viem';
+import type { InternalExecutionSettings } from '../execution/types';
 import type { ApproveTokenRequest, RevokeApprovalRequest } from './types';
-export declare const setAllowance: (walletClient: WalletClient, tokenAddress: string, contractAddress: string, amount: bigint, returnPopulatedTransaction?: boolean) => Promise<Hash>;
+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>;