@gearbox-protocol/sdk 16.0.0-next.43 → 16.0.0-next.45

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 (88) hide show
  1. package/dist/cjs/onchain/accounts/index.js +0 -2
  2. package/dist/cjs/onchain/accounts/withdrawal-compressor/RedemptionLoggerV310Contract.js +13 -7
  3. package/dist/cjs/onchain/accounts/withdrawal-compressor/errors.js +0 -19
  4. package/dist/cjs/onchain/accounts/withdrawal-compressor/index.js +1 -2
  5. package/dist/cjs/onchain/index.js +0 -4
  6. package/dist/cjs/onchain/market/adapters/contracts/BalancerV3RouterAdapterContract.js +33 -1
  7. package/dist/cjs/onchain/market/index.js +0 -2
  8. package/dist/cjs/onchain/market/zapper/ZapperContract.js +15 -8
  9. package/dist/cjs/onchain/market/zapper/errors.js +0 -18
  10. package/dist/cjs/onchain/market/zapper/index.js +1 -2
  11. package/dist/cjs/onchain/validation/checks.js +1 -1
  12. package/dist/cjs/preview/index.js +1 -10
  13. package/dist/cjs/preview/parse/errors.js +0 -35
  14. package/dist/cjs/preview/parse/index.js +1 -5
  15. package/dist/cjs/preview/parse/parseOperationCalldata.js +28 -17
  16. package/dist/cjs/preview/parse/parsePoolOperationCalldata.js +17 -11
  17. package/dist/cjs/preview/prerequisites/checkPrerequisites.js +5 -2
  18. package/dist/cjs/preview/preview/detectDelayedClaim.js +9 -7
  19. package/dist/cjs/preview/preview/detectDelayedOperation.js +11 -4
  20. package/dist/cjs/preview/preview/errors.js +0 -17
  21. package/dist/cjs/preview/preview/index.js +1 -2
  22. package/dist/cjs/preview/preview/previewOperation.js +30 -42
  23. package/dist/cjs/preview/preview/previewPoolPositionOperation.js +7 -3
  24. package/dist/cjs/preview/simulate/errors.js +13 -23
  25. package/dist/cjs/preview/simulate/index.js +1 -1
  26. package/dist/cjs/preview/simulate/simulateOperation.js +6 -4
  27. package/dist/cjs/preview/simulate/simulatePoolOperation.js +6 -3
  28. package/dist/esm/onchain/accounts/index.js +1 -2
  29. package/dist/esm/onchain/accounts/withdrawal-compressor/RedemptionLoggerV310Contract.js +13 -7
  30. package/dist/esm/onchain/accounts/withdrawal-compressor/errors.js +1 -19
  31. package/dist/esm/onchain/accounts/withdrawal-compressor/index.js +2 -2
  32. package/dist/esm/onchain/index.js +1 -3
  33. package/dist/esm/onchain/market/adapters/contracts/BalancerV3RouterAdapterContract.js +33 -1
  34. package/dist/esm/onchain/market/index.js +1 -2
  35. package/dist/esm/onchain/market/zapper/ZapperContract.js +15 -8
  36. package/dist/esm/onchain/market/zapper/errors.js +1 -18
  37. package/dist/esm/onchain/market/zapper/index.js +2 -2
  38. package/dist/esm/onchain/validation/checks.js +1 -1
  39. package/dist/esm/preview/index.js +2 -6
  40. package/dist/esm/preview/parse/errors.js +1 -33
  41. package/dist/esm/preview/parse/index.js +2 -3
  42. package/dist/esm/preview/parse/parseOperationCalldata.js +28 -17
  43. package/dist/esm/preview/parse/parsePoolOperationCalldata.js +17 -11
  44. package/dist/esm/preview/prerequisites/checkPrerequisites.js +5 -2
  45. package/dist/esm/preview/preview/detectDelayedClaim.js +9 -7
  46. package/dist/esm/preview/preview/detectDelayedOperation.js +11 -4
  47. package/dist/esm/preview/preview/errors.js +1 -17
  48. package/dist/esm/preview/preview/index.js +2 -2
  49. package/dist/esm/preview/preview/previewOperation.js +31 -43
  50. package/dist/esm/preview/preview/previewPoolPositionOperation.js +7 -3
  51. package/dist/esm/preview/simulate/errors.js +14 -23
  52. package/dist/esm/preview/simulate/index.js +2 -2
  53. package/dist/esm/preview/simulate/simulateOperation.js +6 -4
  54. package/dist/esm/preview/simulate/simulatePoolOperation.js +6 -3
  55. package/dist/types/model/errors.d.ts +1 -1
  56. package/dist/types/onchain/accounts/index.d.ts +1 -1
  57. package/dist/types/onchain/accounts/withdrawal-compressor/RedemptionLoggerV310Contract.d.ts +6 -4
  58. package/dist/types/onchain/accounts/withdrawal-compressor/errors.d.ts +2 -11
  59. package/dist/types/onchain/accounts/withdrawal-compressor/index.d.ts +1 -1
  60. package/dist/types/onchain/accounts/withdrawal-compressor/types.d.ts +6 -4
  61. package/dist/types/onchain/index.d.ts +2 -2
  62. package/dist/types/onchain/market/index.d.ts +1 -1
  63. package/dist/types/onchain/market/zapper/ZapperContract.d.ts +7 -3
  64. package/dist/types/onchain/market/zapper/errors.d.ts +1 -10
  65. package/dist/types/onchain/market/zapper/index.d.ts +1 -1
  66. package/dist/types/onchain/market/zapper/types.d.ts +4 -1
  67. package/dist/types/onchain/validation/checks.d.ts +1 -1
  68. package/dist/types/preview/index.d.ts +4 -4
  69. package/dist/types/preview/parse/errors.d.ts +3 -21
  70. package/dist/types/preview/parse/index.d.ts +1 -1
  71. package/dist/types/preview/parse/parseOperationCalldata.d.ts +5 -1
  72. package/dist/types/preview/parse/parsePoolOperationCalldata.d.ts +5 -2
  73. package/dist/types/preview/prerequisites/checkPrerequisites.d.ts +6 -1
  74. package/dist/types/preview/preview/detectDelayedClaim.d.ts +7 -6
  75. package/dist/types/preview/preview/detectDelayedOperation.d.ts +3 -1
  76. package/dist/types/preview/preview/errors.d.ts +1 -10
  77. package/dist/types/preview/preview/index.d.ts +2 -2
  78. package/dist/types/preview/preview/previewOperation.d.ts +10 -10
  79. package/dist/types/preview/preview/previewPoolPositionOperation.d.ts +3 -1
  80. package/dist/types/preview/simulate/errors.d.ts +2 -11
  81. package/dist/types/preview/simulate/index.d.ts +2 -2
  82. package/dist/types/preview/simulate/simulateOperation.d.ts +4 -1
  83. package/dist/types/preview/simulate/simulatePoolOperation.d.ts +4 -1
  84. package/dist/types/sdk/prepare/errors.d.ts +1 -1
  85. package/dist/types/sdk/preview/PreviewNamespace.d.ts +2 -2
  86. package/dist/types/sdk/preview/types.d.ts +3 -3
  87. package/dist/types/sdk/types.d.ts +1 -3
  88. package/package.json +1 -1
@@ -1,9 +1,9 @@
1
1
  import { OperationPreview } from "../../model/previews.js";
2
2
  import { SDKReturn } from "../../model/result.js";
3
3
  import "../../model/index.js";
4
+ import { InvalidDelayedIntentError } from "../../onchain/accounts/withdrawal-compressor/errors.js";
4
5
  import { UnsupportedZapperFunctionError } from "../../onchain/market/zapper/errors.js";
5
6
  import { PluginsMap } from "../../onchain/plugins/types.js";
6
- import { InvalidDelayedIntentError } from "../../onchain/accounts/withdrawal-compressor/errors.js";
7
7
  import "../../onchain/index.js";
8
8
  import { UnsupportedPoolFunctionError, UnsupportedTargetError } from "../parse/errors.js";
9
9
  import { PreviewOperationInput, PreviewOperationOptions } from "../types.js";
@@ -12,21 +12,21 @@ import { UnsupportedOperationError } from "./errors.js";
12
12
  import { PreviewSimulationError } from "../simulate/errors.js";
13
13
  //#region src/preview/preview/previewOperation.d.ts
14
14
  /**
15
- * Everything {@link previewOperation} can refuse with: the verdicts its
16
- * pipeline raises, discriminated by `code`. Each is a plain object — never a
17
- * thrown `Error` — per the SDK's refusal vocabulary.
15
+ * Everything {@link previewOperation} can refuse with: the refusal errors
16
+ * its pipeline raises, discriminated by `code`. Each is a plain object —
17
+ * never a thrown `Error` — per the SDK's refusal vocabulary.
18
18
  */
19
- type PreviewVerdictError = UnsupportedTargetError | UnsupportedPoolFunctionError | UnsupportedZapperFunctionError | UnsupportedOperationError | InvalidDelayedIntentError | PreviewSimulationError;
19
+ type PreviewOperationError = UnsupportedTargetError | UnsupportedPoolFunctionError | UnsupportedZapperFunctionError | UnsupportedOperationError | InvalidDelayedIntentError | PreviewSimulationError;
20
20
  /**
21
21
  * Previews a raw operation calldata: decodes it into a typed operation and
22
22
  * assembles an operation-specific, human-displayable preview.
23
23
  *
24
24
  * Answers an {@link SDKReturn} envelope: the preview behind `ok: true`, or —
25
25
  * when the transaction is one the previewer refuses to read — a
26
- * {@link PreviewVerdictError} behind `ok: false`. A thrown exception still
27
- * means the SDK could not do its job (a read failed, the targeted credit
28
- * account could not be resolved), not a verdict on the transaction.
26
+ * {@link PreviewOperationError} behind `ok: false`. A thrown exception
27
+ * still means the SDK could not do its job (a read failed, the targeted
28
+ * credit account could not be resolved), not a refusal of the transaction.
29
29
  */
30
- declare function previewOperation<P extends PluginsMap = PluginsMap>(input: PreviewOperationInput<P>, options?: PreviewOperationOptions): Promise<SDKReturn<OperationPreview, PreviewVerdictError>>;
30
+ declare function previewOperation<P extends PluginsMap = PluginsMap>(input: PreviewOperationInput<P>, options?: PreviewOperationOptions): Promise<SDKReturn<OperationPreview, PreviewOperationError>>;
31
31
  //#endregion
32
- export { PreviewVerdictError, previewOperation };
32
+ export { PreviewOperationError, previewOperation };
@@ -1,11 +1,13 @@
1
1
  import { PoolPositionOperationPreview } from "../../model/previews.js";
2
+ import { SDKReturn } from "../../model/result.js";
2
3
  import "../../model/index.js";
3
4
  import { PluginsMap } from "../../onchain/plugins/types.js";
4
5
  import "../../onchain/index.js";
5
6
  import { PoolOperation } from "../parse/types-pools.js";
6
7
  import { PreviewOperationInput, PreviewOperationOptions } from "../types.js";
7
8
  import "../parse/index.js";
9
+ import { PreviewSimulationError } from "../simulate/errors.js";
8
10
  //#region src/preview/preview/previewPoolPositionOperation.d.ts
9
- declare function previewPoolPositionOperation<P extends PluginsMap>(input: PreviewOperationInput<P>, operation: PoolOperation, options?: PreviewOperationOptions): Promise<PoolPositionOperationPreview>;
11
+ declare function previewPoolPositionOperation<P extends PluginsMap>(input: PreviewOperationInput<P>, operation: PoolOperation, options?: PreviewOperationOptions): Promise<SDKReturn<PoolPositionOperationPreview, PreviewSimulationError>>;
10
12
  //#endregion
11
13
  export { previewPoolPositionOperation };
@@ -10,26 +10,17 @@ interface SimulationFlowFailure {
10
10
  detail: SimulationError;
11
11
  }
12
12
  /**
13
- * Verdict answered when the pool simulation fails. It wraps each flow's
13
+ * Refusal answered when the pool simulation fails. It wraps each flow's
14
14
  * decoded revert reason (see {@link failures}). A plain returned object per
15
15
  * the SDK's refusal vocabulary — not a thrown `Error`.
16
16
  */
17
17
  interface PreviewSimulationError extends IGearboxError {
18
18
  code: "previewSimulationFailed";
19
- /** Per-flow decoded failures behind this verdict. */
19
+ /** Per-flow decoded failures behind this refusal. */
20
20
  failures: SimulationFlowFailure[];
21
21
  /** First flow failure that was itself an `Error`, kept for debugging. */
22
22
  cause?: Error;
23
23
  }
24
- /**
25
- * Builds the verdict. Callable with or without `new`, so pre-declassing raise
26
- * sites keep compiling; `instanceof` matches on the `code` discriminant, and
27
- * the answer is never an `Error`.
28
- */
29
- declare const PreviewSimulationError: {
30
- (failures: SimulationFlowFailure[]): PreviewSimulationError;
31
- new (failures: SimulationFlowFailure[]): PreviewSimulationError;
32
- };
33
24
  /**
34
25
  * Normalises an unknown rejection reason into a {@link PreviewSimulationError}.
35
26
  * Pass-through when it already is one; otherwise decodes it under `source`.
@@ -1,7 +1,7 @@
1
- import { PreviewSimulationError, SimulationError, SimulationFlowFailure, SimulationFlowSource } from "./errors.js";
1
+ import { PreviewSimulationError, SimulationError, SimulationFlowFailure, SimulationFlowSource, asPreviewSimulationError } from "./errors.js";
2
2
  import { PoolOperationSimulationResult, SimulationInput } from "./types.js";
3
3
  import { simulateFacadeOperation } from "./simulateFacadeOperation.js";
4
4
  import { simulateOperation } from "./simulateOperation.js";
5
5
  import { simulatePoolOperation } from "./simulatePoolOperation.js";
6
6
  import { simulateRWAOperation } from "./simulateRWAOperation.js";
7
- export { type PoolOperationSimulationResult, PreviewSimulationError, type SimulationError, type SimulationFlowFailure, type SimulationFlowSource, type SimulationInput, simulateFacadeOperation, simulateOperation, simulatePoolOperation, simulateRWAOperation };
7
+ export { type PoolOperationSimulationResult, type PreviewSimulationError, type SimulationError, type SimulationFlowFailure, type SimulationFlowSource, type SimulationInput, asPreviewSimulationError, simulateFacadeOperation, simulateOperation, simulatePoolOperation, simulateRWAOperation };
@@ -1,9 +1,12 @@
1
+ import { SDKReturn } from "../../model/result.js";
2
+ import "../../model/index.js";
1
3
  import { PreviewOperationOptions } from "../types.js";
4
+ import { PreviewSimulationError } from "./errors.js";
2
5
  import { PoolOperationSimulationResult, SimulationInput } from "./types.js";
3
6
  //#region src/preview/simulate/simulateOperation.d.ts
4
7
  /**
5
8
  * Simulates a parsed pool or credit account operation
6
9
  */
7
- declare function simulateOperation(input: SimulationInput, options?: PreviewOperationOptions): Promise<PoolOperationSimulationResult>;
10
+ declare function simulateOperation(input: SimulationInput, options?: PreviewOperationOptions): Promise<SDKReturn<PoolOperationSimulationResult, PreviewSimulationError>>;
8
11
  //#endregion
9
12
  export { simulateOperation };
@@ -1,6 +1,9 @@
1
+ import { SDKReturn } from "../../model/result.js";
2
+ import "../../model/index.js";
1
3
  import { PoolOperation } from "../parse/types-pools.js";
2
4
  import { PreviewOperationOptions } from "../types.js";
3
5
  import "../parse/index.js";
6
+ import { PreviewSimulationError } from "./errors.js";
4
7
  import { PoolOperationSimulationResult, SimulationInput } from "./types.js";
5
8
  //#region src/preview/simulate/simulatePoolOperation.d.ts
6
9
  /**
@@ -17,6 +20,6 @@ import { PoolOperationSimulationResult, SimulationInput } from "./types.js";
17
20
  * It does not execute the calldata, so it ignores balance/allowance
18
21
  * prerequisites (preview reads succeed regardless).
19
22
  */
20
- declare function simulatePoolOperation(input: SimulationInput<PoolOperation>, options?: PreviewOperationOptions): Promise<PoolOperationSimulationResult>;
23
+ declare function simulatePoolOperation(input: SimulationInput<PoolOperation>, options?: PreviewOperationOptions): Promise<SDKReturn<PoolOperationSimulationResult, PreviewSimulationError>>;
21
24
  //#endregion
22
25
  export { simulatePoolOperation };
@@ -235,7 +235,7 @@ interface CreditAccountNotFoundError extends IGearboxError {
235
235
  * connected to, a market or token address it knows nothing about, a contract
236
236
  * that reverted where nothing should, a bug of ours.
237
237
  *
238
- * The one code that is not a verdict on the request — everything above says
238
+ * The one code that is not a refusal of the request — everything above says
239
239
  * "this cannot be done", this one says "we do not know". It exists so that a
240
240
  * refusable `prepare` method always answers: the failure that used to escape
241
241
  * as an exception arrives here instead, whole, under `cause`.
@@ -3,7 +3,7 @@ import { SDKReturn } from "../../model/result.js";
3
3
  import "../../model/index.js";
4
4
  import { MultichainSDK } from "../../onchain/MultichainSDK.js";
5
5
  import "../../onchain/index.js";
6
- import { PreviewVerdictError } from "../../preview/preview/previewOperation.js";
6
+ import { PreviewOperationError } from "../../preview/preview/previewOperation.js";
7
7
  import "../../preview/index.js";
8
8
  import { IPreview } from "./types.js";
9
9
  import { NamespaceOptions } from "../types.js";
@@ -17,7 +17,7 @@ declare class PreviewNamespace implements IPreview {
17
17
  /**
18
18
  * {@inheritDoc IPreview.previewOperation}
19
19
  **/
20
- previewOperation(input: PreviewOperationInput, options?: PreviewOperationOptions): Promise<SDKReturn<OperationPreview, PreviewVerdictError>>;
20
+ previewOperation(input: PreviewOperationInput, options?: PreviewOperationOptions): Promise<SDKReturn<OperationPreview, PreviewOperationError>>;
21
21
  }
22
22
  //#endregion
23
23
  export { PreviewNamespace };
@@ -1,7 +1,7 @@
1
1
  import { OperationPreview, PreviewOperationInput, PreviewOperationOptions } from "../../model/previews.js";
2
2
  import { SDKReturn } from "../../model/result.js";
3
3
  import "../../model/index.js";
4
- import { PreviewVerdictError } from "../../preview/preview/previewOperation.js";
4
+ import { PreviewOperationError } from "../../preview/preview/previewOperation.js";
5
5
  import "../../preview/index.js";
6
6
  //#region src/sdk/preview/types.d.ts
7
7
  /**
@@ -10,11 +10,11 @@ import "../../preview/index.js";
10
10
  interface IPreview {
11
11
  /**
12
12
  * Decodes a raw operation and assembles an operation-specific,
13
- * human-displayable preview. A verdict on the calldata — an unsupported
13
+ * human-displayable preview. A refusal of the calldata — an unsupported
14
14
  * target, function or operation, a foreign delayed intent, a failed
15
15
  * simulation — is the `ok: false` half; genuine failures still throw.
16
16
  **/
17
- previewOperation(input: PreviewOperationInput, options?: PreviewOperationOptions): Promise<SDKReturn<OperationPreview, PreviewVerdictError>>;
17
+ previewOperation(input: PreviewOperationInput, options?: PreviewOperationOptions): Promise<SDKReturn<OperationPreview, PreviewOperationError>>;
18
18
  }
19
19
  /**
20
20
  * `sdk.preview` per mode: an on-chain read, absent when the SDK reads no chain.
@@ -114,9 +114,7 @@ interface OnchainByMode {
114
114
  * The banners the backend attaches to a pool opportunity or a strategy
115
115
  * position, see {@link Notice}.
116
116
  **/
117
- interface INotices {
118
- (subject: NoticeSubject): Promise<DataResponse<Notice[]>>;
119
- }
117
+ type INotices = (subject: NoticeSubject) => Promise<DataResponse<Notice[]>>;
120
118
  /**
121
119
  * `sdk.notices` per mode: a backend read, absent when the SDK reads no backend.
122
120
  **/
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@gearbox-protocol/sdk",
3
- "version": "16.0.0-next.43",
3
+ "version": "16.0.0-next.45",
4
4
  "description": "Gearbox SDK",
5
5
  "license": "MIT",
6
6
  "repository": {