@lifi/sdk 4.1.0 → 4.2.0

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.
Files changed (210) hide show
  1. package/CHANGELOG.md +6 -0
  2. package/dist/cjs/actions/getChains.d.ts +7 -8
  3. package/dist/cjs/actions/getConnections.d.ts +6 -7
  4. package/dist/cjs/actions/getContractCallsQuote.d.ts +7 -8
  5. package/dist/cjs/actions/getGasRecommendation.d.ts +7 -8
  6. package/dist/cjs/actions/getNameServiceAddress.d.ts +6 -7
  7. package/dist/cjs/actions/getQuote.d.ts +7 -8
  8. package/dist/cjs/actions/getRelayedTransactionStatus.d.ts +7 -8
  9. package/dist/cjs/actions/getRelayerQuote.d.ts +7 -8
  10. package/dist/cjs/actions/getRoutes.d.ts +7 -8
  11. package/dist/cjs/actions/getStatus.d.ts +7 -8
  12. package/dist/cjs/actions/getStepTransaction.d.ts +7 -8
  13. package/dist/cjs/actions/getStepTransaction.js +2 -0
  14. package/dist/cjs/actions/getStepTransaction.js.map +1 -1
  15. package/dist/cjs/actions/getToken.d.ts +8 -9
  16. package/dist/cjs/actions/getTokenBalance.d.ts +8 -9
  17. package/dist/cjs/actions/getTokenBalances.d.ts +8 -9
  18. package/dist/cjs/actions/getTokenBalancesByChain.d.ts +8 -9
  19. package/dist/cjs/actions/getTokenBalancesByChain.js +4 -2
  20. package/dist/cjs/actions/getTokenBalancesByChain.js.map +1 -1
  21. package/dist/cjs/actions/getTokens.d.ts +6 -7
  22. package/dist/cjs/actions/getTools.d.ts +6 -7
  23. package/dist/cjs/actions/getTransactionHistory.d.ts +13 -19
  24. package/dist/cjs/actions/getWalletBalances.d.ts +7 -8
  25. package/dist/cjs/actions/index.d.ts +109 -110
  26. package/dist/cjs/actions/patchContractCalls.d.ts +0 -1
  27. package/dist/cjs/actions/relayTransaction.d.ts +7 -8
  28. package/dist/cjs/client/createClient.d.ts +0 -1
  29. package/dist/cjs/client/getClientStorage.d.ts +0 -1
  30. package/dist/cjs/core/BaseStepExecutionTask.d.ts +0 -1
  31. package/dist/cjs/core/BaseStepExecutor.d.ts +0 -1
  32. package/dist/cjs/core/StatusManager.d.ts +40 -51
  33. package/dist/cjs/core/TaskPipeline.d.ts +0 -1
  34. package/dist/cjs/core/actionMessages.d.ts +0 -1
  35. package/dist/cjs/core/execution.d.ts +29 -30
  36. package/dist/cjs/core/executionState.d.ts +0 -1
  37. package/dist/cjs/core/prepareRestart.d.ts +0 -1
  38. package/dist/cjs/core/tasks/CheckBalanceTask.d.ts +6 -7
  39. package/dist/cjs/core/tasks/PrepareTransactionTask.d.ts +0 -1
  40. package/dist/cjs/core/tasks/WaitForTransactionStatusTask.d.ts +0 -1
  41. package/dist/cjs/core/tasks/helpers/checkBalance.d.ts +17 -18
  42. package/dist/cjs/core/tasks/helpers/getTransactionRequestData.d.ts +0 -1
  43. package/dist/cjs/core/tasks/helpers/stepComparison.d.ts +11 -12
  44. package/dist/cjs/core/tasks/helpers/waitForTransactionStatus.d.ts +0 -1
  45. package/dist/cjs/core/utils.d.ts +7 -8
  46. package/dist/cjs/errors/SDKError.d.ts +0 -1
  47. package/dist/cjs/errors/baseError.d.ts +0 -1
  48. package/dist/cjs/errors/errors.d.ts +4 -5
  49. package/dist/cjs/errors/httpError.d.ts +0 -1
  50. package/dist/cjs/errors/utils/baseErrorRootCause.d.ts +0 -1
  51. package/dist/cjs/types/actions.d.ts +7 -7
  52. package/dist/cjs/types/core.d.ts +3 -4
  53. package/dist/cjs/types/execution.d.ts +0 -1
  54. package/dist/cjs/utils/checkPackageUpdates.js +1 -1
  55. package/dist/cjs/utils/convertQuoteToRoute.d.ts +9 -10
  56. package/dist/cjs/utils/formatUnits.d.ts +2 -2
  57. package/dist/cjs/utils/getTransactionMessage.d.ts +0 -1
  58. package/dist/cjs/utils/isHex.d.ts +1 -3
  59. package/dist/cjs/utils/isRoutesRequest.d.ts +0 -1
  60. package/dist/cjs/utils/isStep.d.ts +0 -1
  61. package/dist/cjs/utils/isToken.d.ts +0 -1
  62. package/dist/cjs/utils/parseUnits.d.ts +2 -2
  63. package/dist/cjs/utils/request.d.ts +0 -1
  64. package/dist/cjs/utils/waitForResult.d.ts +8 -8
  65. package/dist/cjs/utils/withDedupe.d.ts +5 -8
  66. package/dist/cjs/utils/withTimeout.d.ts +10 -16
  67. package/dist/cjs/version.d.ts +1 -1
  68. package/dist/cjs/version.js +1 -1
  69. package/dist/cjs/version.js.map +1 -1
  70. package/dist/esm/actions/getChains.d.ts +7 -8
  71. package/dist/esm/actions/getChains.d.ts.map +1 -1
  72. package/dist/esm/actions/getConnections.d.ts +6 -7
  73. package/dist/esm/actions/getConnections.d.ts.map +1 -1
  74. package/dist/esm/actions/getContractCallsQuote.d.ts +7 -8
  75. package/dist/esm/actions/getContractCallsQuote.d.ts.map +1 -1
  76. package/dist/esm/actions/getGasRecommendation.d.ts +7 -8
  77. package/dist/esm/actions/getGasRecommendation.d.ts.map +1 -1
  78. package/dist/esm/actions/getNameServiceAddress.d.ts +6 -7
  79. package/dist/esm/actions/getNameServiceAddress.d.ts.map +1 -1
  80. package/dist/esm/actions/getQuote.d.ts +7 -8
  81. package/dist/esm/actions/getQuote.d.ts.map +1 -1
  82. package/dist/esm/actions/getRelayedTransactionStatus.d.ts +7 -8
  83. package/dist/esm/actions/getRelayedTransactionStatus.d.ts.map +1 -1
  84. package/dist/esm/actions/getRelayerQuote.d.ts +7 -8
  85. package/dist/esm/actions/getRelayerQuote.d.ts.map +1 -1
  86. package/dist/esm/actions/getRoutes.d.ts +7 -8
  87. package/dist/esm/actions/getRoutes.d.ts.map +1 -1
  88. package/dist/esm/actions/getStatus.d.ts +7 -8
  89. package/dist/esm/actions/getStatus.d.ts.map +1 -1
  90. package/dist/esm/actions/getStepTransaction.d.ts +7 -8
  91. package/dist/esm/actions/getStepTransaction.d.ts.map +1 -1
  92. package/dist/esm/actions/getStepTransaction.js +2 -0
  93. package/dist/esm/actions/getStepTransaction.js.map +1 -1
  94. package/dist/esm/actions/getToken.d.ts +8 -9
  95. package/dist/esm/actions/getToken.d.ts.map +1 -1
  96. package/dist/esm/actions/getTokenBalance.d.ts +8 -9
  97. package/dist/esm/actions/getTokenBalance.d.ts.map +1 -1
  98. package/dist/esm/actions/getTokenBalances.d.ts +8 -9
  99. package/dist/esm/actions/getTokenBalances.d.ts.map +1 -1
  100. package/dist/esm/actions/getTokenBalancesByChain.d.ts +8 -9
  101. package/dist/esm/actions/getTokenBalancesByChain.d.ts.map +1 -1
  102. package/dist/esm/actions/getTokenBalancesByChain.js +4 -2
  103. package/dist/esm/actions/getTokenBalancesByChain.js.map +1 -1
  104. package/dist/esm/actions/getTokens.d.ts +6 -7
  105. package/dist/esm/actions/getTokens.d.ts.map +1 -1
  106. package/dist/esm/actions/getTools.d.ts +6 -7
  107. package/dist/esm/actions/getTools.d.ts.map +1 -1
  108. package/dist/esm/actions/getTransactionHistory.d.ts +13 -19
  109. package/dist/esm/actions/getTransactionHistory.d.ts.map +1 -1
  110. package/dist/esm/actions/getWalletBalances.d.ts +7 -8
  111. package/dist/esm/actions/getWalletBalances.d.ts.map +1 -1
  112. package/dist/esm/actions/index.d.ts +109 -110
  113. package/dist/esm/actions/index.d.ts.map +1 -1
  114. package/dist/esm/actions/patchContractCalls.d.ts +0 -1
  115. package/dist/esm/actions/patchContractCalls.d.ts.map +1 -1
  116. package/dist/esm/actions/relayTransaction.d.ts +7 -8
  117. package/dist/esm/actions/relayTransaction.d.ts.map +1 -1
  118. package/dist/esm/client/createClient.d.ts +0 -1
  119. package/dist/esm/client/createClient.d.ts.map +1 -1
  120. package/dist/esm/client/getClientStorage.d.ts +0 -1
  121. package/dist/esm/client/getClientStorage.d.ts.map +1 -1
  122. package/dist/esm/core/BaseStepExecutionTask.d.ts +0 -1
  123. package/dist/esm/core/BaseStepExecutionTask.d.ts.map +1 -1
  124. package/dist/esm/core/BaseStepExecutor.d.ts +0 -1
  125. package/dist/esm/core/BaseStepExecutor.d.ts.map +1 -1
  126. package/dist/esm/core/StatusManager.d.ts +40 -51
  127. package/dist/esm/core/StatusManager.d.ts.map +1 -1
  128. package/dist/esm/core/TaskPipeline.d.ts +0 -1
  129. package/dist/esm/core/TaskPipeline.d.ts.map +1 -1
  130. package/dist/esm/core/actionMessages.d.ts +0 -1
  131. package/dist/esm/core/actionMessages.d.ts.map +1 -1
  132. package/dist/esm/core/execution.d.ts +29 -30
  133. package/dist/esm/core/execution.d.ts.map +1 -1
  134. package/dist/esm/core/executionState.d.ts +0 -1
  135. package/dist/esm/core/executionState.d.ts.map +1 -1
  136. package/dist/esm/core/prepareRestart.d.ts +0 -1
  137. package/dist/esm/core/prepareRestart.d.ts.map +1 -1
  138. package/dist/esm/core/storage.d.ts.map +1 -1
  139. package/dist/esm/core/tasks/CheckBalanceTask.d.ts +6 -7
  140. package/dist/esm/core/tasks/CheckBalanceTask.d.ts.map +1 -1
  141. package/dist/esm/core/tasks/PrepareTransactionTask.d.ts +0 -1
  142. package/dist/esm/core/tasks/PrepareTransactionTask.d.ts.map +1 -1
  143. package/dist/esm/core/tasks/WaitForTransactionStatusTask.d.ts +0 -1
  144. package/dist/esm/core/tasks/WaitForTransactionStatusTask.d.ts.map +1 -1
  145. package/dist/esm/core/tasks/helpers/checkBalance.d.ts +17 -18
  146. package/dist/esm/core/tasks/helpers/checkBalance.d.ts.map +1 -1
  147. package/dist/esm/core/tasks/helpers/getTransactionRequestData.d.ts +0 -1
  148. package/dist/esm/core/tasks/helpers/getTransactionRequestData.d.ts.map +1 -1
  149. package/dist/esm/core/tasks/helpers/stepComparison.d.ts +11 -12
  150. package/dist/esm/core/tasks/helpers/stepComparison.d.ts.map +1 -1
  151. package/dist/esm/core/tasks/helpers/waitForTransactionStatus.d.ts +0 -1
  152. package/dist/esm/core/tasks/helpers/waitForTransactionStatus.d.ts.map +1 -1
  153. package/dist/esm/core/utils.d.ts +7 -8
  154. package/dist/esm/core/utils.d.ts.map +1 -1
  155. package/dist/esm/errors/SDKError.d.ts +0 -1
  156. package/dist/esm/errors/SDKError.d.ts.map +1 -1
  157. package/dist/esm/errors/baseError.d.ts +0 -1
  158. package/dist/esm/errors/baseError.d.ts.map +1 -1
  159. package/dist/esm/errors/constants.d.ts.map +1 -1
  160. package/dist/esm/errors/errors.d.ts +4 -5
  161. package/dist/esm/errors/errors.d.ts.map +1 -1
  162. package/dist/esm/errors/httpError.d.ts +0 -1
  163. package/dist/esm/errors/httpError.d.ts.map +1 -1
  164. package/dist/esm/errors/utils/baseErrorRootCause.d.ts +0 -1
  165. package/dist/esm/errors/utils/baseErrorRootCause.d.ts.map +1 -1
  166. package/dist/esm/errors/utils/rootCause.d.ts.map +1 -1
  167. package/dist/esm/types/actions.d.ts +7 -7
  168. package/dist/esm/types/actions.d.ts.map +1 -1
  169. package/dist/esm/types/core.d.ts +3 -4
  170. package/dist/esm/types/core.d.ts.map +1 -1
  171. package/dist/esm/types/execution.d.ts +0 -1
  172. package/dist/esm/types/execution.d.ts.map +1 -1
  173. package/dist/esm/types/request.d.ts.map +1 -1
  174. package/dist/esm/utils/checkPackageUpdates.d.ts.map +1 -1
  175. package/dist/esm/utils/checkPackageUpdates.js +1 -1
  176. package/dist/esm/utils/convertQuoteToRoute.d.ts +9 -10
  177. package/dist/esm/utils/convertQuoteToRoute.d.ts.map +1 -1
  178. package/dist/esm/utils/decode.d.ts.map +1 -1
  179. package/dist/esm/utils/fetchTxErrorDetails.d.ts.map +1 -1
  180. package/dist/esm/utils/formatUnits.d.ts +2 -2
  181. package/dist/esm/utils/formatUnits.d.ts.map +1 -1
  182. package/dist/esm/utils/getTransactionMessage.d.ts +0 -1
  183. package/dist/esm/utils/getTransactionMessage.d.ts.map +1 -1
  184. package/dist/esm/utils/isHex.d.ts +1 -3
  185. package/dist/esm/utils/isHex.d.ts.map +1 -1
  186. package/dist/esm/utils/isRoutesRequest.d.ts +0 -1
  187. package/dist/esm/utils/isRoutesRequest.d.ts.map +1 -1
  188. package/dist/esm/utils/isStep.d.ts +0 -1
  189. package/dist/esm/utils/isStep.d.ts.map +1 -1
  190. package/dist/esm/utils/isToken.d.ts +0 -1
  191. package/dist/esm/utils/isToken.d.ts.map +1 -1
  192. package/dist/esm/utils/parseUnits.d.ts +2 -2
  193. package/dist/esm/utils/parseUnits.d.ts.map +1 -1
  194. package/dist/esm/utils/request.d.ts +0 -1
  195. package/dist/esm/utils/request.d.ts.map +1 -1
  196. package/dist/esm/utils/sleep.d.ts.map +1 -1
  197. package/dist/esm/utils/toQueryString.d.ts.map +1 -1
  198. package/dist/esm/utils/waitForResult.d.ts +8 -8
  199. package/dist/esm/utils/waitForResult.d.ts.map +1 -1
  200. package/dist/esm/utils/withDedupe.d.ts +5 -8
  201. package/dist/esm/utils/withDedupe.d.ts.map +1 -1
  202. package/dist/esm/utils/withTimeout.d.ts +10 -16
  203. package/dist/esm/utils/withTimeout.d.ts.map +1 -1
  204. package/dist/esm/version.d.ts +1 -1
  205. package/dist/esm/version.d.ts.map +1 -1
  206. package/dist/esm/version.js +1 -1
  207. package/dist/esm/version.js.map +1 -1
  208. package/package.json +1 -1
  209. package/src/actions/getStepTransaction.ts +4 -0
  210. package/src/version.ts +1 -1
@@ -1,29 +1,28 @@
1
1
  import { SDKClient } from "../../../types/core.js";
2
2
  import { LiFiStep } from "@lifi/types";
3
-
4
3
  //#region src/core/tasks/helpers/checkBalance.d.ts
5
4
  type CheckBalanceOptions = {
6
5
  /**
7
- * Set to `false` when outer-tx gas is paid by something other than
8
- * `walletAddress` (SCA executor, 4337 bundler / paymaster, relayer):
9
- * `gasPart` is excluded from the sufficiency check and slippage rescue.
10
- * Source amount and non-included fees (e.g. LZ `msg.value`) are still
11
- * verified. Defaults to `true` (strict, today's behavior).
12
- */
6
+ * Set to `false` when outer-tx gas is paid by something other than
7
+ * `walletAddress` (SCA executor, 4337 bundler / paymaster, relayer):
8
+ * `gasPart` is excluded from the sufficiency check and slippage rescue.
9
+ * Source amount and non-included fees (e.g. LZ `msg.value`) are still
10
+ * verified. Defaults to `true` (strict, today's behavior).
11
+ */
13
12
  walletPaysGas?: boolean;
14
13
  };
15
14
  /**
16
- * Verifies that the wallet holds enough of every token required to execute
17
- * the step on its source chain — the source-token amount, any gas costs, and
18
- * any non-included fee costs. Reads all balances in one batched provider
19
- * call, retries within a bounded budget to absorb transient RPC failures and
20
- * post-confirmation propagation lag, and applies slippage to the source-token
21
- * portion only as a last resort (overhead is never trimmed).
22
- *
23
- * Throws BalanceError("The balance is too low.") on a genuine shortfall, or
24
- * BalanceError("Could not read wallet balance.") if the balance can't be read
25
- * after retries.
26
- */
15
+ * Verifies that the wallet holds enough of every token required to execute
16
+ * the step on its source chain — the source-token amount, any gas costs, and
17
+ * any non-included fee costs. Reads all balances in one batched provider
18
+ * call, retries within a bounded budget to absorb transient RPC failures and
19
+ * post-confirmation propagation lag, and applies slippage to the source-token
20
+ * portion only as a last resort (overhead is never trimmed).
21
+ *
22
+ * Throws BalanceError("The balance is too low.") on a genuine shortfall, or
23
+ * BalanceError("Could not read wallet balance.") if the balance can't be read
24
+ * after retries.
25
+ */
27
26
  declare const checkBalance: (client: SDKClient, walletAddress: string, step: LiFiStep, options?: CheckBalanceOptions) => Promise<void>;
28
27
  //#endregion
29
28
  export { CheckBalanceOptions, checkBalance };
@@ -1,5 +1,4 @@
1
1
  import { ExecutionOptions, LiFiStepExtended } from "../../../types/core.js";
2
-
3
2
  //#region src/core/tasks/helpers/getTransactionRequestData.d.ts
4
3
  declare const getTransactionRequestData: (step: LiFiStepExtended, executionOptions?: ExecutionOptions) => Promise<string>;
5
4
  //#endregion
@@ -1,20 +1,19 @@
1
1
  import { ExecutionOptions } from "../../../types/core.js";
2
2
  import { StatusManager } from "../../StatusManager.js";
3
3
  import { LiFiStep } from "@lifi/types";
4
-
5
4
  //#region src/core/tasks/helpers/stepComparison.d.ts
6
5
  /**
7
- * This method checks whether the new and updated Step meets the required exchange rate conditions.
8
- * If yes it returns the updated Step.
9
- * If no and if user interaction is allowed it triggers the acceptExchangeRateUpdateHook. If no user interaction is allowed it aborts.
10
- * @param statusManager
11
- * @param oldStep
12
- * @param newStep
13
- * @param settings
14
- * @param allowUserInteraction
15
- * @param executionOptions
16
- * @returns Return LiFiStep
17
- */
6
+ * This method checks whether the new and updated Step meets the required exchange rate conditions.
7
+ * If yes it returns the updated Step.
8
+ * If no and if user interaction is allowed it triggers the acceptExchangeRateUpdateHook. If no user interaction is allowed it aborts.
9
+ * @param statusManager
10
+ * @param oldStep
11
+ * @param newStep
12
+ * @param settings
13
+ * @param allowUserInteraction
14
+ * @param executionOptions
15
+ * @returns Return LiFiStep
16
+ */
18
17
  declare const stepComparison: (statusManager: StatusManager, oldStep: LiFiStep, newStep: LiFiStep, allowUserInteraction: boolean, executionOptions?: ExecutionOptions) => Promise<LiFiStep>;
19
18
  //#endregion
20
19
  export { stepComparison };
@@ -1,7 +1,6 @@
1
1
  import { ExecutionActionType, SDKClient } from "../../../types/core.js";
2
2
  import { StatusManager } from "../../StatusManager.js";
3
3
  import { LiFiStep, StatusResponse } from "@lifi/types";
4
-
5
4
  //#region src/core/tasks/helpers/waitForTransactionStatus.d.ts
6
5
  declare function waitForTransactionStatus(client: SDKClient, statusManager: StatusManager, txHash: string, step: LiFiStep, actionType: ExecutionActionType, interval?: number): Promise<StatusResponse>;
7
6
  //#endregion
@@ -1,15 +1,14 @@
1
1
  import { RPCUrls } from "../types/core.js";
2
2
  import { ChainId, ExtendedChain, LiFiStep } from "@lifi/types";
3
-
4
3
  //#region src/core/utils.d.ts
5
4
  /**
6
- * Used to check if changed exchange rate is in the range of slippage threshold.
7
- * We use a slippage value as a threshold to trigger the rate change hook.
8
- * This can result in almost doubled slippage for the user and need to be revisited.
9
- * @param oldStep - old step
10
- * @param newStep - new step
11
- * @returns Boolean
12
- */
5
+ * Used to check if changed exchange rate is in the range of slippage threshold.
6
+ * We use a slippage value as a threshold to trigger the rate change hook.
7
+ * This can result in almost doubled slippage for the user and need to be revisited.
8
+ * @param oldStep - old step
9
+ * @param newStep - new step
10
+ * @returns Boolean
11
+ */
13
12
  declare function checkStepSlippageThreshold(oldStep: LiFiStep, newStep: LiFiStep): boolean;
14
13
  declare function getRpcUrlsFromChains(existingRpcUrls: RPCUrls, chains: ExtendedChain[], skipChains?: ChainId[]): RPCUrls;
15
14
  //#endregion
@@ -2,7 +2,6 @@ import { ExecutionAction } from "../types/core.js";
2
2
  import { ErrorCode } from "./constants.js";
3
3
  import { BaseError } from "./baseError.js";
4
4
  import { LiFiStep } from "@lifi/types";
5
-
6
5
  //#region src/errors/SDKError.d.ts
7
6
  declare class SDKError extends Error {
8
7
  step?: LiFiStep;
@@ -1,5 +1,4 @@
1
1
  import { ErrorCode, ErrorName } from "./constants.js";
2
-
3
2
  //#region src/errors/baseError.d.ts
4
3
  declare class BaseError extends Error {
5
4
  code: ErrorCode;
@@ -1,7 +1,6 @@
1
1
  import { ExecuteStepRetryParams } from "../types/core.js";
2
2
  import { LiFiErrorCode } from "./constants.js";
3
3
  import { BaseError } from "./baseError.js";
4
-
5
4
  //#region src/errors/errors.d.ts
6
5
  declare class RPCError extends BaseError {
7
6
  constructor(code: LiFiErrorCode, message: string, cause?: Error);
@@ -25,10 +24,10 @@ declare class ValidationError extends BaseError {
25
24
  constructor(message: string);
26
25
  }
27
26
  /**
28
- * Thrown by a step executor when executeStep should be retried with the given params
29
- * (e.g. wallet rejected 7702 upgrade → retry with atomicityNotReady).
30
- * The execution layer catches this and retries executeStep(client, step, retryParams).
31
- */
27
+ * Thrown by a step executor when executeStep should be retried with the given params
28
+ * (e.g. wallet rejected 7702 upgrade → retry with atomicityNotReady).
29
+ * The execution layer catches this and retries executeStep(client, step, retryParams).
30
+ */
32
31
  declare class ExecuteStepRetryError extends BaseError {
33
32
  readonly retryParams: ExecuteStepRetryParams;
34
33
  constructor(message: string, retryParams: ExecuteStepRetryParams, cause?: Error);
@@ -2,7 +2,6 @@ import { ExtendedRequestInit } from "../types/request.js";
2
2
  import { ErrorName } from "./constants.js";
3
3
  import { BaseError } from "./baseError.js";
4
4
  import { UnavailableRoutes } from "@lifi/types";
5
-
6
5
  //#region src/errors/httpError.d.ts
7
6
  interface ServerErrorResponseBody {
8
7
  code: number;
@@ -1,5 +1,4 @@
1
1
  import { BaseError } from "../baseError.js";
2
-
3
2
  //#region src/errors/utils/baseErrorRootCause.d.ts
4
3
  declare const getRootCauseBaseError: (e: Error) => BaseError;
5
4
  declare const getRootCauseBaseErrorMessage: (e: Error) => string;
@@ -1,13 +1,12 @@
1
1
  import { Action, GetStatusRequest, LiFiStep, QuoteRequest as QuoteRequest$1, RoutesRequest as RoutesRequest$1, SignedLiFiStep } from "@lifi/types";
2
-
3
2
  //#region src/types/actions.d.ts
4
3
  type GetStatusRequestExtended = GetStatusRequest & {
5
4
  fromAddress?: string;
6
5
  };
7
6
  /**
8
- * Optional limit-order fields. Supplying them opts a request into limit-order
9
- * handling; resolution happens on the backend.
10
- */
7
+ * Optional limit-order fields. Supplying them opts a request into limit-order
8
+ * handling; resolution happens on the backend.
9
+ */
11
10
  type OrderFields = {
12
11
  toAmount?: string;
13
12
  validUntil?: number;
@@ -15,12 +14,13 @@ type OrderFields = {
15
14
  };
16
15
  type RoutesRequest = Omit<RoutesRequest$1, "options"> & OrderFields & {
17
16
  options?: RoutesRequest$1["options"] & {
18
- /** (default: false) Whether to request private routes */private?: boolean;
17
+ /** (default: false) Whether to request private routes */
18
+ private?: boolean;
19
19
  };
20
20
  };
21
21
  /**
22
- * A step request that may carry the optional limit-order `action` fields.
23
- */
22
+ * A step request that may carry the optional limit-order `action` fields.
23
+ */
24
24
  type LiFiStepRequest = (LiFiStep | SignedLiFiStep) & {
25
25
  action: Action & OrderFields;
26
26
  };
@@ -1,7 +1,6 @@
1
1
  import { SDKStorage } from "../core/storage.js";
2
2
  import { ExtendedRequestInit } from "./request.js";
3
3
  import { ChainId, ChainType, CoinKey, ContractCall, ExtendedChain, FeeCost, GasCost, LiFiStep, Route, RouteOptions, Step, Substatus, Token, TokenAmount } from "@lifi/types";
4
-
5
4
  //#region src/types/core.d.ts
6
5
  type RequestInterceptor = (request: ExtendedRequestInit) => ExtendedRequestInit | Promise<ExtendedRequestInit>;
7
6
  interface SDKBaseConfig {
@@ -53,9 +52,9 @@ interface InteractionSettings {
53
52
  allowExecution?: boolean;
54
53
  }
55
54
  /**
56
- * Params passed when retrying executeStep after an ExecuteStepRetryError.
57
- * Providers can use this to pass strategy-specific retry options (e.g. atomicityNotReady for Ethereum 7702).
58
- */
55
+ * Params passed when retrying executeStep after an ExecuteStepRetryError.
56
+ * Providers can use this to pass strategy-specific retry options (e.g. atomicityNotReady for Ethereum 7702).
57
+ */
59
58
  type ExecuteStepRetryParams = Record<string, unknown>;
60
59
  interface StepExecutor {
61
60
  allowUserInteraction: boolean;
@@ -1,7 +1,6 @@
1
1
  import { ExecuteStepRetryParams, ExecutionOptions, LiFiStepExtended, SDKClient } from "./core.js";
2
2
  import { StatusManager } from "../core/StatusManager.js";
3
3
  import { ExtendedChain } from "@lifi/types";
4
-
5
4
  //#region src/types/execution.d.ts
6
5
  interface StepExecutorBaseContext {
7
6
  statusManager: StatusManager;
@@ -5,7 +5,7 @@ const checkPackageUpdates = async (packageName, packageVersion) => {
5
5
  try {
6
6
  const pkgName = packageName ?? "@lifi/sdk";
7
7
  const latestVersion = (await (await fetch(`https://registry.npmjs.org/${pkgName}/latest`)).json()).version;
8
- const currentVersion = packageVersion ?? "4.1.0";
8
+ const currentVersion = packageVersion ?? "4.2.0";
9
9
  if (latestVersion > currentVersion) console.warn(`${pkgName}: new package version is available. Please update as soon as possible to enjoy the newest features. Current version: ${currentVersion}. Latest version: ${latestVersion}.`);
10
10
  } catch (_error) {}
11
11
  };
@@ -1,21 +1,20 @@
1
1
  import { LiFiStep, Route } from "@lifi/types";
2
-
3
2
  //#region src/utils/convertQuoteToRoute.d.ts
4
3
  interface ConvertQuoteToRouteOptions {
5
4
  /**
6
- * When true, if the quote has zero output values (toAmount, toAmountMin, toAmountUSD),
7
- * use the values from the previous included step that has non-zero output.
8
- */
5
+ * When true, if the quote has zero output values (toAmount, toAmountMin, toAmountUSD),
6
+ * use the values from the previous included step that has non-zero output.
7
+ */
9
8
  adjustZeroOutputFromPreviousStep?: boolean;
10
9
  }
11
10
  declare function formatTokenPrice(amount?: string | bigint, price?: string, decimals?: number): number;
12
11
  /**
13
- * Converts a quote to Route
14
- * @param quote - Step returned from the quote endpoint.
15
- * @param options - Optional configuration for handling edge cases.
16
- * @returns - The route to be executed.
17
- * @throws {BaseError} Throws a ValidationError if the step has missing values.
18
- */
12
+ * Converts a quote to Route
13
+ * @param quote - Step returned from the quote endpoint.
14
+ * @param options - Optional configuration for handling edge cases.
15
+ * @returns - The route to be executed.
16
+ * @throws {BaseError} Throws a ValidationError if the step has missing values.
17
+ */
19
18
  declare const convertQuoteToRoute: (quote: LiFiStep, options?: ConvertQuoteToRouteOptions) => Route;
20
19
  //#endregion
21
20
  export { convertQuoteToRoute, formatTokenPrice };
@@ -1,7 +1,7 @@
1
1
  //#region src/utils/formatUnits.d.ts
2
2
  /**
3
- * Divides a number by a given exponent of base 10 (10exponent), and formats it into a string representation of the number.
4
- */
3
+ * Divides a number by a given exponent of base 10 (10exponent), and formats it into a string representation of the number.
4
+ */
5
5
  declare function formatUnits(value: bigint, decimals: number): string;
6
6
  //#endregion
7
7
  export { formatUnits };
@@ -1,6 +1,5 @@
1
1
  import { SDKClient } from "../types/core.js";
2
2
  import { LiFiStep } from "@lifi/types";
3
-
4
3
  //#region src/utils/getTransactionMessage.d.ts
5
4
  declare const getTransactionFailedMessage: (client: SDKClient, step: LiFiStep, txLink?: string) => Promise<string>;
6
5
  //#endregion
@@ -1,8 +1,6 @@
1
1
  //#region src/utils/isHex.d.ts
2
2
  type Hex = `0x${string}`;
3
- declare function isHex(value: unknown, {
4
- strict
5
- }?: {
3
+ declare function isHex(value: unknown, { strict }?: {
6
4
  strict?: boolean | undefined;
7
5
  }): value is Hex;
8
6
  //#endregion
@@ -1,5 +1,4 @@
1
1
  import { RoutesRequest } from "@lifi/types";
2
-
3
2
  //#region src/utils/isRoutesRequest.d.ts
4
3
  declare const isRoutesRequest: (routesRequest: RoutesRequest) => routesRequest is RoutesRequest;
5
4
  //#endregion
@@ -1,5 +1,4 @@
1
1
  import { LiFiStep } from "@lifi/types";
2
-
3
2
  //#region src/utils/isStep.d.ts
4
3
  declare const isStep: (step: LiFiStep) => step is LiFiStep;
5
4
  //#endregion
@@ -1,5 +1,4 @@
1
1
  import { StaticToken } from "@lifi/types";
2
-
3
2
  //#region src/utils/isToken.d.ts
4
3
  declare const isToken: (token: StaticToken) => token is StaticToken;
5
4
  //#endregion
@@ -1,7 +1,7 @@
1
1
  //#region src/utils/parseUnits.d.ts
2
2
  /**
3
- * Multiplies a string representation of a number by a given exponent of base 10 (10exponent).
4
- */
3
+ * Multiplies a string representation of a number by a given exponent of base 10 (10exponent).
4
+ */
5
5
  declare function parseUnits(value: string, decimals: number): bigint;
6
6
  //#endregion
7
7
  export { parseUnits };
@@ -1,6 +1,5 @@
1
1
  import { ExtendedRequestInit } from "../types/request.js";
2
2
  import { SDKBaseConfig } from "../types/core.js";
3
-
4
3
  //#region src/utils/request.d.ts
5
4
  declare const requestSettings: {
6
5
  retries: number;
@@ -1,13 +1,13 @@
1
1
  //#region src/utils/waitForResult.d.ts
2
2
  /**
3
- * Repeatedly calls a given asynchronous function until it resolves with a value
4
- * @param fn The function that should be repeated
5
- * @param interval The timeout in milliseconds between retries, or a function that receives the current poll count and returns the interval. Defaults to 5000
6
- * @param maxRetries Maximum number of retries before throwing an error, defaults to 3
7
- * @param shouldRetry Optional predicate to determine if an error should trigger a retry
8
- * @returns The result of the fn function
9
- * @throws Error if maximum retries is reached, if function keeps returning undefined, or if shouldRetry returns false
10
- */
3
+ * Repeatedly calls a given asynchronous function until it resolves with a value
4
+ * @param fn The function that should be repeated
5
+ * @param interval The timeout in milliseconds between retries, or a function that receives the current poll count and returns the interval. Defaults to 5000
6
+ * @param maxRetries Maximum number of retries before throwing an error, defaults to 3
7
+ * @param shouldRetry Optional predicate to determine if an error should trigger a retry
8
+ * @returns The result of the fn function
9
+ * @throws Error if maximum retries is reached, if function keeps returning undefined, or if shouldRetry returns false
10
+ */
11
11
  declare const waitForResult: <T>(fn: () => Promise<T | undefined>, interval?: number | ((poll: number) => number), maxRetries?: number, shouldRetry?: (count: number, error: unknown) => boolean) => Promise<T>;
12
12
  //#endregion
13
13
  export { waitForResult };
@@ -1,9 +1,9 @@
1
1
  //#region src/utils/withDedupe.d.ts
2
2
  /**
3
- * Map with a LRU (Least recently used) policy.
4
- *
5
- * https://en.wikipedia.org/wiki/Cache_replacement_policies#LRU
6
- */
3
+ * Map with a LRU (Least recently used) policy.
4
+ *
5
+ * https://en.wikipedia.org/wiki/Cache_replacement_policies#LRU
6
+ */
7
7
  declare class LruMap<value = unknown> extends Map<string, value> {
8
8
  maxSize: number;
9
9
  constructor(size: number);
@@ -14,10 +14,7 @@ type WithDedupeOptions = {
14
14
  id?: string | undefined;
15
15
  };
16
16
  /** Deduplicates in-flight promises. */
17
- declare function withDedupe<T>(fn: () => Promise<T>, {
18
- enabled,
19
- id
20
- }: WithDedupeOptions): Promise<T>;
17
+ declare function withDedupe<T>(fn: () => Promise<T>, { enabled, id }: WithDedupeOptions): Promise<T>;
21
18
  //#endregion
22
19
  export { LruMap, withDedupe };
23
20
  //# sourceMappingURL=withDedupe.d.ts.map
@@ -1,22 +1,16 @@
1
1
  //#region src/utils/withTimeout.d.ts
2
2
  /**
3
- * Wraps a function in a timeout.
4
- * Based on viem's withTimeout implementation.
5
- * @param fn - The function to wrap.
6
- * @param timeout - The timeout in milliseconds.
7
- * @param errorInstance - The error instance to throw when the timeout is reached.
8
- * @param signal - Whether or not the timeout should use an abort signal.
9
- * @returns The result of the function.
10
- */
11
- declare function withTimeout<T>(fn: ({
12
- signal
13
- }: {
3
+ * Wraps a function in a timeout.
4
+ * Based on viem's withTimeout implementation.
5
+ * @param fn - The function to wrap.
6
+ * @param timeout - The timeout in milliseconds.
7
+ * @param errorInstance - The error instance to throw when the timeout is reached.
8
+ * @param signal - Whether or not the timeout should use an abort signal.
9
+ * @returns The result of the function.
10
+ */
11
+ declare function withTimeout<T>(fn: ({ signal }: {
14
12
  signal: AbortController["signal"] | null;
15
- }) => Promise<T>, {
16
- errorInstance,
17
- timeout,
18
- signal
19
- }: {
13
+ }) => Promise<T>, { errorInstance, timeout, signal }: {
20
14
  errorInstance?: Error | undefined;
21
15
  timeout: number;
22
16
  signal?: boolean | undefined;
@@ -1,6 +1,6 @@
1
1
  //#region src/version.d.ts
2
2
  declare const name = "@lifi/sdk";
3
- declare const version = "4.1.0";
3
+ declare const version = "4.2.0";
4
4
  //#endregion
5
5
  export { name, version };
6
6
  //# sourceMappingURL=version.d.ts.map
@@ -1,7 +1,7 @@
1
1
  Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
2
2
  //#region src/version.ts
3
3
  const name = "@lifi/sdk";
4
- const version = "4.1.0";
4
+ const version = "4.2.0";
5
5
  //#endregion
6
6
  exports.name = name;
7
7
  exports.version = version;
@@ -1 +1 @@
1
- {"version":3,"file":"version.js","names":[],"sources":["../../src/version.ts"],"sourcesContent":["export const name = '@lifi/sdk'\nexport const version = '4.1.0'\n"],"mappings":";;AAAA,MAAa,OAAO;AACpB,MAAa,UAAU"}
1
+ {"version":3,"file":"version.js","names":[],"sources":["../../src/version.ts"],"sourcesContent":["export const name = '@lifi/sdk'\nexport const version = '4.2.0'\n"],"mappings":";;AAAA,MAAa,OAAO;AACpB,MAAa,UAAU"}
@@ -1,15 +1,14 @@
1
1
  import { SDKBaseConfig, SDKClient } from "../types/core.js";
2
2
  import { ChainsRequest, ExtendedChain, RequestOptions } from "@lifi/types";
3
-
4
3
  //#region src/actions/getChains.d.ts
5
4
  /**
6
- * Get all available chains
7
- * @param client - The SDK client
8
- * @param params - The configuration of the requested chains
9
- * @param options - Request options
10
- * @returns A list of all available chains
11
- * @throws {LiFiError} Throws a LiFiError if request fails.
12
- */
5
+ * Get all available chains
6
+ * @param client - The SDK client
7
+ * @param params - The configuration of the requested chains
8
+ * @param options - Request options
9
+ * @returns A list of all available chains
10
+ * @throws {LiFiError} Throws a LiFiError if request fails.
11
+ */
13
12
  declare const getChains: (client: SDKClient, params?: ChainsRequest, options?: RequestOptions) => Promise<ExtendedChain[]>;
14
13
  declare const _getChains: (config: SDKBaseConfig, params?: ChainsRequest, options?: RequestOptions) => Promise<ExtendedChain[]>;
15
14
  //#endregion
@@ -1 +1 @@
1
- {"version":3,"file":"getChains.d.ts","names":[],"sources":["../../../src/actions/getChains.ts"],"mappings":";;;;;;AAkBA;;;;;;cAAa,SAAA,GACX,MAAA,EAAQ,SAAA,EACR,MAAA,GAAS,aAAA,EACT,OAAA,GAAU,cAAA,KACT,OAAA,CAAQ,aAAA;AAAA,cAIE,UAAA,GACX,MAAA,EAAQ,aAAA,EACR,MAAA,GAAS,aAAA,EACT,OAAA,GAAU,cAAA,KACT,OAAA,CAAQ,aAAA"}
1
+ {"version":3,"file":"getChains.d.ts","names":[],"sources":["../../../src/actions/getChains.ts"],"mappings":";;;;;;;;;;;cAkBa,YACX,QAAQ,WACR,SAAS,eACT,UAAU,mBACT,QAAQ;cAIE,aACX,QAAQ,eACR,SAAS,eACT,UAAU,mBACT,QAAQ"}
@@ -1,14 +1,13 @@
1
1
  import { SDKClient } from "../types/core.js";
2
2
  import { ConnectionsRequest, ConnectionsResponse, RequestOptions } from "@lifi/types";
3
-
4
3
  //#region src/actions/getConnections.d.ts
5
4
  /**
6
- * Get all the available connections for swap/bridging tokens
7
- * @param client - The SDK client
8
- * @param connectionRequest ConnectionsRequest
9
- * @param options - Request options
10
- * @returns ConnectionsResponse
11
- */
5
+ * Get all the available connections for swap/bridging tokens
6
+ * @param client - The SDK client
7
+ * @param connectionRequest ConnectionsRequest
8
+ * @param options - Request options
9
+ * @returns ConnectionsResponse
10
+ */
12
11
  declare const getConnections: (client: SDKClient, connectionRequest: ConnectionsRequest, options?: RequestOptions) => Promise<ConnectionsResponse>;
13
12
  //#endregion
14
13
  export { getConnections };
@@ -1 +1 @@
1
- {"version":3,"file":"getConnections.d.ts","names":[],"sources":["../../../src/actions/getConnections.ts"],"mappings":";;;;;;AAeA;;;;;cAAa,cAAA,GACX,MAAA,EAAQ,SAAA,EACR,iBAAA,EAAmB,kBAAA,EACnB,OAAA,GAAU,cAAA,KACT,OAAA,CAAQ,mBAAA"}
1
+ {"version":3,"file":"getConnections.d.ts","names":[],"sources":["../../../src/actions/getConnections.ts"],"mappings":";;;;;;;;;;cAea,iBACX,QAAQ,WACR,mBAAmB,oBACnB,UAAU,mBACT,QAAQ"}
@@ -1,15 +1,14 @@
1
1
  import { SDKClient } from "../types/core.js";
2
2
  import { ContractCallsQuoteRequest, LiFiStep, RequestOptions } from "@lifi/types";
3
-
4
3
  //#region src/actions/getContractCallsQuote.d.ts
5
4
  /**
6
- * Get a quote for a destination contract call
7
- * @param client - The SDK client
8
- * @param params - The configuration of the requested destination call
9
- * @param options - Request options
10
- * @throws {LiFiError} - Throws a LiFiError if request fails
11
- * @returns - Returns step.
12
- */
5
+ * Get a quote for a destination contract call
6
+ * @param client - The SDK client
7
+ * @param params - The configuration of the requested destination call
8
+ * @param options - Request options
9
+ * @throws {LiFiError} - Throws a LiFiError if request fails
10
+ * @returns - Returns step.
11
+ */
13
12
  declare const getContractCallsQuote: (client: SDKClient, params: ContractCallsQuoteRequest, options?: RequestOptions) => Promise<LiFiStep>;
14
13
  //#endregion
15
14
  export { getContractCallsQuote };
@@ -1 +1 @@
1
- {"version":3,"file":"getContractCallsQuote.d.ts","names":[],"sources":["../../../src/actions/getContractCallsQuote.ts"],"mappings":";;;;;;AAsBA;;;;;;cAAa,qBAAA,GACX,MAAA,EAAQ,SAAA,EACR,MAAA,EAAQ,yBAAA,EACR,OAAA,GAAU,cAAA,KACT,OAAA,CAAQ,QAAA"}
1
+ {"version":3,"file":"getContractCallsQuote.d.ts","names":[],"sources":["../../../src/actions/getContractCallsQuote.ts"],"mappings":";;;;;;;;;;;cAsBa,wBACX,QAAQ,WACR,QAAQ,2BACR,UAAU,mBACT,QAAQ"}
@@ -1,15 +1,14 @@
1
1
  import { SDKClient } from "../types/core.js";
2
2
  import { GasRecommendationRequest, GasRecommendationResponse, RequestOptions } from "@lifi/types";
3
-
4
3
  //#region src/actions/getGasRecommendation.d.ts
5
4
  /**
6
- * Get gas recommendation for a certain chain
7
- * @param client - The SDK client
8
- * @param params - Configuration of the requested gas recommendation.
9
- * @param options - Request options
10
- * @throws {LiFiError} Throws a LiFiError if request fails.
11
- * @returns Gas recommendation response.
12
- */
5
+ * Get gas recommendation for a certain chain
6
+ * @param client - The SDK client
7
+ * @param params - Configuration of the requested gas recommendation.
8
+ * @param options - Request options
9
+ * @throws {LiFiError} Throws a LiFiError if request fails.
10
+ * @returns Gas recommendation response.
11
+ */
13
12
  declare const getGasRecommendation: (client: SDKClient, params: GasRecommendationRequest, options?: RequestOptions) => Promise<GasRecommendationResponse>;
14
13
  //#endregion
15
14
  export { getGasRecommendation };
@@ -1 +1 @@
1
- {"version":3,"file":"getGasRecommendation.d.ts","names":[],"sources":["../../../src/actions/getGasRecommendation.ts"],"mappings":";;;;;;AAkBA;;;;;;cAAa,oBAAA,GACX,MAAA,EAAQ,SAAA,EACR,MAAA,EAAQ,wBAAA,EACR,OAAA,GAAU,cAAA,KACT,OAAA,CAAQ,yBAAA"}
1
+ {"version":3,"file":"getGasRecommendation.d.ts","names":[],"sources":["../../../src/actions/getGasRecommendation.ts"],"mappings":";;;;;;;;;;;cAkBa,uBACX,QAAQ,WACR,QAAQ,0BACR,UAAU,mBACT,QAAQ"}
@@ -1,14 +1,13 @@
1
1
  import { SDKClient } from "../types/core.js";
2
2
  import { ChainType } from "@lifi/types";
3
-
4
3
  //#region src/actions/getNameServiceAddress.d.ts
5
4
  /**
6
- * Get the address of a name service
7
- * @param client - The SDK client
8
- * @param name - The name to resolve
9
- * @param chainType - The chain type to resolve the name on
10
- * @returns The address of the name service
11
- */
5
+ * Get the address of a name service
6
+ * @param client - The SDK client
7
+ * @param name - The name to resolve
8
+ * @param chainType - The chain type to resolve the name on
9
+ * @returns The address of the name service
10
+ */
12
11
  declare const getNameServiceAddress: (client: SDKClient, name: string, chainType?: ChainType) => Promise<string | undefined>;
13
12
  //#endregion
14
13
  export { getNameServiceAddress };
@@ -1 +1 @@
1
- {"version":3,"file":"getNameServiceAddress.d.ts","names":[],"sources":["../../../src/actions/getNameServiceAddress.ts"],"mappings":";;;;;;AAUA;;;;;cAAa,qBAAA,GACX,MAAA,EAAQ,SAAA,EACR,IAAA,UACA,SAAA,GAAY,SAAA,KACX,OAAA"}
1
+ {"version":3,"file":"getNameServiceAddress.d.ts","names":[],"sources":["../../../src/actions/getNameServiceAddress.ts"],"mappings":";;;;;;;;;;cAUa,wBACX,QAAQ,WACR,cACA,YAAY,cACX"}