@gearbox-protocol/sdk 14.11.0-next.8 → 14.11.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 (186) hide show
  1. package/dist/cjs/common-utils/utils/index.js +0 -2
  2. package/dist/cjs/dev/index.js +1 -3
  3. package/dist/cjs/dev/isOutOfSyncError.js +3 -1
  4. package/dist/cjs/history/assembleOperations.js +6 -6
  5. package/dist/cjs/history/classifyMulticallOperations.js +25 -31
  6. package/dist/cjs/{preview/trace → history}/errors.js +26 -0
  7. package/dist/cjs/history/extractProtocolCalls.js +53 -0
  8. package/dist/cjs/{preview/trace → history}/extractTransfers.js +23 -11
  9. package/dist/cjs/{preview/trace → history}/findFacadeCalls.js +3 -3
  10. package/dist/cjs/history/index.js +2 -0
  11. package/dist/cjs/{preview/parse/types-facades.js → history/inner-operations.js} +2 -2
  12. package/dist/cjs/{preview/parse/types-adapters.js → history/internal-types.js} +2 -2
  13. package/dist/cjs/history/parseCreditAccountTransaction.js +6 -5
  14. package/dist/cjs/history/toLegacyOperation.js +2 -6
  15. package/dist/cjs/{common-utils/utils/trace.js → history/trace-utils.js} +5 -62
  16. package/dist/cjs/permissionless/bindings/pricefeeds/curve-twap.js +2 -2
  17. package/dist/cjs/plugins/adapters/contracts/AbstractAdapter.js +37 -25
  18. package/dist/cjs/plugins/adapters/contracts/AccountMigratorAdapterContract.js +0 -9
  19. package/dist/cjs/rewards/rewards/api.js +4 -2
  20. package/dist/cjs/rewards/rewards/merkl-api.js +9 -3
  21. package/dist/esm/common-utils/utils/index.js +0 -1
  22. package/dist/esm/dev/index.js +0 -1
  23. package/dist/esm/dev/isOutOfSyncError.js +3 -1
  24. package/dist/esm/history/assembleOperations.js +6 -8
  25. package/dist/esm/history/classifyMulticallOperations.js +23 -29
  26. package/dist/esm/{preview/trace → history}/errors.js +24 -0
  27. package/dist/esm/history/extractProtocolCalls.js +32 -0
  28. package/dist/esm/{preview/trace → history}/extractTransfers.js +23 -11
  29. package/dist/esm/{preview/trace → history}/findFacadeCalls.js +2 -4
  30. package/dist/esm/history/index.js +1 -0
  31. package/dist/esm/history/parseCreditAccountTransaction.js +4 -3
  32. package/dist/esm/history/toLegacyOperation.js +2 -6
  33. package/dist/esm/history/trace-utils.js +36 -0
  34. package/dist/esm/permissionless/bindings/pricefeeds/curve-twap.js +2 -2
  35. package/dist/esm/plugins/adapters/contracts/AbstractAdapter.js +38 -28
  36. package/dist/esm/plugins/adapters/contracts/AccountMigratorAdapterContract.js +0 -9
  37. package/dist/esm/rewards/rewards/api.js +4 -2
  38. package/dist/esm/rewards/rewards/merkl-api.js +9 -3
  39. package/dist/types/common-utils/utils/index.d.ts +0 -1
  40. package/dist/types/dev/index.d.ts +0 -1
  41. package/dist/types/history/assembleOperations.d.ts +6 -11
  42. package/dist/types/history/classifyMulticallOperations.d.ts +9 -21
  43. package/dist/types/{preview/trace → history}/errors.d.ts +10 -0
  44. package/dist/types/history/extractProtocolCalls.d.ts +8 -0
  45. package/dist/types/{preview/trace → history}/extractTransfers.d.ts +7 -15
  46. package/dist/types/{preview/trace → history}/findFacadeCalls.d.ts +2 -3
  47. package/dist/types/history/index.d.ts +1 -0
  48. package/dist/types/history/inner-operations.d.ts +57 -0
  49. package/dist/types/history/internal-types.d.ts +47 -0
  50. package/dist/types/history/mapOperations.d.ts +9 -7
  51. package/dist/types/history/trace-utils.d.ts +12 -0
  52. package/dist/types/history/types.d.ts +71 -22
  53. package/dist/types/plugins/adapters/contracts/AbstractAdapter.d.ts +17 -16
  54. package/dist/types/plugins/adapters/contracts/AccountMigratorAdapterContract.d.ts +1 -10
  55. package/dist/types/plugins/adapters/contracts/ConvexV1BaseRewardPoolAdapterContract.d.ts +1 -1
  56. package/dist/types/plugins/adapters/contracts/ConvexV1BoosterAdapterContract.d.ts +1 -1
  57. package/dist/types/plugins/adapters/contracts/Curve2AssetsAdapterContract.d.ts +1 -1
  58. package/dist/types/plugins/adapters/contracts/Curve3AssetsAdapterContract.d.ts +1 -1
  59. package/dist/types/plugins/adapters/contracts/Curve4AssetsAdapterContract.d.ts +1 -1
  60. package/dist/types/plugins/adapters/contracts/CurveV1AdapterDeposit.d.ts +1 -1
  61. package/dist/types/plugins/adapters/contracts/CurveV1AdapterStETHContract.d.ts +1 -1
  62. package/dist/types/plugins/adapters/contracts/CurveV1StableNGAdapterContract.d.ts +1 -1
  63. package/dist/types/plugins/adapters/contracts/DaiUsdsAdapterContract.d.ts +1 -1
  64. package/dist/types/plugins/adapters/contracts/ERC4626AdapterContract.d.ts +1 -1
  65. package/dist/types/plugins/adapters/contracts/ERC4626ReferralAdapterContract.d.ts +1 -1
  66. package/dist/types/plugins/adapters/contracts/LidoV1AdapterContract.d.ts +1 -1
  67. package/dist/types/plugins/adapters/contracts/MellowDVVAdapterContract.d.ts +1 -1
  68. package/dist/types/plugins/adapters/contracts/MellowERC4626VaultAdapterContract.d.ts +1 -1
  69. package/dist/types/plugins/adapters/contracts/UniswapV2AdapterContract.d.ts +1 -1
  70. package/dist/types/plugins/adapters/contracts/UniswapV4AdapterContract.d.ts +1 -1
  71. package/dist/types/plugins/adapters/contracts/WstETHV1AdapterContract.d.ts +1 -1
  72. package/dist/types/plugins/adapters/transferHelpers.d.ts +1 -1
  73. package/dist/types/plugins/adapters/types.d.ts +46 -8
  74. package/dist/types/rewards/rewards/api.d.ts +2 -1
  75. package/dist/types/rewards/rewards/merkl-api.d.ts +2 -1
  76. package/package.json +1 -6
  77. package/dist/cjs/dev/verifyTestnet.js +0 -124
  78. package/dist/cjs/plugins/adapters/transfers.js +0 -16
  79. package/dist/cjs/preview/index.js +0 -28
  80. package/dist/cjs/preview/package.json +0 -1
  81. package/dist/cjs/preview/parse/classifyInnerOperations.js +0 -92
  82. package/dist/cjs/preview/parse/errors.js +0 -47
  83. package/dist/cjs/preview/parse/extractExpectedBalanceChanges.js +0 -48
  84. package/dist/cjs/preview/parse/index.js +0 -34
  85. package/dist/cjs/preview/parse/parseFacadeOperationCalldata.js +0 -115
  86. package/dist/cjs/preview/parse/parseOperationCalldata.js +0 -46
  87. package/dist/cjs/preview/parse/parsePoolOperationCalldata.js +0 -77
  88. package/dist/cjs/preview/parse/types-pools.js +0 -16
  89. package/dist/cjs/preview/parse/types.js +0 -37
  90. package/dist/cjs/preview/prerequisites/AllowancePrerequisite.js +0 -78
  91. package/dist/cjs/preview/prerequisites/BalancePrerequisite.js +0 -77
  92. package/dist/cjs/preview/prerequisites/Prerequisite.js +0 -85
  93. package/dist/cjs/preview/prerequisites/buildPrerequisites.js +0 -187
  94. package/dist/cjs/preview/prerequisites/index.js +0 -34
  95. package/dist/cjs/preview/prerequisites/prepareAction.js +0 -48
  96. package/dist/cjs/preview/prerequisites/runPrerequisites.js +0 -71
  97. package/dist/cjs/preview/prerequisites/types.js +0 -16
  98. package/dist/cjs/preview/simulate/constants.js +0 -28
  99. package/dist/cjs/preview/simulate/errors.js +0 -98
  100. package/dist/cjs/preview/simulate/extractERC20Transfers.js +0 -47
  101. package/dist/cjs/preview/simulate/holders.js +0 -45
  102. package/dist/cjs/preview/simulate/index.js +0 -40
  103. package/dist/cjs/preview/simulate/simulateFacadeOperation.js +0 -30
  104. package/dist/cjs/preview/simulate/simulateOperation.js +0 -37
  105. package/dist/cjs/preview/simulate/simulatePoolOpMulticall.js +0 -155
  106. package/dist/cjs/preview/simulate/simulatePoolOpV1.js +0 -106
  107. package/dist/cjs/preview/simulate/simulatePoolOperation.js +0 -62
  108. package/dist/cjs/preview/simulate/types.js +0 -16
  109. package/dist/cjs/preview/trace/extractAdapterCallTraces.js +0 -58
  110. package/dist/cjs/preview/trace/index.js +0 -30
  111. package/dist/cjs/preview/trace/types.js +0 -16
  112. package/dist/esm/common-utils/utils/trace.js +0 -93
  113. package/dist/esm/dev/verifyTestnet.js +0 -98
  114. package/dist/esm/preview/index.js +0 -4
  115. package/dist/esm/preview/package.json +0 -1
  116. package/dist/esm/preview/parse/classifyInnerOperations.js +0 -68
  117. package/dist/esm/preview/parse/errors.js +0 -22
  118. package/dist/esm/preview/parse/extractExpectedBalanceChanges.js +0 -24
  119. package/dist/esm/preview/parse/index.js +0 -7
  120. package/dist/esm/preview/parse/parseFacadeOperationCalldata.js +0 -91
  121. package/dist/esm/preview/parse/parseOperationCalldata.js +0 -25
  122. package/dist/esm/preview/parse/parsePoolOperationCalldata.js +0 -53
  123. package/dist/esm/preview/parse/types-facades.js +0 -0
  124. package/dist/esm/preview/parse/types-pools.js +0 -0
  125. package/dist/esm/preview/parse/types.js +0 -9
  126. package/dist/esm/preview/prerequisites/AllowancePrerequisite.js +0 -57
  127. package/dist/esm/preview/prerequisites/BalancePrerequisite.js +0 -56
  128. package/dist/esm/preview/prerequisites/Prerequisite.js +0 -63
  129. package/dist/esm/preview/prerequisites/buildPrerequisites.js +0 -163
  130. package/dist/esm/preview/prerequisites/index.js +0 -7
  131. package/dist/esm/preview/prerequisites/prepareAction.js +0 -23
  132. package/dist/esm/preview/prerequisites/runPrerequisites.js +0 -47
  133. package/dist/esm/preview/prerequisites/types.js +0 -0
  134. package/dist/esm/preview/simulate/constants.js +0 -4
  135. package/dist/esm/preview/simulate/errors.js +0 -75
  136. package/dist/esm/preview/simulate/extractERC20Transfers.js +0 -23
  137. package/dist/esm/preview/simulate/holders.js +0 -21
  138. package/dist/esm/preview/simulate/index.js +0 -12
  139. package/dist/esm/preview/simulate/simulateFacadeOperation.js +0 -6
  140. package/dist/esm/preview/simulate/simulateOperation.js +0 -13
  141. package/dist/esm/preview/simulate/simulatePoolOpMulticall.js +0 -130
  142. package/dist/esm/preview/simulate/simulatePoolOpV1.js +0 -82
  143. package/dist/esm/preview/simulate/simulatePoolOperation.js +0 -41
  144. package/dist/esm/preview/simulate/types.js +0 -0
  145. package/dist/esm/preview/trace/extractAdapterCallTraces.js +0 -40
  146. package/dist/esm/preview/trace/index.js +0 -5
  147. package/dist/esm/preview/trace/types.js +0 -0
  148. package/dist/types/common-utils/utils/trace.d.ts +0 -73
  149. package/dist/types/dev/verifyTestnet.d.ts +0 -82
  150. package/dist/types/plugins/adapters/transfers.d.ts +0 -17
  151. package/dist/types/preview/index.d.ts +0 -4
  152. package/dist/types/preview/parse/classifyInnerOperations.d.ts +0 -21
  153. package/dist/types/preview/parse/errors.d.ts +0 -17
  154. package/dist/types/preview/parse/extractExpectedBalanceChanges.d.ts +0 -22
  155. package/dist/types/preview/parse/index.d.ts +0 -7
  156. package/dist/types/preview/parse/parseFacadeOperationCalldata.d.ts +0 -19
  157. package/dist/types/preview/parse/parseOperationCalldata.d.ts +0 -23
  158. package/dist/types/preview/parse/parsePoolOperationCalldata.d.ts +0 -17
  159. package/dist/types/preview/parse/types-adapters.d.ts +0 -69
  160. package/dist/types/preview/parse/types-facades.d.ts +0 -157
  161. package/dist/types/preview/parse/types-pools.d.ts +0 -55
  162. package/dist/types/preview/parse/types.d.ts +0 -44
  163. package/dist/types/preview/prerequisites/AllowancePrerequisite.d.ts +0 -24
  164. package/dist/types/preview/prerequisites/BalancePrerequisite.d.ts +0 -23
  165. package/dist/types/preview/prerequisites/Prerequisite.d.ts +0 -60
  166. package/dist/types/preview/prerequisites/buildPrerequisites.d.ts +0 -16
  167. package/dist/types/preview/prerequisites/index.d.ts +0 -7
  168. package/dist/types/preview/prerequisites/prepareAction.d.ts +0 -52
  169. package/dist/types/preview/prerequisites/runPrerequisites.d.ts +0 -12
  170. package/dist/types/preview/prerequisites/types.d.ts +0 -78
  171. package/dist/types/preview/simulate/constants.d.ts +0 -6
  172. package/dist/types/preview/simulate/errors.d.ts +0 -51
  173. package/dist/types/preview/simulate/extractERC20Transfers.d.ts +0 -11
  174. package/dist/types/preview/simulate/holders.d.ts +0 -7
  175. package/dist/types/preview/simulate/index.d.ts +0 -9
  176. package/dist/types/preview/simulate/simulateFacadeOperation.d.ts +0 -25
  177. package/dist/types/preview/simulate/simulateOperation.d.ts +0 -20
  178. package/dist/types/preview/simulate/simulatePoolOpMulticall.d.ts +0 -28
  179. package/dist/types/preview/simulate/simulatePoolOpV1.d.ts +0 -14
  180. package/dist/types/preview/simulate/simulatePoolOperation.d.ts +0 -8
  181. package/dist/types/preview/simulate/types.d.ts +0 -79
  182. package/dist/types/preview/trace/extractAdapterCallTraces.d.ts +0 -23
  183. package/dist/types/preview/trace/index.d.ts +0 -5
  184. package/dist/types/preview/trace/types.d.ts +0 -21
  185. /package/dist/esm/{plugins/adapters/transfers.js → history/inner-operations.js} +0 -0
  186. /package/dist/esm/{preview/parse/types-adapters.js → history/internal-types.js} +0 -0
@@ -1,17 +0,0 @@
1
- import type { Address } from "viem";
2
- /**
3
- * A single ERC-20 Transfer event captured between Execute boundaries.
4
- *
5
- * Internal to `plugins/adapters` (kept here so {@link toNetTransfers} stays
6
- * typed) and intentionally **not** re-exported from the package barrel: the
7
- * canonical, public `TokenTransfer` lives in the `preview` module. The two are
8
- * structurally identical, so values flow between the modules without casts.
9
- *
10
- * @deprecated Will be deprecated when we get rid of classifyLegacyOperation
11
- */
12
- export interface TokenTransfer {
13
- token: Address;
14
- amount: bigint;
15
- from: Address;
16
- to: Address;
17
- }
@@ -1,4 +0,0 @@
1
- export * from "./parse/index.js";
2
- export * from "./prerequisites/index.js";
3
- export * from "./simulate/index.js";
4
- export * from "./trace/index.js";
@@ -1,21 +0,0 @@
1
- import type { Address } from "viem";
2
- import type { OnchainSDK, ParsedCallV2 } from "../../sdk/index.js";
3
- import type { InnerOperation } from "./types.js";
4
- export interface ClassifyInnerOperationsProps {
5
- sdk: OnchainSDK;
6
- /** Underlying token of the credit manager, used for debt operations. */
7
- underlying: Address;
8
- }
9
- /**
10
- * Calldata-only counterpart of the SDK's `classifyMulticallOperations`.
11
- *
12
- * Maps each inner multicall entry to an {@link InnerOperation}:
13
- * - adapter and unknown targets become a pure-descriptor `Execute`
14
- * {@link AdapterOperation};
15
- * - credit-facade self-calls map to the matching inner facade operation.
16
- *
17
- * Raw calldata has no execution trace, so the trace-derived adapter data
18
- * (`protocol`, `transfers`) and `legacy` are intentionally absent; they are only
19
- * recovered by trace-based flows (history, facade simulation).
20
- */
21
- export declare function classifyInnerOperations(calls: ParsedCallV2[], props: ClassifyInnerOperationsProps): InnerOperation[];
@@ -1,17 +0,0 @@
1
- import type { Address } from "viem";
2
- /**
3
- * Thrown when the target of a transaction is neither a known Gearbox pool nor a
4
- * credit facade.
5
- */
6
- export declare class UnsupportedTargetError extends Error {
7
- readonly target: Address;
8
- constructor(target: Address);
9
- }
10
- /**
11
- * Thrown when a pool call uses a function other than ERC4626 `deposit`/`redeem`.
12
- */
13
- export declare class UnsupportedPoolFunctionError extends Error {
14
- readonly pool: Address;
15
- readonly functionName: string;
16
- constructor(pool: Address, functionName: string);
17
- }
@@ -1,22 +0,0 @@
1
- import type { ParsedCallV2 } from "../../sdk/index.js";
2
- import type { ExpectedBalanceChange } from "./types.js";
3
- /**
4
- * Recovers the potential balance changes declared by a router-generated
5
- * `storeExpectedBalances`/`compareBalances` pair inside a credit-facade
6
- * multicall.
7
- *
8
- * The detection is intentionally limited to the router shape:
9
- * - `onDemandPriceUpdates` calls are dropped first (they may only appear at the
10
- * front of a multicall);
11
- * - the remaining calls must start with `storeExpectedBalances` and end with
12
- * `compareBalances`.
13
- *
14
- * When the multicall does not match this shape, `undefined` is returned. On a
15
- * match, the `BalanceDelta[]` argument of `storeExpectedBalances` is decoded
16
- * into {@link ExpectedBalanceChange}[] (the `amount` is the signed `int256`
17
- * delta and may be negative).
18
- *
19
- * @param innerCalls - Raw (already-decoded) inner multicall calls.
20
- * @returns The declared balance changes, or `undefined` when not router-shaped.
21
- */
22
- export declare function extractExpectedBalanceChanges(innerCalls: ParsedCallV2[]): ExpectedBalanceChange[] | undefined;
@@ -1,7 +0,0 @@
1
- export * from "./classifyInnerOperations.js";
2
- export * from "./errors.js";
3
- export * from "./extractExpectedBalanceChanges.js";
4
- export * from "./parseFacadeOperationCalldata.js";
5
- export * from "./parseOperationCalldata.js";
6
- export * from "./parsePoolOperationCalldata.js";
7
- export * from "./types.js";
@@ -1,19 +0,0 @@
1
- import { type Hex } from "viem";
2
- import type { CreditFacadeV310Contract, OnchainSDK } from "../../sdk/index.js";
3
- import type { OuterFacadeOperation } from "./types.js";
4
- export interface ParseFacadeOperationCalldataProps {
5
- sdk: OnchainSDK;
6
- /** Resolved credit facade contract for the transaction target. */
7
- facade: CreditFacadeV310Contract;
8
- calldata: Hex;
9
- }
10
- /**
11
- * Decodes a credit-facade entry-point call into the matching
12
- * {@link OuterFacadeOperation}.
13
- *
14
- * Transaction-level metadata (`txHash`, `blockNumber`, `timestamp`) is not part
15
- * of the base `preview` operation: those values are only known once the
16
- * transaction is mined and are added in `history` mode. `creditAccount` is
17
- * `zeroAddress` for `openCreditAccount` (the address is assigned on-chain).
18
- */
19
- export declare function parseFacadeOperationCalldata(props: ParseFacadeOperationCalldataProps): OuterFacadeOperation;
@@ -1,23 +0,0 @@
1
- import type { Address, Hex } from "viem";
2
- import { type PluginsMap } from "../../sdk/index.js";
3
- import type { Operation, SdkWithAdapters } from "./types.js";
4
- export interface ParseOperationCalldataInput<P extends PluginsMap = PluginsMap> {
5
- /**
6
- * Already-attached SDK; chain, RPC and block are baked in at attach time.
7
- * Must be created with the adapters plugin (enforced at compile time) so
8
- * adapter contracts resolve during multicall classification.
9
- */
10
- sdk: SdkWithAdapters<P>;
11
- to: Address;
12
- calldata: Hex;
13
- /** Transaction sender, contextual only. */
14
- sender: Address;
15
- }
16
- /**
17
- * Decodes raw operation calldata into an {@link Operation}.
18
- *
19
- * Routes by the resolved contract at `to`: a pool yields a deposit/redeem
20
- * operation, a credit facade yields one facade operation. Anything else throws
21
- * {@link UnsupportedTargetError}.
22
- */
23
- export declare function parseOperationCalldata<P extends PluginsMap>(input: ParseOperationCalldataInput<P>): Operation;
@@ -1,17 +0,0 @@
1
- import type { Hex } from "viem";
2
- import type { OnchainSDK, PoolV310Contract } from "../../sdk/index.js";
3
- import type { PoolOperation } from "./types.js";
4
- export interface ParsePoolOperationCalldataProps {
5
- sdk: OnchainSDK;
6
- /** Resolved pool contract for the transaction target. */
7
- pool: PoolV310Contract;
8
- calldata: Hex;
9
- }
10
- /**
11
- * Decodes ERC4626 pool calldata into a {@link PoolOperation}. Supports every
12
- * deposit/mint/withdraw/redeem variant of `IPoolV3` (and the `IERC4626` base it
13
- * extends): `deposit`/`depositWithReferral`, `mint`/`mintWithReferral`,
14
- * `withdraw` and `redeem`. Any other selector throws
15
- * {@link UnsupportedPoolFunctionError}.
16
- */
17
- export declare function parsePoolOperationCalldata(props: ParsePoolOperationCalldataProps): PoolOperation;
@@ -1,69 +0,0 @@
1
- import type { Address } from "viem";
2
- import type { AdapterProtocolOperation } from "../../plugins/adapters/index.js";
3
- /**
4
- * A single ERC-20 Transfer event captured between Execute boundaries.
5
- *
6
- * Canonical, public definition owned by the `preview` module; `plugins/adapters`
7
- * keeps a structurally identical internal copy for its legacy helpers.
8
- */
9
- export interface TokenTransfer {
10
- token: Address;
11
- amount: bigint;
12
- from: Address;
13
- to: Address;
14
- }
15
- /**
16
- * Pure adapter-call descriptor: everything that can be recovered without an
17
- * execution trace (from raw calldata alone).
18
- */
19
- export interface AdapterOperationBase {
20
- operation: "Execute";
21
- /**
22
- * Address of Gearbox Adapter contract
23
- */
24
- adapter: Address;
25
- /**
26
- * Namespaced adapter type
27
- * E.g. "ADAPTER::FLUID_DEX"
28
- */
29
- adapterType: string;
30
- /**
31
- * Adapter contract version
32
- */
33
- version: number;
34
- /**
35
- * Label of protocol contract (NOT adapter contract)
36
- */
37
- label?: string;
38
- /**
39
- * Function name of adapter contract
40
- */
41
- adapterFunctionName: string;
42
- /**
43
- * Arguments of adapter contract
44
- */
45
- adapterArgs: Record<string, unknown>;
46
- }
47
- /**
48
- * Adapter `Execute` operation, generic over the extra data added by consumers.
49
- *
50
- * - calldata-only parse uses `Ext = {}` (pure descriptor);
51
- * - trace-based flows (history, facade simulation) use {@link TraceAdapterExt};
52
- * - history additionally intersects `{ legacy: LegacyAdapterOperation }`.
53
- */
54
- export type AdapterOperation<Ext extends object = {}> = AdapterOperationBase & Ext;
55
- /**
56
- * Trace-derived adapter data: the protocol-level call and the ERC-20 transfers
57
- * made during the adapter call. Both are only available from an execution
58
- * trace, so they always travel together.
59
- *
60
- * `protocol` is optional: it is absent when no external protocol call was
61
- * recovered for the adapter `Execute`. This happens for the account-migrator
62
- * adapter (its `execute` targets the migrator bot, not an external protocol),
63
- * for unknown adapters in non-strict mode (no ABI to decode against), and when
64
- * the protocol calldata cannot be decoded.
65
- */
66
- export interface TraceAdapterExt {
67
- protocol?: AdapterProtocolOperation;
68
- transfers: TokenTransfer[];
69
- }
@@ -1,157 +0,0 @@
1
- import type { Address, Hex } from "viem";
2
- import type { AdapterOperation } from "./types-adapters.js";
3
- /**
4
- * Increase debt (borrow more).
5
- * @see https://github.com/Gearbox-protocol/charts_server/blob/master/core/operation_type_v3.go#L149-L154
6
- */
7
- export interface IncreaseDebtOp {
8
- operation: "IncreaseBorrowedAmount";
9
- token: Address;
10
- amount: bigint;
11
- }
12
- /**
13
- * Decrease debt (repay).
14
- * @see https://github.com/Gearbox-protocol/charts_server/blob/master/core/operation_type_v3.go#L155-L161
15
- */
16
- export interface DecreaseDebtOp {
17
- operation: "DecreaseBorrowedAmount";
18
- token: Address;
19
- amount: bigint;
20
- }
21
- /**
22
- * Add collateral to credit account.
23
- */
24
- export interface AddCollateralOp {
25
- operation: "AddCollateral";
26
- token: Address;
27
- amount: bigint;
28
- }
29
- /**
30
- * Withdraw collateral from credit account.
31
- * @see https://github.com/Gearbox-protocol/charts_server/blob/master/core/operation_type_v3.go#L162-L171
32
- */
33
- export interface WithdrawCollateralOp {
34
- operation: "WithdrawCollateral";
35
- token: Address;
36
- amount: bigint;
37
- to: Address;
38
- phantomToken?: Address;
39
- }
40
- /**
41
- * Update token quota on credit account.
42
- * @see https://github.com/Gearbox-protocol/charts_server/blob/master/core/operation_type_v3.go#L172-L178
43
- */
44
- export interface UpdateQuotaOp {
45
- operation: "UpdateQuota";
46
- token: Address;
47
- change: bigint;
48
- }
49
- /**
50
- * Union of facade inner-call operation types (non-adapter credit account operations).
51
- * Discriminated on the `operation` field.
52
- */
53
- export type InnerFacadeOperation = IncreaseDebtOp | DecreaseDebtOp | AddCollateralOp | WithdrawCollateralOp | UpdateQuotaOp;
54
- /**
55
- * All operations that can happen within a CreditFacade's multicall and that we're interested in.
56
- *
57
- * Generic over the adapter-operation extension `Ext` (see {@link AdapterOperation}).
58
- */
59
- export type InnerOperation<Ext extends object = {}> = AdapterOperation<Ext> | InnerFacadeOperation;
60
- /**
61
- * Transaction-level metadata available only when parsing a mined transaction
62
- * (the `history` mode). It is intentionally absent from base `preview`
63
- * operations, which describe not-yet-mined calls where these values are unknown.
64
- */
65
- export interface OperationMetadata {
66
- txHash: Hex;
67
- blockNumber: number;
68
- timestamp: number;
69
- }
70
- export interface FacadeOperationMetadata {
71
- creditManager: Address;
72
- creditFacade: Address;
73
- }
74
- /**
75
- * Signed token balance delta recovered from a router-generated
76
- * `storeExpectedBalances` call (the `BalanceDelta` struct). `amount` is the
77
- * signed `int256` delta, so it may be negative.
78
- */
79
- export interface ExpectedBalanceChange {
80
- token: Address;
81
- delta: bigint;
82
- }
83
- export interface MulticallOperation<Ext extends object = {}> extends FacadeOperationMetadata {
84
- operation: "MultiCall" | "BotMulticall";
85
- creditAccount: Address;
86
- multicall: InnerOperation<Ext>[];
87
- /**
88
- * Potential balance changes declared by a router-generated
89
- * `storeExpectedBalances`/`compareBalances` pair, or `undefined` when the
90
- * multicall is not router-shaped. See {@link ExpectedBalanceChange}.
91
- */
92
- expectedBalanceChanges?: ExpectedBalanceChange[];
93
- }
94
- export interface OpenCreditAccountOperation<Ext extends object = {}> extends FacadeOperationMetadata {
95
- operation: "OpenCreditAccount";
96
- creditAccount: Address;
97
- onBehalfOf: Address;
98
- referralCode: bigint;
99
- multicall: InnerOperation<Ext>[];
100
- /**
101
- * Potential balance changes declared by a router-generated
102
- * `storeExpectedBalances`/`compareBalances` pair, or `undefined` when the
103
- * multicall is not router-shaped. See {@link ExpectedBalanceChange}.
104
- */
105
- expectedBalanceChanges?: ExpectedBalanceChange[];
106
- }
107
- export interface CloseCreditAccountOperation<Ext extends object = {}> extends FacadeOperationMetadata {
108
- operation: "CloseCreditAccount";
109
- creditAccount: Address;
110
- multicall: InnerOperation<Ext>[];
111
- /**
112
- * Potential balance changes declared by a router-generated
113
- * `storeExpectedBalances`/`compareBalances` pair, or `undefined` when the
114
- * multicall is not router-shaped. See {@link ExpectedBalanceChange}.
115
- */
116
- expectedBalanceChanges?: ExpectedBalanceChange[];
117
- }
118
- export interface LiquidateCreditAccountOperation<Ext extends object = {}> extends FacadeOperationMetadata {
119
- operation: "LiquidateCreditAccount";
120
- creditAccount: Address;
121
- to: Address;
122
- token: Address;
123
- remainingFunds: bigint;
124
- multicall: InnerOperation<Ext>[];
125
- /**
126
- * Potential balance changes declared by a router-generated
127
- * `storeExpectedBalances`/`compareBalances` pair, or `undefined` when the
128
- * multicall is not router-shaped. See {@link ExpectedBalanceChange}.
129
- */
130
- expectedBalanceChanges?: ExpectedBalanceChange[];
131
- }
132
- export interface PartialLiquidationOperation extends FacadeOperationMetadata {
133
- operation: "PartiallyLiquidateCreditAccount";
134
- creditAccount: Address;
135
- token: Address;
136
- repaidAmount: bigint;
137
- minSeizedAmount: bigint;
138
- to: Address;
139
- }
140
- export interface DirectTokenTransferOperation {
141
- operation: "DirectTokenTransfer";
142
- protocol: Address;
143
- token: Address;
144
- from: Address;
145
- creditAccount: Address;
146
- amount: bigint;
147
- }
148
- /**
149
- * Discriminated union of all facade-level operation types.
150
- * One per facade entry-point call within a transaction.
151
- */
152
- export type OuterFacadeOperation<Ext extends object = {}> = MulticallOperation<Ext> | OpenCreditAccountOperation<Ext> | CloseCreditAccountOperation<Ext> | LiquidateCreditAccountOperation<Ext> | PartialLiquidationOperation;
153
- /**
154
- * Discriminated union of all credit account operation types
155
- * (facade operations + direct token transfers).
156
- */
157
- export type CreditAccountOperation<Ext extends object = {}> = OuterFacadeOperation<Ext> | DirectTokenTransferOperation;
@@ -1,55 +0,0 @@
1
- import type { Address } from "viem";
2
- /**
3
- * ERC4626 `deposit` into a Gearbox pool.
4
- */
5
- export interface PoolDepositOperation {
6
- operation: "Deposit";
7
- pool: Address;
8
- receiver: Address;
9
- /** Underlying assets supplied to the pool. */
10
- assets: bigint;
11
- underlying: Address;
12
- /** Referral code, present only for `depositWithReferral` calls. */
13
- referralCode?: bigint;
14
- }
15
- /**
16
- * ERC4626 `mint` into a Gearbox pool. Unlike `deposit`, the caller specifies the
17
- * amount of shares to mint; the assets pulled are resolved by the pool.
18
- */
19
- export interface PoolMintOperation {
20
- operation: "Mint";
21
- pool: Address;
22
- receiver: Address;
23
- /** Pool shares (diesel) minted to the receiver. */
24
- shares: bigint;
25
- underlying: Address;
26
- /** Referral code, present only for `mintWithReferral` calls. */
27
- referralCode?: bigint;
28
- }
29
- /**
30
- * ERC4626 `withdraw` from a Gearbox pool. Unlike `redeem`, the caller specifies
31
- * the amount of underlying assets to withdraw; the shares burned are resolved by
32
- * the pool.
33
- */
34
- export interface PoolWithdrawOperation {
35
- operation: "Withdraw";
36
- pool: Address;
37
- receiver: Address;
38
- owner: Address;
39
- /** Underlying assets withdrawn to the receiver. */
40
- assets: bigint;
41
- underlying: Address;
42
- }
43
- /**
44
- * ERC4626 `redeem` from a Gearbox pool.
45
- */
46
- export interface PoolRedeemOperation {
47
- operation: "Redeem";
48
- pool: Address;
49
- receiver: Address;
50
- owner: Address;
51
- /** Pool shares (diesel) burned. */
52
- shares: bigint;
53
- underlying: Address;
54
- }
55
- export type PoolOperation = PoolDepositOperation | PoolMintOperation | PoolWithdrawOperation | PoolRedeemOperation;
@@ -1,44 +0,0 @@
1
- import type { AdaptersPlugin } from "../../plugins/adapters/index.js";
2
- import type { OnchainSDK, PluginsMap } from "../../sdk/index.js";
3
- import type { OuterFacadeOperation } from "./types-facades.js";
4
- import type { PoolOperation } from "./types-pools.js";
5
- export * from "./types-adapters.js";
6
- export * from "./types-facades.js";
7
- export * from "./types-pools.js";
8
- /**
9
- * True when the plugin map `P` contains the {@link AdaptersPlugin} under any
10
- * key. Matched nominally (the plugin's private fields make it non-structural),
11
- * so unrelated plugins never satisfy it.
12
- */
13
- export type HasAdaptersPlugin<P extends PluginsMap> = Extract<P[keyof P], AdaptersPlugin> extends never ? false : true;
14
- /**
15
- * Compile-time guard for the adapters plugin. Resolves to a no-op (`unknown`)
16
- * when `P` includes the {@link AdaptersPlugin}, otherwise to an error-shaped
17
- * type that makes the surrounding call fail to type-check.
18
- *
19
- * Intended to be intersected with a function argument so callers must pass an
20
- * SDK whose adapter contracts are registered (required for multicall
21
- * classification).
22
- */
23
- export type RequireAdaptersPlugin<P extends PluginsMap> = HasAdaptersPlugin<P> extends true ? unknown : {
24
- "OnchainSDK must be created with the AdaptersPlugin": never;
25
- };
26
- /**
27
- * {@link OnchainSDK} whose plugin map is guaranteed at compile time to include
28
- * the {@link AdaptersPlugin}.
29
- */
30
- export type SdkWithAdapters<P extends PluginsMap = PluginsMap> = OnchainSDK<P> & RequireAdaptersPlugin<P>;
31
- /**
32
- * Result of decoding a single raw operation calldata: either a pool
33
- * deposit/redeem or one of the credit-facade operations.
34
- *
35
- * Calldata-only parse produces base (descriptor) adapter operations, so the
36
- * facade operations are used with the default `Ext = {}`.
37
- */
38
- export type Operation = PoolOperation | OuterFacadeOperation;
39
- /**
40
- * Narrows an {@link Operation} to a {@link PoolOperation} (deposit, mint,
41
- * withdraw or redeem). Used by the UI to decide whether a custom view exists for
42
- * the parsed result; everything else falls back to the raw JSON view.
43
- */
44
- export declare function isPoolOperation(tx: Operation): tx is PoolOperation;
@@ -1,24 +0,0 @@
1
- import { type Address, type ContractFunctionParameters } from "viem";
2
- import { type MulticallCallResult, Prerequisite } from "./Prerequisite.js";
3
- import type { PrerequisiteDetail, PrerequisiteResult } from "./types.js";
4
- export interface AllowancePrerequisiteProps {
5
- token: Address;
6
- owner: Address;
7
- spender: Address;
8
- required: bigint;
9
- title?: string;
10
- id?: string;
11
- }
12
- /** Checks that `owner` granted `spender` an ERC-20 allowance >= `required`. */
13
- export declare class AllowancePrerequisite extends Prerequisite<"allowance"> {
14
- private readonly _id;
15
- private readonly _title;
16
- private readonly _detail;
17
- constructor(props: AllowancePrerequisiteProps);
18
- get id(): string;
19
- get kind(): "allowance";
20
- get title(): string;
21
- get detail(): PrerequisiteDetail<"allowance">;
22
- calls(): ContractFunctionParameters[];
23
- resolve(slice: MulticallCallResult[]): PrerequisiteResult<"allowance">;
24
- }
@@ -1,23 +0,0 @@
1
- import { type Address, type ContractFunctionParameters } from "viem";
2
- import { type MulticallCallResult, Prerequisite } from "./Prerequisite.js";
3
- import type { PrerequisiteDetail, PrerequisiteResult } from "./types.js";
4
- export interface BalancePrerequisiteProps {
5
- token: Address;
6
- owner: Address;
7
- required: bigint;
8
- title?: string;
9
- id?: string;
10
- }
11
- /** Checks that `owner` holds an ERC-20 balance >= `required`. */
12
- export declare class BalancePrerequisite extends Prerequisite<"balance"> {
13
- private readonly _id;
14
- private readonly _title;
15
- private readonly _detail;
16
- constructor(props: BalancePrerequisiteProps);
17
- get id(): string;
18
- get kind(): "balance";
19
- get title(): string;
20
- get detail(): PrerequisiteDetail<"balance">;
21
- calls(): ContractFunctionParameters[];
22
- resolve(slice: MulticallCallResult[]): PrerequisiteResult<"balance">;
23
- }
@@ -1,60 +0,0 @@
1
- import { type ContractFunctionParameters } from "viem";
2
- import type { PrerequisiteContext, PrerequisiteDetail, PrerequisiteError, PrerequisiteKind, PrerequisiteResult } from "./types.js";
3
- /**
4
- * One entry of a viem `multicall({ allowFailure: true })` response: either a
5
- * decoded `result` or the `error` that the call reverted with.
6
- */
7
- export type MulticallCallResult = {
8
- status: "success";
9
- result: unknown;
10
- error?: undefined;
11
- } | {
12
- status: "failure";
13
- result?: undefined;
14
- error: Error;
15
- };
16
- /**
17
- * Decodes an unknown error into a {@link PrerequisiteError} with a
18
- * human-readable revert reason. Mirrors the SDK's `extractCallError`: walk the
19
- * viem error chain for a {@link ContractFunctionRevertedError} and use its
20
- * `errorName`, otherwise fall back to the error's short message / name.
21
- */
22
- export declare function toPrerequisiteError(cause: unknown): PrerequisiteError;
23
- /**
24
- * A single verifiable prerequisite for a transaction. Subclasses describe the
25
- * on-chain reads they need ({@link calls}) and how to turn the multicall slice
26
- * into a {@link PrerequisiteResult} ({@link resolve}).
27
- *
28
- * Identity (`id`, `kind`, `title`) and build-time `detail` are exposed as
29
- * read-only accessors; subclasses back them with private fields. The shared
30
- * {@link satisfiedResult}/{@link errorResult} helpers are `protected` so each
31
- * subclass builds results consistently.
32
- *
33
- * The same instance can be verified standalone via {@link verify} or batched
34
- * together with others by `verifyPrerequisites`.
35
- */
36
- export declare abstract class Prerequisite<K extends PrerequisiteKind> {
37
- /** Stable identifier, used as a React key and for deduplication. */
38
- abstract get id(): string;
39
- /** Discriminant tying this check to its detail payload. */
40
- abstract get kind(): K;
41
- /** Human-readable label shown in the UI. */
42
- abstract get title(): string;
43
- /** Inputs known before reading the chain (no `actual` yet). */
44
- abstract get detail(): PrerequisiteDetail<K>;
45
- /** Contract reads this check needs (usually one). */
46
- abstract calls(ctx: PrerequisiteContext): ContractFunctionParameters[];
47
- /** Maps this check's slice of the multicall response into a result. */
48
- abstract resolve(slice: MulticallCallResult[]): PrerequisiteResult<K>;
49
- /**
50
- * Verifies this prerequisite on its own using an `allowFailure` multicall.
51
- * Prefer `verifyPrerequisites` to batch several checks into one round-trip.
52
- */
53
- verify(ctx: PrerequisiteContext): Promise<PrerequisiteResult<K>>;
54
- /** Builds a successful result; `detail` carries the on-chain `actual`. */
55
- protected satisfiedResult(satisfied: boolean, detail: PrerequisiteDetail<K>): PrerequisiteResult<K>;
56
- /** Builds a failed result from a decoded read error. */
57
- protected errorResult(error: PrerequisiteError): PrerequisiteResult<K>;
58
- }
59
- /** Any prerequisite regardless of its kind, used for heterogeneous lists. */
60
- export type AnyPrerequisite = Prerequisite<PrerequisiteKind>;
@@ -1,16 +0,0 @@
1
- import type { Operation } from "../parse/index.js";
2
- import type { AnyPrerequisite } from "./Prerequisite.js";
3
- import type { PrerequisiteContext } from "./types.js";
4
- /**
5
- * Derives the on-chain prerequisites for a parsed operation: the conditions
6
- * that must hold for the call not to revert and that we can verify with the
7
- * SDK (token approvals, wallet balances).
8
- *
9
- * Only *sender-actionable* prerequisites belong here: conditions the LP
10
- * provider or borrower can fix themselves before retrying (e.g. approve a
11
- * token, top up a balance). Non-actionable protocol/admin state (pool pause,
12
- * available pool liquidity, health factor, liquidatability, degen NFT gating,
13
- * bot permissions) is intentionally out of scope, since the user cannot
14
- * resolve it. New {@link AnyPrerequisite} subclasses must follow the same rule.
15
- */
16
- export declare function buildPrerequisites(tx: Operation, ctx: PrerequisiteContext): AnyPrerequisite[];
@@ -1,7 +0,0 @@
1
- export * from "./AllowancePrerequisite.js";
2
- export * from "./BalancePrerequisite.js";
3
- export * from "./buildPrerequisites.js";
4
- export * from "./Prerequisite.js";
5
- export * from "./prepareAction.js";
6
- export * from "./runPrerequisites.js";
7
- export * from "./types.js";