@secondlayer/sdk 6.34.0 → 6.35.0

package/dist/subgraphs/index.d.ts

@@ -1023,19 +1023,27 @@ type IndexPrint = IndexEventBase & {
 /** Decoded chain event, discriminated by `event_type`. */
 type IndexEvent = IndexFtTransfer | IndexNftTransfer | IndexStxTransfer | IndexStxMint | IndexStxBurn | IndexStxLock | IndexFtMint | IndexFtBurn | IndexNftMint | IndexNftBurn | IndexPrint;
 type IndexEventType = IndexEvent["event_type"];
-type EventsEnvelope = {
-	events: IndexEvent[]
+type EventsEnvelope<T extends IndexEventType = IndexEventType> = {
+	events: IndexEventOf<T>[]
 	next_cursor: string | null
 	tip: IndexTip
 	reorgs: IndexReorg[]
 };
-type EventsListParams = {
-	/** Required. One of the decoded event types. */
-	eventType: IndexEventType
+/** The single decoded-event member matching one `event_type` literal.
+*  `IndexEventOf<"ft_transfer">` is `IndexFtTransfer`. */
+type IndexEventOf<T extends IndexEventType> = Extract<IndexEvent, {
+	event_type: T
+}>;
+type EventsListParams<T extends IndexEventType = IndexEventType> = {
+	/** Required. One of the decoded event types. Passing a literal narrows the
+	*  rows every surface hands back to that event's own shape. */
+	eventType: T
 	cursor?: string | null
 	fromCursor?: string | null
 	limit?: number
-	contractId?: string
+	/** One id, or several to scope the sweep to a set of contracts (max 20).
+	*  Mutually exclusive with `trait`. */
+	contractId?: string | readonly string[]
 	assetIdentifier?: string
 	sender?: string
 	recipient?: string
@@ -1050,11 +1058,11 @@ type EventsListParams = {
 	*  the only source of the submitting sender. */
 	txContext?: boolean
 };
-type EventsWalkParams = Omit<EventsListParams, "limit"> & {
+type EventsWalkParams<T extends IndexEventType = IndexEventType> = Omit<EventsListParams<T>, "limit"> & {
 	batchSize?: number
 	signal?: AbortSignal
 };
-type EventsConsumeParams = Omit<EventsListParams, "cursor" | "fromCursor" | "limit"> & IndexConsumeOptions<IndexEvent, EventsEnvelope>;
+type EventsConsumeParams<T extends IndexEventType = IndexEventType> = Omit<EventsListParams<T>, "cursor" | "fromCursor" | "limit"> & IndexConsumeOptions<IndexEventOf<T>, EventsEnvelope<T>>;
 type IndexContractCall = {
 	cursor: string
 	block_height: number
@@ -1079,7 +1087,9 @@ type ContractCallsListParams = {
 	cursor?: string | null
 	fromCursor?: string | null
 	limit?: number
-	contractId?: string
+	/** One id, or several to scope the sweep to a set of contracts (max 20).
+	*  Mutually exclusive with `trait`. */
+	contractId?: string | readonly string[]
 	functionName?: string
 	sender?: string
 	fromHeight?: number
@@ -1565,12 +1575,21 @@ type SbtcEventsWalkParams = Omit<SbtcEventsListParams, "limit"> & {
 	batchSize?: number
 	signal?: AbortSignal
 };
+type SbtcEventsConsumeParams = Omit<SbtcEventsListParams, "cursor" | "fromCursor" | "limit"> & IndexConsumeOptions<IndexSbtcEvent, SbtcEventsEnvelope>;
+type SbtcDepositsConsumeParams = Omit<SbtcDepositsListParams, "cursor" | "fromCursor" | "limit"> & IndexConsumeOptions<IndexSbtcDeposit, SbtcDepositsEnvelope>;
 /** `index.sbtc` — the decoded sBTC peg surface (deposits, withdrawals, raw
 *  events, scoreboard). The only productized decoded sBTC peg feed on Stacks. */
 interface SbtcResource {
 	deposits: {
 		list(params?: SbtcDepositsListParams): Promise<SbtcDepositsEnvelope>
 		walk(params?: SbtcDepositsWalkParams): AsyncIterable<IndexSbtcDeposit>
+		/** Checkpointed sweep of completed deposits — append-only, so safe to
+		*  mirror. See {@link IndexConsumeOptions}. */
+		consume(params: SbtcDepositsConsumeParams): Promise<{
+			cursor: string | null
+			pages: number
+			emptyPolls: number
+		}>
 		/** Fetch a completed deposit by Bitcoin txid; 404 → null. */
 		get(bitcoinTxid: string): Promise<SbtcDepositEnvelope | null>
 	};
@@ -1583,6 +1602,13 @@ interface SbtcResource {
 	events: {
 		list(params?: SbtcEventsListParams): Promise<SbtcEventsEnvelope>
 		walk(params?: SbtcEventsWalkParams): AsyncIterable<IndexSbtcEvent>
+		/** Checkpointed sweep of the raw peg event log — append-only across all
+		*  six topics. See {@link IndexConsumeOptions}. */
+		consume(params: SbtcEventsConsumeParams): Promise<{
+			cursor: string | null
+			pages: number
+			emptyPolls: number
+		}>
 	};
 	/** The peg scoreboard — a single all-time aggregate (no pagination). */
 	summary(): Promise<SbtcSummaryEnvelope>;
@@ -1725,10 +1751,10 @@ interface NftTransfersResource {
 }
 /** `index.events` — callable shorthand for `.list()`; `eventType` is required. */
 interface IndexEventsResource {
-	(params: EventsListParams): Promise<EventsEnvelope>;
-	list(params: EventsListParams): Promise<EventsEnvelope>;
-	walk(params: EventsWalkParams): AsyncIterable<IndexEvent>;
-	consume(params: EventsConsumeParams): Promise<{
+	<T extends IndexEventType>(params: EventsListParams<T>): Promise<EventsEnvelope<T>>;
+	list<T extends IndexEventType>(params: EventsListParams<T>): Promise<EventsEnvelope<T>>;
+	walk<T extends IndexEventType>(params: EventsWalkParams<T>): AsyncIterable<IndexEventOf<T>>;
+	consume<T extends IndexEventType>(params: EventsConsumeParams<T>): Promise<{
 		cursor: string | null
 		pages: number
 		emptyPolls: number

package/dist/subgraphs/index.js

@@ -807,6 +807,19 @@ class Index extends BaseClient {
     deposits: {
       list: (params = {}) => this.listSbtcDeposits(params),
       walk: (params = {}) => this.walkSbtcDeposits(params),
+      consume: (params) => consumeIndexFeed({
+        ...params,
+        fetchPage: ({ cursor, fromHeight, limit }) => this.listSbtcDeposits({
+          confirmed: params.confirmed,
+          sender: params.sender,
+          bitcoinTxid: params.bitcoinTxid,
+          toHeight: params.toHeight,
+          cursor,
+          fromHeight,
+          limit
+        }),
+        itemsOf: (envelope) => envelope.deposits
+      }),
       get: (bitcoinTxid) => this.getSbtcDeposit(bitcoinTxid)
     },
     withdrawals: {
@@ -816,7 +829,22 @@ class Index extends BaseClient {
     },
     events: {
       list: (params = {}) => this.listSbtcEvents(params),
-      walk: (params = {}) => this.walkSbtcEvents(params)
+      walk: (params = {}) => this.walkSbtcEvents(params),
+      consume: (params) => consumeIndexFeed({
+        ...params,
+        fetchPage: ({ cursor, fromHeight, limit }) => this.listSbtcEvents({
+          confirmed: params.confirmed,
+          topic: params.topic,
+          sender: params.sender,
+          requestId: params.requestId,
+          bitcoinTxid: params.bitcoinTxid,
+          toHeight: params.toHeight,
+          cursor,
+          fromHeight,
+          limit
+        }),
+        itemsOf: (envelope) => envelope.events
+      })
     },
     summary: () => this.getSbtcSummary()
   };
@@ -1762,5 +1790,5 @@ export {
   Subgraphs
 };
 
-//# debugId=875C963182FEF66164756E2164756E21
+//# debugId=C01B0960A474ED8C64756E2164756E21
 //# sourceMappingURL=index.js.map