@secondlayer/subgraphs 0.8.1 → 0.9.1

package/dist/src/runtime/block-processor.d.ts

@@ -18,19 +18,98 @@ interface SubgraphTable {
 }
 /** Subgraph schema — maps table names to table definitions */
 type SubgraphSchema = Record<string, SubgraphTable>;
-/** Source filter for what blockchain data this subgraph processes */
-interface SubgraphSource {
-	/** Contract principal (e.g., SP000...::contract-name). Supports * wildcards. */
-	contract?: string;
-	/** Event name/topic to filter on */
-	event?: string;
-	/** Function name to filter on */
-	function?: string;
-	/** Transaction type filter (e.g., "stx_transfer", "contract_call") */
-	type?: string;
-	/** Minimum amount filter (for stx_transfer sources) */
+/** STX event filters */
+interface StxTransferFilter {
+	type: "stx_transfer";
+	sender?: string;
+	recipient?: string;
 	minAmount?: bigint;
+	maxAmount?: bigint;
 }
+interface StxMintFilter {
+	type: "stx_mint";
+	recipient?: string;
+	minAmount?: bigint;
+}
+interface StxBurnFilter {
+	type: "stx_burn";
+	sender?: string;
+	minAmount?: bigint;
+}
+interface StxLockFilter {
+	type: "stx_lock";
+	lockedAddress?: string;
+	minAmount?: bigint;
+}
+/** FT event filters */
+interface FtTransferFilter {
+	type: "ft_transfer";
+	assetIdentifier?: string;
+	sender?: string;
+	recipient?: string;
+	minAmount?: bigint;
+}
+interface FtMintFilter {
+	type: "ft_mint";
+	assetIdentifier?: string;
+	recipient?: string;
+	minAmount?: bigint;
+}
+interface FtBurnFilter {
+	type: "ft_burn";
+	assetIdentifier?: string;
+	sender?: string;
+	minAmount?: bigint;
+}
+/** NFT event filters */
+interface NftTransferFilter {
+	type: "nft_transfer";
+	assetIdentifier?: string;
+	sender?: string;
+	recipient?: string;
+}
+interface NftMintFilter {
+	type: "nft_mint";
+	assetIdentifier?: string;
+	recipient?: string;
+}
+interface NftBurnFilter {
+	type: "nft_burn";
+	assetIdentifier?: string;
+	sender?: string;
+}
+/** Contract event filters */
+interface ContractCallFilter {
+	type: "contract_call";
+	contractId?: string;
+	functionName?: string;
+	caller?: string;
+	/** ABI for typed event.args. If omitted, auto-fetched at deploy time. */
+	abi?: Record<string, unknown>;
+}
+interface ContractDeployFilter {
+	type: "contract_deploy";
+	deployer?: string;
+	contractName?: string;
+}
+interface PrintEventFilter {
+	type: "print_event";
+	contractId?: string;
+	topic?: string;
+}
+/** All subgraph filter types — discriminated on `type` */
+type SubgraphFilter = StxTransferFilter | StxMintFilter | StxBurnFilter | StxLockFilter | FtTransferFilter | FtMintFilter | FtBurnFilter | NftTransferFilter | NftMintFilter | NftBurnFilter | ContractCallFilter | ContractDeployFilter | PrintEventFilter;
+/** Transaction metadata available in handlers */
+interface TxMeta {
+	txId: string;
+	sender: string;
+	type: string;
+	status: string;
+	contractId?: string | null;
+	functionName?: string | null;
+}
+/** Value or computed function that receives existing row */
+type ComputedValue<T = unknown> = T | ((existing: Record<string, unknown> | null) => T);
 /** Context passed to subgraph handlers during event processing */
 interface SubgraphContext {
 	block: {
@@ -39,18 +118,29 @@ interface SubgraphContext {
 		timestamp: number
 		burnBlockHeight: number
 	};
-	tx: {
-		txId: string
-		sender: string
-		type: string
-		status: string
-	};
+	tx: TxMeta;
 	insert(table: string, row: Record<string, unknown>): void;
 	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;
+	/** 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 */
+	patchOrInsert(table: string, key: Record<string, unknown>, row: Record<string, ComputedValue>): Promise<void>;
 	findOne(table: string, where: Record<string, unknown>): Promise<Record<string, unknown> | null>;
 	findMany(table: string, where: Record<string, unknown>): Promise<Record<string, unknown>[]>;
+	/** Format a bigint amount with decimal places */
+	formatUnits(value: bigint, decimals: number): string;
+	/** Count rows matching filter */
+	count(table: string, where?: Record<string, unknown>): Promise<number>;
+	/** Sum a numeric column */
+	sum(table: string, column: string, where?: Record<string, unknown>): Promise<bigint>;
+	/** Min of a numeric column */
+	min(table: string, column: string, where?: Record<string, unknown>): Promise<bigint | null>;
+	/** Max of a numeric column */
+	max(table: string, column: string, where?: Record<string, unknown>): Promise<bigint | null>;
+	/** Count distinct values in a column */
+	countDistinct(table: string, column: string, where?: Record<string, unknown>): Promise<number>;
 }
 /** Handler function that processes events and writes to the subgraph */
 type SubgraphHandler = (event: Record<string, unknown>, ctx: SubgraphContext) => Promise<void> | void;
@@ -64,11 +154,11 @@ interface SubgraphDefinition {
 	description?: string;
 	/** Block height to start indexing from (default: 1) */
 	startBlock?: number;
-	/** What blockchain data to process — one or more source filters */
-	sources: SubgraphSource[];
+	/** Named source filters — keys become handler keys */
+	sources: Record<string, SubgraphFilter>;
 	/** Tables in this subgraph */
 	schema: SubgraphSchema;
-	/** Keyed handler functions — keys match sourceKey() output, "*" is catch-all */
+	/** Handler functions — keys must match source names (or "*" for catch-all) */
 	handlers: Record<string, SubgraphHandler>;
 }
 import { Transaction } from "kysely";