@lifi/sdk 2.0.0-beta.0 → 2.0.0-beta.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/Lifi.d.ts CHANGED
@@ -1,5 +1,5 @@
1
1
  import { FallbackProvider } from '@ethersproject/providers';
2
- import { ChainId, ChainKey, ContractCallQuoteRequest, ExtendedChain, GetStatusRequest, PossibilitiesRequest, PossibilitiesResponse, QuoteRequest, RequestOptions, Route, RoutesRequest, RoutesResponse, StatusResponse, Step, Token, TokenAmount, TokensRequest, TokensResponse, ToolsRequest, ToolsResponse } from '@lifi/types';
2
+ 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';
3
3
  import { Signer } from 'ethers';
4
4
  import { ApproveTokenRequest, RevokeApprovalRequest } from './allowance';
5
5
  import { Config, ConfigUpdate, ExecutionSettings, RevokeTokenData } from './types';
@@ -83,7 +83,7 @@ export default class LIFI {
83
83
  getChains: () => Promise<ExtendedChain[]>;
84
84
  /**
85
85
  * Get a set of routes for a request that describes a transfer of tokens.
86
- * @param {RoutesRequest} routesRequest - A description of the transfer.
86
+ * @param {RoutesRequest} request - A description of the transfer.
87
87
  * @return {Promise<RoutesResponse>} The resulting routes that can be used to realize the described transfer of tokens.
88
88
  * @throws {LifiError} Throws a LifiError if request fails.
89
89
  */
@@ -95,6 +95,12 @@ export default class LIFI {
95
95
  * @throws {LifiError} Throws a LifiError if request fails.
96
96
  */
97
97
  getStepTransaction: (step: Step, options?: RequestOptions) => Promise<Step>;
98
+ /**
99
+ * Get gas recommendation for a certain chain
100
+ * @param {GasRecommendationRequest} request - Configuration of the requested recommendation.
101
+ * @throws {LifiError} Throws a LifiError if request fails.
102
+ */
103
+ getGasRecommendation: (request: GasRecommendationRequest, options?: RequestOptions) => Promise<GasRecommendationResponse>;
98
104
  /**
99
105
  * Stops the execution of an active route.
100
106
  * @param {Route} route - A route that is currently in execution.
package/dist/Lifi.js CHANGED
@@ -113,7 +113,7 @@ export default class LIFI {
113
113
  };
114
114
  /**
115
115
  * Get a set of routes for a request that describes a transfer of tokens.
116
- * @param {RoutesRequest} routesRequest - A description of the transfer.
116
+ * @param {RoutesRequest} request - A description of the transfer.
117
117
  * @return {Promise<RoutesResponse>} The resulting routes that can be used to realize the described transfer of tokens.
118
118
  * @throws {LifiError} Throws a LifiError if request fails.
119
119
  */
@@ -129,6 +129,14 @@ export default class LIFI {
129
129
  this.getStepTransaction = async (step, options) => {
130
130
  return ApiService.getStepTransaction(step, options);
131
131
  };
132
+ /**
133
+ * Get gas recommendation for a certain chain
134
+ * @param {GasRecommendationRequest} request - Configuration of the requested recommendation.
135
+ * @throws {LifiError} Throws a LifiError if request fails.
136
+ */
137
+ this.getGasRecommendation = async (request, options) => {
138
+ return ApiService.getGasRecommendation(request, options);
139
+ };
132
140
  /**
133
141
  * Stops the execution of an active route.
134
142
  * @param {Route} route - A route that is currently in execution.
@@ -1,5 +1,5 @@
1
1
  import { FallbackProvider } from '@ethersproject/providers';
2
- import { ChainId, ChainKey, ContractCallQuoteRequest, ExtendedChain, GetStatusRequest, PossibilitiesRequest, PossibilitiesResponse, QuoteRequest, RequestOptions, Route, RoutesRequest, RoutesResponse, StatusResponse, Step, Token, TokenAmount, TokensRequest, TokensResponse, ToolsRequest, ToolsResponse } from '@lifi/types';
2
+ 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';
3
3
  import { Signer } from 'ethers';
4
4
  import { ApproveTokenRequest, RevokeApprovalRequest } from './allowance';
5
5
  import { Config, ConfigUpdate, ExecutionSettings, RevokeTokenData } from './types';
@@ -83,7 +83,7 @@ export default class LIFI {
83
83
  getChains: () => Promise<ExtendedChain[]>;
84
84
  /**
85
85
  * Get a set of routes for a request that describes a transfer of tokens.
86
- * @param {RoutesRequest} routesRequest - A description of the transfer.
86
+ * @param {RoutesRequest} request - A description of the transfer.
87
87
  * @return {Promise<RoutesResponse>} The resulting routes that can be used to realize the described transfer of tokens.
88
88
  * @throws {LifiError} Throws a LifiError if request fails.
89
89
  */
@@ -95,6 +95,12 @@ export default class LIFI {
95
95
  * @throws {LifiError} Throws a LifiError if request fails.
96
96
  */
97
97
  getStepTransaction: (step: Step, options?: RequestOptions) => Promise<Step>;
98
+ /**
99
+ * Get gas recommendation for a certain chain
100
+ * @param {GasRecommendationRequest} request - Configuration of the requested recommendation.
101
+ * @throws {LifiError} Throws a LifiError if request fails.
102
+ */
103
+ getGasRecommendation: (request: GasRecommendationRequest, options?: RequestOptions) => Promise<GasRecommendationResponse>;
98
104
  /**
99
105
  * Stops the execution of an active route.
100
106
  * @param {Route} route - A route that is currently in execution.
package/dist/cjs/Lifi.js CHANGED
@@ -141,7 +141,7 @@ class LIFI {
141
141
  };
142
142
  /**
143
143
  * Get a set of routes for a request that describes a transfer of tokens.
144
- * @param {RoutesRequest} routesRequest - A description of the transfer.
144
+ * @param {RoutesRequest} request - A description of the transfer.
145
145
  * @return {Promise<RoutesResponse>} The resulting routes that can be used to realize the described transfer of tokens.
146
146
  * @throws {LifiError} Throws a LifiError if request fails.
147
147
  */
@@ -157,6 +157,14 @@ class LIFI {
157
157
  this.getStepTransaction = async (step, options) => {
158
158
  return ApiService_1.default.getStepTransaction(step, options);
159
159
  };
160
+ /**
161
+ * Get gas recommendation for a certain chain
162
+ * @param {GasRecommendationRequest} request - Configuration of the requested recommendation.
163
+ * @throws {LifiError} Throws a LifiError if request fails.
164
+ */
165
+ this.getGasRecommendation = async (request, options) => {
166
+ return ApiService_1.default.getGasRecommendation(request, options);
167
+ };
160
168
  /**
161
169
  * Stops the execution of an active route.
162
170
  * @param {Route} route - A route that is currently in execution.
@@ -65,9 +65,8 @@ const checkPackageUpdates = async (packageName, packageVersion, disableCheck) =>
65
65
  }
66
66
  try {
67
67
  const pkgName = packageName ?? version_1.name;
68
- const response = await (0, exports.request)('https://registry.npmjs.org/${pkgName}/latest');
69
- const data = await response.json();
70
- const latestVersion = data.version;
68
+ const response = await (0, exports.request)(`https://registry.npmjs.org/${pkgName}/latest`);
69
+ const latestVersion = response.version;
71
70
  const currentVersion = packageVersion ?? version_1.version;
72
71
  if (semverCompare(latestVersion, currentVersion)) {
73
72
  console.warn(
@@ -1,2 +1,2 @@
1
1
  export declare const name = "@lifi/sdk";
2
- export declare const version = "2.0.0-beta.0";
2
+ export declare const version = "2.0.0-beta.2";
@@ -2,4 +2,4 @@
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.version = exports.name = void 0;
4
4
  exports.name = '@lifi/sdk';
5
- exports.version = '2.0.0-beta.0';
5
+ exports.version = '2.0.0-beta.2';
package/dist/helpers.js CHANGED
@@ -58,9 +58,8 @@ export const checkPackageUpdates = async (packageName, packageVersion, disableCh
58
58
  }
59
59
  try {
60
60
  const pkgName = packageName ?? name;
61
- const response = await request('https://registry.npmjs.org/${pkgName}/latest');
62
- const data = await response.json();
63
- const latestVersion = data.version;
61
+ const response = await request(`https://registry.npmjs.org/${pkgName}/latest`);
62
+ const latestVersion = response.version;
64
63
  const currentVersion = packageVersion ?? version;
65
64
  if (semverCompare(latestVersion, currentVersion)) {
66
65
  console.warn(
package/dist/version.d.ts CHANGED
@@ -1,2 +1,2 @@
1
1
  export declare const name = "@lifi/sdk";
2
- export declare const version = "2.0.0-beta.0";
2
+ export declare const version = "2.0.0-beta.2";
package/dist/version.js CHANGED
@@ -1,2 +1,2 @@
1
1
  export const name = '@lifi/sdk';
2
- export const version = '2.0.0-beta.0';
2
+ export const version = '2.0.0-beta.2';
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@lifi/sdk",
3
- "version": "2.0.0-beta.0",
3
+ "version": "2.0.0-beta.2",
4
4
  "description": "LI.FI Any-to-Any Cross-Chain-Swap SDK",
5
5
  "main": "./dist/cjs/index.js",
6
6
  "module": "./dist/index.js",