@gearbox-protocol/sdk 13.7.0-kyc.3 → 14.0.0-next.10

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 (214) hide show
  1. package/dist/cjs/dev/AccountOpener.js +5 -45
  2. package/dist/cjs/dev/RevolverTransport.js +10 -4
  3. package/dist/cjs/dev/index.js +0 -2
  4. package/dist/cjs/dev/logSplitterTransport.js +10 -1
  5. package/dist/cjs/permissionless/utils/create2.js +2 -2
  6. package/dist/cjs/permissionless/utils/price-update/get-price-feeds.js +11 -5
  7. package/dist/cjs/permissionless/utils/price-update/get-price-update-tx.js +11 -5
  8. package/dist/cjs/permissionless/utils/price-update/get-prices.js +12 -6
  9. package/dist/cjs/sdk/MultichainSDK.js +232 -0
  10. package/dist/cjs/sdk/OnchainSDK.js +478 -0
  11. package/dist/cjs/sdk/accounts/AbstractCreditAccountsService.js +16 -324
  12. package/dist/cjs/sdk/accounts/CreditAccountsServiceV310.js +1 -7
  13. package/dist/cjs/sdk/base/TokensMeta.js +42 -22
  14. package/dist/cjs/sdk/base/token-types.js +0 -9
  15. package/dist/cjs/sdk/chain/chains.js +1 -2
  16. package/dist/cjs/sdk/constants/address-provider.js +0 -3
  17. package/dist/cjs/sdk/core/errors.js +77 -0
  18. package/dist/cjs/sdk/core/index.js +2 -0
  19. package/dist/cjs/sdk/index.js +4 -2
  20. package/dist/cjs/sdk/market/MarketRegister.js +116 -70
  21. package/dist/cjs/sdk/market/MarketSuite.js +0 -3
  22. package/dist/cjs/sdk/market/index.js +0 -2
  23. package/dist/cjs/sdk/market/pool/PoolSuite.js +0 -3
  24. package/dist/cjs/sdk/market/pool/PoolV310Contract.js +2 -11
  25. package/dist/cjs/sdk/market/pool/index.js +0 -2
  26. package/dist/cjs/sdk/market/pricefeeds/PriceFeedsRegister.js +10 -3
  27. package/dist/cjs/sdk/market/pricefeeds/updates/PythAccumulatorUpdateData.js +20 -23
  28. package/dist/cjs/sdk/market/pricefeeds/updates/PythUpdater.js +7 -4
  29. package/dist/cjs/sdk/market/pricefeeds/updates/RedstoneUpdater.js +4 -4
  30. package/dist/cjs/sdk/market/pricefeeds/updates/fetchPythPayloads.js +1 -1
  31. package/dist/cjs/sdk/market/pricefeeds/updates/index.js +3 -0
  32. package/dist/cjs/sdk/options.js +24 -52
  33. package/dist/cjs/sdk/plugins/BasePlugin.js +11 -4
  34. package/dist/cjs/sdk/pools/PoolService.js +12 -104
  35. package/dist/cjs/sdk/utils/formatter.js +99 -20
  36. package/dist/cjs/sdk/utils/viem/index.js +3 -3
  37. package/dist/cjs/sdk/utils/viem/watchBlocksAsync.js +76 -0
  38. package/dist/esm/dev/AccountOpener.js +6 -47
  39. package/dist/esm/dev/RevolverTransport.js +10 -4
  40. package/dist/esm/dev/index.js +0 -1
  41. package/dist/esm/dev/logSplitterTransport.js +10 -1
  42. package/dist/esm/permissionless/utils/create2.js +1 -1
  43. package/dist/esm/permissionless/utils/price-update/get-price-feeds.js +12 -6
  44. package/dist/esm/permissionless/utils/price-update/get-price-update-tx.js +13 -7
  45. package/dist/esm/permissionless/utils/price-update/get-prices.js +13 -7
  46. package/dist/esm/sdk/MultichainSDK.js +217 -0
  47. package/dist/esm/sdk/OnchainSDK.js +472 -0
  48. package/dist/esm/sdk/accounts/AbstractCreditAccountsService.js +17 -328
  49. package/dist/esm/sdk/accounts/CreditAccountsServiceV310.js +1 -7
  50. package/dist/esm/sdk/base/TokensMeta.js +44 -22
  51. package/dist/esm/sdk/base/token-types.js +0 -6
  52. package/dist/esm/sdk/chain/chains.js +1 -2
  53. package/dist/esm/sdk/constants/address-provider.js +0 -2
  54. package/dist/esm/sdk/core/errors.js +48 -0
  55. package/dist/esm/sdk/core/index.js +1 -0
  56. package/dist/esm/sdk/index.js +2 -1
  57. package/dist/esm/sdk/market/MarketRegister.js +118 -74
  58. package/dist/esm/sdk/market/MarketSuite.js +0 -3
  59. package/dist/esm/sdk/market/index.js +0 -1
  60. package/dist/esm/sdk/market/pool/PoolSuite.js +0 -3
  61. package/dist/esm/sdk/market/pool/PoolV310Contract.js +2 -11
  62. package/dist/esm/sdk/market/pool/index.js +0 -1
  63. package/dist/esm/sdk/market/pricefeeds/PriceFeedsRegister.js +10 -3
  64. package/dist/esm/sdk/market/pricefeeds/updates/PythAccumulatorUpdateData.js +20 -13
  65. package/dist/esm/sdk/market/pricefeeds/updates/PythUpdater.js +7 -4
  66. package/dist/esm/sdk/market/pricefeeds/updates/RedstoneUpdater.js +4 -4
  67. package/dist/esm/sdk/market/pricefeeds/updates/fetchPythPayloads.js +1 -1
  68. package/dist/esm/sdk/market/pricefeeds/updates/index.js +2 -0
  69. package/dist/esm/sdk/options.js +22 -51
  70. package/dist/esm/sdk/plugins/BasePlugin.js +11 -4
  71. package/dist/esm/sdk/pools/PoolService.js +13 -109
  72. package/dist/esm/sdk/utils/formatter.js +99 -10
  73. package/dist/esm/sdk/utils/viem/index.js +1 -1
  74. package/dist/esm/sdk/utils/viem/watchBlocksAsync.js +52 -0
  75. package/dist/types/dev/RevolverTransport.d.ts +2 -1
  76. package/dist/types/dev/calcLiquidatableLTs.d.ts +2 -2
  77. package/dist/types/dev/claimFromFaucet.d.ts +2 -2
  78. package/dist/types/dev/create2.d.ts +3 -4
  79. package/dist/types/dev/index.d.ts +0 -1
  80. package/dist/types/dev/logSplitterTransport.d.ts +3 -1
  81. package/dist/types/dev/migrateFaucet.d.ts +2 -2
  82. package/dist/types/dev/mint/AbstractMinter.d.ts +2 -2
  83. package/dist/types/dev/mint/FallbackMinter.d.ts +2 -2
  84. package/dist/types/dev/mint/factory.d.ts +2 -2
  85. package/dist/types/dev/replaceStorage.d.ts +1 -1
  86. package/dist/types/permissionless/utils/price-update/get-updatable-feeds.d.ts +2 -2
  87. package/dist/types/plugins/accounts/AccountsPlugin.d.ts +2 -2
  88. package/dist/types/plugins/accounts-counter/AccountsCounterPlugin.d.ts +2 -2
  89. package/dist/types/plugins/adapters/AdaptersPlugin.d.ts +2 -2
  90. package/dist/types/plugins/apy/ApyPlugin.d.ts +2 -2
  91. package/dist/types/plugins/bots/BotsPlugin.d.ts +2 -2
  92. package/dist/types/plugins/bots/PartialLiquidationBotV310Contract.d.ts +2 -2
  93. package/dist/types/plugins/degen-distributors/DegenDistributorsPlugin.d.ts +2 -2
  94. package/dist/types/plugins/delayed-withdrawal/DelayedWithdrawalPlugin.d.ts +2 -2
  95. package/dist/types/sdk/MultichainSDK.d.ts +144 -0
  96. package/dist/types/sdk/OnchainSDK.d.ts +257 -0
  97. package/dist/types/sdk/accounts/AbstractCreditAccountsService.d.ts +4 -54
  98. package/dist/types/sdk/accounts/CreditAccountsServiceV310.d.ts +1 -1
  99. package/dist/types/sdk/accounts/createCreditAccountService.d.ts +2 -2
  100. package/dist/types/sdk/accounts/types.d.ts +15 -95
  101. package/dist/types/sdk/base/SDKConstruct.d.ts +4 -4
  102. package/dist/types/sdk/base/TokensMeta.d.ts +3 -14
  103. package/dist/types/sdk/base/token-types.d.ts +4 -44
  104. package/dist/types/sdk/base/types.d.ts +2 -116
  105. package/dist/types/sdk/chain/chains.d.ts +1 -5
  106. package/dist/types/sdk/constants/address-provider.d.ts +0 -1
  107. package/dist/types/sdk/core/createAddressProvider.d.ts +3 -3
  108. package/dist/types/sdk/core/errors.d.ts +51 -0
  109. package/dist/types/sdk/core/index.d.ts +1 -0
  110. package/dist/types/sdk/index.d.ts +2 -1
  111. package/dist/types/sdk/market/MarketRegister.d.ts +11 -8
  112. package/dist/types/sdk/market/MarketSuite.d.ts +2 -4
  113. package/dist/types/sdk/market/adapters/createAdapter.d.ts +2 -2
  114. package/dist/types/sdk/market/credit/CreditConfiguratorV310Contract.d.ts +3 -3
  115. package/dist/types/sdk/market/credit/CreditManagerV310Contract.d.ts +2 -2
  116. package/dist/types/sdk/market/credit/CreditSuite.d.ts +2 -2
  117. package/dist/types/sdk/market/credit/createCreditConfigurator.d.ts +2 -2
  118. package/dist/types/sdk/market/credit/createCreditFacade.d.ts +2 -2
  119. package/dist/types/sdk/market/credit/createCreditManager.d.ts +2 -2
  120. package/dist/types/sdk/market/credit/types.d.ts +1 -1
  121. package/dist/types/sdk/market/index.d.ts +0 -1
  122. package/dist/types/sdk/market/loss-policy/AliasLossPolicyV310Contract.d.ts +3 -3
  123. package/dist/types/sdk/market/loss-policy/createLossPolicy.d.ts +2 -2
  124. package/dist/types/sdk/market/oracle/PriceOracleBaseContract.d.ts +5 -6
  125. package/dist/types/sdk/market/oracle/PriceOracleV310Contract.d.ts +2 -2
  126. package/dist/types/sdk/market/oracle/createPriceOracle.d.ts +2 -2
  127. package/dist/types/sdk/market/oracle/types.d.ts +10 -3
  128. package/dist/types/sdk/market/pool/PoolSuite.d.ts +2 -4
  129. package/dist/types/sdk/market/pool/PoolV310Contract.d.ts +2 -6
  130. package/dist/types/sdk/market/pool/createInterestRateModel.d.ts +2 -2
  131. package/dist/types/sdk/market/pool/createPool.d.ts +2 -2
  132. package/dist/types/sdk/market/pool/createPoolQuotaKeeper.d.ts +2 -2
  133. package/dist/types/sdk/market/pool/createRateKeeper.d.ts +2 -2
  134. package/dist/types/sdk/market/pool/index.d.ts +0 -1
  135. package/dist/types/sdk/market/pricefeeds/PriceFeedsRegister.d.ts +8 -3
  136. package/dist/types/sdk/market/pricefeeds/updates/PythAccumulatorUpdateData.d.ts +12 -13
  137. package/dist/types/sdk/market/pricefeeds/updates/PythUpdater.d.ts +8 -3
  138. package/dist/types/sdk/market/pricefeeds/updates/RedstoneUpdater.d.ts +8 -3
  139. package/dist/types/sdk/market/pricefeeds/updates/index.d.ts +1 -0
  140. package/dist/types/sdk/market/pricefeeds/updates/types.d.ts +4 -0
  141. package/dist/types/sdk/market/types.d.ts +1 -1
  142. package/dist/types/sdk/options.d.ts +15 -16
  143. package/dist/types/sdk/plugins/BasePlugin.d.ts +12 -6
  144. package/dist/types/sdk/plugins/errors.d.ts +2 -2
  145. package/dist/types/sdk/plugins/types.d.ts +16 -6
  146. package/dist/types/sdk/pools/PoolService.d.ts +8 -8
  147. package/dist/types/sdk/pools/types.d.ts +2 -3
  148. package/dist/types/sdk/router/AbstractRouterContract.d.ts +3 -3
  149. package/dist/types/sdk/router/RouterV310Contract.d.ts +2 -2
  150. package/dist/types/sdk/router/createRouter.d.ts +2 -2
  151. package/dist/types/sdk/router/helpers.d.ts +1 -1
  152. package/dist/types/sdk/types/state-human.d.ts +10 -2
  153. package/dist/types/sdk/types/state.d.ts +14 -8
  154. package/dist/types/sdk/utils/filterDust.d.ts +2 -2
  155. package/dist/types/sdk/utils/formatter.d.ts +1 -1
  156. package/dist/types/sdk/utils/isDust.d.ts +2 -2
  157. package/dist/types/sdk/utils/toAddress.d.ts +1 -1
  158. package/dist/types/sdk/utils/viem/getLogsPaginated.d.ts +1 -2
  159. package/dist/types/sdk/utils/viem/getLogsSafe.d.ts +1 -1
  160. package/dist/types/sdk/utils/viem/index.d.ts +1 -1
  161. package/dist/types/sdk/utils/viem/simulateWithPriceUpdates.d.ts +1 -2
  162. package/dist/types/sdk/utils/viem/watchBlocksAsync.d.ts +74 -0
  163. package/package.json +3 -6
  164. package/dist/cjs/abi/kyc/iDSRegistryService.js +0 -70
  165. package/dist/cjs/abi/kyc/iDSToken.js +0 -71
  166. package/dist/cjs/abi/kyc/iKYCCompressor.js +0 -196
  167. package/dist/cjs/abi/kyc/iKYCFactory.js +0 -122
  168. package/dist/cjs/abi/kyc/iKYCUnderlying.js +0 -401
  169. package/dist/cjs/abi/kyc/iSecuritizeDegenNFT.js +0 -326
  170. package/dist/cjs/abi/kyc/iSecuritizeKYCFactory.js +0 -319
  171. package/dist/cjs/dev/CachedStateSubscriber.js +0 -78
  172. package/dist/cjs/sdk/GearboxSDK.js +0 -696
  173. package/dist/cjs/sdk/market/kyc/KYCRegistry.js +0 -269
  174. package/dist/cjs/sdk/market/kyc/index.js +0 -26
  175. package/dist/cjs/sdk/market/kyc/securitize/SecuritizeKYCFactory.js +0 -244
  176. package/dist/cjs/sdk/market/kyc/securitize/constants.js +0 -28
  177. package/dist/cjs/sdk/market/kyc/securitize/index.js +0 -26
  178. package/dist/cjs/sdk/market/kyc/securitize/types.js +0 -16
  179. package/dist/cjs/sdk/market/kyc/types.js +0 -34
  180. package/dist/cjs/sdk/utils/viem/executeDelegatedMulticalls.js +0 -38
  181. package/dist/esm/abi/kyc/iDSRegistryService.js +0 -46
  182. package/dist/esm/abi/kyc/iDSToken.js +0 -47
  183. package/dist/esm/abi/kyc/iKYCCompressor.js +0 -172
  184. package/dist/esm/abi/kyc/iKYCFactory.js +0 -98
  185. package/dist/esm/abi/kyc/iKYCUnderlying.js +0 -377
  186. package/dist/esm/abi/kyc/iSecuritizeDegenNFT.js +0 -302
  187. package/dist/esm/abi/kyc/iSecuritizeKYCFactory.js +0 -295
  188. package/dist/esm/dev/CachedStateSubscriber.js +0 -54
  189. package/dist/esm/sdk/GearboxSDK.js +0 -689
  190. package/dist/esm/sdk/market/kyc/KYCRegistry.js +0 -253
  191. package/dist/esm/sdk/market/kyc/index.js +0 -3
  192. package/dist/esm/sdk/market/kyc/securitize/SecuritizeKYCFactory.js +0 -220
  193. package/dist/esm/sdk/market/kyc/securitize/constants.js +0 -4
  194. package/dist/esm/sdk/market/kyc/securitize/index.js +0 -3
  195. package/dist/esm/sdk/market/kyc/securitize/types.js +0 -0
  196. package/dist/esm/sdk/market/kyc/types.js +0 -9
  197. package/dist/esm/sdk/utils/viem/executeDelegatedMulticalls.js +0 -14
  198. package/dist/types/abi/kyc/iDSRegistryService.d.ts +0 -71
  199. package/dist/types/abi/kyc/iDSToken.d.ts +0 -67
  200. package/dist/types/abi/kyc/iKYCCompressor.d.ts +0 -228
  201. package/dist/types/abi/kyc/iKYCFactory.d.ts +0 -139
  202. package/dist/types/abi/kyc/iKYCUnderlying.d.ts +0 -548
  203. package/dist/types/abi/kyc/iSecuritizeDegenNFT.d.ts +0 -404
  204. package/dist/types/abi/kyc/iSecuritizeKYCFactory.d.ts +0 -376
  205. package/dist/types/dev/CachedStateSubscriber.d.ts +0 -21
  206. package/dist/types/sdk/GearboxSDK.d.ts +0 -324
  207. package/dist/types/sdk/market/kyc/KYCRegistry.d.ts +0 -52
  208. package/dist/types/sdk/market/kyc/index.d.ts +0 -3
  209. package/dist/types/sdk/market/kyc/securitize/SecuritizeKYCFactory.d.ts +0 -428
  210. package/dist/types/sdk/market/kyc/securitize/constants.d.ts +0 -1
  211. package/dist/types/sdk/market/kyc/securitize/index.d.ts +0 -3
  212. package/dist/types/sdk/market/kyc/securitize/types.d.ts +0 -127
  213. package/dist/types/sdk/market/kyc/types.d.ts +0 -170
  214. package/dist/types/sdk/utils/viem/executeDelegatedMulticalls.d.ts +0 -28
@@ -1,696 +0,0 @@
1
- "use strict";
2
- var __defProp = Object.defineProperty;
3
- var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
4
- var __getOwnPropNames = Object.getOwnPropertyNames;
5
- var __hasOwnProp = Object.prototype.hasOwnProperty;
6
- var __export = (target, all) => {
7
- for (var name in all)
8
- __defProp(target, name, { get: all[name], enumerable: true });
9
- };
10
- var __copyProps = (to, from, except, desc) => {
11
- if (from && typeof from === "object" || typeof from === "function") {
12
- for (let key of __getOwnPropNames(from))
13
- if (!__hasOwnProp.call(to, key) && key !== except)
14
- __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
15
- }
16
- return to;
17
- };
18
- var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
19
- var GearboxSDK_exports = {};
20
- __export(GearboxSDK_exports, {
21
- GearboxSDK: () => GearboxSDK,
22
- STATE_VERSION: () => STATE_VERSION
23
- });
24
- module.exports = __toCommonJS(GearboxSDK_exports);
25
- var import_viem = require("viem");
26
- var import_base = require("./base/index.js");
27
- var import_chain = require("./chain/index.js");
28
- var import_constants = require("./constants/index.js");
29
- var import_core = require("./core/index.js");
30
- var import_kyc = require("./market/kyc/index.js");
31
- var import_MarketRegister = require("./market/MarketRegister.js");
32
- var import_pricefeeds = require("./market/pricefeeds/index.js");
33
- var import_plugins = require("./plugins/index.js");
34
- var import_router = require("./router/index.js");
35
- var import_utils = require("./utils/index.js");
36
- var import_internal = require("./utils/internal/index.js");
37
- var import_viem2 = require("./utils/viem/index.js");
38
- const ERR_NOT_ATTACHED = new Error("Gearbox SDK not attached");
39
- const STATE_VERSION = 1;
40
- function createClient(opts, network) {
41
- let transport;
42
- if ("client" in opts) {
43
- return opts.client;
44
- }
45
- if ("transport" in opts) {
46
- transport = opts.transport;
47
- } else {
48
- const rpcs = opts.rpcURLs.map(
49
- (url) => (0, import_viem.http)(url, {
50
- ...opts.httpTransportOptions,
51
- timeout: opts.timeout,
52
- retryCount: opts.retryCount
53
- })
54
- );
55
- transport = rpcs.length > 1 ? (0, import_viem.fallback)(rpcs) : rpcs[0];
56
- }
57
- const chain = network ? (0, import_viem.defineChain)({
58
- ...(0, import_chain.getChain)(network.networkType),
59
- id: network.chainId
60
- }) : void 0;
61
- return (0, import_viem.createPublicClient)({ transport, chain });
62
- }
63
- async function attachClient(options, network) {
64
- let { chainId, networkType } = network;
65
- const attachClient2 = createClient(options);
66
- if (networkType) {
67
- if (!chainId) {
68
- chainId = (0, import_chain.getChain)(networkType).id;
69
- }
70
- } else {
71
- networkType = await (0, import_chain.detectNetwork)(attachClient2);
72
- if (!chainId) {
73
- chainId = await attachClient2.getChainId();
74
- }
75
- }
76
- return createClient(options, { networkType, chainId });
77
- }
78
- class GearboxSDK extends import_base.ChainContractsRegister {
79
- #hooks = new import_internal.Hooks();
80
- /**
81
- * Registered plugin instances, keyed by plugin name.
82
- **/
83
- plugins;
84
- #currentBlock;
85
- #timestamp;
86
- #syncing = false;
87
- #addressProvider;
88
- #attachConfig;
89
- #marketRegister;
90
- #kyc;
91
- #priceFeeds;
92
- /**
93
- * Gas limit applied to read-only `eth_call` requests.
94
- * `undefined` means that gas limit will not be set on read-only calls,
95
- * leaving it to rpc provider to decide.
96
- **/
97
- gasLimit;
98
- /**
99
- * When `true`, the SDK throws on unrecognised contract types instead of
100
- * falling back to a generic contract wrapper.
101
- **/
102
- strictContractTypes;
103
- /**
104
- * Registers a callback for an SDK lifecycle event.
105
- *
106
- * @see {@link SDKHooks} for available event names.
107
- **/
108
- addHook = this.#hooks.addHook.bind(this.#hooks);
109
- /**
110
- * Removes a previously registered lifecycle callback.
111
- *
112
- * @see {@link SDKHooks} for available event names.
113
- **/
114
- removeHook = this.#hooks.removeHook.bind(this.#hooks);
115
- /**
116
- * Creates and initialises a new SDK instance by reading live on-chain state.
117
- *
118
- * This is the primary way to bootstrap the SDK. The method connects to the
119
- * chain, discovers the address provider and all configured markets, and
120
- * attaches any supplied plugins.
121
- *
122
- * @param options - Combined SDK, client, and (optional) network options.
123
- * @returns A fully initialised SDK instance.
124
- **/
125
- static async attach(options) {
126
- const {
127
- logger,
128
- plugins,
129
- blockNumber,
130
- redstone,
131
- pyth,
132
- ignoreUpdateablePrices,
133
- ignoreMarkets,
134
- marketConfigurators: mcs,
135
- kycFactories: kfs,
136
- strictContractTypes,
137
- gasLimit
138
- } = options;
139
- let { addressProvider } = options;
140
- const client = await attachClient(options, options);
141
- if (!addressProvider) {
142
- addressProvider = import_constants.ADDRESS_PROVIDER_V310;
143
- }
144
- const marketConfigurators = mcs ?? import_utils.TypedObjectUtils.keys(client.chain.defaultMarketConfigurators);
145
- const kycFactories = kfs ?? client.chain.kycFactories;
146
- return new GearboxSDK({
147
- client,
148
- logger,
149
- plugins,
150
- strictContractTypes,
151
- gasLimit
152
- }).#attach({
153
- addressProvider,
154
- blockNumber,
155
- ignoreUpdateablePrices,
156
- ignoreMarkets,
157
- marketConfigurators,
158
- kycFactories,
159
- redstone,
160
- pyth
161
- });
162
- }
163
- /**
164
- * Creates a new SDK instance from a previously serialised {@link GearboxState}
165
- * snapshot, without making any on-chain calls.
166
- *
167
- * Use this for fast startup when a recent state snapshot is available
168
- * (e.g. loaded from a file or received from a backend service).
169
- *
170
- * @param options - SDK and client options (block number and address provider
171
- * are taken from the snapshot).
172
- * @param state - Serialised state obtained from {@link GearboxSDK.state}.
173
- * @returns A fully initialised SDK instance.
174
- * @throws If the snapshot's {@link STATE_VERSION} does not match.
175
- **/
176
- static hydrate(options, state) {
177
- const { logger, plugins, strictContractTypes, gasLimit, ...rest } = options;
178
- const client = createClient(options, {
179
- networkType: state.network,
180
- chainId: state.chainId
181
- });
182
- return new GearboxSDK({
183
- client,
184
- plugins,
185
- logger,
186
- strictContractTypes,
187
- gasLimit
188
- }).#hydrate(rest, state);
189
- }
190
- constructor(options) {
191
- super(options.client, options.logger);
192
- this.strictContractTypes = options.strictContractTypes ?? false;
193
- this.plugins = options.plugins ?? {};
194
- for (const plugin of Object.values(this.plugins)) {
195
- plugin.sdk = this;
196
- }
197
- if (options.gasLimit !== null) {
198
- this.gasLimit = options.gasLimit || (0, import_chain.getChain)(this.networkType).gasLimit;
199
- }
200
- }
201
- async #attach(opts) {
202
- const {
203
- addressProvider,
204
- blockNumber,
205
- ignoreUpdateablePrices,
206
- ignoreMarkets,
207
- marketConfigurators,
208
- kycFactories,
209
- redstone,
210
- pyth
211
- } = opts;
212
- const re = this.#attachConfig ? "re" : "";
213
- this.logger?.info(
214
- {
215
- networkType: this.networkType,
216
- chainId: this.chainId,
217
- addressProvider,
218
- marketConfigurators,
219
- kycFactories,
220
- blockNumber,
221
- ignoreMarkets
222
- },
223
- `${re}attaching gearbox sdk`
224
- );
225
- if (!!blockNumber && !opts.redstone?.historicTimestamp) {
226
- this.logger?.warn(
227
- `${re}attaching to fixed block number, but redstone historicTimestamp is not set. price updates might fail`
228
- );
229
- }
230
- if (!!blockNumber && !opts.pyth?.historicTimestamp) {
231
- this.logger?.warn(
232
- `${re}attaching to fixed block number, but pyth historicTimestamp is not set. price updates might fail`
233
- );
234
- }
235
- this.#attachConfig = opts;
236
- const time = Date.now();
237
- const block = await this.client.getBlock(
238
- blockNumber ? { blockNumber: BigInt(blockNumber) } : {
239
- blockTag: "latest"
240
- }
241
- );
242
- this.#currentBlock = block.number;
243
- this.#timestamp = block.timestamp;
244
- this.#priceFeeds = new import_pricefeeds.PriceFeedRegister(this, { redstone, pyth });
245
- this.logger?.debug(
246
- `${re}attach block number ${this.currentBlock} timestamp ${this.timestamp}`
247
- );
248
- this.#addressProvider = await (0, import_core.createAddressProvider)(this, addressProvider);
249
- this.logger?.debug(
250
- `address provider version: ${this.#addressProvider.version}`
251
- );
252
- await this.#addressProvider.syncState(this.currentBlock);
253
- this.#marketRegister = new import_MarketRegister.MarketRegister(this, ignoreMarkets);
254
- this.#kyc = new import_kyc.KYCRegistry(this);
255
- if (!marketConfigurators.length) {
256
- this.logger?.warn(
257
- "no market configurators provided, skipping market loading"
258
- );
259
- } else {
260
- const delegated = [
261
- ...this.#marketRegister.getLoadMulticalls(marketConfigurators),
262
- ...this.#kyc.getLoadMulticalls(marketConfigurators, kycFactories)
263
- ];
264
- let txs = [];
265
- if (!ignoreUpdateablePrices) {
266
- const updatables = await this.#priceFeeds.getPartialUpdatablePriceFeeds(
267
- marketConfigurators
268
- );
269
- const updates = await this.#priceFeeds.generatePriceFeedsUpdateTxs(updatables);
270
- txs = updates.txs;
271
- }
272
- this.logger?.debug(
273
- { configurators: marketConfigurators },
274
- `calling getMarkets with ${txs.length} price updates in block ${this.currentBlock}`
275
- );
276
- await (0, import_viem2.executeDelegatedMulticalls)(this.client, delegated, {
277
- priceUpdates: txs,
278
- blockNumber: this.currentBlock,
279
- gas: this.gasLimit
280
- });
281
- }
282
- const pluginsList = import_utils.TypedObjectUtils.entries(this.plugins);
283
- const pluginResponse = await Promise.allSettled(
284
- pluginsList.map(([name, plugin]) => {
285
- if (plugin.attach) {
286
- this.logger?.debug(`${re}attaching plugin ${name}`);
287
- return plugin.attach();
288
- }
289
- return void 0;
290
- })
291
- );
292
- pluginResponse.forEach((r, i) => {
293
- const [name, plugin] = pluginsList[i];
294
- if (plugin.attach && r.status === "fulfilled") {
295
- this.logger?.debug(`${re}attached plugin ${name}`);
296
- } else if (plugin.attach && r.status === "rejected") {
297
- this.logger?.error(r.reason, `failed to ${re}attach plugin ${name}`);
298
- }
299
- });
300
- this.logger?.info(`${re}attach time: ${Date.now() - time} ms`);
301
- return this;
302
- }
303
- #hydrate(options, state) {
304
- const { logger: _logger, ignoreMarkets, ...opts } = options;
305
- if (state.version !== STATE_VERSION) {
306
- throw new Error(
307
- `hydrated state version is ${state.version}, but expected ${STATE_VERSION}`
308
- );
309
- }
310
- const re = this.#attachConfig ? "re" : "";
311
- this.logger?.info(
312
- { networkType: this.networkType },
313
- `${re}hydrating sdk state`
314
- );
315
- this.#currentBlock = state.currentBlock;
316
- this.#timestamp = state.timestamp;
317
- this.#priceFeeds = new import_pricefeeds.PriceFeedRegister(this, {
318
- redstone: opts.redstone,
319
- pyth: opts.pyth
320
- });
321
- this.#addressProvider = (0, import_core.hydrateAddressProvider)(this, state.addressProvider);
322
- this.logger?.debug(
323
- `address provider version: ${this.#addressProvider.version}`
324
- );
325
- this.#marketRegister = new import_MarketRegister.MarketRegister(this, ignoreMarkets);
326
- this.#marketRegister.hydrate(state.markets);
327
- this.#kyc = new import_kyc.KYCRegistry(this);
328
- this.#kyc.setState(state.kyc);
329
- this.#attachConfig = {
330
- ...opts,
331
- addressProvider: this.addressProvider.address,
332
- marketConfigurators: this.marketRegister.marketConfigurators.map(
333
- (m) => m.address
334
- ),
335
- kycFactories: this.kyc.factories.map((f) => f.address),
336
- blockNumber: this.currentBlock
337
- };
338
- for (const [name, plugin] of import_utils.TypedObjectUtils.entries(this.plugins)) {
339
- const pluginState = state.plugins[name];
340
- if (plugin.hydrate && pluginState) {
341
- if (!pluginState.loaded) {
342
- this.logger?.debug(
343
- `skipping ${re}hydrating plugin ${name} state: not loaded`
344
- );
345
- continue;
346
- }
347
- if (pluginState.version !== plugin.version) {
348
- throw new import_plugins.PluginStateVersionError(plugin, pluginState);
349
- }
350
- plugin.hydrate(pluginState);
351
- }
352
- }
353
- this.logger?.info(`${re}hydrated sdk state`);
354
- return this;
355
- }
356
- /**
357
- * Re-attaches the SDK using the same configuration, discarding all cached
358
- * state and re-reading everything from the chain.
359
- *
360
- * Useful when the SDK needs a full refresh (e.g. after a protocol upgrade).
361
- * Note that if the original `blockNumber` was pinned, the same block is
362
- * re-used — call {@link syncState} instead if you want to advance.
363
- *
364
- * @throws If the SDK has not been attached yet.
365
- **/
366
- async reattach() {
367
- if (!this.#attachConfig) {
368
- throw new Error("cannot reattach, attach config is not set");
369
- }
370
- await this.#attach(this.#attachConfig);
371
- }
372
- /**
373
- * Replaces the SDK's in-memory state with a new serialised snapshot
374
- * without re-creating the instance.
375
- *
376
- * After hydration the `rehydrate` hook is triggered so that listeners
377
- * can react to the state change.
378
- *
379
- * @param state - Serialised state obtained from {@link GearboxSDK.state}.
380
- * @throws If the SDK has not been attached or hydrated yet.
381
- **/
382
- async rehydrate(state) {
383
- if (!this.#attachConfig) {
384
- throw new Error("cannot rehydrate, attach config is not set");
385
- }
386
- const opts = {
387
- ignoreUpdateablePrices: this.#attachConfig.ignoreUpdateablePrices,
388
- redstone: this.#attachConfig.redstone,
389
- pyth: this.#attachConfig.pyth
390
- };
391
- this.#hydrate(opts, state);
392
- await this.#hooks.triggerHooks("rehydrate", {
393
- blockNumber: state.currentBlock,
394
- timestamp: state.timestamp
395
- });
396
- }
397
- /**
398
- * Gearbox network type the SDK is connected to (e.g. `"Mainnet"`, `"Arbitrum"`).
399
- **/
400
- get networkType() {
401
- return this.client.chain.network;
402
- }
403
- /**
404
- * Returns a human-readable snapshot of the entire SDK state, suitable
405
- * for logging or diagnostic inspection.
406
- *
407
- * @param raw - When `true`, include raw numeric values alongside
408
- * formatted ones.
409
- * @default true
410
- **/
411
- stateHuman(raw = true) {
412
- return {
413
- block: Number(this.currentBlock),
414
- timestamp: (0, import_utils.formatTimestamp)(Number(this.timestamp), raw),
415
- core: {
416
- addressProviderV3: this.addressProvider.stateHuman(raw)
417
- },
418
- tokens: this.tokensMeta.values(),
419
- kyc: this.kyc.stateHuman(raw),
420
- plugins: Object.fromEntries(
421
- import_utils.TypedObjectUtils.entries(this.plugins).map(([name, plugin]) => [
422
- name,
423
- plugin.loaded ? plugin.stateHuman?.(raw) : void 0
424
- ])
425
- ),
426
- ...this.marketRegister.stateHuman(raw)
427
- };
428
- }
429
- /**
430
- * Serialisable snapshot of the current SDK state.
431
- *
432
- * The returned object can be persisted (e.g. written to a file) and later
433
- * passed to {@link GearboxSDK.hydrate} for instant restoration without
434
- * on-chain reads.
435
- **/
436
- get state() {
437
- return {
438
- version: STATE_VERSION,
439
- network: this.networkType,
440
- chainId: this.chainId,
441
- currentBlock: this.currentBlock,
442
- timestamp: this.timestamp,
443
- addressProvider: this.addressProvider.state,
444
- markets: this.marketRegister.state,
445
- kyc: this.kyc.state,
446
- plugins: Object.fromEntries(
447
- import_utils.TypedObjectUtils.entries(this.plugins).map(([name, plugin]) => [
448
- name,
449
- plugin.loaded ? { version: plugin.version, loaded: true, ...plugin.state } : { version: plugin.version, loaded: false }
450
- ])
451
- )
452
- };
453
- }
454
- /**
455
- * Incrementally updates the SDK state by replaying on-chain events from the
456
- * last processed block up to the target block (defaults to `latest`).
457
- *
458
- * Use the to periodically update sdk state on cron, or subscribe to new blocks
459
- * using viem's `watchBlocks`
460
- *
461
- * On failure the SDK reverts to the previous block/timestamp so that
462
- * subsequent calls can retry.
463
- *
464
- * @param opts - Target block and sync behaviour. When omitted the latest
465
- * block is fetched automatically.
466
- * @returns `true` if the sync completed successfully, `false` if it was
467
- * skipped or failed.
468
- **/
469
- async syncState(opts) {
470
- let {
471
- blockNumber,
472
- timestamp,
473
- ignoreUpdateablePrices = this.#attachConfig?.ignoreUpdateablePrices
474
- } = opts ?? {};
475
- if (this.#attachConfig?.redstone?.historicTimestamp || this.#attachConfig?.pyth?.historicTimestamp) {
476
- throw new Error(
477
- "syncState is not supported with redstone or pyth historicTimestamp"
478
- );
479
- }
480
- if (!blockNumber || !timestamp) {
481
- const block = await this.client.getBlock({
482
- blockTag: "latest"
483
- });
484
- blockNumber = block.number;
485
- timestamp = block.timestamp;
486
- }
487
- if (blockNumber <= this.currentBlock) {
488
- return false;
489
- }
490
- if (this.#syncing) {
491
- this.logger?.warn(
492
- `cannot sync to ${blockNumber}, already syncing at ${this.currentBlock}`
493
- );
494
- return false;
495
- }
496
- this.#syncing = true;
497
- const prevBlock = this.currentBlock;
498
- const prevTimestamp = this.timestamp;
499
- let success = false;
500
- try {
501
- let delta = Math.floor(Date.now() / 1e3) - Number(timestamp);
502
- this.logger?.debug(
503
- `syncing state to block ${blockNumber} (delta ${delta}s )...`
504
- );
505
- const watchAddresses = [
506
- ...Array.from(this.marketRegister.watchAddresses),
507
- this.addressProvider.address
508
- ];
509
- const fromBlock = this.currentBlock + 1n;
510
- this.logger?.debug(
511
- `getting logs from ${watchAddresses.length} addresses in [${fromBlock}:${blockNumber}]`
512
- );
513
- const logs = await (0, import_viem2.getLogsSafe)(this.client, {
514
- fromBlock,
515
- toBlock: blockNumber,
516
- address: watchAddresses
517
- });
518
- for (const log of logs) {
519
- const contract = this.getContract(log.address);
520
- if (contract) {
521
- const event = (0, import_viem.parseEventLogs)({
522
- abi: contract.abi,
523
- logs: [log]
524
- })[0];
525
- contract.processLog(event);
526
- }
527
- }
528
- this.#currentBlock = blockNumber;
529
- this.#timestamp = timestamp;
530
- await this.marketRegister.syncState(ignoreUpdateablePrices);
531
- await this.#hooks.triggerHooks("syncState", {
532
- blockNumber,
533
- timestamp,
534
- ignoreUpdateablePrices
535
- });
536
- const pluginsList = import_utils.TypedObjectUtils.entries(this.plugins);
537
- const pluginResponse = await Promise.allSettled(
538
- pluginsList.map(([name, plugin]) => {
539
- if (plugin.syncState) {
540
- this.logger?.debug(`syncing plugin ${name}`);
541
- return plugin.syncState();
542
- }
543
- return void 0;
544
- })
545
- );
546
- pluginResponse.forEach((r, i) => {
547
- const [name, plugin] = pluginsList[i];
548
- if (plugin.syncState && r.status === "fulfilled") {
549
- this.logger?.debug(`synced plugin ${name}`);
550
- } else if (plugin.syncState && r.status === "rejected") {
551
- this.logger?.error(r.reason, `failed to sync plugin ${name}`);
552
- }
553
- });
554
- delta = Math.floor(Date.now() / 1e3) - Number(timestamp);
555
- this.logger?.debug(
556
- `synced state to block ${blockNumber} (delta ${delta}s)`
557
- );
558
- success = true;
559
- } catch (e) {
560
- this.logger?.error(
561
- `sync state to block ${blockNumber} with ts ${timestamp} failed, reverting to old block ${prevBlock} with ts ${prevTimestamp}: ${e}`
562
- );
563
- this.#currentBlock = prevBlock;
564
- this.#timestamp = prevTimestamp;
565
- } finally {
566
- this.#syncing = false;
567
- }
568
- return success;
569
- }
570
- /**
571
- * Block number that the SDK state corresponds to.
572
- *
573
- * @throws If the SDK has not been attached or hydrated yet.
574
- **/
575
- get currentBlock() {
576
- if (this.#currentBlock === void 0) {
577
- throw ERR_NOT_ATTACHED;
578
- }
579
- return this.#currentBlock;
580
- }
581
- /**
582
- * Block timestamp (Unix epoch seconds) corresponding to {@link currentBlock}.
583
- *
584
- * @throws If the SDK has not been attached or hydrated yet.
585
- **/
586
- get timestamp() {
587
- if (this.#timestamp === void 0) {
588
- throw ERR_NOT_ATTACHED;
589
- }
590
- return this.#timestamp;
591
- }
592
- /**
593
- * Global registry of all price feeds known to the SDK (on all markets).
594
- *
595
- * Unlike per-oracle price feed references, this register does not carry
596
- * oracle-specific metadata (staleness period, main/reserve designation, etc.).
597
- *
598
- * @throws If the SDK has not been attached or hydrated yet.
599
- **/
600
- get priceFeeds() {
601
- if (this.#priceFeeds === void 0) {
602
- throw ERR_NOT_ATTACHED;
603
- }
604
- return this.#priceFeeds;
605
- }
606
- /**
607
- * Address of the GEAR governance token on this chain, or `undefined`
608
- * if the address provider does not list it.
609
- **/
610
- get gear() {
611
- try {
612
- const g = this.addressProvider.getAddress(import_constants.AP_GEAR_TOKEN, import_constants.NO_VERSION);
613
- return g;
614
- } catch (e) {
615
- this.logger?.warn(e);
616
- return void 0;
617
- }
618
- }
619
- /**
620
- * The chain's address provider contract, the central directory for all
621
- * protocol-wide Gearbox protocol addresses.
622
- *
623
- * @throws If the SDK has not been attached or hydrated yet.
624
- **/
625
- get addressProvider() {
626
- if (this.#addressProvider === void 0) {
627
- throw ERR_NOT_ATTACHED;
628
- }
629
- return this.#addressProvider;
630
- }
631
- /**
632
- * Registry of all loaded markets (pools, credit managers, oracles, etc.).
633
- *
634
- * @throws If the SDK has not been attached or hydrated yet.
635
- **/
636
- get marketRegister() {
637
- if (this.#marketRegister === void 0) {
638
- throw ERR_NOT_ATTACHED;
639
- }
640
- return this.#marketRegister;
641
- }
642
- /**
643
- * KYC register for KYC-wrapped underlying tokens and factories.
644
- *
645
- * @throws If the SDK has not been attached or hydrated yet.
646
- **/
647
- get kyc() {
648
- if (this.#kyc === void 0) {
649
- throw ERR_NOT_ATTACHED;
650
- }
651
- return this.#kyc;
652
- }
653
- /**
654
- * Resolves the appropriate router contract for a given credit manager,
655
- * credit facade, or explicit version range.
656
- *
657
- * @param params - Identifies the context: a credit manager address/state,
658
- * a credit facade address/state, or a {@link VersionRange}.
659
- * @returns The matching router contract instance.
660
- * @throws If the credit facade version is unsupported or no router is
661
- * registered for the resolved version range.
662
- **/
663
- routerFor(params) {
664
- let routerRange;
665
- if (Array.isArray(params)) {
666
- routerRange = params;
667
- } else {
668
- let facadeAddr;
669
- if ("creditFacade" in params) {
670
- facadeAddr = (0, import_utils.toAddress)(params.creditFacade);
671
- } else {
672
- const cm = this.marketRegister.findCreditManager(
673
- (0, import_utils.toAddress)(params.creditManager)
674
- );
675
- facadeAddr = cm.creditFacade.address;
676
- }
677
- const facadeV = this.mustGetContract(facadeAddr).version;
678
- if ((0, import_constants.isV310)(facadeV)) {
679
- routerRange = import_constants.VERSION_RANGE_310;
680
- } else {
681
- throw new Error(`Unsupported credit facade version ${facadeV}`);
682
- }
683
- }
684
- const routerEntry = this.addressProvider.getLatest(import_constants.AP_ROUTER, routerRange);
685
- if (!routerEntry) {
686
- throw new Error(`router not found in version range ${routerRange}`);
687
- }
688
- const [routerAddr, routerV] = routerEntry;
689
- return (0, import_router.createRouter)(this, routerAddr, routerV);
690
- }
691
- }
692
- // Annotate the CommonJS export names for ESM import in node:
693
- 0 && (module.exports = {
694
- GearboxSDK,
695
- STATE_VERSION
696
- });