@secondlayer/subgraphs 3.22.0 → 3.23.0

package/dist/src/testing/index.d.ts

@@ -1,4 +1,32 @@
-import { AbiContract } from "@secondlayer/stacks/clarity";
+import { AbiContract as AbiContract2 } from "@secondlayer/stacks/clarity";
+/**
+* How long a read stays valid.
+*
+* - `per-block` (default): pinned to the block being processed, cached under
+*   its `index_block_hash`. Sound for any read-only function — reindexing the
+*   same block always returns the same value, and a reorg-replaced block has a
+*   different id so it can't inherit the orphaned answer.
+* - `contract-constant`: the caller asserts the value cannot change for this
+*   contract and these args (SIP-010 `get-decimals`/`get-symbol`), so it is
+*   resolved ONCE instead of once per block. This is the mode that makes a
+*   backfill affordable — under `per-block` every block is a distinct key and
+*   therefore a distinct RPC. Declaring it on a value that does change pins the
+*   first answer forever, so it is opt-in and never inferred.
+*/
+type ChainReadCacheMode = "per-block" | "contract-constant";
+type ChainReadOptions = {
+	cache?: ChainReadCacheMode
+};
+/**
+* `ChainReadClient` with the ABI generic erased. Structurally cheap, so the
+* base `SubgraphContext` can carry it; `TypedSubgraphContext` uses the real
+* one and handlers get full inference.
+*/
+interface ErasedChainReadClient {
+	contract(contractId: string, abi: unknown, options?: ChainReadOptions): {
+		read: Record<string, (args?: Record<string, unknown>) => Promise<unknown>>
+	};
+}
 /** Supported column types for subgraph schemas */
 type ColumnType = "text" | "uint" | "int" | "principal" | "boolean" | "timestamp" | "jsonb";
 /** Column definition in a subgraph table */
@@ -216,7 +244,7 @@ interface ContractCallFilter extends TraitScope, FactoryScope {
 	* definition and used at runtime to decode args by name. Omit to keep
 	* `event.args` as a positional `unknown[]`.
 	*/
-	abi?: AbiContract;
+	abi?: AbiContract2;
 }
 interface ContractDeployFilter {
 	type: "contract_deploy";
@@ -285,6 +313,13 @@ interface BlockMeta {
 	hash: string;
 	timestamp: number;
 	burnBlockHeight: number;
+	/**
+	* Nakamoto StacksBlockId — the identifier `?tip=` accepts, and the only way
+	* to pin a read-only call to THIS block. Null on rows ingested before it
+	* was persisted; `ctx.client.readOnly` refuses to run rather than silently
+	* reading at the node's tip.
+	*/
+	indexBlockHash?: string | null;
 }
 interface TxMeta2 {
 	txId: string;
@@ -324,7 +359,7 @@ type EventRecord = {
 * Returns the payload the handler will receive.
 */
 declare function buildEventPayload(filter: SubgraphFilter, tx: MatchedTx["tx"], event: MatchedTx["events"][0] | null): Record<string, unknown>;
-import { AbiContract as AbiContract2, ExtractFunctionArgs, ExtractFunctionNames } from "@secondlayer/stacks/clarity";
+import { AbiContract as AbiContract3, ExtractFunctionArgs as ExtractFunctionArgs2, ExtractFunctionNames } from "@secondlayer/stacks/clarity";
 /** Maps a ColumnType string literal to its TypeScript equivalent */
 type ColumnToTS<T extends string> = T extends "uint" | "int" ? bigint : T extends "text" | "principal" | "timestamp" ? string : T extends "boolean" ? boolean : T extends "jsonb" ? Record<string, unknown> : unknown;
 /** Infer TS type for a single column definition, respecting nullable */
@@ -396,8 +431,17 @@ interface TypedSubgraphContext<S extends SubgraphSchema> {
 		hash: string
 		timestamp: number
 		burnBlockHeight: number
+		/** Nakamoto StacksBlockId, when the block row carries one. */
+		indexBlockHash?: string | null
 	};
 	tx: TxMeta;
+	/**
+	* Read-only contract calls pinned to this block. Erased here for the same
+	* reason as on `SubgraphContext`: an ABI-generic method on a structurally
+	* compared interface exceeds TS's instantiation budget. Wrap it with
+	* `readContractAt(ctx, id, abi)` for full ABI typing at the call site.
+	*/
+	client: ErasedChainReadClient;
 	insert<T extends TableName<S>>(table: T, row: WriteRow<S[T]>): void;
 	update<T extends TableName<S>>(table: T, where: RowWhere<S, T>, set: Partial<WriteRow<S[T]>>): void;
 	upsert<
@@ -508,10 +552,10 @@ interface ContractDeployPayload {
 * present for back-compat. Without an `abi`, the payload is {@link ContractCallEvent}.
 */
 type ContractCallPayload<F> = F extends {
-	abi: infer A extends AbiContract2
+	abi: infer A extends AbiContract3
 	functionName: infer N extends string
 } ? N extends ExtractFunctionNames<A> ? ContractCallEvent & {
-	input: ExtractFunctionArgs<A, N>
+	input: ExtractFunctionArgs2<A, N>
 } : ContractCallEvent : ContractCallEvent;
 /**
 * Print event typed per topic. When a `print_event` source declares a `prints`
@@ -601,6 +645,9 @@ interface TestSubgraphContext<S extends SubgraphSchema> extends Omit<TypedSubgra
 declare function createTestContext<const S extends SubgraphSchema>(schema: S, options?: {
 	block?: Partial<BlockMeta>
 	tx?: Partial<TxMeta2>
+	/** Stubbed `ctx.client.readOnly` results, keyed
+	*  `"<contractId>.<function-name>"`. */
+	reads?: Record<string, unknown>
 }): TestSubgraphContext<S>;
 /**
 * Build a handler-shaped event payload for a source, typed by that source's

package/dist/src/testing/index.js

@@ -145,6 +145,139 @@ function generateSubgraphSQL(def, schemaNameOverride) {
   return { statements, hash };
 }
 
+// src/runtime/chain-read.ts
+import { getSourceDb } from "@secondlayer/shared/db";
+import { http, createPublicClient } from "@secondlayer/stacks";
+import {
+  ContractResponseError,
+  buildFunctionArgs,
+  isResponseOutput,
+  readContract
+} from "@secondlayer/stacks/actions";
+import {
+  clarityValueToJSUntyped,
+  deserializeCV,
+  normalizeAbi,
+  serializeCV,
+  toCamelCase
+} from "@secondlayer/stacks/clarity";
+function readContractAt(ctx, contractId, abi, options) {
+  return ctx.client.contract(contractId, abi, options);
+}
+
+class ChainReadError extends Error {
+  name = "ChainReadError";
+}
+function nodeClient(rpcUrl) {
+  return createPublicClient({
+    transport: http(rpcUrl, { retryCount: 0, timeout: 1e4 })
+  });
+}
+
+class ConcurrencyGate {
+  limit;
+  active = 0;
+  queue = [];
+  constructor(limit) {
+    this.limit = limit;
+  }
+  async run(fn) {
+    if (this.active >= this.limit) {
+      await new Promise((resolve) => this.queue.push(resolve));
+    }
+    this.active++;
+    try {
+      return await fn();
+    } finally {
+      this.active--;
+      this.queue.shift()?.();
+    }
+  }
+}
+var DEFAULT_MAX_CONCURRENT_READS = 4;
+function maxConcurrentReads() {
+  const raw = process.env.SUBGRAPH_CHAIN_READ_CONCURRENCY;
+  const parsed = raw ? Number.parseInt(raw, 10) : Number.NaN;
+  return Number.isFinite(parsed) && parsed > 0 ? parsed : DEFAULT_MAX_CONCURRENT_READS;
+}
+var gate = new ConcurrencyGate(maxConcurrentReads());
+function hashArgs(args) {
+  const serialized = args.map((arg) => serializeCV(arg)).join(",");
+  return Bun.hash(serialized).toString(16);
+}
+function findFunction(abi, name) {
+  const fn = abi.functions.find((f) => f.name === name);
+  if (!fn) {
+    throw new ChainReadError(`No function "${name}" in the supplied ABI.`);
+  }
+  if (fn.access !== "read-only") {
+    throw new ChainReadError(`"${name}" is ${fn.access}, not read-only — a handler cannot call it.`);
+  }
+  return fn;
+}
+function createChainReadClient(ctx) {
+  const readValue = async (contractId, abi, functionName, args, options) => {
+    const rpcUrl = ctx.rpcUrl ?? process.env.STACKS_NODE_RPC_URL;
+    if (!rpcUrl) {
+      throw new ChainReadError("ctx.client needs a Stacks node: set STACKS_NODE_RPC_URL on the subgraph processor.");
+    }
+    const constant = options.cache === "contract-constant";
+    if (!constant && !ctx.indexBlockHash) {
+      throw new ChainReadError(`Block ${ctx.blockHeight} has no index_block_hash, so a read cannot be pinned to it. Reading at the node's tip would make this handler non-deterministic (the same reindex would produce different rows). Re-ingest the block, or pass cache: "contract-constant" if the value genuinely cannot change.`);
+    }
+    const fn = findFunction(abi, functionName);
+    const clarityArgs = buildFunctionArgs(fn, args);
+    const db = ctx.db ?? getSourceDb();
+    const argsHash = hashArgs(clarityArgs);
+    const pinnedTo = constant ? null : ctx.indexBlockHash;
+    const cached = await db.selectFrom("chain_read_cache").select("result_hex").where("contract_id", "=", contractId).where("function_name", "=", fn.name).where("args_hash", "=", argsHash).where((eb) => pinnedTo === null ? eb("index_block_hash", "is", null) : eb("index_block_hash", "=", pinnedTo)).executeTakeFirst();
+    const resultHex = cached?.result_hex ?? await gate.run(async () => {
+      const value2 = await readContract(nodeClient(rpcUrl), {
+        contract: contractId,
+        functionName: fn.name,
+        args: clarityArgs,
+        tip: ctx.indexBlockHash ?? undefined
+      });
+      return serializeCV(value2);
+    });
+    if (!cached) {
+      await db.insertInto("chain_read_cache").values({
+        contract_id: contractId,
+        function_name: fn.name,
+        args_hash: argsHash,
+        index_block_hash: pinnedTo,
+        block_height: constant ? null : ctx.blockHeight,
+        result_hex: resultHex
+      }).onConflict((oc) => oc.doNothing()).execute();
+    }
+    const value = deserializeCV(resultHex);
+    const js = clarityValueToJSUntyped(fn.outputs, value);
+    if (isResponseOutput(fn.outputs)) {
+      const response = js;
+      if ("ok" in response)
+        return response.ok;
+      throw new ContractResponseError(`${contractId}::${fn.name} returned an err response.`, response.err);
+    }
+    return js;
+  };
+  return {
+    contract(contractId, rawAbi, options = {}) {
+      const abi = normalizeAbi(rawAbi);
+      const camelToKebab = new Map;
+      for (const fn of abi.functions) {
+        camelToKebab.set(toCamelCase(fn.name), fn.name);
+      }
+      const read = new Proxy({}, {
+        get(_target, prop) {
+          const fnName = camelToKebab.get(prop) ?? prop;
+          return (args = {}) => readValue(contractId, abi, fnName, args, options);
+        }
+      });
+      return { read };
+    }
+  };
+}
+
 // src/runtime/context.ts
 var JOURNAL_RETENTION_BLOCKS = 300;
 var journalEnsured = new Set;
@@ -163,6 +296,7 @@ class SubgraphContext {
   ops = [];
   byo;
   journal;
+  _client;
   constructor(db, pgSchemaName2, subgraphSchema, block, tx, byo = false, journal = false) {
     this.db = db;
     this.pgSchemaName = pgSchemaName2;
@@ -172,6 +306,13 @@ class SubgraphContext {
     this.byo = byo;
     this.journal = journal;
   }
+  get client() {
+    this._client ??= createChainReadClient({
+      blockHeight: this.block.height,
+      indexBlockHash: this.block.indexBlockHash
+    });
+    return this._client;
+  }
   get tx() {
     return this._tx;
   }
@@ -733,11 +874,11 @@ function buildWhereClause(where) {
 }
 
 // src/runtime/clarity.ts
-import { cvToValue, deserializeCV } from "@secondlayer/stacks/clarity";
+import { cvToValue, deserializeCV as deserializeCV2 } from "@secondlayer/stacks/clarity";
 function decodeClarityValue(hex) {
   try {
     const cleanHex = hex.startsWith("0x") ? hex.slice(2) : hex;
-    const cv = deserializeCV(cleanHex);
+    const cv = deserializeCV2(cleanHex);
     return cvToValue(cv);
   } catch {
     return hex;
@@ -768,8 +909,8 @@ import { getErrorMessage } from "@secondlayer/shared";
 import { logger as logger2 } from "@secondlayer/shared/logger";
 import {
   clarityValueToJS,
-  deserializeCV as deserializeCV2,
-  toCamelCase
+  deserializeCV as deserializeCV3,
+  toCamelCase as toCamelCase2
 } from "@secondlayer/stacks/clarity";
 
 // src/runtime/print-validate.ts
@@ -932,7 +1073,7 @@ function buildContractCallInput(filter, tx) {
       return;
     try {
       const clean = hex.startsWith("0x") ? hex.slice(2) : hex;
-      input[toCamelCase(arg.name)] = decodeArg(arg.type, deserializeCV2(clean));
+      input[toCamelCase2(arg.name)] = decodeArg(arg.type, deserializeCV3(clean));
     } catch {}
   });
   return input;
@@ -1210,6 +1351,7 @@ async function runHandlers(subgraph, matched, ctx, opts) {
 }
 
 // src/testing/index.ts
+import { normalizeAbi as normalizeAbi2, toCamelCase as toCamelCase3 } from "@secondlayer/stacks/clarity";
 var TEST_SCHEMA_NAME = "subgraph_test";
 function defaultBlock(overrides = {}) {
   return {
@@ -1244,6 +1386,29 @@ class InMemorySubgraphContext extends SubgraphContext {
   async rowsOf(table) {
     return this.overlayMany(table, {}, await this.readRows(table, {}));
   }
+  setReads(reads) {
+    this._client = {
+      contract(contractId, abi) {
+        const camelToKebab = new Map;
+        for (const fn of normalizeAbi2(abi).functions) {
+          camelToKebab.set(toCamelCase3(fn.name), fn.name);
+        }
+        const read = new Proxy({}, {
+          get(_target, prop) {
+            const fnName = camelToKebab.get(prop) ?? prop;
+            const key = `${contractId}.${fnName}`;
+            return async () => {
+              if (!(key in reads)) {
+                throw new Error(`No stubbed chain read for "${key}" — pass it via createTestContext(schema, { reads: { "${key}": … } }).`);
+              }
+              return reads[key];
+            };
+          }
+        });
+        return { read };
+      }
+    };
+  }
   async commitOps() {
     const tables = new Set;
     for (const op of this.ops)
@@ -1264,6 +1429,7 @@ function sameValue(a, b) {
 }
 function createTestContext(schema, options = {}) {
   const impl = new InMemorySubgraphContext(schema, defaultBlock(options.block), defaultTx(options.tx));
+  impl.setReads(options.reads ?? {});
   const ctx = impl;
   ctx.rows = (table) => impl.rowsOf(table);
   ctx.commit = () => impl.commitOps();
@@ -1293,5 +1459,5 @@ export {
   buildEvent
 };
 
-//# debugId=C4A30CB87BF18B8464756E2164756E21
+//# debugId=FEF5AC4898A3E56764756E2164756E21
 //# sourceMappingURL=index.js.map