@lifi/sdk 2.0.0-beta.1 → 2.0.0-beta.3

package/dist/Lifi.d.ts

@@ -1,5 +1,5 @@
 import { FallbackProvider } from '@ethersproject/providers';
-import { ChainId, ChainKey, ContractCallQuoteRequest, ExtendedChain, GetStatusRequest, PossibilitiesRequest, PossibilitiesResponse, QuoteRequest, RequestOptions, Route, RoutesRequest, RoutesResponse, StatusResponse, Step, Token, TokenAmount, TokensRequest, TokensResponse, ToolsRequest, ToolsResponse } from '@lifi/types';
+import { ChainId, ChainKey, ContractCallQuoteRequest, ExtendedChain, GasRecommendationRequest, GasRecommendationResponse, GetStatusRequest, PossibilitiesRequest, PossibilitiesResponse, QuoteRequest, RequestOptions, Route, RoutesRequest, RoutesResponse, StatusResponse, Step, Token, TokenAmount, TokensRequest, TokensResponse, ToolsRequest, ToolsResponse } from '@lifi/types';
 import { Signer } from 'ethers';
 import { ApproveTokenRequest, RevokeApprovalRequest } from './allowance';
 import { Config, ConfigUpdate, ExecutionSettings, RevokeTokenData } from './types';
@@ -83,7 +83,7 @@ export default class LIFI {
     getChains: () => Promise<ExtendedChain[]>;
     /**
      * Get a set of routes for a request that describes a transfer of tokens.
-     * @param {RoutesRequest} routesRequest - A description of the transfer.
+     * @param {RoutesRequest} request - A description of the transfer.
      * @return {Promise<RoutesResponse>} The resulting routes that can be used to realize the described transfer of tokens.
      * @throws {LifiError} Throws a LifiError if request fails.
      */
@@ -95,6 +95,12 @@ export default class LIFI {
      * @throws {LifiError} Throws a LifiError if request fails.
      */
     getStepTransaction: (step: Step, options?: RequestOptions) => Promise<Step>;
+    /**
+     * Get gas recommendation for a certain chain
+     * @param {GasRecommendationRequest} request - Configuration of the requested recommendation.
+     * @throws {LifiError} Throws a LifiError if request fails.
+     */
+    getGasRecommendation: (request: GasRecommendationRequest, options?: RequestOptions) => Promise<GasRecommendationResponse>;
     /**
      * Stops the execution of an active route.
      * @param {Route} route - A route that is currently in execution.

package/dist/Lifi.js

@@ -113,7 +113,7 @@ export default class LIFI {
         };
         /**
          * Get a set of routes for a request that describes a transfer of tokens.
-         * @param {RoutesRequest} routesRequest - A description of the transfer.
+         * @param {RoutesRequest} request - A description of the transfer.
          * @return {Promise<RoutesResponse>} The resulting routes that can be used to realize the described transfer of tokens.
          * @throws {LifiError} Throws a LifiError if request fails.
          */
@@ -129,6 +129,14 @@ export default class LIFI {
         this.getStepTransaction = async (step, options) => {
             return ApiService.getStepTransaction(step, options);
         };
+        /**
+         * Get gas recommendation for a certain chain
+         * @param {GasRecommendationRequest} request - Configuration of the requested recommendation.
+         * @throws {LifiError} Throws a LifiError if request fails.
+         */
+        this.getGasRecommendation = async (request, options) => {
+            return ApiService.getGasRecommendation(request, options);
+        };
         /**
          * Stops the execution of an active route.
          * @param {Route} route - A route that is currently in execution.

package/dist/cjs/Lifi.d.ts

@@ -1,5 +1,5 @@
 import { FallbackProvider } from '@ethersproject/providers';
-import { ChainId, ChainKey, ContractCallQuoteRequest, ExtendedChain, GetStatusRequest, PossibilitiesRequest, PossibilitiesResponse, QuoteRequest, RequestOptions, Route, RoutesRequest, RoutesResponse, StatusResponse, Step, Token, TokenAmount, TokensRequest, TokensResponse, ToolsRequest, ToolsResponse } from '@lifi/types';
+import { ChainId, ChainKey, ContractCallQuoteRequest, ExtendedChain, GasRecommendationRequest, GasRecommendationResponse, GetStatusRequest, PossibilitiesRequest, PossibilitiesResponse, QuoteRequest, RequestOptions, Route, RoutesRequest, RoutesResponse, StatusResponse, Step, Token, TokenAmount, TokensRequest, TokensResponse, ToolsRequest, ToolsResponse } from '@lifi/types';
 import { Signer } from 'ethers';
 import { ApproveTokenRequest, RevokeApprovalRequest } from './allowance';
 import { Config, ConfigUpdate, ExecutionSettings, RevokeTokenData } from './types';
@@ -83,7 +83,7 @@ export default class LIFI {
     getChains: () => Promise<ExtendedChain[]>;
     /**
      * Get a set of routes for a request that describes a transfer of tokens.
-     * @param {RoutesRequest} routesRequest - A description of the transfer.
+     * @param {RoutesRequest} request - A description of the transfer.
      * @return {Promise<RoutesResponse>} The resulting routes that can be used to realize the described transfer of tokens.
      * @throws {LifiError} Throws a LifiError if request fails.
      */
@@ -95,6 +95,12 @@ export default class LIFI {
      * @throws {LifiError} Throws a LifiError if request fails.
      */
     getStepTransaction: (step: Step, options?: RequestOptions) => Promise<Step>;
+    /**
+     * Get gas recommendation for a certain chain
+     * @param {GasRecommendationRequest} request - Configuration of the requested recommendation.
+     * @throws {LifiError} Throws a LifiError if request fails.
+     */
+    getGasRecommendation: (request: GasRecommendationRequest, options?: RequestOptions) => Promise<GasRecommendationResponse>;
     /**
      * Stops the execution of an active route.
      * @param {Route} route - A route that is currently in execution.

package/dist/cjs/Lifi.js

@@ -141,7 +141,7 @@ class LIFI {
         };
         /**
          * Get a set of routes for a request that describes a transfer of tokens.
-         * @param {RoutesRequest} routesRequest - A description of the transfer.
+         * @param {RoutesRequest} request - A description of the transfer.
          * @return {Promise<RoutesResponse>} The resulting routes that can be used to realize the described transfer of tokens.
          * @throws {LifiError} Throws a LifiError if request fails.
          */
@@ -157,6 +157,14 @@ class LIFI {
         this.getStepTransaction = async (step, options) => {
             return ApiService_1.default.getStepTransaction(step, options);
         };
+        /**
+         * Get gas recommendation for a certain chain
+         * @param {GasRecommendationRequest} request - Configuration of the requested recommendation.
+         * @throws {LifiError} Throws a LifiError if request fails.
+         */
+        this.getGasRecommendation = async (request, options) => {
+            return ApiService_1.default.getGasRecommendation(request, options);
+        };
         /**
          * Stops the execution of an active route.
          * @param {Route} route - A route that is currently in execution.

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

@@ -3,7 +3,7 @@ import { ChainId, ChainKey, ExtendedChain, PossibilitiesRequest, PossibilitiesRe
 declare const _default: {
     getChains: (options?: RequestOptions | undefined) => Promise<ExtendedChain[]>;
     getContractCallQuote: (requestConfig: ContractCallQuoteRequest, options?: RequestOptions | undefined) => Promise<Step>;
-    getGasRecommendation: ({ chainId, fromChain, fromToken }: GasRecommendationRequest, options?: RequestOptions | undefined) => Promise<GasRecommendationResponse>;
+    getGasRecommendation: (requestConfig: GasRecommendationRequest, options?: RequestOptions | undefined) => Promise<GasRecommendationResponse>;
     getPossibilities: (requestConfig?: PossibilitiesRequest | undefined, options?: RequestOptions | undefined) => Promise<PossibilitiesResponse>;
     getQuote: (requestConfig: QuoteRequest, options?: RequestOptions | undefined) => Promise<Step>;
     getRoutes: (requestConfig: RoutesRequest, options?: RequestOptions | undefined) => Promise<RoutesResponse>;

package/dist/cjs/services/ApiService.js

@@ -277,15 +277,17 @@ const getTokens = async (requestConfig, options) => {
     });
     return response;
 };
-const getGasRecommendation = async ({ chainId, fromChain, fromToken }, options) => {
+const getGasRecommendation = async (requestConfig, options) => {
     const config = ConfigService_1.default.getInstance().getConfig();
-    if (!chainId) {
+    Object.keys(requestConfig).forEach((key) => !requestConfig[key] &&
+        delete requestConfig[key]);
+    if (!requestConfig.chainId) {
         throw new errors_1.ValidationError('Required parameter "chainId" is missing.');
     }
     try {
-        const response = await (0, helpers_1.request)(`${config.apiUrl}/gas/suggestion/${chainId}?${new URLSearchParams({
-            fromChain,
-            fromToken,
+        const response = await (0, helpers_1.request)(`${config.apiUrl}/gas/suggestion/${requestConfig.chainId}?${new URLSearchParams({
+            fromChain: requestConfig.fromChain,
+            fromToken: requestConfig.fromToken,
         })}`, {
             signal: options?.signal,
         });

package/dist/cjs/version.d.ts

@@ -1,2 +1,2 @@
 export declare const name = "@lifi/sdk";
-export declare const version = "2.0.0-beta.1";
+export declare const version = "2.0.0-beta.3";

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 = '2.0.0-beta.1';
+exports.version = '2.0.0-beta.3';

package/dist/services/ApiService.d.ts

@@ -3,7 +3,7 @@ import { ChainId, ChainKey, ExtendedChain, PossibilitiesRequest, PossibilitiesRe
 declare const _default: {
     getChains: (options?: RequestOptions | undefined) => Promise<ExtendedChain[]>;
     getContractCallQuote: (requestConfig: ContractCallQuoteRequest, options?: RequestOptions | undefined) => Promise<Step>;
-    getGasRecommendation: ({ chainId, fromChain, fromToken }: GasRecommendationRequest, options?: RequestOptions | undefined) => Promise<GasRecommendationResponse>;
+    getGasRecommendation: (requestConfig: GasRecommendationRequest, options?: RequestOptions | undefined) => Promise<GasRecommendationResponse>;
     getPossibilities: (requestConfig?: PossibilitiesRequest | undefined, options?: RequestOptions | undefined) => Promise<PossibilitiesResponse>;
     getQuote: (requestConfig: QuoteRequest, options?: RequestOptions | undefined) => Promise<Step>;
     getRoutes: (requestConfig: RoutesRequest, options?: RequestOptions | undefined) => Promise<RoutesResponse>;

package/dist/services/ApiService.js

@@ -272,15 +272,17 @@ const getTokens = async (requestConfig, options) => {
     });
     return response;
 };
-const getGasRecommendation = async ({ chainId, fromChain, fromToken }, options) => {
+const getGasRecommendation = async (requestConfig, options) => {
     const config = ConfigService.getInstance().getConfig();
-    if (!chainId) {
+    Object.keys(requestConfig).forEach((key) => !requestConfig[key] &&
+        delete requestConfig[key]);
+    if (!requestConfig.chainId) {
         throw new ValidationError('Required parameter "chainId" is missing.');
     }
     try {
-        const response = await request(`${config.apiUrl}/gas/suggestion/${chainId}?${new URLSearchParams({
-            fromChain,
-            fromToken,
+        const response = await request(`${config.apiUrl}/gas/suggestion/${requestConfig.chainId}?${new URLSearchParams({
+            fromChain: requestConfig.fromChain,
+            fromToken: requestConfig.fromToken,
         })}`, {
             signal: options?.signal,
         });

package/dist/version.d.ts

@@ -1,2 +1,2 @@
 export declare const name = "@lifi/sdk";
-export declare const version = "2.0.0-beta.1";
+export declare const version = "2.0.0-beta.3";

package/dist/version.js

@@ -1,2 +1,2 @@
 export const name = '@lifi/sdk';
-export const version = '2.0.0-beta.1';
+export const version = '2.0.0-beta.3';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lifi/sdk",
-  "version": "2.0.0-beta.1",
+  "version": "2.0.0-beta.3",
   "description": "LI.FI Any-to-Any Cross-Chain-Swap SDK",
   "main": "./dist/cjs/index.js",
   "module": "./dist/index.js",