@secondlayer/sdk 6.54.1 → 7.0.0

package/dist/streams/index.d.ts

@@ -1,4 +1,4 @@
-import { STREAMS_EVENT_TYPES, StreamsEventType } from "@secondlayer/shared";
+import { STREAMS_EVENT_TYPES, StreamsEvent, StreamsEventType } from "@secondlayer/shared/streams-rows";
 /**
 * A consumer sink: the destination adapter a consume loop writes through.
 *
@@ -216,113 +216,7 @@ type IndexPrint = IndexEventBase & {
 };
 /** Decoded chain event, discriminated by `event_type`. */
 type IndexEvent = IndexFtTransfer | IndexNftTransfer | IndexStxTransfer | IndexStxMint | IndexStxBurn | IndexStxLock | IndexFtMint | IndexFtBurn | IndexNftMint | IndexNftBurn | IndexPrint;
-/** A Clarity value as Streams serves it: the canonical hex string, a typed
-*  object carrying that hex (`{ hex }`), or a decoded Clarity-JSON object.
-*  Decode helpers (`decodeNftTransfer`, etc.) resolve it to a concrete value. */
-type StreamsClarityValue = string | {
-	hex: string;
-} | Record<string, unknown>;
-type StxTransferPayload = {
-	sender: string;
-	recipient: string;
-	amount: string;
-	memo?: string;
-};
-type StxMintPayload = {
-	recipient: string;
-	amount: string;
-};
-type StxBurnPayload = {
-	sender: string;
-	amount: string;
-};
-type StxLockPayload = {
-	locked_address: string;
-	locked_amount: string;
-	unlock_height: string;
-};
-type FtTransferPayload = {
-	asset_identifier: string;
-	sender: string;
-	recipient: string;
-	amount: string;
-};
-type FtMintPayload = {
-	asset_identifier: string;
-	recipient: string;
-	amount: string;
-};
-type FtBurnPayload = {
-	asset_identifier: string;
-	sender: string;
-	amount: string;
-};
-type NftTransferPayload = {
-	asset_identifier: string;
-	sender: string;
-	recipient: string;
-	value: StreamsClarityValue;
-	/** Canonical serialized hex of `value`, when the stream carries it. */
-	raw_value?: string;
-};
-type NftMintPayload = {
-	asset_identifier: string;
-	recipient: string;
-	value: StreamsClarityValue;
-	raw_value?: string;
-};
-type NftBurnPayload = {
-	asset_identifier: string;
-	sender: string;
-	value: StreamsClarityValue;
-	raw_value?: string;
-};
-type PrintPayload = {
-	contract_id?: string | null;
-	topic?: string;
-	value?: unknown;
-	raw_value?: string;
-};
-/** Union of every Streams payload shape, discriminated by `event_type` on the
-*  parent `StreamsEvent`. */
-type StreamsEventPayload = StxTransferPayload | StxMintPayload | StxBurnPayload | StxLockPayload | FtTransferPayload | FtMintPayload | FtBurnPayload | NftTransferPayload | NftMintPayload | NftBurnPayload | PrintPayload;
-type StreamsEventBase = {
-	/**
-	* Globally unique, monotonic position of this event (`<block>:<index>`). Use
-	* it as the primary key of your projection rows — replaying a batch then
-	* upserts cleanly. Don't synthesize your own id from `tx_id`/`event_index`.
-	*/
-	cursor: string;
-	block_height: number;
-	block_hash: string;
-	burn_block_height: number;
-	tx_id: string;
-	tx_index: number;
-	event_index: number;
-	contract_id: string | null;
-	ts: string;
-	/**
-	* True when this event's block is past the finality boundary (immutable).
-	* Optional for back-compat; the API always sets it on Streams responses.
-	*/
-	finalized?: boolean;
-	/**
-	* Labels whose filter group this event satisfied, present only when the
-	* request used a labelled `filters` map. The SDK dispatches on it for you
-	* (`on.<label>`), so handlers rarely read it directly.
-	*/
-	matched?: string[];
-};
-type StreamsEventOf<
-	T extends StreamsEventType,
-	P
-> = StreamsEventBase & {
-	event_type: T;
-	payload: P;
-};
-/** A raw Streams event. Discriminated on `event_type`, so `event.payload`
-*  narrows to the matching payload shape once the type is checked. */
-type StreamsEvent = StreamsEventOf<"stx_transfer", StxTransferPayload> | StreamsEventOf<"stx_mint", StxMintPayload> | StreamsEventOf<"stx_burn", StxBurnPayload> | StreamsEventOf<"stx_lock", StxLockPayload> | StreamsEventOf<"ft_transfer", FtTransferPayload> | StreamsEventOf<"ft_mint", FtMintPayload> | StreamsEventOf<"ft_burn", FtBurnPayload> | StreamsEventOf<"nft_transfer", NftTransferPayload> | StreamsEventOf<"nft_mint", NftMintPayload> | StreamsEventOf<"nft_burn", NftBurnPayload> | StreamsEventOf<"print", PrintPayload>;
+import { StreamsEventPayload } from "@secondlayer/shared/streams-rows";
 type StreamsTip = {
 	block_height: number;
 	block_hash: string;
@@ -819,20 +713,6 @@ type StreamsClient = {
 	dumps: StreamsDumps;
 	canonical(height: number): Promise<StreamsCanonicalBlock>;
 	tip(): Promise<StreamsTip>;
-	/** Your own Streams consumption (events today + this month) and tier limits. */
-	usage(): Promise<StreamsUsage>;
-};
-type StreamsUsage = {
-	product: "streams";
-	tier: string;
-	limits: {
-		rate_limit_per_second: number | null;
-		retention_days: number | null;
-	};
-	usage: {
-		events_today: number;
-		events_this_month: number;
-	};
 };
 type CreateStreamsClientOptions = {
 	apiKey: string;
@@ -893,7 +773,7 @@ declare function decode(event: StreamsEvent): IndexEvent;
 interface SecondLayerErrorOptions {
 	cause?: Error;
 	details?: string;
-	/** Stable machine-readable code (e.g. `UPGRADE_REQUIRED`, `BYO_BREAKING_CHANGE`). */
+	/** Stable machine-readable code (e.g. `UPGRADE_REQUIRED`). */
 	code?: string;
 	/** Docs page that explains this failure and its fix. */
 	docsUrl?: string;
@@ -908,10 +788,9 @@ interface SecondLayerErrorOptions {
 * Root of the SDK error family. Implements the same protocol as `BaseError`
 * in `@secondlayer/stacks` (`shortMessage`, `cause`, `toJSON`) so a failed
 * chain read and a failed platform read serialize and introspect identically.
-* It intentionally does NOT extend that class: `BaseError.details` is a
-* `string`, while {@link ByoBreakingChangeError.details} is the documented
-* structured migration plan — and cross-package `instanceof` is unreliable
-* under per-package bundling anyway (match on `code`/`name` across packages).
+* It intentionally does NOT extend that class: cross-package `instanceof` is
+* unreliable under per-package bundling anyway (match on `code`/`name` across
+* packages).
 *
 * `retryable` is the signal the consume loops act on: 429/5xx/network are
 * retryable, 4xx and body-serialization failures are not.
@@ -990,255 +869,8 @@ declare class StreamsServerError extends ApiError {
 declare class StreamsSignatureError extends SecondLayerError {
 	constructor(message?: string);
 }
-type FtTransferEvent = Extract<StreamsEvent, {
-	event_type: "ft_transfer";
-}>;
-type DecodedFtTransferPayload = {
-	asset_identifier: string;
-	contract_id: string;
-	token_name: string | null;
-	sender: string;
-	recipient: string;
-	amount: string;
-};
-type DecodedFtTransfer = {
-	cursor: string;
-	block_height: number;
-	tx_id: string;
-	tx_index: number;
-	event_index: number;
-	event_type: "ft_transfer";
-	decoded_payload: DecodedFtTransferPayload;
-	source_cursor: string;
-};
-declare function isFtTransfer(event: StreamsEvent): event is FtTransferEvent;
-declare function decodeFtTransfer(event: StreamsEvent): DecodedFtTransfer;
-type NftTransferEvent = Extract<StreamsEvent, {
-	event_type: "nft_transfer";
-}>;
-type DecodedNftTransferPayload = {
-	asset_identifier: string;
-	contract_id: string;
-	token_name: string | null;
-	sender: string;
-	recipient: string;
-	value: string;
-};
-type DecodedNftTransfer = {
-	cursor: string;
-	block_height: number;
-	tx_id: string;
-	tx_index: number;
-	event_index: number;
-	event_type: "nft_transfer";
-	decoded_payload: DecodedNftTransferPayload;
-	source_cursor: string;
-};
-declare function isNftTransfer(event: StreamsEvent): event is NftTransferEvent;
-declare function decodeNftTransfer(event: StreamsEvent): DecodedNftTransfer;
-type DecodedStxTransferPayload = {
-	sender: string;
-	recipient: string;
-	amount: string;
-	memo: string | null;
-};
-type DecodedStxTransfer = {
-	cursor: string;
-	block_height: number;
-	tx_id: string;
-	tx_index: number;
-	event_index: number;
-	event_type: "stx_transfer";
-	decoded_payload: DecodedStxTransferPayload;
-	source_cursor: string;
-};
-type DecodedStxMintPayload = {
-	recipient: string;
-	amount: string;
-};
-type DecodedStxMint = {
-	cursor: string;
-	block_height: number;
-	tx_id: string;
-	tx_index: number;
-	event_index: number;
-	event_type: "stx_mint";
-	decoded_payload: DecodedStxMintPayload;
-	source_cursor: string;
-};
-type DecodedStxBurnPayload = {
-	sender: string;
-	amount: string;
-};
-type DecodedStxBurn = {
-	cursor: string;
-	block_height: number;
-	tx_id: string;
-	tx_index: number;
-	event_index: number;
-	event_type: "stx_burn";
-	decoded_payload: DecodedStxBurnPayload;
-	source_cursor: string;
-};
-declare function isStxTransfer(event: StreamsEvent): event is StreamsEvent & {
-	event_type: "stx_transfer";
-};
-declare function decodeStxTransfer(event: StreamsEvent): DecodedStxTransfer;
-declare function isStxMint(event: StreamsEvent): event is StreamsEvent & {
-	event_type: "stx_mint";
-};
-declare function decodeStxMint(event: StreamsEvent): DecodedStxMint;
-declare function isStxBurn(event: StreamsEvent): event is StreamsEvent & {
-	event_type: "stx_burn";
-};
-declare function decodeStxBurn(event: StreamsEvent): DecodedStxBurn;
-type DecodedStxLockPayload = {
-	sender: string;
-	amount: string;
-	payload: {
-		unlock_height: string | null;
-	};
-};
-type DecodedStxLock = {
-	cursor: string;
-	block_height: number;
-	tx_id: string;
-	tx_index: number;
-	event_index: number;
-	event_type: "stx_lock";
-	decoded_payload: DecodedStxLockPayload;
-	source_cursor: string;
-};
-declare function isStxLock(event: StreamsEvent): event is StreamsEvent & {
-	event_type: "stx_lock";
-};
-declare function decodeStxLock(event: StreamsEvent): DecodedStxLock;
-type DecodedFtMintPayload = {
-	asset_identifier: string;
-	contract_id: string;
-	token_name: string | null;
-	recipient: string;
-	amount: string;
-};
-type DecodedFtMint = {
-	cursor: string;
-	block_height: number;
-	tx_id: string;
-	tx_index: number;
-	event_index: number;
-	event_type: "ft_mint";
-	decoded_payload: DecodedFtMintPayload;
-	source_cursor: string;
-};
-type DecodedFtBurnPayload = {
-	asset_identifier: string;
-	contract_id: string;
-	token_name: string | null;
-	sender: string;
-	amount: string;
-};
-type DecodedFtBurn = {
-	cursor: string;
-	block_height: number;
-	tx_id: string;
-	tx_index: number;
-	event_index: number;
-	event_type: "ft_burn";
-	decoded_payload: DecodedFtBurnPayload;
-	source_cursor: string;
-};
-type DecodedNftMintPayload = {
-	asset_identifier: string;
-	contract_id: string;
-	token_name: string | null;
-	recipient: string;
-	value: string;
-};
-type DecodedNftMint = {
-	cursor: string;
-	block_height: number;
-	tx_id: string;
-	tx_index: number;
-	event_index: number;
-	event_type: "nft_mint";
-	decoded_payload: DecodedNftMintPayload;
-	source_cursor: string;
-};
-type DecodedNftBurnPayload = {
-	asset_identifier: string;
-	contract_id: string;
-	token_name: string | null;
-	sender: string;
-	value: string;
-};
-type DecodedNftBurn = {
-	cursor: string;
-	block_height: number;
-	tx_id: string;
-	tx_index: number;
-	event_index: number;
-	event_type: "nft_burn";
-	decoded_payload: DecodedNftBurnPayload;
-	source_cursor: string;
-};
-declare function isFtMint(event: StreamsEvent): event is StreamsEvent & {
-	event_type: "ft_mint";
-};
-declare function decodeFtMint(event: StreamsEvent): DecodedFtMint;
-declare function isFtBurn(event: StreamsEvent): event is StreamsEvent & {
-	event_type: "ft_burn";
-};
-declare function decodeFtBurn(event: StreamsEvent): DecodedFtBurn;
-declare function isNftMint(event: StreamsEvent): event is StreamsEvent & {
-	event_type: "nft_mint";
-};
-declare function decodeNftMint(event: StreamsEvent): DecodedNftMint;
-declare function isNftBurn(event: StreamsEvent): event is StreamsEvent & {
-	event_type: "nft_burn";
-};
-declare function decodeNftBurn(event: StreamsEvent): DecodedNftBurn;
-/** Decoded form of a Clarity `print` event:
-*  - `topic`: the print topic, when the contract emits a `{ topic, ... }` tuple
-*  - `value`: the Clarity value decoded to JSON (uints as strings, buffers as
-*    `0x…` hex, tuples as objects)
-*  - `raw_value`: the canonical serialized hex, for byte-exact consumers */
-type DecodedPrintValue = {
-	topic: string | null;
-	value: unknown;
-	raw_value: string | null;
-};
-type DecodedPrintPayload = {
-	contract_id: string | null;
-	payload: DecodedPrintValue;
-};
-type DecodedPrint = {
-	cursor: string;
-	block_height: number;
-	tx_id: string;
-	tx_index: number;
-	event_index: number;
-	event_type: "print";
-	decoded_payload: DecodedPrintPayload;
-	source_cursor: string;
-};
-declare function isPrint(event: StreamsEvent): event is StreamsEvent & {
-	event_type: "print";
-};
-declare function decodePrint(event: StreamsEvent): DecodedPrint;
-/** Superset of the columns the decoded_events table holds. Every decoded
-*  event's `decoded_payload` is assignable to this, so the indexer's writer
-*  can map columns generically instead of per-event-type. */
-type DecodedEventColumns = {
-	contract_id?: string | null;
-	asset_identifier?: string | null;
-	sender?: string | null;
-	recipient?: string | null;
-	amount?: string | null;
-	value?: string | null;
-	memo?: string | null;
-	/** JSONB overflow for non-flat types (e.g. print's decoded value). */
-	payload?: unknown;
-};
+import { decodeFtTransfer, isFtTransfer, decodeNftTransfer, isNftTransfer, decodeStxBurn, decodeStxLock, decodeStxMint, decodeStxTransfer, isStxBurn, isStxLock, isStxMint, isStxTransfer, decodeFtBurn, decodeFtMint, decodeNftBurn, decodeNftMint, isFtBurn, isFtMint, isNftBurn, isNftMint, decodePrint, isPrint } from "@secondlayer/shared/streams-rows";
+import { DecodedEventColumns, DecodedEventRow, DecodedFtBurn, DecodedFtBurnPayload, DecodedFtMint, DecodedFtMintPayload, DecodedFtTransfer, DecodedFtTransferPayload, DecodedNftBurn, DecodedNftBurnPayload, DecodedNftMint, DecodedNftMintPayload, DecodedNftTransfer, DecodedNftTransferPayload, DecodedPrint, DecodedPrintPayload, DecodedPrintValue, DecodedStxBurn, DecodedStxBurnPayload, DecodedStxLock, DecodedStxLockPayload, DecodedStxMint, DecodedStxMintPayload, DecodedStxTransfer, DecodedStxTransferPayload, FtTransferEvent, FtTransferPayload as FtTransferPayload2, NftTransferEvent, NftTransferPayload as NftTransferPayload2 } from "@secondlayer/shared/streams-rows";
 /**
 * Helpers for Streams cursors. A cursor is the opaque `<block>:<index>` string
 * that marks a position in the event stream; treat the format as an
@@ -1269,5 +901,4 @@ declare const Cursor: {
 		eventIndex: number;
 	};
 };
-type DecodedEventRow = DecodedFtTransfer | DecodedNftTransfer | DecodedStxTransfer | DecodedStxMint | DecodedStxBurn | DecodedStxLock | DecodedFtMint | DecodedFtBurn | DecodedNftMint | DecodedNftBurn | DecodedPrint;
-export { isStxTransfer, isStxMint, isStxLock, isStxBurn, isPrint, isNftTransfer, isNftMint, isNftBurn, isFtTransfer, isFtMint, isFtBurn, decodeStxTransfer, decodeStxMint, decodeStxLock, decodeStxBurn, decodePrint, decodeNftTransfer, decodeNftMint, decodeNftBurn, decodeFtTransfer, decodeFtMint, decodeFtBurn, decode, createStreamsClient, ValidationError, StreamsUsage, StreamsTip, StreamsSignatureError, StreamsServerError, StreamsReorgsListParams, StreamsReorgsListEnvelope, StreamsReorgContext, StreamsReorg, StreamsEventsSubscribeParams, StreamsEventsStreamParams, StreamsEventsListParams, StreamsEventsListEnvelope, StreamsEventsEnvelope, StreamsEventsConsumeResult, StreamsEventsConsumeParams, StreamsEventType, StreamsEventPayload, StreamsEvent, StreamsDumpsManifest, StreamsDumps, StreamsDumpFile, StreamsConsumeParams, StreamsClient, StreamsCanonicalBlock, StreamsBatchContext, StreamsBatch, STREAMS_EVENT_TYPES, RateLimitError, NftTransferPayload, NftTransferEvent, FtTransferPayload, FtTransferEvent, FetchLike2 as FetchLike, DecodedStxTransferPayload, DecodedStxTransfer, DecodedStxMintPayload, DecodedStxMint, DecodedStxLockPayload, DecodedStxLock, DecodedStxBurnPayload, DecodedStxBurn, DecodedPrintValue, DecodedPrintPayload, DecodedPrint, DecodedNftTransferPayload, DecodedNftTransfer, DecodedNftMintPayload, DecodedNftMint, DecodedNftBurnPayload, DecodedNftBurn, DecodedFtTransferPayload, DecodedFtTransfer, DecodedFtMintPayload, DecodedFtMint, DecodedFtBurnPayload, DecodedFtBurn, DecodedEventRow, DecodedEventColumns, Cursor, ConsumerBatchContext, AuthError };
+export { isStxTransfer, isStxMint, isStxLock, isStxBurn, isPrint, isNftTransfer, isNftMint, isNftBurn, isFtTransfer, isFtMint, isFtBurn, decodeStxTransfer, decodeStxMint, decodeStxLock, decodeStxBurn, decodePrint, decodeNftTransfer, decodeNftMint, decodeNftBurn, decodeFtTransfer, decodeFtMint, decodeFtBurn, decode, createStreamsClient, ValidationError, StreamsTip, StreamsSignatureError, StreamsServerError, StreamsReorgsListParams, StreamsReorgsListEnvelope, StreamsReorgContext, StreamsReorg, StreamsEventsSubscribeParams, StreamsEventsStreamParams, StreamsEventsListParams, StreamsEventsListEnvelope, StreamsEventsEnvelope, StreamsEventsConsumeResult, StreamsEventsConsumeParams, StreamsEventType, StreamsEventPayload, StreamsEvent, StreamsDumpsManifest, StreamsDumps, StreamsDumpFile, StreamsConsumeParams, StreamsClient, StreamsCanonicalBlock, StreamsBatchContext, StreamsBatch, STREAMS_EVENT_TYPES, RateLimitError, NftTransferPayload2 as NftTransferPayload, NftTransferEvent, FtTransferPayload2 as FtTransferPayload, FtTransferEvent, FetchLike2 as FetchLike, DecodedStxTransferPayload, DecodedStxTransfer, DecodedStxMintPayload, DecodedStxMint, DecodedStxLockPayload, DecodedStxLock, DecodedStxBurnPayload, DecodedStxBurn, DecodedPrintValue, DecodedPrintPayload, DecodedPrint, DecodedNftTransferPayload, DecodedNftTransfer, DecodedNftMintPayload, DecodedNftMint, DecodedNftBurnPayload, DecodedNftBurn, DecodedFtTransferPayload, DecodedFtTransfer, DecodedFtMintPayload, DecodedFtMint, DecodedFtBurnPayload, DecodedFtBurn, DecodedEventRow, DecodedEventColumns, Cursor, ConsumerBatchContext, AuthError };