@secondlayer/subgraphs 3.11.0 → 3.13.0

package/dist/src/index.d.ts

@@ -206,6 +206,13 @@ interface SubgraphContext {
 	update(table: string, where: Record<string, unknown>, set: Record<string, unknown>): void;
 	upsert(table: string, key: Record<string, unknown>, row: Record<string, unknown>): void;
 	delete(table: string, where: Record<string, unknown>): void;
+	/**
+	* Atomic counter update — the blessed accumulator primitive. Applies
+	* `col = COALESCE(col, 0) + delta` per column (insert-or-add); deltas may
+	* be negative. Requires a uniqueKeys constraint matching `key`. Prefer
+	* this over patchOrInsert with functional updaters for running totals.
+	*/
+	increment(table: string, key: Record<string, unknown>, deltas: Record<string, bigint | number>): void;
 	/** Partial update — sets only specified fields, preserves others */
 	patch(table: string, where: Record<string, unknown>, set: Record<string, unknown>): void;
 	/** Find-then-merge-or-insert. Values can be functions: (existing) => newValue */
@@ -237,6 +244,9 @@ interface SubgraphDefinition {
 	description?: string;
 	/** Block height to start indexing from (default: 1) */
 	startBlock?: number;
+	/** 'concurrent' = tip-first: live at tip now, history backfills behind.
+	*  Requires order-tolerant handlers. Default 'blocking'. */
+	backfillMode?: "blocking" | "concurrent";
 	/** Named source filters — keys become handler keys */
 	sources: Record<string, SubgraphFilter>;
 	/** Tables in this subgraph */
@@ -252,6 +262,8 @@ interface ReindexOptions {
 	fromBlock?: number;
 	toBlock?: number;
 	schemaName?: string;
+	/** Op row to receive processed_events on each progress flush. */
+	operationId?: string;
 	signal?: AbortSignal;
 }
 /**
@@ -269,6 +281,7 @@ declare function reindexSubgraph(def: SubgraphDefinition, opts?: ReindexOptions)
 */
 declare function resumeReindex(def: SubgraphDefinition, opts: {
 	schemaName: string
+	operationId?: string
 	signal?: AbortSignal
 }): Promise<{
 	processed: number
@@ -282,6 +295,7 @@ declare function backfillSubgraph(def: SubgraphDefinition, opts: {
 	fromBlock: number
 	toBlock: number
 	schemaName?: string
+	operationId?: string
 	signal?: AbortSignal
 }): Promise<{
 	processed: number
@@ -727,6 +741,14 @@ interface ColumnDiff {
 * Compare two multi-table subgraph schemas and return differences.
 */
 declare function diffSchema(existing: SubgraphSchema, incoming: SubgraphSchema): TableDiff;
+/**
+* Returns true if the diff contains any breaking changes
+* (removed tables, removed columns, or changed column types).
+*/
+declare function hasBreakingChanges(diff: TableDiff): {
+	breaking: boolean
+	reasons: string[]
+};
 interface DeployDiff {
 	addedTables: string[];
 	removedTables: string[];
@@ -794,4 +816,17 @@ declare function deploySchema(db: AnyDb, def: SubgraphDefinition, handlerPath: s
 	version: string
 	diff?: DeployDiff
 }>;
-export { validateSubgraphDefinition, resumeReindex, renderDeployPlan, reindexSubgraph, pgSchemaName, generateSubgraphSQL, generatePrismaSchema, generateKyselySchema, generateIndexSchema, generateDrizzleSchema, diffSchema, deploySchema, defineSubgraph, backfillSubgraph, WriteRow, WhereInput, TypedSubgraphDefinition, TypedSubgraphContext, TypedHandlers, TxMeta, TableDiff, SystemRow, SubscribeOptions, SubgraphTableClient, SubgraphTable, SubgraphSchema, SubgraphHandler, SubgraphFilter, SubgraphDefinition, SubgraphContext, SubgraphColumn, StxTransferPayload, StxTransferFilter, StxMintPayload, StxMintFilter, StxLockPayload, StxLockFilter, StxBurnPayload, StxBurnFilter, RowValue, ReindexOptions, PrismaGenOptions, PrintEventPayload, PrintEventFor, PrintEventFilter, NftTransferPayload, NftTransferFilter, NftMintPayload, NftMintFilter, NftBurnPayload, NftBurnFilter, KyselyGenOptions, InferTableRow, InferSubgraphClient, InferColumnType, IndexCodegenTarget, IndexCodegenOptions, INDEX_CODEGEN_TABLES, GeneratedSQL, FtTransferPayload, FtTransferFilter, FtMintPayload, FtMintFilter, FtBurnPayload, FtBurnFilter, FindManyOptions, EventForFilter, DrizzleGenOptions, DeployPlan, DeployDiff, ContractDeployPayload, ContractDeployFilter, ContractCallPayload, ContractCallFilter, ContractCallEvent, ComputedValue, ComparisonFilter, ColumnType, ColumnToTS, ColumnDiff, ByoMigrationPlan, ByoBreakingChangeError, AnyEvent, AggregateSpec, AggregateResult };
+/** A (decoded event type, optional contract scope) pair the sparse probe
+*  checks. Contract scoping is what makes token-subgraph reindexes leap over
+*  everything that isn't their token. */
+type SparseProbeTarget = {
+	eventType: string
+	contractId?: string
+};
+/** Sparse scanning is sound only when EVERY source is an event-type filter —
+*  a contract_call/contract_deploy source matches transactions, which the
+*  event probe can't see. */
+declare function canSparseScan(subgraph: SubgraphDefinition): boolean;
+/** Probe targets for a subgraph's filters: decoded type + contract scope when\\n*  the filter pins one (assetIdentifier "SP….contract::asset" or contractId). */
+declare function sparseProbeTargets(subgraph: SubgraphDefinition): SparseProbeTarget[];
+export { validateSubgraphDefinition, sparseProbeTargets, resumeReindex, renderDeployPlan, reindexSubgraph, pgSchemaName, hasBreakingChanges, generateSubgraphSQL, generatePrismaSchema, generateKyselySchema, generateIndexSchema, generateDrizzleSchema, diffSchema, deploySchema, defineSubgraph, canSparseScan, backfillSubgraph, WriteRow, WhereInput, TypedSubgraphDefinition, TypedSubgraphContext, TypedHandlers, TxMeta, TableDiff, SystemRow, SubscribeOptions, SubgraphTableClient, SubgraphTable, SubgraphSchema, SubgraphHandler, SubgraphFilter, SubgraphDefinition, SubgraphContext, SubgraphColumn, StxTransferPayload, StxTransferFilter, StxMintPayload, StxMintFilter, StxLockPayload, StxLockFilter, StxBurnPayload, StxBurnFilter, SparseProbeTarget, RowValue, ReindexOptions, PrismaGenOptions, PrintEventPayload, PrintEventFor, PrintEventFilter, NftTransferPayload, NftTransferFilter, NftMintPayload, NftMintFilter, NftBurnPayload, NftBurnFilter, KyselyGenOptions, InferTableRow, InferSubgraphClient, InferColumnType, IndexCodegenTarget, IndexCodegenOptions, INDEX_CODEGEN_TABLES, GeneratedSQL, FtTransferPayload, FtTransferFilter, FtMintPayload, FtMintFilter, FtBurnPayload, FtBurnFilter, FindManyOptions, EventForFilter, DrizzleGenOptions, DeployPlan, DeployDiff, ContractDeployPayload, ContractDeployFilter, ContractCallPayload, ContractCallFilter, ContractCallEvent, ComputedValue, ComparisonFilter, ColumnType, ColumnToTS, ColumnDiff, ByoMigrationPlan, ByoBreakingChangeError, AnyEvent, AggregateSpec, AggregateResult };