@secondlayer/subgraphs 3.22.0 → 3.23.1

package/dist/src/runtime/context.d.ts

@@ -1,3 +1,62 @@
+import { UnwrapResponse } from "@secondlayer/stacks/actions";
+import { AbiContract, ExtractFunctionArgs, ExtractFunctionOutput, ExtractReadOnlyFunctions, ToCamelCase } 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
+};
+/**
+* The chain-read surface, fully typed by an ABI.
+*
+* Shaped like `getContract` from `@secondlayer/stacks` — the same ABI in, the
+* same camelCased read methods out — minus `call`/`buildCall`: a handler
+* indexes the chain, it never writes to it.
+*
+* Reached through {@link readContractAt} rather than off `ctx.client`
+* directly: an ABI-generic method living on the context interface makes every
+* structural comparison of a subgraph definition instantiate it, which exceeds
+* TS's depth budget. At a call site the ABI is already concrete and it costs
+* nothing.
+*/
+interface ChainReadClient {
+	/**
+	* Read-only methods of a contract, evaluated against the exact block being
+	* processed.
+	*
+	* Every call is pinned to the block's `index_block_hash`, so a handler is a
+	* pure function of its block: reindexing a range produces byte-identical
+	* rows. Reading at the node's tip instead would make the same reindex
+	* return different values — that is the corruption this refuses to allow,
+	* so a block whose id was never persisted throws rather than falling back.
+	*
+	* Results are memoized in Postgres, so a value is fetched once per block
+	* rather than once per event (or once per contract with
+	* `cache: "contract-constant"`).
+	*/
+	contract<const C extends AbiContract>(contractId: string, abi: C, options?: ChainReadOptions): {
+		read: ChainReadMethods<C>
+	};
+}
+/**
+* The camelCased read methods of an ABI. Spelled out rather than reused from
+* `ContractInstance<C>["read"]`: that type is a conditional over the codegen
+* brand, and evaluating it wherever a subgraph definition is structurally
+* compared pushes TS past its instantiation depth.
+*/
+type ChainReadMethods<C extends AbiContract> = { [N in ExtractReadOnlyFunctions<C> as ToCamelCase<N>] : (args: ExtractFunctionArgs<C, N>) => Promise<UnwrapResponse<ExtractFunctionOutput<C, N>>> };
 /** Supported column types for subgraph schemas */
 type ColumnType = "text" | "uint" | "int" | "principal" | "boolean" | "timestamp" | "jsonb";
 /** Column definition in a subgraph table */
@@ -49,9 +108,9 @@ type SubgraphSchema = Record<string, SubgraphTable>;
 type RowValue = string | number | bigint | boolean | null | undefined | Record<string, unknown> | unknown[];
 /** Value or computed function that receives existing row */
 type ComputedValue = RowValue | ((existing: Record<string, unknown> | null) => unknown);
-import { Database } from "@secondlayer/shared/db";
-import { Kysely, Transaction } from "kysely";
-type AnyDb = Kysely<Database> | Transaction<Database>;
+import { Database as Database2 } from "@secondlayer/shared/db";
+import { Kysely as Kysely2, Transaction } from "kysely";
+type AnyDb = Kysely2<Database2> | Transaction<Database2>;
 /** Reorg journal entries older than this many blocks are prunable — far past
 *  Stacks finality (observed reorg depth is single digits). */
 declare const JOURNAL_RETENTION_BLOCKS = 300;
@@ -83,6 +142,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;
@@ -127,7 +193,15 @@ declare class SubgraphContext2 {
 	* journal would just be churn the pruner deletes.
 	*/
 	private readonly journal;
+	/** Memoized per block; see the `client` getter. */
+	protected _client?: ChainReadClient;
 	constructor(db: AnyDb, pgSchemaName: string, subgraphSchema: SubgraphSchema, block: BlockMeta, tx: TxMeta2, byo?: boolean, journal?: boolean);
+	/**
+	* Chain reads pinned to THIS block. Lazily built so a handler that never
+	* reads never touches the node config, and so the in-memory test context
+	* can override it without a node.
+	*/
+	get client(): ChainReadClient;
 	get tx(): TxMeta2;
 	/** Update the current transaction context (used by runner between events) */
 	setTx(tx: TxMeta2): void;

package/dist/src/runtime/context.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;
   }
@@ -736,5 +877,5 @@ export {
   JOURNAL_RETENTION_BLOCKS
 };
 
-//# debugId=52F456C4AF4B631864756E2164756E21
+//# debugId=943E34F234EEBFC564756E2164756E21
 //# sourceMappingURL=context.js.map