@gearbox-protocol/sdk 15.1.0-next.1 → 15.1.0-next.2

package/dist/cjs/sdk/utils/viem/executeMulticallBatches.js

@@ -0,0 +1,32 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+//#region src/sdk/utils/viem/executeMulticallBatches.ts
+/**
+* Executes the calls of several {@link MulticallBatch}es as a single multicall
+* aggregate and dispatches each batch its own slice of the results.
+*
+* Failures are allowed per call: loaders in a batch decide themselves how to
+* treat a reverted call (e.g. `contractType()` reverting on a plain ERC-20 is
+* expected). Use {@link executeDelegatedMulticalls} instead when the calls need
+* price updates applied first.
+*
+* @param client - Viem public client.
+* @param batches - Batches to execute together, empty ones are allowed.
+* @param opts - Block number forwarded to the multicall.
+**/
+async function executeMulticallBatches(client, batches, opts = {}) {
+	const contracts = batches.flatMap((b) => b.contracts);
+	if (!contracts.length) return;
+	const results = await client.multicall({
+		contracts,
+		allowFailure: true,
+		batchSize: 0,
+		blockNumber: opts.blockNumber
+	});
+	let offset = 0;
+	for (const batch of batches) {
+		batch.onResults(results.slice(offset, offset + batch.contracts.length));
+		offset += batch.contracts.length;
+	}
+}
+//#endregion
+exports.executeMulticallBatches = executeMulticallBatches;

package/dist/cjs/sdk/utils/viem/index.js

@@ -1,6 +1,7 @@
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
 const require_sdk_utils_viem_cast = require("./cast.js");
 const require_sdk_utils_viem_simulateCall = require("./simulateCall.js");
+const require_sdk_utils_viem_executeMulticallBatches = require("./executeMulticallBatches.js");
 const require_sdk_utils_viem_simulateMulticall = require("./simulateMulticall.js");
 const require_sdk_utils_viem_simulateWithPriceUpdates = require("./simulateWithPriceUpdates.js");
 const require_sdk_utils_viem_executeDelegatedMulticalls = require("./executeDelegatedMulticalls.js");
@@ -10,6 +11,7 @@ exports.SimulateWithPriceUpdatesError = require_sdk_utils_viem_simulateWithPrice
 exports.SimulationError = require_sdk_utils_viem_simulateCall.SimulationError;
 exports.estimateRawTxGas = require_sdk_utils_viem_sendRawTx.estimateRawTxGas;
 exports.executeDelegatedMulticalls = require_sdk_utils_viem_executeDelegatedMulticalls.executeDelegatedMulticalls;
+exports.executeMulticallBatches = require_sdk_utils_viem_executeMulticallBatches.executeMulticallBatches;
 exports.generateCastTraceCall = require_sdk_utils_viem_cast.generateCastTraceCall;
 exports.getCastTraceArgs = require_sdk_utils_viem_cast.getCastTraceArgs;
 exports.getSimulateWithPriceUpdatesError = require_sdk_utils_viem_simulateWithPriceUpdates.getSimulateWithPriceUpdatesError;

package/dist/esm/abi/iExpirable.js

@@ -0,0 +1,14 @@
+//#region src/abi/iExpirable.ts
+const iExpirableAbi = [{
+	type: "function",
+	inputs: [],
+	name: "isExpired",
+	outputs: [{
+		name: "",
+		internalType: "bool",
+		type: "bool"
+	}],
+	stateMutability: "view"
+}];
+//#endregion
+export { iExpirableAbi };

package/dist/esm/dev/AccountOpener.js

@@ -1,9 +1,9 @@
+import { ierc20Abi } from "../abi/iERC20.js";
 import { iCreditFacadeV310Abi } from "../abi/310/generated.js";
 import { AddressMap } from "../sdk/utils/AddressMap.js";
 import { AddressSet } from "../sdk/utils/AddressSet.js";
 import { AssetsMap } from "../sdk/utils/AssetsMap.js";
 import { childLogger } from "../sdk/utils/childLogger.js";
-import { ierc20Abi } from "../abi/iERC20.js";
 import "../sdk/constants/addresses.js";
 import { MAX_UINT256, PERCENTAGE_FACTOR } from "../sdk/constants/math.js";
 import { SDKConstruct } from "../sdk/base/SDKConstruct.js";
@@ -86,7 +86,6 @@ var AccountOpener = class extends SDKConstruct {
 			depositIntoPools,
 			claimFromFaucet
 		}, "opening credit accounts");
-		await Promise.all([this.sdk.tokensMeta.loadTokenData(), this.sdk.marketRegister.loadZappers()]);
 		let deposits = [];
 		if (depositIntoPools) try {
 			deposits = await this.#depositIntoPools(targets);

package/dist/esm/dev/withdrawalUtils.js

@@ -1,6 +1,6 @@
+import { iWithdrawalCompressorV313Abi } from "../abi/IWithdrawalCompressorV313.js";
 import { getNetworkType } from "../sdk/chain/chains.js";
 import { getWithdrawalCompressorAddress } from "../sdk/accounts/withdrawal-compressor/addresses.js";
-import { iWithdrawalCompressorV313Abi } from "../abi/IWithdrawalCompressorV313.js";
 import "../sdk/index.js";
 import { iMidasDataFeedAbi, iMidasRedemptionVaultAbi, midasGatewayAbi, midasRedeemerAbi, midasRedemptionVaultPhantomTokenAbi, securitizeRedeemerAbi, securitizeRedemptionGatewayAbi, securitizeRedemptionPhantomTokenAbi } from "./withdrawalAbi.js";
 import { erc20Abi, hexToString, parseAbi, parseEther } from "viem";

package/dist/esm/plugins/adapters/contracts/ERC4626AdapterContract.js

@@ -1,5 +1,5 @@
-import { MissingSerializedParamsError } from "../../../sdk/base/errors.js";
 import { ierc4626AdapterAbi } from "../../../abi/ierc4626Adapter.js";
+import { MissingSerializedParamsError } from "../../../sdk/base/errors.js";
 import "../../../sdk/index.js";
 import { fnSigToName, swapFromTransfers } from "../transferHelpers.js";
 import { AbstractAdapterContract } from "./AbstractAdapter.js";

package/dist/esm/preview/simulate/simulatePoolOperation.js

@@ -1,5 +1,5 @@
-import { iPoolV310Abi } from "../../abi/310/generated.js";
 import { iZapperAbi } from "../../abi/iZapper.js";
+import { iPoolV310Abi } from "../../abi/310/generated.js";
 import { asPreviewSimulationError } from "./errors.js";
 //#region src/preview/simulate/simulatePoolOperation.ts
 function previewRead(operation) {

package/dist/esm/preview/trace/extractTransfers.js

@@ -1,6 +1,6 @@
+import { ierc20Abi } from "../../abi/iERC20.js";
 import { iCreditFacadeV310Abi } from "../../abi/310/generated.js";
 import { AddressMap } from "../../sdk/utils/AddressMap.js";
-import { ierc20Abi } from "../../abi/iERC20.js";
 import "../../sdk/index.js";
 import { UnexpectedFacadeEventOrderError } from "./errors.js";
 import { getAddress, isAddressEqual, parseEventLogs } from "viem";

package/dist/esm/sdk/MultichainSDK.js

@@ -68,7 +68,6 @@ var MultichainSDK = class {
 			const perChainOpts = options?.perChain?.[network] ?? {};
 			return sdk.attach({
 				...perChainOpts,
-				loadZappers: perChainOpts.loadZappers ?? options?.loadZappers,
 				redstone: {
 					...options?.redstone,
 					cache: this.#redstoneCache,
@@ -88,7 +87,7 @@ var MultichainSDK = class {
 	*   state and `allowMissingChains` is not set.
 	*/
 	hydrate(state, options) {
-		if (state.version !== 1) throw new SdkStateVersionMismatchError(1, state.version);
+		if (state.version !== 2) throw new SdkStateVersionMismatchError(2, state.version);
 		if (options?.redstone) this.#redstoneCache = new PriceUpdatesCache({
 			ttl: options.redstone.cacheTTL ?? 225e3,
 			historical: !!options.redstone.historicTimestamp
@@ -168,7 +167,7 @@ var MultichainSDK = class {
 	**/
 	get state() {
 		return {
-			version: 1,
+			version: 2,
 			chains: [...this.#chains.values()].map((sdk) => sdk.state)
 		};
 	}
@@ -178,7 +177,7 @@ var MultichainSDK = class {
 	*/
 	stateHuman(raw) {
 		return {
-			version: 1,
+			version: 2,
 			chains: [...this.#chains.values()].map((sdk) => sdk.stateHuman(raw))
 		};
 	}

package/dist/esm/sdk/OnchainSDK.js

@@ -7,6 +7,7 @@ import "./constants/index.js";
 import { formatTimestamp } from "./utils/formatter.js";
 import { toAddress } from "./utils/toAddress.js";
 import "./utils/index.js";
+import { executeMulticallBatches } from "./utils/viem/executeMulticallBatches.js";
 import { ChainContractsRegister } from "./base/ChainContractsRegister.js";
 import "./base/index.js";
 import { executeDelegatedMulticalls } from "./utils/viem/executeDelegatedMulticalls.js";
@@ -40,7 +41,7 @@ import { createPublicClient, fallback, http, parseEventLogs } from "viem";
 * Serialised state format version, checked during hydration to detect
 * incompatible snapshots.
 **/
-const STATE_VERSION = 1;
+const STATE_VERSION = 2;
 /**
 * @internal
 * Creates a viem `PublicClient` from the given connection options.
@@ -150,7 +151,7 @@ var OnchainSDK = class extends ChainContractsRegister {
 	*/
 	async attach(options) {
 		if (this.#attached) throw new SdkAlreadyAttachedError();
-		const { addressProvider = ADDRESS_PROVIDER_V310, blockNumber, ignoreUpdateablePrices, ignoreMarkets, marketConfigurators: mcs, redstone, loadZappers } = options ?? {};
+		const { addressProvider = ADDRESS_PROVIDER_V310, blockNumber, ignoreUpdateablePrices, ignoreMarkets, marketConfigurators: mcs, redstone } = options ?? {};
 		const marketConfigurators = mcs ?? TypedObjectUtils.keys(this.client.chain.defaultMarketConfigurators);
 		const rwaFactories = options?.rwaFactories ?? this.client.chain.rwaFactories;
 		this.logger?.info({
@@ -174,19 +175,15 @@ var OnchainSDK = class extends ChainContractsRegister {
 		this.#marketRegister = new MarketRegister(this, ignoreMarkets);
 		if (!marketConfigurators.length) this.logger?.warn("no market configurators provided, skipping market loading");
 		else {
+			const priceUpdates = await this.#getPriceUpdateTxs(marketConfigurators, ignoreUpdateablePrices);
+			this.logger?.debug({ configurators: marketConfigurators }, `calling getMarkets with ${priceUpdates.length} price updates in block ${this.currentBlock}`);
 			const delegated = [...this.#marketRegister.getLoadMulticalls(marketConfigurators), ...this.#rwa.getLoadMulticalls(marketConfigurators, rwaFactories)];
-			let txs = [];
-			if (!ignoreUpdateablePrices) {
-				const updatables = await this.#priceFeeds.getPartialUpdatablePriceFeeds(marketConfigurators);
-				txs = (await this.#priceFeeds.generatePriceFeedsUpdateTxs(updatables)).txs;
-			}
-			this.logger?.debug({ configurators: marketConfigurators }, `calling getMarkets with ${txs.length} price updates in block ${this.currentBlock}`);
 			await executeDelegatedMulticalls(this.client, delegated, {
-				priceUpdates: txs,
+				priceUpdates,
 				blockNumber: this.currentBlock,
 				gas: this.gasLimit
 			});
-			if (loadZappers) await this.#marketRegister.loadZappers();
+			await this.#warmup();
 		}
 		const pluginsList = TypedObjectUtils.entries(this.plugins);
 		(await Promise.allSettled(pluginsList.map(([name, plugin]) => {
@@ -203,6 +200,36 @@ var OnchainSDK = class extends ChainContractsRegister {
 		this.#attached = true;
 	}
 	/**
+	* @internal
+	* Pass 0 of attach: resolves the price updates that the market reads of
+	* pass 1 are simulated with.
+	*
+	* @param configurators - Market configurators whose feeds are considered.
+	* @param ignoreUpdateablePrices - When `true`, no updates are fetched.
+	**/
+	async #getPriceUpdateTxs(configurators, ignoreUpdateablePrices) {
+		if (ignoreUpdateablePrices) return [];
+		const updatables = await this.priceFeeds.getPartialUpdatablePriceFeeds(configurators);
+		const { txs } = await this.priceFeeds.generatePriceFeedsUpdateTxs(updatables);
+		return txs;
+	}
+	/**
+	* @internal
+	* Pass 2 of attach: loads the data that is read synchronously afterwards
+	* (zappers, withdrawable assets, extended token data) in a single multicall.
+	*
+	* Also re-run after a sync that reloaded the markets these caches derive from.
+	*
+	* @param force - Reload caches that are already populated.
+	**/
+	async #warmup(force = false) {
+		await executeMulticallBatches(this.client, [
+			this.marketRegister.getLoadZappersMulticall(force),
+			...this.#withdrawalCompressor ? [this.#withdrawalCompressor.getLoadWithdrawableAssetsMulticall(force)] : [],
+			this.tokensMeta.getLoadTokenDataMulticall()
+		], { blockNumber: this.currentBlock });
+	}
+	/**
 	* Restores SDK state from a previously serialised {@link GearboxState}
 	* snapshot, without making any on-chain calls.
 	*
@@ -214,7 +241,7 @@ var OnchainSDK = class extends ChainContractsRegister {
 	*/
 	hydrate(state, options) {
 		if (this.#attached) throw new SdkAlreadyAttachedError();
-		if (state.version !== 1) throw new SdkStateVersionMismatchError(1, state.version);
+		if (state.version !== 2) throw new SdkStateVersionMismatchError(2, state.version);
 		if (state.network !== this.networkType) throw new SdkChainMismatchError(this.networkType, state.network);
 		const { ignoreMarkets, redstone } = options ?? {};
 		this.logger?.info({ networkType: this.networkType }, "hydrating sdk state");
@@ -228,6 +255,7 @@ var OnchainSDK = class extends ChainContractsRegister {
 		this.#rwa = new RWARegistry(this);
 		this.#rwa.setState(state.rwa);
 		if (state.withdrawals) this.#withdrawalCompressor?.hydrate(state.withdrawals);
+		if (state.tokens) this.tokensMeta.hydrate(state.tokens);
 		for (const [name, plugin] of TypedObjectUtils.entries(this.plugins)) {
 			const pluginState = state.plugins[name];
 			if (plugin.hydrate && pluginState) {
@@ -273,13 +301,14 @@ var OnchainSDK = class extends ChainContractsRegister {
 	/** Serialisable snapshot of the current SDK state. */
 	get state() {
 		return {
-			version: 1,
+			version: 2,
 			network: this.networkType,
 			chainId: this.chainId,
 			currentBlock: this.currentBlock,
 			timestamp: this.timestamp,
 			addressProvider: this.addressProvider.state,
 			...this.marketRegister.state,
+			tokens: this.tokensMeta.state,
 			rwa: this.#rwa.state,
 			withdrawals: this.#withdrawalCompressor?.state,
 			plugins: Object.fromEntries(TypedObjectUtils.entries(this.plugins).map(([name, plugin]) => [name, plugin.loaded ? {
@@ -338,7 +367,7 @@ var OnchainSDK = class extends ChainContractsRegister {
 			}
 			this.#currentBlock = blockNumber;
 			this.#timestamp = timestamp;
-			await this.marketRegister.syncState(ignoreUpdateablePrices);
+			if (await this.marketRegister.syncState(ignoreUpdateablePrices, this.#rwa.getSyncMulticalls())) await this.#warmup(true);
 			const pluginsList = TypedObjectUtils.entries(this.plugins);
 			(await Promise.allSettled(pluginsList.map(([name, plugin]) => {
 				if (plugin.syncState) {

package/dist/esm/sdk/accounts/CreditAccountsServiceV310.js

@@ -1,3 +1,5 @@
+import { iBaseRewardPoolAbi } from "../../abi/iBaseRewardPool.js";
+import { ierc4626AdapterAbi } from "../../abi/ierc4626Adapter.js";
 import { AP_REWARDS_COMPRESSOR } from "../constants/address-provider.js";
 import { ADDRESS_0X0 } from "../constants/addresses.js";
 import { MAX_UINT256 } from "../constants/math.js";
@@ -8,8 +10,6 @@ import "../base/index.js";
 import { AccountBotsService } from "./bots/AccountBotsService.js";
 import "./bots/index.js";
 import { rewardsCompressorAbi } from "../../abi/compressors/rewardsCompressor.js";
-import { iBaseRewardPoolAbi } from "../../abi/iBaseRewardPool.js";
-import { ierc4626AdapterAbi } from "../../abi/ierc4626Adapter.js";
 import { expectedBalanceDeltas } from "../market/credit/expectedBalanceDeltas.js";
 import "../market/index.js";
 import { CreditAccountCompressor } from "./credit-account-compressor/CreditAccountCompressor.js";

package/dist/esm/sdk/accounts/liquidations/LiquidationsService.js

@@ -1,3 +1,4 @@
+import { iLiquidationCompressorV313Abi } from "../../../abi/ILiquidationCompressorV313.js";
 import { AddressSet } from "../../utils/AddressSet.js";
 import { bytes32ToString } from "../../utils/bytes32ToString.js";
 import { ADDRESS_0X0 } from "../../constants/addresses.js";
@@ -19,7 +20,6 @@ import { SecuritizeLiquidatorContract } from "../../market/rwa/securitize/Securi
 import "../../market/rwa/securitize/index.js";
 import "../../market/index.js";
 import { LIQUIDATION_APPROVAL_BUFFER, LIQUIDATION_COMPRESSOR_V313_ADDRESS } from "./constants.js";
-import { iLiquidationCompressorV313Abi } from "../../../abi/ILiquidationCompressorV313.js";
 //#region src/sdk/accounts/liquidations/LiquidationsService.ts
 /**
 * Service for discovering liquidatable credit accounts and previewing manual

package/dist/esm/sdk/accounts/withdrawal-compressor/AbstractWithdrawalCompressorContract.js

@@ -3,8 +3,10 @@ import "../../constants/addresses.js";
 import "../../constants/index.js";
 import { hexEq } from "../../utils/hex.js";
 import "../../utils/index.js";
+import { executeMulticallBatches } from "../../utils/viem/executeMulticallBatches.js";
 import { BaseContract } from "../../base/BaseContract.js";
 import "../../base/index.js";
+import "../../utils/viem/index.js";
 import { decodeDelayedIntent } from "./intent-codec.js";
 import { isAddressEqual } from "viem";
 //#region src/sdk/accounts/withdrawal-compressor/AbstractWithdrawalCompressorContract.ts
@@ -57,37 +59,46 @@ var AbstractWithdrawalCompressorContract = class extends BaseContract {
 	**/
 	getWithdrawableAssets(...creditManagers) {
 		const cache = this.#withdrawableAssets;
-		if (!cache) throw new Error("withdrawable assets are not loaded, call loadWithdrawableAssets first");
+		if (!cache) throw new Error("withdrawable assets are not loaded, check if the sdk was properly attached or hydrated");
 		if (creditManagers.length === 0) return cache.values().flat();
 		return creditManagers.flatMap((cm) => cache.get(cm) ?? []);
 	}
 	/**
-	* {@inheritDoc IWithdrawalCompressorContract.loadWithdrawableAssets}
+	* {@inheritDoc IWithdrawalCompressorContract.getLoadWithdrawableAssetsMulticall}
 	**/
-	async loadWithdrawableAssets(force, blockNumber) {
-		if (this.#withdrawableAssets && !force) return this.getWithdrawableAssets();
+	getLoadWithdrawableAssetsMulticall(force) {
+		if (this.#withdrawableAssets && !force) return {
+			contracts: [],
+			onResults: () => {}
+		};
 		const cms = this.#sdk.marketRegister.creditManagers.map((cm) => cm.creditManager.address);
-		const resp = await this.client.multicall({
+		return {
 			contracts: cms.map((cm) => ({
 				address: this.address,
 				abi: this.abi,
 				functionName: "getWithdrawableAssets",
 				args: [cm]
 			})),
-			allowFailure: true,
-			batchSize: 0,
-			blockNumber
-		});
-		const cache = new AddressMap(void 0, MAP_LABEL);
-		for (let i = 0; i < resp.length; i++) {
-			const r = resp[i];
-			if (r.status !== "success") {
-				this.logger?.warn(`failed to get withdrawable assets of credit manager ${cms[i]}: ${r.error}`);
-				continue;
+			onResults: (resps) => {
+				const cache = new AddressMap(void 0, MAP_LABEL);
+				for (let i = 0; i < resps.length; i++) {
+					const r = resps[i];
+					if (r.status !== "success") {
+						this.logger?.warn(`failed to get withdrawable assets of credit manager ${cms[i]}: ${r.error}`);
+						continue;
+					}
+					const assets = r.result;
+					if (assets.length > 0) cache.upsert(cms[i], assets.map((a) => toWithdrawableAsset(a, cms[i])));
+				}
+				this.#withdrawableAssets = cache;
 			}
-			if (r.result.length > 0) cache.upsert(cms[i], r.result.map((a) => toWithdrawableAsset(a, cms[i])));
-		}
-		this.#withdrawableAssets = cache;
+		};
+	}
+	/**
+	* {@inheritDoc IWithdrawalCompressorContract.loadWithdrawableAssets}
+	**/
+	async loadWithdrawableAssets(force, blockNumber) {
+		await executeMulticallBatches(this.client, [this.getLoadWithdrawableAssetsMulticall(force)], { blockNumber });
 		return this.getWithdrawableAssets();
 	}
 	/**

package/dist/esm/sdk/accounts/withdrawal-compressor/RedemptionLoggerV310Contract.js

@@ -1,7 +1,7 @@
+import { iRedemptionLoggerV310Abi } from "../../../abi/iRedemptionLoggerV310.js";
 import { BaseContract } from "../../base/BaseContract.js";
 import "../../base/index.js";
 import { decodeDelayedIntent } from "./intent-codec.js";
-import { iRedemptionLoggerV310Abi } from "../../../abi/iRedemptionLoggerV310.js";
 import { InvalidDelayedIntentError } from "./errors.js";
 //#region src/sdk/accounts/withdrawal-compressor/RedemptionLoggerV310Contract.ts
 const abi = iRedemptionLoggerV310Abi;

package/dist/esm/sdk/accounts/withdrawal-compressor/WithdrawalCompressorV310Contract.js

@@ -1,5 +1,5 @@
-import { AbstractWithdrawalCompressorContract } from "./AbstractWithdrawalCompressorContract.js";
 import { iWithdrawalCompressorV310Abi } from "../../../abi/IWithdrawalCompressorV310.js";
+import { AbstractWithdrawalCompressorContract } from "./AbstractWithdrawalCompressorContract.js";
 //#region src/sdk/accounts/withdrawal-compressor/WithdrawalCompressorV310Contract.ts
 const abi = iWithdrawalCompressorV310Abi;
 /**

package/dist/esm/sdk/accounts/withdrawal-compressor/WithdrawalCompressorV311Contract.js

@@ -1,5 +1,5 @@
-import { AbstractWithdrawalCompressorContract } from "./AbstractWithdrawalCompressorContract.js";
 import { iWithdrawalCompressorV311Abi } from "../../../abi/IWithdrawalCompressorV311.js";
+import { AbstractWithdrawalCompressorContract } from "./AbstractWithdrawalCompressorContract.js";
 //#region src/sdk/accounts/withdrawal-compressor/WithdrawalCompressorV311Contract.ts
 const abi = iWithdrawalCompressorV311Abi;
 /**

package/dist/esm/sdk/accounts/withdrawal-compressor/WithdrawalCompressorV313Contract.js

@@ -1,6 +1,6 @@
+import { iWithdrawalCompressorV313Abi } from "../../../abi/IWithdrawalCompressorV313.js";
 import { encodeDelayedIntent } from "./intent-codec.js";
 import { AbstractWithdrawalCompressorContract, iCreditAccountAbi, toClaimableWithdrawal, toPendingWithdrawal, toRequestableWithdrawal } from "./AbstractWithdrawalCompressorContract.js";
-import { iWithdrawalCompressorV313Abi } from "../../../abi/IWithdrawalCompressorV313.js";
 import { toWithdrawalStatus } from "./types.js";
 //#region src/sdk/accounts/withdrawal-compressor/WithdrawalCompressorV313Contract.ts
 const abi = iWithdrawalCompressorV313Abi;

package/dist/esm/sdk/base/TokensMeta.js

@@ -1,11 +1,13 @@
+import { iExpirableAbi } from "../../abi/iExpirable.js";
+import { iStateSerializerAbi } from "../../abi/iStateSerializer.js";
+import { iVersionAbi } from "../../abi/iVersion.js";
 import { AddressMap } from "../utils/AddressMap.js";
 import { AddressSet } from "../utils/AddressSet.js";
 import { bytes32ToString } from "../utils/bytes32ToString.js";
 import { getAssetType } from "../chain/chains.js";
 import { formatBN } from "../utils/formatter.js";
 import "../utils/index.js";
-import { iStateSerializerAbi } from "../../abi/iStateSerializer.js";
-import { iVersionAbi } from "../../abi/iVersion.js";
+import { executeMulticallBatches } from "../utils/viem/executeMulticallBatches.js";
 //#region src/sdk/base/TokensMeta.ts
 /**
 * Registry of token metadata (symbol, decimals, phantom type) keyed by address.
@@ -62,7 +64,7 @@ var TokensMeta = class extends AddressMap {
 	* @returns
 	*/
 	isPhantomToken(t) {
-		if (!this.#tokenDataLoaded.has(t.addr)) throw new Error(`extended token data not loaded for ${t.symbol} (${t.addr})`);
+		if (!this.#tokenDataLoaded.has(t.addr)) throw new Error(`extended token data not loaded for ${t.symbol} (${t.addr}), check if the sdk was properly attached or hydrated`);
 		return !!t.contractType?.startsWith("PHANTOM_TOKEN::");
 	}
 	/**
@@ -167,44 +169,93 @@ var TokensMeta = class extends AddressMap {
 		return meta;
 	}
 	/**
+	* @internal
+	*
+	* Returns the multicall batch that loads extended token data (`contractType`
+	* and `serialize()`) for the tokens that do not have it yet. Used by the SDK
+	* to warm this cache together with other loaders in a single multicall.
+	*
+	* @param tokens - tokens to load data for, defaults to all tokens
+	**/
+	getLoadTokenDataMulticall(...tokens) {
+		const tokenz = new AddressSet(tokens.length > 0 ? tokens : this.keys());
+		const tokensToLoad = Array.from(tokenz.difference(this.#tokenDataLoaded));
+		return {
+			contracts: tokensToLoad.flatMap((t) => [
+				{
+					address: t,
+					abi: iVersionAbi,
+					functionName: "contractType"
+				},
+				{
+					address: t,
+					abi: iStateSerializerAbi,
+					functionName: "serialize"
+				},
+				{
+					address: t,
+					abi: iExpirableAbi,
+					functionName: "isExpired"
+				}
+			]),
+			onResults: (resps) => {
+				this.#logger?.debug(`loaded data of ${tokensToLoad.length} tokens`);
+				for (let i = 0; i < tokensToLoad.length; i++) {
+					this.#overrideTokenMeta(tokensToLoad[i], resps[3 * i], resps[3 * i + 1], resps[3 * i + 2]);
+					this.#tokenDataLoaded.add(tokensToLoad[i]);
+				}
+			}
+		};
+	}
+	/**
 	* Loads token information about phantom tokens
 	* In future other custom tokens types that do not have compressors might be handled here
 	*
+	* Tokens loaded during SDK attach or restored by {@link hydrate} are skipped,
+	* so calling this after either is a no-op.
+	*
 	* @param tokens - tokens to load data for, defaults to all tokens
 	*/
 	async loadTokenData(...tokens) {
-		const tokenz = new AddressSet(tokens.length > 0 ? tokens : this.keys());
-		const tokensToLoad = Array.from(tokenz.difference(this.#tokenDataLoaded));
-		if (tokensToLoad.length === 0) return;
-		const resp = await this.#client.multicall({
-			contracts: tokensToLoad.flatMap((t) => [{
-				address: t,
-				abi: iVersionAbi,
-				functionName: "contractType"
-			}, {
-				address: t,
-				abi: iStateSerializerAbi,
-				functionName: "serialize"
-			}]),
-			allowFailure: true,
-			batchSize: 0
-		});
-		this.#logger?.debug(`loaded ${resp.length} contract types`);
-		for (let i = 0; i < tokensToLoad.length; i++) {
-			this.#overrideTokenMeta(tokensToLoad[i], resp[2 * i], resp[2 * i + 1]);
-			this.#tokenDataLoaded.add(tokensToLoad[i]);
-		}
+		await executeMulticallBatches(this.#client, [this.getLoadTokenDataMulticall(...tokens)]);
+	}
+	/**
+	* Serializable snapshot of all token metadata, suitable for hydration.
+	**/
+	get state() {
+		return {
+			tokens: this.values(),
+			extendedLoaded: this.#tokenDataLoaded.asArray()
+		};
 	}
-	#overrideTokenMeta(token, contractTypeResp, _serializeResp) {
+	/**
+	* Restores token metadata from a previously serialized snapshot,
+	* bypassing on-chain reads.
+	*
+	* Entries are merged into the ones already registered by markets, zappers and
+	* the RWA registry (see {@link upsert}), so the snapshot must be applied last
+	* for its augmented fields to win.
+	*
+	* @param state - Token metadata snapshot.
+	**/
+	hydrate(state) {
+		for (const token of state.tokens) this.upsert(token.addr, token);
+		for (const token of state.extendedLoaded) this.#tokenDataLoaded.add(token);
+	}
+	#overrideTokenMeta(token, contractTypeResp, serializeResp, isExpiredResp) {
 		const meta = this.mustGet(token);
+		const update = { ...meta };
 		if (contractTypeResp.status === "success") {
 			const contractType = bytes32ToString(contractTypeResp.result);
-			this.upsert(token, {
-				...meta,
-				contractType
-			});
+			update.contractType = contractType;
+			update.serializedParams = serializeResp.status === "success" ? serializeResp.result : void 0;
 			this.#logger?.debug(`token ${meta.symbol} is ${contractType}`);
 		}
+		if (isExpiredResp.status === "success") {
+			update.isExpired = isExpiredResp.result;
+			this.#logger?.debug(`token ${meta.symbol} is expirable, expired: ${isExpiredResp.result}`);
+		}
+		if (contractTypeResp.status === "success" || isExpiredResp.status === "success") this.upsert(token, update);
 		return this.mustGet(token);
 	}
 };

package/dist/esm/sdk/chain/detectNetwork.js

@@ -1,5 +1,5 @@
-import { chains } from "./chains.js";
 import { ierc20Abi } from "../../abi/iERC20.js";
+import { chains } from "./chains.js";
 //#region src/sdk/chain/detectNetwork.ts
 /**
 * Detects the network type from the given client.

package/dist/esm/sdk/core/createAddressProvider.js

@@ -1,8 +1,8 @@
+import { iVersionAbi } from "../../abi/iVersion.js";
 import { AP_MARKET_COMPRESSOR, AP_PRICE_FEED_COMPRESSOR } from "../constants/address-provider.js";
 import { isV310 } from "../constants/versions.js";
 import "../constants/index.js";
 import { hexEq } from "../utils/hex.js";
-import { iVersionAbi } from "../../abi/iVersion.js";
 import { AddressProviderV310Contract } from "./AddressProviderV310Contract.js";
 //#region src/sdk/core/createAddressProvider.ts
 const OVERRIDE_ADDRESSES = { Mainnet: {

package/dist/esm/sdk/index.js

@@ -30,6 +30,7 @@ import { ZodAddress, ZodBigInt, ZodHex } from "./utils/zod.js";
 import "./utils/index.js";
 import { generateCastTraceCall, getCastTraceArgs } from "./utils/viem/cast.js";
 import { SimulationError, simulateCall } from "./utils/viem/simulateCall.js";
+import { executeMulticallBatches } from "./utils/viem/executeMulticallBatches.js";
 import { TokensMeta } from "./base/TokensMeta.js";
 import { ChainContractsRegister } from "./base/ChainContractsRegister.js";
 import { Construct } from "./base/Construct.js";
@@ -147,4 +148,4 @@ import { OnchainSDK, STATE_VERSION } from "./OnchainSDK.js";
 import { MultichainSDK } from "./MultichainSDK.js";
 import { attachOptionsSchema, onchainSDKOptionsSchema } from "./options.js";
 import "./types/index.js";
-export { ADDRESS_0X0, ADDRESS_PROVIDER_V310, AP_ACCOUNT_FACTORY, AP_ACL, AP_BOT_LIST, AP_BYTECODE_REPOSITORY, AP_CONTRACTS_REGISTER, AP_CONTROLLER_TIMELOCK, AP_CREDIT_ACCOUNT_COMPRESSOR, AP_CREDIT_SUITE_COMPRESSOR, AP_DATA_COMPRESSOR, AP_DELEVERAGE_BOT_HV, AP_DELEVERAGE_BOT_LV, AP_DELEVERAGE_BOT_PEGGED, AP_GAUGE_COMPRESSOR, AP_GEAR_STAKING, AP_GEAR_TOKEN, AP_INFLATION_ATTACK_BLOCKER, AP_INSOLVENCY_CHECKER, AP_MARKET_COMPRESSOR, AP_MARKET_CONFIGURATOR, AP_PARTIAL_LIQUIDATION_BOT, AP_PERIPHERY_COMPRESSOR, AP_PRICE_FEED_COMPRESSOR, AP_PRICE_FEED_STORE, AP_PRICE_ORACLE, AP_REDEMPTION_LOGGER, AP_REWARDS_COMPRESSOR, AP_ROUTER, AP_RWA_COMPRESSOR, AP_TOKEN_COMPRESSOR, AP_TREASURY, AP_WETH_GATEWAY, AP_WETH_TOKEN, AP_ZAPPER_REGISTER, AP_ZERO_PRICE_FEED, AbstractLPPriceFeedContract, AbstractPriceFeedContract, AbstractWithdrawalCompressorContract, AccountBotsService, AddressMap, AddressProviderV310Contract, AddressSet, AssetsMap, BLOCKS_PER_WEEK_BY_NETWORK, BalancerStablePriceFeedContract, BalancerWeightedPriceFeedContract, BaseContract, BasePlugin, BigIntMath, BotPermissions, BoundedPriceFeedContract, ChainContractsRegister, ChainNotConfiguredError, CompositePriceFeedContract, Construct, ContractParseError, CreditAccountCompressor, CreditAccountCompressorV310Contract, CreditAccountOperationsService, CreditAccountsServiceV310, CreditConfiguratorV310Contract, CreditFacadeV310BaseContract, CreditFacadeV310Contract, CreditManagerV310Contract, CreditSuite, CurveCryptoPriceFeedContract, CurveStablePriceFeedContract, CurveUSDPriceFeedContract, DELAYED_INTENT_TYPES, DELAYED_INTENT_VERSION, DUST_THRESHOLD, Erc4626PriceFeedContract, ExternalPriceFeedContract, GaugeContract, IERC20ZapperContract, IETHZapperContract, InvalidDelayedIntentError, LEVERAGE_DECIMALS, LIQUIDATION_APPROVAL_BUFFER, LIQUIDATION_COMPRESSOR_V313_ADDRESS, LinearInterestRateModelContract, LiquidationsService, MAX_INT, MAX_UINT16, MAX_UINT256, MIN_INT96, MULTICALL_ADDRESS, MarketRegister, MarketSuite, MellowLRTPriceFeedContract, MidasLiquidatorContract, MissingSerializedParamsError, MultichainConstruct, MultichainLiquidationsService, MultichainOpportunitiesService, MultichainPositionsService, MultichainSDK, NATIVE_ADDRESS, NOT_DEPLOYED, NO_VERSION, NetworkType, OnchainSDK, OpportunitiesService, PARTIAL_LIQUIDATION_BUFFER_BPS, PERCENTAGE_DECIMALS, PERCENTAGE_FACTOR, PERCENTAGE_FACTOR_1KK, PERIPHERY_CONTRACTS, PHANTOM_TOKEN_CONTRACT_TYPES, PHANTOM_TOKEN_MIDAS_REDEMPTION, PHANTOM_TOKEN_SECURITIZE_REDEMPTION, PRICE_DECIMALS, PRICE_DECIMALS_POW, PartialPriceFeedInitError, PendleTWAPPTPriceFeed, PeripheryCompressorV310Contract, PlaceholderAdapterContract, PlaceholderContract, PluginStateVersionError, PoolService, PoolSuite, PoolV310Contract, PositionsService, PriceFeedRef, PriceFeedRegister, PriceOracleV310Contract, PythPriceFeed, RAMP_DURATION_BY_NETWORK, RAY, RAY_DECIMALS_POW, RWARegistry, RWA_FACTORY_SECURITIZE, RWA_FACTORY_TYPES, RWA_LIQUIDATOR_MIDAS, RWA_LIQUIDATOR_SECURITIZE, RWA_ON_DEMAND_LP_MONOPOLIZED, RWA_UNDERLYING_DEFAULT, RWA_UNDERLYING_ON_DEMAND, RedemptionLoggerV310Contract, RedstonePriceFeedContract, RouterV310Contract, SDKConstruct, SECONDS_PER_YEAR, SECURITIZE_REGISTER_VAULT_TYPES, SLIPPAGE_DECIMALS, STATE_VERSION, SUPPORTED_NETWORKS, SdkAlreadyAttachedError, SdkChainMismatchError, SdkMissingChainStateError, SdkNotAttachedError, SdkStateVersionMismatchError, SdkSyncFailedError, SecuritizeLiquidatorContract, SecuritizeRWAFactory, SimulateWithPriceUpdatesError, SimulationError, TokensMeta, TypedObjectUtils, UnsupportedZapperFunctionError, VERSION_RANGE_310, VotingContractStatus, WAD, WAD_DECIMALS_POW, WithdrawalCompressorV310Contract, WithdrawalCompressorV311Contract, WithdrawalCompressorV313Contract, WstETHPriceFeedContract, YearnPriceFeedContract, ZapperContract, ZeroPriceFeedContract, ZodAddress, ZodBigInt, ZodHex, additionalBorrowApyBps, assetsMap, attachOptionsSchema, borrowApyBps, botPermissionsToString, bytes32ToString, chains, childLogger, createAdapter, createAddressProvider, createPriceOracle, createRawTx, createRedemptionLogger, createRouter, createWithdrawalCompressor, createZapper, abi as creditFacadeV310Abi, decodeDelayedIntent, detectNetwork, dominantCollateral, encodeDelayedIntent, estimateRawTxGas, etherscanApiUrl, etherscanUrl, executeDelegatedMulticalls, expectedBalanceDeltas, fetchRedstonePayloads, filterDust, filterDustUSD, findCuratorMarketConfigurator, fmtBinaryMask, formatBN, formatBNvalue, formatDuration, formatLeverage, formatNumberToString_, formatPercentage, formatTimestamp, functionArgsToMap, functionArgsToRecord, generateCastTraceCall, getAssetType, getCastTraceArgs, getChain, getCuratorName, getFunctionSignature, getNetworkType, getRawPriceUpdates, getSimulateWithPriceUpdatesError, getWithdrawalCompressorAddress, halfRAY, healthFactorBps, hexEq, hydrateAddressProvider, iCreditAccountAbi, isDust, isLPPriceFeed, isPublicNetwork, isRWAFactory, isRWAToken, isSunsetPool, isSunsetStrategy, isSupportedNetwork, isUpdatablePriceFeed, isV310, isVersionRange, json_parse, json_stringify, maxLeverage, minSeizedAmount, mustGetDominantCollateral, numberWithCommas, onchainSDKOptionsSchema, optimalHFForPartialLiquidation, optimalRepaidAmount, percentFmt, positionLeverage, primaryInstantOutput, rayToBps, rayToNumber, retry, sendRawTx, shortAddress, shortHash, simulateCall, simulateMulticall, simulateWithPriceUpdates, toAddress, toBN, toBigInt, toChainIds, toClaimableWithdrawal, toPendingWithdrawal, toRequestableWithdrawal, toSignificant, toWithdrawalStatus, usdToNumber, utilizationBps, watchBlocksAsync };
+export { ADDRESS_0X0, ADDRESS_PROVIDER_V310, AP_ACCOUNT_FACTORY, AP_ACL, AP_BOT_LIST, AP_BYTECODE_REPOSITORY, AP_CONTRACTS_REGISTER, AP_CONTROLLER_TIMELOCK, AP_CREDIT_ACCOUNT_COMPRESSOR, AP_CREDIT_SUITE_COMPRESSOR, AP_DATA_COMPRESSOR, AP_DELEVERAGE_BOT_HV, AP_DELEVERAGE_BOT_LV, AP_DELEVERAGE_BOT_PEGGED, AP_GAUGE_COMPRESSOR, AP_GEAR_STAKING, AP_GEAR_TOKEN, AP_INFLATION_ATTACK_BLOCKER, AP_INSOLVENCY_CHECKER, AP_MARKET_COMPRESSOR, AP_MARKET_CONFIGURATOR, AP_PARTIAL_LIQUIDATION_BOT, AP_PERIPHERY_COMPRESSOR, AP_PRICE_FEED_COMPRESSOR, AP_PRICE_FEED_STORE, AP_PRICE_ORACLE, AP_REDEMPTION_LOGGER, AP_REWARDS_COMPRESSOR, AP_ROUTER, AP_RWA_COMPRESSOR, AP_TOKEN_COMPRESSOR, AP_TREASURY, AP_WETH_GATEWAY, AP_WETH_TOKEN, AP_ZAPPER_REGISTER, AP_ZERO_PRICE_FEED, AbstractLPPriceFeedContract, AbstractPriceFeedContract, AbstractWithdrawalCompressorContract, AccountBotsService, AddressMap, AddressProviderV310Contract, AddressSet, AssetsMap, BLOCKS_PER_WEEK_BY_NETWORK, BalancerStablePriceFeedContract, BalancerWeightedPriceFeedContract, BaseContract, BasePlugin, BigIntMath, BotPermissions, BoundedPriceFeedContract, ChainContractsRegister, ChainNotConfiguredError, CompositePriceFeedContract, Construct, ContractParseError, CreditAccountCompressor, CreditAccountCompressorV310Contract, CreditAccountOperationsService, CreditAccountsServiceV310, CreditConfiguratorV310Contract, CreditFacadeV310BaseContract, CreditFacadeV310Contract, CreditManagerV310Contract, CreditSuite, CurveCryptoPriceFeedContract, CurveStablePriceFeedContract, CurveUSDPriceFeedContract, DELAYED_INTENT_TYPES, DELAYED_INTENT_VERSION, DUST_THRESHOLD, Erc4626PriceFeedContract, ExternalPriceFeedContract, GaugeContract, IERC20ZapperContract, IETHZapperContract, InvalidDelayedIntentError, LEVERAGE_DECIMALS, LIQUIDATION_APPROVAL_BUFFER, LIQUIDATION_COMPRESSOR_V313_ADDRESS, LinearInterestRateModelContract, LiquidationsService, MAX_INT, MAX_UINT16, MAX_UINT256, MIN_INT96, MULTICALL_ADDRESS, MarketRegister, MarketSuite, MellowLRTPriceFeedContract, MidasLiquidatorContract, MissingSerializedParamsError, MultichainConstruct, MultichainLiquidationsService, MultichainOpportunitiesService, MultichainPositionsService, MultichainSDK, NATIVE_ADDRESS, NOT_DEPLOYED, NO_VERSION, NetworkType, OnchainSDK, OpportunitiesService, PARTIAL_LIQUIDATION_BUFFER_BPS, PERCENTAGE_DECIMALS, PERCENTAGE_FACTOR, PERCENTAGE_FACTOR_1KK, PERIPHERY_CONTRACTS, PHANTOM_TOKEN_CONTRACT_TYPES, PHANTOM_TOKEN_MIDAS_REDEMPTION, PHANTOM_TOKEN_SECURITIZE_REDEMPTION, PRICE_DECIMALS, PRICE_DECIMALS_POW, PartialPriceFeedInitError, PendleTWAPPTPriceFeed, PeripheryCompressorV310Contract, PlaceholderAdapterContract, PlaceholderContract, PluginStateVersionError, PoolService, PoolSuite, PoolV310Contract, PositionsService, PriceFeedRef, PriceFeedRegister, PriceOracleV310Contract, PythPriceFeed, RAMP_DURATION_BY_NETWORK, RAY, RAY_DECIMALS_POW, RWARegistry, RWA_FACTORY_SECURITIZE, RWA_FACTORY_TYPES, RWA_LIQUIDATOR_MIDAS, RWA_LIQUIDATOR_SECURITIZE, RWA_ON_DEMAND_LP_MONOPOLIZED, RWA_UNDERLYING_DEFAULT, RWA_UNDERLYING_ON_DEMAND, RedemptionLoggerV310Contract, RedstonePriceFeedContract, RouterV310Contract, SDKConstruct, SECONDS_PER_YEAR, SECURITIZE_REGISTER_VAULT_TYPES, SLIPPAGE_DECIMALS, STATE_VERSION, SUPPORTED_NETWORKS, SdkAlreadyAttachedError, SdkChainMismatchError, SdkMissingChainStateError, SdkNotAttachedError, SdkStateVersionMismatchError, SdkSyncFailedError, SecuritizeLiquidatorContract, SecuritizeRWAFactory, SimulateWithPriceUpdatesError, SimulationError, TokensMeta, TypedObjectUtils, UnsupportedZapperFunctionError, VERSION_RANGE_310, VotingContractStatus, WAD, WAD_DECIMALS_POW, WithdrawalCompressorV310Contract, WithdrawalCompressorV311Contract, WithdrawalCompressorV313Contract, WstETHPriceFeedContract, YearnPriceFeedContract, ZapperContract, ZeroPriceFeedContract, ZodAddress, ZodBigInt, ZodHex, additionalBorrowApyBps, assetsMap, attachOptionsSchema, borrowApyBps, botPermissionsToString, bytes32ToString, chains, childLogger, createAdapter, createAddressProvider, createPriceOracle, createRawTx, createRedemptionLogger, createRouter, createWithdrawalCompressor, createZapper, abi as creditFacadeV310Abi, decodeDelayedIntent, detectNetwork, dominantCollateral, encodeDelayedIntent, estimateRawTxGas, etherscanApiUrl, etherscanUrl, executeDelegatedMulticalls, executeMulticallBatches, expectedBalanceDeltas, fetchRedstonePayloads, filterDust, filterDustUSD, findCuratorMarketConfigurator, fmtBinaryMask, formatBN, formatBNvalue, formatDuration, formatLeverage, formatNumberToString_, formatPercentage, formatTimestamp, functionArgsToMap, functionArgsToRecord, generateCastTraceCall, getAssetType, getCastTraceArgs, getChain, getCuratorName, getFunctionSignature, getNetworkType, getRawPriceUpdates, getSimulateWithPriceUpdatesError, getWithdrawalCompressorAddress, halfRAY, healthFactorBps, hexEq, hydrateAddressProvider, iCreditAccountAbi, isDust, isLPPriceFeed, isPublicNetwork, isRWAFactory, isRWAToken, isSunsetPool, isSunsetStrategy, isSupportedNetwork, isUpdatablePriceFeed, isV310, isVersionRange, json_parse, json_stringify, maxLeverage, minSeizedAmount, mustGetDominantCollateral, numberWithCommas, onchainSDKOptionsSchema, optimalHFForPartialLiquidation, optimalRepaidAmount, percentFmt, positionLeverage, primaryInstantOutput, rayToBps, rayToNumber, retry, sendRawTx, shortAddress, shortHash, simulateCall, simulateMulticall, simulateWithPriceUpdates, toAddress, toBN, toBigInt, toChainIds, toClaimableWithdrawal, toPendingWithdrawal, toRequestableWithdrawal, toSignificant, toWithdrawalStatus, usdToNumber, utilizationBps, watchBlocksAsync };