@secondlayer/stacks 6.2.0 → 6.2.2

package/dist/src/filters/index.d.cts

@@ -1,3 +1,4 @@
+/** The decoded event types. Index and Streams expose the same set. */
 declare const DECODED_EVENT_TYPES: readonly ["stx_transfer", "stx_mint", "stx_burn", "stx_lock", "ft_transfer", "ft_mint", "ft_burn", "nft_transfer", "nft_mint", "nft_burn", "print"];
 type DecodedEventType = (typeof DECODED_EVENT_TYPES)[number];
 /** Opt-in node vm_events, stored names. Parallel to DECODED_EVENT_TYPES — not
@@ -125,21 +126,22 @@ type Principal = string & {
 	readonly __principal: unique symbol
 };
 /**
-* `<contract>::<asset-name>` — the shape a fungible/non-fungible asset filter
-* takes, expressed so the compiler can check it.
+* A fungible or non-fungible asset identifier: `<contract>::<asset-name>`.
+*
+* This is the shape an asset filter takes, expressed so the compiler can check it.
 *
 * The most common mistake in this API is passing a CONTRACT ID
 * (`SP….sbtc-token`) where an asset identifier (`SP….sbtc-token::sbtc-token`)
 * belongs, and the failure mode is a query that quietly returns zero rows. The
 * two differ structurally by `::`, so a template-literal type catches it at the
-* call site — no brand, no cast, literals just work.
+* call site. No brand, no cast, literals just work.
 *
 * A value that is only known at runtime (config, env) is not narrow enough on
 * purpose; run it through {@link assetId} once, which validates and narrows.
 *
-* Wildcard patterns (Webhooks/Subgraphs-only) are admitted by the second arm — they
-* are legitimately not full identifiers (`SPB.*`), and the runtime validator
-* short-circuits on them for the same reason.
+* Wildcard patterns (Webhooks/Subgraphs-only) are admitted by the second arm.
+* They are legitimately not full identifiers (`SPB.*`), and the runtime
+* validator short-circuits on them for the same reason.
 */
 type AssetIdentifier = `${string}::${string}` | `${string}*${string}`;
 /**
@@ -153,9 +155,12 @@ declare function assetId(value: string): AssetIdentifier;
 *  Shares {@link parsePrincipal} with the ABI guards so the two surfaces can't
 *  disagree about what a principal is. */
 declare function isPrincipal(value: string): value is Principal;
-/** Webhooks and Subgraph sources match `*` wildcards in
-*  principal/identifier patterns; every
-*  other surface treats the value literally. */
+/**
+* Tells whether a value contains a `*` wildcard.
+*
+* Webhooks and Subgraph sources match `*` wildcards in principal and
+* identifier patterns; every other surface treats the value literally.
+*/
 declare function hasWildcard(value: string): boolean;
 /** Throw unless `value` is a principal or a wildcard pattern. The factories
 *  call this so a swapped argument (asset id where a sender belongs, typo'd
@@ -340,14 +345,18 @@ interface SbtcWithdrawalSweptConfirmedSpec {
 	sweepTxid?: string;
 }
 type ChainEventFilterSpec = StxTransferSpec | StxMintSpec | StxBurnSpec | StxLockSpec | FtTransferSpec | FtMintSpec | FtBurnSpec | NftTransferSpec | NftMintSpec | NftBurnSpec | ContractCallSpec | ContractDeploySpec | NestedContractCallSpec | VarSetSpec | MapSetSpec | MapInsertSpec | MapDeleteSpec | PrintEventSpec | SbtcDepositSpec | SbtcWithdrawalCreateSpec | SbtcWithdrawalAcceptSpec | SbtcWithdrawalRejectSpec | SbtcWithdrawalSweptConfirmedSpec;
+/** The filter spec for one chain event type. */
 type SpecFor<T extends ChainEventFilterType> = Extract<ChainEventFilterSpec, {
 	type: T
 }>;
-/** The members expressible as subgraph sources (everything but the
-*  Webhooks-only sBTC lifecycle types). Instantiating
-*  `ChainEventFilter<SubgraphMemberType>` keeps `toSubgraphSource` present:
-*  the conditional in `ProjectionsFor` evaluates over this whole union
-*  (non-distributive at an instantiated site), and every member qualifies. */
+/**
+* The members you can use as subgraph sources.
+*
+* Everything but the Webhooks-only sBTC lifecycle types. Instantiating
+* `ChainEventFilter<SubgraphMemberType>` keeps `toSubgraphSource` present: the
+* conditional in `ProjectionsFor` evaluates over this whole union
+* (non-distributive at an instantiated site), and every member qualifies.
+*/
 type SubgraphMemberType = Exclude<ChainEventFilterType, `sbtc_${string}`>;
 /** A subgraph-source-shaped filter object (the `toSubgraphSource()` output /
 *  `fromSubgraphSource()` input). */
@@ -428,10 +437,11 @@ type ProjectionsFor<
 	toSubgraphSource(): S
 } : {});
 /**
-* A canonical chain-event filter: the spec fields plus the projections its
-* member supports. Write the filter once; project it to a query
-* (`toIndexParams`), a stream (`toStreamsParams`), a webhook trigger
-* (`toChainTrigger`), or a subgraph source (`toSubgraphSource`).
+* A chain-event filter: the spec fields plus its member's projections.
+*
+* Write the filter once; project it to a query (`toIndexParams`), a stream
+* (`toStreamsParams`), a webhook trigger (`toChainTrigger`), or a subgraph
+* source (`toSubgraphSource`).
 */
 type ChainEventFilter<
 	T extends ChainEventFilterType = ChainEventFilterType,
@@ -439,11 +449,15 @@ type ChainEventFilter<
 		type: T
 	} = SpecFor<T>
 > = S & ProjectionsFor<T, S>;
-/** Build a canonical filter: validated spec + the projections its member
-*  supports (methods are attached per member at runtime, matching the
-*  type-level gating exactly). `const F` preserves field literals — a
-*  `prints`/`abi` declaration keeps its exact type through
-*  `toSubgraphSource()`, which is what feeds `defineSubgraph` narrowing. */
+/**
+* Builds a canonical filter from a member type and its fields.
+*
+* It validates the spec and attaches the projections its member supports.
+* Methods are attached per member at runtime, matching the type-level gating
+* exactly. `const F` preserves field literals, so a `prints` or `abi`
+* declaration keeps its exact type through `toSubgraphSource()`, which is what
+* feeds `defineSubgraph` narrowing.
+*/
 declare function makeChainEventFilter<
 	T extends ChainEventFilterType,
 	const F extends Omit<SpecFor<T>, "type">
@@ -451,29 +465,87 @@ declare function makeChainEventFilter<
 	type: T
 } & F>;
 /**
-* Rehydrate a canonical filter from a subgraph-source-shaped object (the
-* inverse of `toSubgraphSource`). Powers migration and the round-trip
-* property gate: `toSubgraphSource(fromSubgraphSource(f))` must deep-equal
-* `f` for every production subgraph source.
+* Rebuilds a canonical filter from a subgraph source object.
+*
+* It is the inverse of `toSubgraphSource`. It powers migration and the
+* round-trip property gate: `toSubgraphSource(fromSubgraphSource(f))` must
+* deep-equal `f` for every production subgraph source.
 */
 declare function fromSubgraphSource(source: SubgraphSourceSpec): ChainEventFilter<SubgraphMemberType>;
+/** The fields a filter factory takes for one event type, without `type`. */
 type Fields<T extends ChainEventFilterType> = Omit<SpecFor<T>, "type">;
 /** The `on.*` namespace, annotated explicitly — bunup's dts emitter needs an
 *  annotation on exported values (an inferred object of generic factories
 *  collapses to `{}` in the emitted declarations). */
 interface OnNamespace {
+	/**
+	* Matches STX transfers.
+	*
+	* @param fields The members of {@link StxTransferSpec}, without `type`.
+	*/
 	stxTransfer(fields?: Fields<"stx_transfer">): ChainEventFilter<"stx_transfer">;
+	/**
+	* Matches STX mints.
+	*
+	* @param fields The members of {@link StxMintSpec}, without `type`.
+	*/
 	stxMint(fields?: Fields<"stx_mint">): ChainEventFilter<"stx_mint">;
+	/**
+	* Matches STX burns.
+	*
+	* @param fields The members of {@link StxBurnSpec}, without `type`.
+	*/
 	stxBurn(fields?: Fields<"stx_burn">): ChainEventFilter<"stx_burn">;
+	/**
+	* Matches STX lock events.
+	*
+	* @param fields The members of {@link StxLockSpec}, without `type`.
+	*/
 	stxLock(fields?: Fields<"stx_lock">): ChainEventFilter<"stx_lock">;
+	/**
+	* Matches fungible token transfers.
+	*
+	* @param fields The members of {@link FtTransferSpec}, without `type`.
+	*/
 	ftTransfer(fields?: Fields<"ft_transfer">): ChainEventFilter<"ft_transfer">;
+	/**
+	* Matches fungible token mints.
+	*
+	* @param fields The members of {@link FtMintSpec}, without `type`.
+	*/
 	ftMint(fields?: Fields<"ft_mint">): ChainEventFilter<"ft_mint">;
+	/**
+	* Matches fungible token burns.
+	*
+	* @param fields The members of {@link FtBurnSpec}, without `type`.
+	*/
 	ftBurn(fields?: Fields<"ft_burn">): ChainEventFilter<"ft_burn">;
+	/**
+	* Matches NFT transfers.
+	*
+	* @param fields The members of {@link NftTransferSpec}, without `type`.
+	*/
 	nftTransfer(fields?: Fields<"nft_transfer">): ChainEventFilter<"nft_transfer">;
+	/**
+	* Matches NFT mints.
+	*
+	* @param fields The members of {@link NftMintSpec}, without `type`.
+	*/
 	nftMint(fields?: Fields<"nft_mint">): ChainEventFilter<"nft_mint">;
+	/**
+	* Matches NFT burns.
+	*
+	* @param fields The members of {@link NftBurnSpec}, without `type`.
+	*/
 	nftBurn(fields?: Fields<"nft_burn">): ChainEventFilter<"nft_burn">;
-	/** `abi` literals are preserved (`const A`) so `toSubgraphSource()` keeps
-	*  typing `event.input` inside `defineSubgraph`. */
+	/**
+	* Matches contract calls.
+	*
+	* `abi` literals are preserved (`const A`), so `toSubgraphSource()` keeps
+	* typing `event.input` inside `defineSubgraph`.
+	*
+	* @param fields The members of {@link ContractCallSpec}, without `type`.
+	*/
 	contractCall<const A extends AbiContract | undefined = undefined>(fields?: Omit<SpecFor<"contract_call">, "type" | "abi"> & {
 		abi?: A
 	}): ChainEventFilter<"contract_call", {
@@ -481,10 +553,21 @@ interface OnNamespace {
 	} & Omit<SpecFor<"contract_call">, "type" | "abi"> & {
 		abi?: A
 	}>;
+	/**
+	* Matches contract deployments.
+	*
+	* @param fields The members of {@link ContractDeploySpec}, without `type`.
+	*/
 	contractDeploy(fields?: Fields<"contract_deploy">): ChainEventFilter<"contract_deploy">;
-	/** Canonical member is `print_event` (as Subgraphs and Webhooks spell
-	*  it); `toIndexParams`/`toStreamsParams` project to `print`. `prints`
-	*  literals are preserved (`const P`) for per-topic `event.data` narrowing. */
+	/**
+	* Matches `print` events.
+	*
+	* The canonical member is `print_event`, as Subgraphs and Webhooks spell it;
+	* `toIndexParams` and `toStreamsParams` project to `print`. `prints` literals
+	* are preserved (`const P`), so `event.data` narrows per topic.
+	*
+	* @param fields The members of {@link PrintEventSpec}, without `type`.
+	*/
 	print<const P extends Record<string, Record<string, PrintFieldType>> | undefined = undefined>(fields?: Omit<SpecFor<"print_event">, "type" | "prints"> & {
 		prints?: P
 	}): ChainEventFilter<"print_event", {
@@ -492,15 +575,75 @@ interface OnNamespace {
 	} & Omit<SpecFor<"print_event">, "type" | "prints"> & {
 		prints?: P
 	}>;
+	/**
+	* Matches contract calls made from inside another contract.
+	*
+	* @param fields The members of {@link NestedContractCallSpec}, without `type`.
+	*/
 	nestedCall(fields?: Fields<"nested_contract_call">): ChainEventFilter<"nested_contract_call">;
+	/**
+	* Matches data variable writes.
+	*
+	* @param fields The members of {@link VarSetSpec}, without `type`.
+	*/
 	varSet(fields?: Fields<"var_set">): ChainEventFilter<"var_set">;
+	/**
+	* Matches `map-set` writes.
+	*
+	* @param fields The members of {@link MapSetSpec}, without `type`.
+	*/
 	mapSet(fields?: Fields<"map_set">): ChainEventFilter<"map_set">;
+	/**
+	* Matches `map-insert` writes.
+	*
+	* @param fields The members of {@link MapInsertSpec}, without `type`.
+	*/
 	mapInsert(fields?: Fields<"map_insert">): ChainEventFilter<"map_insert">;
+	/**
+	* Matches `map-delete` writes.
+	*
+	* @param fields The members of {@link MapDeleteSpec}, without `type`.
+	*/
 	mapDelete(fields?: Fields<"map_delete">): ChainEventFilter<"map_delete">;
+	/**
+	* Matches sBTC deposits.
+	*
+	* Webhooks only: it has no Index, Streams or subgraph projection.
+	*
+	* @param fields The members of {@link SbtcDepositSpec}, without `type`.
+	*/
 	sbtcDeposit(fields?: Fields<"sbtc_deposit">): ChainEventFilter<"sbtc_deposit">;
+	/**
+	* Matches sBTC withdrawal requests.
+	*
+	* Webhooks only: it has no Index, Streams or subgraph projection.
+	*
+	* @param fields The members of {@link SbtcWithdrawalCreateSpec}, without `type`.
+	*/
 	sbtcWithdrawalCreate(fields?: Fields<"sbtc_withdrawal_create">): ChainEventFilter<"sbtc_withdrawal_create">;
+	/**
+	* Matches accepted sBTC withdrawals.
+	*
+	* Webhooks only: it has no Index, Streams or subgraph projection.
+	*
+	* @param fields The members of {@link SbtcWithdrawalAcceptSpec}, without `type`.
+	*/
 	sbtcWithdrawalAccept(fields?: Fields<"sbtc_withdrawal_accept">): ChainEventFilter<"sbtc_withdrawal_accept">;
+	/**
+	* Matches rejected sBTC withdrawals.
+	*
+	* Webhooks only: it has no Index, Streams or subgraph projection.
+	*
+	* @param fields The members of {@link SbtcWithdrawalRejectSpec}, without `type`.
+	*/
 	sbtcWithdrawalReject(fields?: Fields<"sbtc_withdrawal_reject">): ChainEventFilter<"sbtc_withdrawal_reject">;
+	/**
+	* Matches sBTC withdrawals whose sweep has confirmed.
+	*
+	* Webhooks only: it has no Index, Streams or subgraph projection.
+	*
+	* @param fields The members of {@link SbtcWithdrawalSweptConfirmedSpec}, without `type`.
+	*/
 	sbtcWithdrawalSweptConfirmed(fields?: Fields<"sbtc_withdrawal_swept_confirmed">): ChainEventFilter<"sbtc_withdrawal_swept_confirmed">;
 }
 /**

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

@@ -1,3 +1,4 @@
+/** The decoded event types. Index and Streams expose the same set. */
 declare const DECODED_EVENT_TYPES: readonly ["stx_transfer", "stx_mint", "stx_burn", "stx_lock", "ft_transfer", "ft_mint", "ft_burn", "nft_transfer", "nft_mint", "nft_burn", "print"];
 type DecodedEventType = (typeof DECODED_EVENT_TYPES)[number];
 /** Opt-in node vm_events, stored names. Parallel to DECODED_EVENT_TYPES — not
@@ -125,21 +126,22 @@ type Principal = string & {
 	readonly __principal: unique symbol
 };
 /**
-* `<contract>::<asset-name>` — the shape a fungible/non-fungible asset filter
-* takes, expressed so the compiler can check it.
+* A fungible or non-fungible asset identifier: `<contract>::<asset-name>`.
+*
+* This is the shape an asset filter takes, expressed so the compiler can check it.
 *
 * The most common mistake in this API is passing a CONTRACT ID
 * (`SP….sbtc-token`) where an asset identifier (`SP….sbtc-token::sbtc-token`)
 * belongs, and the failure mode is a query that quietly returns zero rows. The
 * two differ structurally by `::`, so a template-literal type catches it at the
-* call site — no brand, no cast, literals just work.
+* call site. No brand, no cast, literals just work.
 *
 * A value that is only known at runtime (config, env) is not narrow enough on
 * purpose; run it through {@link assetId} once, which validates and narrows.
 *
-* Wildcard patterns (Webhooks/Subgraphs-only) are admitted by the second arm — they
-* are legitimately not full identifiers (`SPB.*`), and the runtime validator
-* short-circuits on them for the same reason.
+* Wildcard patterns (Webhooks/Subgraphs-only) are admitted by the second arm.
+* They are legitimately not full identifiers (`SPB.*`), and the runtime
+* validator short-circuits on them for the same reason.
 */
 type AssetIdentifier = `${string}::${string}` | `${string}*${string}`;
 /**
@@ -153,9 +155,12 @@ declare function assetId(value: string): AssetIdentifier;
 *  Shares {@link parsePrincipal} with the ABI guards so the two surfaces can't
 *  disagree about what a principal is. */
 declare function isPrincipal(value: string): value is Principal;
-/** Webhooks and Subgraph sources match `*` wildcards in
-*  principal/identifier patterns; every
-*  other surface treats the value literally. */
+/**
+* Tells whether a value contains a `*` wildcard.
+*
+* Webhooks and Subgraph sources match `*` wildcards in principal and
+* identifier patterns; every other surface treats the value literally.
+*/
 declare function hasWildcard(value: string): boolean;
 /** Throw unless `value` is a principal or a wildcard pattern. The factories
 *  call this so a swapped argument (asset id where a sender belongs, typo'd
@@ -340,14 +345,18 @@ interface SbtcWithdrawalSweptConfirmedSpec {
 	sweepTxid?: string;
 }
 type ChainEventFilterSpec = StxTransferSpec | StxMintSpec | StxBurnSpec | StxLockSpec | FtTransferSpec | FtMintSpec | FtBurnSpec | NftTransferSpec | NftMintSpec | NftBurnSpec | ContractCallSpec | ContractDeploySpec | NestedContractCallSpec | VarSetSpec | MapSetSpec | MapInsertSpec | MapDeleteSpec | PrintEventSpec | SbtcDepositSpec | SbtcWithdrawalCreateSpec | SbtcWithdrawalAcceptSpec | SbtcWithdrawalRejectSpec | SbtcWithdrawalSweptConfirmedSpec;
+/** The filter spec for one chain event type. */
 type SpecFor<T extends ChainEventFilterType> = Extract<ChainEventFilterSpec, {
 	type: T
 }>;
-/** The members expressible as subgraph sources (everything but the
-*  Webhooks-only sBTC lifecycle types). Instantiating
-*  `ChainEventFilter<SubgraphMemberType>` keeps `toSubgraphSource` present:
-*  the conditional in `ProjectionsFor` evaluates over this whole union
-*  (non-distributive at an instantiated site), and every member qualifies. */
+/**
+* The members you can use as subgraph sources.
+*
+* Everything but the Webhooks-only sBTC lifecycle types. Instantiating
+* `ChainEventFilter<SubgraphMemberType>` keeps `toSubgraphSource` present: the
+* conditional in `ProjectionsFor` evaluates over this whole union
+* (non-distributive at an instantiated site), and every member qualifies.
+*/
 type SubgraphMemberType = Exclude<ChainEventFilterType, `sbtc_${string}`>;
 /** A subgraph-source-shaped filter object (the `toSubgraphSource()` output /
 *  `fromSubgraphSource()` input). */
@@ -428,10 +437,11 @@ type ProjectionsFor<
 	toSubgraphSource(): S
 } : {});
 /**
-* A canonical chain-event filter: the spec fields plus the projections its
-* member supports. Write the filter once; project it to a query
-* (`toIndexParams`), a stream (`toStreamsParams`), a webhook trigger
-* (`toChainTrigger`), or a subgraph source (`toSubgraphSource`).
+* A chain-event filter: the spec fields plus its member's projections.
+*
+* Write the filter once; project it to a query (`toIndexParams`), a stream
+* (`toStreamsParams`), a webhook trigger (`toChainTrigger`), or a subgraph
+* source (`toSubgraphSource`).
 */
 type ChainEventFilter<
 	T extends ChainEventFilterType = ChainEventFilterType,
@@ -439,11 +449,15 @@ type ChainEventFilter<
 		type: T
 	} = SpecFor<T>
 > = S & ProjectionsFor<T, S>;
-/** Build a canonical filter: validated spec + the projections its member
-*  supports (methods are attached per member at runtime, matching the
-*  type-level gating exactly). `const F` preserves field literals — a
-*  `prints`/`abi` declaration keeps its exact type through
-*  `toSubgraphSource()`, which is what feeds `defineSubgraph` narrowing. */
+/**
+* Builds a canonical filter from a member type and its fields.
+*
+* It validates the spec and attaches the projections its member supports.
+* Methods are attached per member at runtime, matching the type-level gating
+* exactly. `const F` preserves field literals, so a `prints` or `abi`
+* declaration keeps its exact type through `toSubgraphSource()`, which is what
+* feeds `defineSubgraph` narrowing.
+*/
 declare function makeChainEventFilter<
 	T extends ChainEventFilterType,
 	const F extends Omit<SpecFor<T>, "type">
@@ -451,29 +465,87 @@ declare function makeChainEventFilter<
 	type: T
 } & F>;
 /**
-* Rehydrate a canonical filter from a subgraph-source-shaped object (the
-* inverse of `toSubgraphSource`). Powers migration and the round-trip
-* property gate: `toSubgraphSource(fromSubgraphSource(f))` must deep-equal
-* `f` for every production subgraph source.
+* Rebuilds a canonical filter from a subgraph source object.
+*
+* It is the inverse of `toSubgraphSource`. It powers migration and the
+* round-trip property gate: `toSubgraphSource(fromSubgraphSource(f))` must
+* deep-equal `f` for every production subgraph source.
 */
 declare function fromSubgraphSource(source: SubgraphSourceSpec): ChainEventFilter<SubgraphMemberType>;
+/** The fields a filter factory takes for one event type, without `type`. */
 type Fields<T extends ChainEventFilterType> = Omit<SpecFor<T>, "type">;
 /** The `on.*` namespace, annotated explicitly — bunup's dts emitter needs an
 *  annotation on exported values (an inferred object of generic factories
 *  collapses to `{}` in the emitted declarations). */
 interface OnNamespace {
+	/**
+	* Matches STX transfers.
+	*
+	* @param fields The members of {@link StxTransferSpec}, without `type`.
+	*/
 	stxTransfer(fields?: Fields<"stx_transfer">): ChainEventFilter<"stx_transfer">;
+	/**
+	* Matches STX mints.
+	*
+	* @param fields The members of {@link StxMintSpec}, without `type`.
+	*/
 	stxMint(fields?: Fields<"stx_mint">): ChainEventFilter<"stx_mint">;
+	/**
+	* Matches STX burns.
+	*
+	* @param fields The members of {@link StxBurnSpec}, without `type`.
+	*/
 	stxBurn(fields?: Fields<"stx_burn">): ChainEventFilter<"stx_burn">;
+	/**
+	* Matches STX lock events.
+	*
+	* @param fields The members of {@link StxLockSpec}, without `type`.
+	*/
 	stxLock(fields?: Fields<"stx_lock">): ChainEventFilter<"stx_lock">;
+	/**
+	* Matches fungible token transfers.
+	*
+	* @param fields The members of {@link FtTransferSpec}, without `type`.
+	*/
 	ftTransfer(fields?: Fields<"ft_transfer">): ChainEventFilter<"ft_transfer">;
+	/**
+	* Matches fungible token mints.
+	*
+	* @param fields The members of {@link FtMintSpec}, without `type`.
+	*/
 	ftMint(fields?: Fields<"ft_mint">): ChainEventFilter<"ft_mint">;
+	/**
+	* Matches fungible token burns.
+	*
+	* @param fields The members of {@link FtBurnSpec}, without `type`.
+	*/
 	ftBurn(fields?: Fields<"ft_burn">): ChainEventFilter<"ft_burn">;
+	/**
+	* Matches NFT transfers.
+	*
+	* @param fields The members of {@link NftTransferSpec}, without `type`.
+	*/
 	nftTransfer(fields?: Fields<"nft_transfer">): ChainEventFilter<"nft_transfer">;
+	/**
+	* Matches NFT mints.
+	*
+	* @param fields The members of {@link NftMintSpec}, without `type`.
+	*/
 	nftMint(fields?: Fields<"nft_mint">): ChainEventFilter<"nft_mint">;
+	/**
+	* Matches NFT burns.
+	*
+	* @param fields The members of {@link NftBurnSpec}, without `type`.
+	*/
 	nftBurn(fields?: Fields<"nft_burn">): ChainEventFilter<"nft_burn">;
-	/** `abi` literals are preserved (`const A`) so `toSubgraphSource()` keeps
-	*  typing `event.input` inside `defineSubgraph`. */
+	/**
+	* Matches contract calls.
+	*
+	* `abi` literals are preserved (`const A`), so `toSubgraphSource()` keeps
+	* typing `event.input` inside `defineSubgraph`.
+	*
+	* @param fields The members of {@link ContractCallSpec}, without `type`.
+	*/
 	contractCall<const A extends AbiContract | undefined = undefined>(fields?: Omit<SpecFor<"contract_call">, "type" | "abi"> & {
 		abi?: A
 	}): ChainEventFilter<"contract_call", {
@@ -481,10 +553,21 @@ interface OnNamespace {
 	} & Omit<SpecFor<"contract_call">, "type" | "abi"> & {
 		abi?: A
 	}>;
+	/**
+	* Matches contract deployments.
+	*
+	* @param fields The members of {@link ContractDeploySpec}, without `type`.
+	*/
 	contractDeploy(fields?: Fields<"contract_deploy">): ChainEventFilter<"contract_deploy">;
-	/** Canonical member is `print_event` (as Subgraphs and Webhooks spell
-	*  it); `toIndexParams`/`toStreamsParams` project to `print`. `prints`
-	*  literals are preserved (`const P`) for per-topic `event.data` narrowing. */
+	/**
+	* Matches `print` events.
+	*
+	* The canonical member is `print_event`, as Subgraphs and Webhooks spell it;
+	* `toIndexParams` and `toStreamsParams` project to `print`. `prints` literals
+	* are preserved (`const P`), so `event.data` narrows per topic.
+	*
+	* @param fields The members of {@link PrintEventSpec}, without `type`.
+	*/
 	print<const P extends Record<string, Record<string, PrintFieldType>> | undefined = undefined>(fields?: Omit<SpecFor<"print_event">, "type" | "prints"> & {
 		prints?: P
 	}): ChainEventFilter<"print_event", {
@@ -492,15 +575,75 @@ interface OnNamespace {
 	} & Omit<SpecFor<"print_event">, "type" | "prints"> & {
 		prints?: P
 	}>;
+	/**
+	* Matches contract calls made from inside another contract.
+	*
+	* @param fields The members of {@link NestedContractCallSpec}, without `type`.
+	*/
 	nestedCall(fields?: Fields<"nested_contract_call">): ChainEventFilter<"nested_contract_call">;
+	/**
+	* Matches data variable writes.
+	*
+	* @param fields The members of {@link VarSetSpec}, without `type`.
+	*/
 	varSet(fields?: Fields<"var_set">): ChainEventFilter<"var_set">;
+	/**
+	* Matches `map-set` writes.
+	*
+	* @param fields The members of {@link MapSetSpec}, without `type`.
+	*/
 	mapSet(fields?: Fields<"map_set">): ChainEventFilter<"map_set">;
+	/**
+	* Matches `map-insert` writes.
+	*
+	* @param fields The members of {@link MapInsertSpec}, without `type`.
+	*/
 	mapInsert(fields?: Fields<"map_insert">): ChainEventFilter<"map_insert">;
+	/**
+	* Matches `map-delete` writes.
+	*
+	* @param fields The members of {@link MapDeleteSpec}, without `type`.
+	*/
 	mapDelete(fields?: Fields<"map_delete">): ChainEventFilter<"map_delete">;
+	/**
+	* Matches sBTC deposits.
+	*
+	* Webhooks only: it has no Index, Streams or subgraph projection.
+	*
+	* @param fields The members of {@link SbtcDepositSpec}, without `type`.
+	*/
 	sbtcDeposit(fields?: Fields<"sbtc_deposit">): ChainEventFilter<"sbtc_deposit">;
+	/**
+	* Matches sBTC withdrawal requests.
+	*
+	* Webhooks only: it has no Index, Streams or subgraph projection.
+	*
+	* @param fields The members of {@link SbtcWithdrawalCreateSpec}, without `type`.
+	*/
 	sbtcWithdrawalCreate(fields?: Fields<"sbtc_withdrawal_create">): ChainEventFilter<"sbtc_withdrawal_create">;
+	/**
+	* Matches accepted sBTC withdrawals.
+	*
+	* Webhooks only: it has no Index, Streams or subgraph projection.
+	*
+	* @param fields The members of {@link SbtcWithdrawalAcceptSpec}, without `type`.
+	*/
 	sbtcWithdrawalAccept(fields?: Fields<"sbtc_withdrawal_accept">): ChainEventFilter<"sbtc_withdrawal_accept">;
+	/**
+	* Matches rejected sBTC withdrawals.
+	*
+	* Webhooks only: it has no Index, Streams or subgraph projection.
+	*
+	* @param fields The members of {@link SbtcWithdrawalRejectSpec}, without `type`.
+	*/
 	sbtcWithdrawalReject(fields?: Fields<"sbtc_withdrawal_reject">): ChainEventFilter<"sbtc_withdrawal_reject">;
+	/**
+	* Matches sBTC withdrawals whose sweep has confirmed.
+	*
+	* Webhooks only: it has no Index, Streams or subgraph projection.
+	*
+	* @param fields The members of {@link SbtcWithdrawalSweptConfirmedSpec}, without `type`.
+	*/
 	sbtcWithdrawalSweptConfirmed(fields?: Fields<"sbtc_withdrawal_swept_confirmed">): ChainEventFilter<"sbtc_withdrawal_swept_confirmed">;
 }
 /**