@steerprotocol/sdk 4.0.0-next.2 → 4.0.0-next.4

package/dist/index.mjs

@@ -2062,6 +2062,7 @@ var AerodromeSlipstreamAdapter = class extends AmmAdapter {
 			blockNumber: context.blockNumber,
 			...captured.account ? { account: captured.account } : {}
 		});
+		if (result[1] <= sqrtRatioAtTick(-887272) + 1n || result[1] >= sqrtRatioAtTick(887272) - 1n) throw new Error("Slipstream quote reached the price limit; full input consumption is not established");
 		return Object.freeze({
 			amountIn: input.amountIn,
 			amountOut: result[0]
@@ -2102,6 +2103,9 @@ var SteerDataAdapter = class extends DataAdapter {
 	async listUserVaults(_request, _options) {
 		throw new Error("User vault discovery is not configured for this data adapter");
 	}
+	async getVaultMetadata(_addresses, _options) {
+		throw new Error("Vault metadata is not configured for this data adapter");
+	}
 };
 //#endregion
 //#region src/data/subgraph.ts
@@ -7742,6 +7746,7 @@ var RpcUniswapV3Adapter = class RpcUniswapV3Adapter extends UniswapV3Adapter {
 			fee: pool.fee,
 			sqrtPriceLimitX96: 0n
 		}]);
+		if (result[1] <= sqrtRatioAtTick(-887272) + 1n || result[1] >= sqrtRatioAtTick(887272) - 1n) throw new Error("V3 quote reached the price limit; full input consumption is not established");
 		return {
 			amountIn: request.amountIn,
 			amountOut: result[0]
@@ -11398,6 +11403,50 @@ var DeploymentRegistry = class {
 	}
 };
 //#endregion
+//#region src/vault/metadata.ts
+function nullableString(value) {
+	if (value === null || typeof value === "string") return value;
+	throw new Error("Malformed vault metadata string");
+}
+/** Validate and detach indexed data, preserving nulls and optional pool keys. */
+function vaultMetadata(value) {
+	const row = record(value);
+	if (typeof row.beaconName !== "string" || !row.beaconName || typeof row.createdAt !== "string" || !/^\d+$/.test(row.createdAt)) throw new Error("Malformed vault metadata identity");
+	const decimals = nullableString(row.decimals);
+	if (decimals !== null && !/^\d+$/.test(decimals)) throw new Error("Malformed vault metadata decimals");
+	const strategy = row.strategyToken === null ? null : record(row.strategyToken);
+	if (strategy !== null && (typeof strategy.id !== "string" || !strategy.id)) throw new Error("Malformed vault strategy token");
+	return Object.freeze({
+		id: indexedAddress(row.id),
+		name: nullableString(row.name),
+		symbol: nullableString(row.symbol),
+		decimals,
+		beaconName: row.beaconName,
+		createdAt: row.createdAt,
+		state: nullableString(row.state),
+		pool: row.pool === null ? null : indexedAddress(row.pool, true),
+		...row.poolKey === void 0 ? {} : { poolKey: nullableString(row.poolKey) },
+		token0: row.token0 === null ? null : indexedAddress(row.token0, true),
+		token1: row.token1 === null ? null : indexedAddress(row.token1, true),
+		payloadIpfs: nullableString(row.payloadIpfs),
+		strategyToken: strategy === null ? null : Object.freeze({ id: String(strategy.id) })
+	});
+}
+/** Validate and detach caller-owned metadata before any asynchronous resolution. */
+function captureVaultMetadata(addresses, values) {
+	if (!Array.isArray(values)) throw new Error("Supplied vault metadata must be an array");
+	const requested = new Set(addresses.map((address) => address.toLowerCase()));
+	const records = /* @__PURE__ */ new Map();
+	for (const value of values) {
+		const metadata = vaultMetadata(value);
+		if (!requested.has(metadata.id)) throw new Error(`Supplied vault metadata contains an unrequested address: ${metadata.id}`);
+		if (records.has(metadata.id)) throw new Error(`Supplied vault metadata contains a duplicate address: ${metadata.id}`);
+		records.set(metadata.id, metadata);
+	}
+	for (const address of requested) if (!records.has(address)) throw new Error(`Supplied vault metadata is missing address: ${address}`);
+	return records;
+}
+//#endregion
 //#region src/vault/resolver-types.ts
 let ProtocolContractRole = /* @__PURE__ */ function(ProtocolContractRole) {
 	ProtocolContractRole["AmmFactory"] = "amm-factory";
@@ -11785,18 +11834,25 @@ async function filterVaultsByFactory(context, vaults, factory, blockNumber) {
 //#endregion
 //#region src/vault/data-adapter.ts
 const nonShareBeacons = ["ScheduledJobs", "DynamicJobs"];
-const vaultsQuery = `query Vaults($first: Int!, $where: Vault_filter!, $block: Int!) {
+const metadataFields = `id name symbol decimals beaconName createdAt state pool poolKey token0 token1 payloadIpfs strategyToken { id }`;
+const metadataQuery = `query VaultMetadata($ids: [ID!]!, $first: Int!) {
+  vaults(first: $first, orderBy: id, orderDirection: asc, where: {id_in: $ids}) { ${metadataFields} }
+  _meta { ${metaFields} }
+}`;
+const vaultsQuery = (balances) => `query Vaults($first: Int!, $where: Vault_filter!, $block: Int!) {
   vaults(first: $first, orderBy: id, orderDirection: asc, where: $where, block: {number: $block}) {
-    id beaconName token0 token1 token0Symbol token1Symbol token0Name token1Name
+    ${balances ? "id beaconName token0 token1" : metadataFields}
+    token0Symbol token1Symbol token0Name token1Name
   }
   _meta(block: {number: $block}) { ${metaFields} }
 }`;
 function matchesToken(row, token, side) {
-	const address = indexedAddress(row[`token${side}`]);
+	if (row[`token${side}`] === null) return false;
+	const address = indexedAddress(row[`token${side}`], true);
 	const symbol = row[`token${side}Symbol`];
 	const name = row[`token${side}Name`];
-	if (typeof symbol !== "string" || typeof name !== "string") throw new Error("Malformed vault token metadata");
-	return (!token.address || token.address === address) && (!token.symbol || symbol.toLowerCase().includes(token.symbol)) && (!token.name || name.toLowerCase().includes(token.name));
+	if (symbol !== null && typeof symbol !== "string" || name !== null && typeof name !== "string") throw new Error("Malformed vault token metadata");
+	return (!token.address || token.address === address) && (!token.symbol || typeof symbol === "string" && symbol.toLowerCase().includes(token.symbol)) && (!token.name || typeof name === "string" && name.toLowerCase().includes(token.name));
 }
 function vaultFilter(token, after, beacons, balances) {
 	const base = {
@@ -11885,7 +11941,7 @@ var CatalogSteerDataAdapter = class extends SteerDataAdapter {
 			...cursor === void 0 ? {} : { cursor },
 			limit: input.limit ?? 1e3
 		}, options, true);
-		const items = await scanVaultBalances(this.#context, page.items, input.account, page.indexedBlock);
+		const items = await scanVaultBalances(this.#context, page.items.map((row) => indexedAddress(row.id)), input.account, page.indexedBlock);
 		return Object.freeze({
 			items,
 			indexedBlock: page.indexedBlock,
@@ -11896,9 +11952,44 @@ var CatalogSteerDataAdapter = class extends SteerDataAdapter {
 			}) } : {}
 		});
 	}
+	async #metadataQuery(query, variables, options) {
+		try {
+			return await this.#query(query, variables, options);
+		} catch (error) {
+			const errors = error instanceof Error ? error.cause : void 0;
+			if (!query.includes("poolKey") || !Array.isArray(errors) || !errors.length || !errors.every((value) => typeof value?.message === "string" && /^Cannot query field "poolKey" on type "Vault"\.(?: Did you mean .*\?)?$/.test(value.message))) throw error;
+			return this.#query(query.replace(/\bpoolKey\b/g, ""), variables, options);
+		}
+	}
+	async getVaultMetadata(addresses, options = {}) {
+		const ids = addresses.map((address) => indexedAddress(address));
+		const unique = [...new Set(ids)];
+		if (!unique.length) return Object.freeze([]);
+		if (unique.length > 1e3) throw new Error("Vault metadata lookup supports at most 1000 addresses");
+		const data = await this.#metadataQuery(metadataQuery, {
+			ids: unique,
+			first: unique.length
+		}, options);
+		snapshot(data);
+		if (!Array.isArray(data.vaults) || data.vaults.length > unique.length) throw new Error("Malformed vault metadata response");
+		const records = /* @__PURE__ */ new Map();
+		for (const value of data.vaults) {
+			const metadata = vaultMetadata(value);
+			if (!unique.includes(metadata.id) || records.has(metadata.id)) throw new Error("Unexpected or duplicate vault metadata");
+			records.set(metadata.id, metadata);
+		}
+		return Object.freeze(ids.map((id) => {
+			const metadata = records.get(id);
+			if (!metadata) throw new Error("Vault metadata is not indexed");
+			return metadata;
+		}));
+	}
 	async listVaults(request = {}, options = {}) {
-		const { indexedBlock: _, ...page } = await this.#listVaults(request, options, false);
-		return Object.freeze(page);
+		const { indexedBlock: _, items, ...page } = await this.#listVaults(request, options, false);
+		return Object.freeze({
+			...page,
+			items: Object.freeze(items.map(vaultMetadata))
+		});
 	}
 	async #listVaults(request = {}, options = {}, balances = false) {
 		const limit = request.limit ?? 100;
@@ -11931,7 +12022,7 @@ var CatalogSteerDataAdapter = class extends SteerDataAdapter {
 			} });
 		} else expected = snapshot(await this.#query(snapshotQuery, {}, options));
 		const beacons = amm ? this.#beacons.get(amm) : void 0;
-		const data = await this.#query(vaultsQuery, {
+		const data = await this.#metadataQuery(vaultsQuery(balances), {
 			first: limit,
 			where: vaultFilter(token, after, beacons, balances),
 			block: expected.block
@@ -11948,13 +12039,15 @@ var CatalogSteerDataAdapter = class extends SteerDataAdapter {
 			if (balances && (typeof row.beaconName !== "string" || nonShareBeacons.includes(row.beaconName))) throw new Error("User vault listing returned a non-share deployment");
 			if (beacons && (typeof row.beaconName !== "string" || !beacons.includes(row.beaconName))) throw new Error("Vault listing does not match the AMM beacon mapping");
 			if (token && !matchesToken(row, token, 0) && !matchesToken(row, token, 1)) throw new Error("Vault listing does not match the token filter");
-			return address;
+			if (!balances) vaultMetadata(row);
+			return row;
 		});
-		const last = items.at(-1);
+		const last = items.at(-1)?.id;
 		const factory = amm ? this.#factories.get(amm) : void 0;
-		const filtered = factory ? await filterVaultsByFactory(this.#context, items, factory, BigInt(expected.block)) : items;
+		const filtered = factory ? await filterVaultsByFactory(this.#context, items.map((row) => indexedAddress(row.id)), factory, BigInt(expected.block)) : items.map((row) => indexedAddress(row.id));
+		const included = new Set(filtered);
 		return Object.freeze({
-			items: Object.freeze(filtered),
+			items: Object.freeze(items.filter((row) => included.has(indexedAddress(row.id)))),
 			indexedBlock: BigInt(expected.block),
 			...items.length === limit && last ? { nextCursor: JSON.stringify({
 				version: 1,
@@ -13758,10 +13851,13 @@ var SteerVault = class {
 	chain;
 	steer;
 	underlying;
-	constructor(address, chain, steer, underlying) {
+	metadata;
+	constructor(address, chain, steer, underlying, metadata) {
 		this.address = address;
 		this.chain = chain;
 		this.steer = steer;
+		this.metadata = vaultMetadata(metadata);
+		if (this.metadata.id !== address.toLowerCase()) throw new Error("Vault metadata belongs to another vault");
 		this.underlying = Object.freeze([...underlying]);
 	}
 };
@@ -14423,7 +14519,7 @@ var AerodromeVault = class extends LiquidityVault {
 	#positionManager;
 	/** @internal */
 	constructor(context, identity) {
-		super(context.address, context.steer.context, context.steer, context.underlying);
+		super(context.address, context.steer.context, context.steer, context.underlying, context.metadata);
 		const underlying = context.underlying[0];
 		if (context.underlying.length !== 1 || underlying?.kind !== "liquidity" || !(underlying.amm instanceof AerodromeSlipstreamAdapter) || typeof underlying.pool !== "string") identityMismatch("Expected one Aerodrome vault pool");
 		requireAddress(underlying.pool);
@@ -14527,6 +14623,7 @@ async function readAerodromeBulkSnapshot(vault, data, rpc, beacon) {
 		steer: vault.steer,
 		address: vault.address,
 		underlying: vault.underlying,
+		metadata: vault.metadata,
 		blockNumber: rpc.blockNumber
 	}, identity, {
 		raw: decodeAerodromeSnapshot(data),
@@ -15566,6 +15663,7 @@ async function readIntegralBulkSnapshot(vault, data, rpc) {
 		steer: vault.steer,
 		address: vault.address,
 		underlying: vault.underlying,
+		metadata: vault.metadata,
 		blockNumber: rpc.blockNumber
 	}, {
 		raw,
@@ -15579,7 +15677,7 @@ var AlgebraIntegralVault = class extends LiquidityVault {
 	amm;
 	pool;
 	constructor(context) {
-		super(context.address, context.steer.context, context.steer, context.underlying);
+		super(context.address, context.steer.context, context.steer, context.underlying, context.metadata);
 		const underlying = context.underlying[0];
 		if (context.underlying.length !== 1 || underlying?.kind !== "liquidity" || !isAlgebraIntegralAdapter(underlying.amm) || typeof underlying.pool !== "string") identityMismatch("Expected one Integral vault pool");
 		requireAddress(underlying.pool);
@@ -17178,6 +17276,7 @@ async function readV3BulkSnapshot(vault, data, rpc) {
 		steer: vault.steer,
 		address: vault.address,
 		underlying: vault.underlying,
+		metadata: vault.metadata,
 		blockNumber: rpc.blockNumber
 	}, {
 		raw,
@@ -17191,7 +17290,7 @@ var UniswapV3Vault = class extends LiquidityVault {
 	amm;
 	pool;
 	constructor(context) {
-		super(context.address, context.steer.context, context.steer, context.underlying);
+		super(context.address, context.steer.context, context.steer, context.underlying, context.metadata);
 		const underlying = context.underlying[0];
 		if (context.underlying.length !== 1 || underlying?.kind !== "liquidity" || !isUniswapV3Adapter(underlying.amm) || typeof underlying.pool !== "string") identityMismatch("Expected one V3 vault pool");
 		requireAddress(underlying.pool);
@@ -18824,7 +18923,7 @@ var UniswapV4Vault = class extends LiquidityVault {
 	amm;
 	pool;
 	constructor(context) {
-		super(context.address, context.steer.context, context.steer, context.underlying);
+		super(context.address, context.steer.context, context.steer, context.underlying, context.metadata);
 		const underlying = context.underlying[0];
 		if (context.underlying.length !== 1 || underlying?.kind !== "liquidity" || !(underlying.amm instanceof UniswapV4Adapter) || !isLiquidityPool(underlying.pool) || typeof underlying.pool === "string") identityMismatch("Expected one standalone V4 vault pool");
 		this.amm = underlying.amm;
@@ -20204,6 +20303,7 @@ async function readLegacyBulkSnapshot(vault, data, rpc, beacon) {
 		steer: vault.steer,
 		address: vault.address,
 		underlying: vault.underlying,
+		metadata: vault.metadata,
 		blockNumber: rpc.blockNumber
 	}, {
 		raw,
@@ -20217,7 +20317,7 @@ var AlgebraLegacyVault = class extends LiquidityVault {
 	amm;
 	pool;
 	constructor(context) {
-		super(context.address, context.steer.context, context.steer, context.underlying);
+		super(context.address, context.steer.context, context.steer, context.underlying, context.metadata);
 		const underlying = context.underlying[0];
 		if (context.underlying.length !== 1 || underlying?.kind !== "liquidity" || !isAlgebraLegacyAdapter(underlying.amm) || typeof underlying.pool !== "string") identityMismatch("Expected one Legacy vault pool");
 		requireAddress(underlying.pool);
@@ -20824,7 +20924,7 @@ var VaultResolver = class {
 		if (!vault) throw new Error("Missing resolved vault");
 		return vault;
 	}
-	async #createVault(context, identity, verified) {
+	async #createVault(context, identity, loadMetadata, verified) {
 		const { steer, address } = context;
 		if (!identity) throw new VaultResolutionError("not-registered", "Vault is not registered with Steer");
 		if (identity.chainId !== steer.context.chainId || addressKey(identity.vaultAddress) !== addressKey(address) || addressKey(identity.registryAddress) !== addressKey(steer.contracts.VaultRegistry.address) || addressKey(identity.beaconAddress) !== addressKey(identity.proxyBeaconAddress)) throw new VaultResolutionError("identity-mismatch", "Vault identity does not match the request");
@@ -20836,9 +20936,12 @@ var VaultResolver = class {
 			lending: /* @__PURE__ */ new Map()
 		};
 		const resolvedUnderlying = Object.freeze(underlying.map((position) => this.#resolveUnderlying(position, adapters)));
+		const metadata = await loadMetadata();
+		if (metadata.id.toLowerCase() !== address.toLowerCase()) throw new Error("Vault metadata belongs to another vault");
 		const resolved = Object.freeze({
 			...context,
-			underlying: resolvedUnderlying
+			underlying: resolvedUnderlying,
+			metadata
 		});
 		const vault = binding.createVault(resolved);
 		this.#validateVault(vault, binding, resolved);
@@ -20858,21 +20961,39 @@ var VaultResolver = class {
 			steer: vault.steer,
 			address: vault.address,
 			underlying: vault.underlying,
+			metadata: vault.metadata,
 			blockNumber
 		});
 		if (snapshot.blockNumber !== blockNumber || !vault.underlying.some((position) => position.kind === "liquidity" && sameLiquidityPool(position.pool, snapshot.pool))) throw new Error("Vault returned another accounting snapshot");
 		return readValidatedVaultSnapshot(vault, snapshot, vault.steer.context);
 	}
+	#metadata(steer, addresses, supplied) {
+		let pending;
+		return async (address) => {
+			if (supplied) {
+				const metadata = supplied.get(address.toLowerCase());
+				if (!metadata) throw new Error(`Supplied vault metadata is missing address: ${address}`);
+				return metadata;
+			}
+			pending ??= steer.dataAdapter.getVaultMetadata(addresses);
+			const metadata = (await pending).find((record) => record.id.toLowerCase() === address.toLowerCase());
+			if (!metadata) throw new Error("Vault metadata is not indexed");
+			return metadata;
+		};
+	}
 	/** Bounded bulk identity pages at one block; compatibility uses four active loads. */
 	async resolveMany(steer, addresses, options) {
 		const inputs = [...addresses];
 		for (const address of inputs) addressKey(address);
+		const supplied = options?.metadata;
+		const metadata = supplied === void 0 ? void 0 : captureVaultMetadata(inputs, supplied);
 		if (!inputs.length) return Object.freeze([]);
 		const blockNumber = await this.#blockNumber(steer, options);
 		const result = [];
 		let bulkSupported = !!this.#reader.readMany;
 		for (let start = 0; start < inputs.length; start += 64) {
 			const batch = inputs.slice(start, start + 64);
+			const loadMetadata = this.#metadata(steer, batch, metadata);
 			const contexts = batch.map((address) => Object.freeze({
 				steer,
 				address,
@@ -20884,13 +21005,13 @@ var VaultResolver = class {
 				for (const [i, context] of contexts.entries()) {
 					const read = reads[i];
 					if (!read) throw new VaultResolutionError("identity-mismatch", "Missing bulk vault identity");
-					result.push((await this.#createVault(context, read.identity, read)).vault);
+					result.push((await this.#createVault(context, read.identity, () => loadMetadata(context.address), read)).vault);
 				}
 			} else {
 				bulkSupported = false;
 				for (let i = 0; i < batch.length; i += 4) result.push(...await Promise.all(contexts.slice(i, i + 4).map(async (context) => {
 					const identity = await this.#reader.readIdentity(context);
-					return (await this.#createVault(context, identity)).vault;
+					return (await this.#createVault(context, identity, () => loadMetadata(context.address))).vault;
 				})));
 			}
 		}
@@ -20906,6 +21027,7 @@ var VaultResolver = class {
 		let bulkSupported = !!this.#reader.readSnapshots;
 		for (let start = 0; start < inputs.length; start += 16) {
 			const batch = inputs.slice(start, start + 16);
+			const loadMetadata = this.#metadata(steer, batch);
 			const contexts = batch.map((address) => Object.freeze({
 				steer,
 				address,
@@ -20917,7 +21039,7 @@ var VaultResolver = class {
 				for (const [i, context] of contexts.entries()) {
 					const read = reads[i];
 					if (!read) throw new Error("Missing bulk vault snapshot");
-					const { vault } = await this.#createVault(context, read.identity, read);
+					const { vault } = await this.#createVault(context, read.identity, () => loadMetadata(context.address), read);
 					if (vault.kind !== "liquidity") throw new VaultResolutionError("invalid-vault", "Vault does not support liquidity snapshots");
 					result.push(await read.readSnapshot(vault));
 				}
@@ -20930,7 +21052,7 @@ var VaultResolver = class {
 						blockNumber
 					});
 					const identity = await this.#reader.readIdentity(context);
-					const { vault, binding, context: resolved } = await this.#createVault(context, identity);
+					const { vault, binding, context: resolved } = await this.#createVault(context, identity, () => loadMetadata(context.address));
 					if (vault.kind !== "liquidity") throw new VaultResolutionError("invalid-vault", "Vault does not support liquidity snapshots");
 					if (!binding.readSnapshot) throw new VaultResolutionError("not-configured", "No verified snapshot reader configured for vault implementation");
 					const snapshot = await binding.readSnapshot(resolved);
@@ -21028,7 +21150,10 @@ var SteerNetwork = class {
 		return this.#vaultResolver().resolve(this, address, options);
 	}
 	async getVaults(addresses, options) {
-		if (!addresses.length) return Object.freeze([]);
+		if (!addresses.length) {
+			if (options?.metadata !== void 0) captureVaultMetadata(addresses, options.metadata);
+			return Object.freeze([]);
+		}
 		return this.#vaultResolver().resolveMany(this, addresses, options);
 	}
 	getVaultSnapshots(addresses, options) {