@secondlayer/sdk 5.2.0 → 5.4.0

package/dist/index.d.ts

@@ -176,6 +176,138 @@ type NftTransfersWalkParams = Omit<NftTransfersListParams, "limit"> & {
 	batchSize?: number
 	signal?: AbortSignal
 };
+type IndexEventBase = {
+	cursor: string
+	block_height: number
+	block_time?: string | null
+	tx_id: string
+	tx_index: number
+	event_index: number
+	contract_id: string | null
+};
+type IndexFtTransfer = IndexEventBase & {
+	event_type: "ft_transfer"
+	asset_identifier: string
+	sender: string
+	recipient: string
+	amount: string
+};
+type IndexNftTransfer = IndexEventBase & {
+	event_type: "nft_transfer"
+	asset_identifier: string
+	sender: string
+	recipient: string
+	value: string
+};
+type IndexStxTransfer = IndexEventBase & {
+	event_type: "stx_transfer"
+	sender: string
+	recipient: string
+	amount: string
+	memo: string | null
+};
+type IndexStxMint = IndexEventBase & {
+	event_type: "stx_mint"
+	recipient: string
+	amount: string
+};
+type IndexStxBurn = IndexEventBase & {
+	event_type: "stx_burn"
+	sender: string
+	amount: string
+};
+type IndexFtMint = IndexEventBase & {
+	event_type: "ft_mint"
+	asset_identifier: string
+	recipient: string
+	amount: string
+};
+type IndexFtBurn = IndexEventBase & {
+	event_type: "ft_burn"
+	asset_identifier: string
+	sender: string
+	amount: string
+};
+type IndexNftMint = IndexEventBase & {
+	event_type: "nft_mint"
+	asset_identifier: string
+	recipient: string
+	value: string
+};
+type IndexNftBurn = IndexEventBase & {
+	event_type: "nft_burn"
+	asset_identifier: string
+	sender: string
+	value: string
+};
+type IndexPrint = IndexEventBase & {
+	event_type: "print"
+	payload: {
+		topic: string | null
+		value: unknown
+		raw_value: string | null
+	}
+};
+/** Decoded chain event, discriminated by `event_type`. */
+type IndexEvent = IndexFtTransfer | IndexNftTransfer | IndexStxTransfer | IndexStxMint | IndexStxBurn | IndexFtMint | IndexFtBurn | IndexNftMint | IndexNftBurn | IndexPrint;
+type IndexEventType = IndexEvent["event_type"];
+type EventsEnvelope = {
+	events: IndexEvent[]
+	next_cursor: string | null
+	tip: IndexTip
+	reorgs: never[]
+};
+type EventsListParams = {
+	/** Required. One of the decoded event types. */
+	eventType: IndexEventType
+	cursor?: string | null
+	fromCursor?: string | null
+	limit?: number
+	contractId?: string
+	assetIdentifier?: string
+	sender?: string
+	recipient?: string
+	fromHeight?: number
+	toHeight?: number
+};
+type EventsWalkParams = Omit<EventsListParams, "limit"> & {
+	batchSize?: number
+	signal?: AbortSignal
+};
+type IndexContractCall = {
+	cursor: string
+	block_height: number
+	block_time?: string | null
+	tx_id: string
+	tx_index: number
+	contract_id: string
+	function_name: string
+	sender: string
+	status: string
+	args: unknown[]
+	result: unknown
+	result_hex: string | null
+};
+type ContractCallsEnvelope = {
+	contract_calls: IndexContractCall[]
+	next_cursor: string | null
+	tip: IndexTip
+	reorgs: never[]
+};
+type ContractCallsListParams = {
+	cursor?: string | null
+	fromCursor?: string | null
+	limit?: number
+	contractId?: string
+	functionName?: string
+	sender?: string
+	fromHeight?: number
+	toHeight?: number
+};
+type ContractCallsWalkParams = Omit<ContractCallsListParams, "limit"> & {
+	batchSize?: number
+	signal?: AbortSignal
+};
 declare class Index extends BaseClient {
 	constructor(options?: Partial<SecondLayerOptions>);
 	readonly ftTransfers: {
@@ -186,10 +318,23 @@ declare class Index extends BaseClient {
 		list: (params?: NftTransfersListParams) => Promise<NftTransfersEnvelope>
 		walk: (params?: NftTransfersWalkParams) => AsyncIterable<NftTransfer>
 	};
+	/** Generic decoded events by `event_type` (the full /v1/index/events surface). */
+	readonly events: {
+		list: (params: EventsListParams) => Promise<EventsEnvelope>
+		walk: (params: EventsWalkParams) => AsyncIterable<IndexEvent>
+	};
+	readonly contractCalls: {
+		list: (params?: ContractCallsListParams) => Promise<ContractCallsEnvelope>
+		walk: (params?: ContractCallsWalkParams) => AsyncIterable<IndexContractCall>
+	};
 	private listFtTransfers;
 	private listNftTransfers;
 	private walkFtTransfers;
 	private walkNftTransfers;
+	private listEvents;
+	private walkEvents;
+	private listContractCalls;
+	private walkContractCalls;
 }
 declare const STREAMS_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 StreamsEventType = (typeof STREAMS_EVENT_TYPES)[number];
@@ -748,4 +893,10 @@ type WebhookHeaderInput = HeaderLookup | StandardWebhooksHeaders | Record<string
 * ```
 */
 declare function verifyWebhookSignature(rawBody: string, headers: WebhookHeaderInput, secret: string, toleranceSeconds?: number): boolean;
-export { verifyWebhookSignature, isStxTransfer, isStxMint, isStxBurn, isPrint, isNftTransfer, isNftMint, isNftBurn, isFtTransfer, isFtMint, isFtBurn, getSubgraph, decodeStxTransfer, decodeStxMint, decodeStxBurn, decodePrint, decodeNftTransfer, decodeNftMint, decodeNftBurn, decodeFtTransfer, decodeFtMint, decodeFtBurn, createStreamsClient, VersionConflictError, ValidationError, UpdateSubscriptionRequest2 as UpdateSubscriptionRequest, Subscriptions, SubscriptionSummary2 as SubscriptionSummary, SubscriptionStatus, SubscriptionRuntime, SubscriptionFormat, SubscriptionDetail2 as SubscriptionDetail, Subgraphs, SubgraphSpecOptions3 as SubgraphSpecOptions, SubgraphSpecFormat2 as SubgraphSpecFormat, SubgraphAgentSchema3 as SubgraphAgentSchema, StreamsTip, StreamsServerError, StreamsReorgsListParams, StreamsReorgsListEnvelope, StreamsReorg, StreamsEventsStreamParams, StreamsEventsListParams, StreamsEventsListEnvelope, StreamsEventsEnvelope, StreamsEventsConsumeResult, StreamsEventsConsumeParams, StreamsEventType, StreamsEventPayload, StreamsEvent, StreamsClient, StreamsCanonicalBlock, SecondLayerOptions, SecondLayer, RotateSecretResponse2 as RotateSecretResponse, ReplayResult2 as ReplayResult, RateLimitError, NftTransfersWalkParams, NftTransfersListParams, NftTransfersEnvelope, NftTransferPayload, NftTransferEvent, NftTransfer, IndexTip, Index, FtTransfersWalkParams, FtTransfersListParams, FtTransfersEnvelope, FtTransferPayload, FtTransferEvent, FtTransfer, FetchLike2 as FetchLike, DeliveryRow2 as DeliveryRow, DecodedStxTransferPayload, DecodedStxTransfer, DecodedStxMintPayload, DecodedStxMint, DecodedStxBurnPayload, DecodedStxBurn, DecodedPrintValue, DecodedPrintPayload, DecodedPrint, DecodedNftTransferPayload, DecodedNftTransfer, DecodedNftMintPayload, DecodedNftMint, DecodedNftBurnPayload, DecodedNftBurn, DecodedFtTransferPayload, DecodedFtTransfer, DecodedFtMintPayload, DecodedFtMint, DecodedFtBurnPayload, DecodedFtBurn, DecodedEventRow, DecodedEventColumns, DeadRow2 as DeadRow, CreateSubscriptionResponse2 as CreateSubscriptionResponse, CreateSubscriptionRequest2 as CreateSubscriptionRequest, AuthError, ApiError };
+/** Make a cvToValue result JSON-serializable: Clarity (u)ints decode to bigint,
+*  which JSON.stringify can't handle — convert recursively to strings. */
+declare function toJsonSafe(value: unknown): unknown;
+/** Decode a hex-encoded Clarity value to JSON-safe JS (uints as strings,
+*  buffers as `0x…` hex, tuples as objects). Returns the input hex on failure. */
+declare function decodeClarityValue(hex: string): unknown;
+export { verifyWebhookSignature, toJsonSafe, isStxTransfer, isStxMint, isStxBurn, isPrint, isNftTransfer, isNftMint, isNftBurn, isFtTransfer, isFtMint, isFtBurn, getSubgraph, decodeStxTransfer, decodeStxMint, decodeStxBurn, decodePrint, decodeNftTransfer, decodeNftMint, decodeNftBurn, decodeFtTransfer, decodeFtMint, decodeFtBurn, decodeClarityValue, createStreamsClient, VersionConflictError, ValidationError, UpdateSubscriptionRequest2 as UpdateSubscriptionRequest, Subscriptions, SubscriptionSummary2 as SubscriptionSummary, SubscriptionStatus, SubscriptionRuntime, SubscriptionFormat, SubscriptionDetail2 as SubscriptionDetail, Subgraphs, SubgraphSpecOptions3 as SubgraphSpecOptions, SubgraphSpecFormat2 as SubgraphSpecFormat, SubgraphAgentSchema3 as SubgraphAgentSchema, StreamsTip, StreamsServerError, StreamsReorgsListParams, StreamsReorgsListEnvelope, StreamsReorg, StreamsEventsStreamParams, StreamsEventsListParams, StreamsEventsListEnvelope, StreamsEventsEnvelope, StreamsEventsConsumeResult, StreamsEventsConsumeParams, StreamsEventType, StreamsEventPayload, StreamsEvent, StreamsClient, StreamsCanonicalBlock, SecondLayerOptions, SecondLayer, RotateSecretResponse2 as RotateSecretResponse, ReplayResult2 as ReplayResult, RateLimitError, NftTransfersWalkParams, NftTransfersListParams, NftTransfersEnvelope, NftTransferPayload, NftTransferEvent, NftTransfer, IndexTip, IndexEventType, IndexEvent, IndexContractCall, Index, FtTransfersWalkParams, FtTransfersListParams, FtTransfersEnvelope, FtTransferPayload, FtTransferEvent, FtTransfer, FetchLike2 as FetchLike, EventsWalkParams, EventsListParams, EventsEnvelope, DeliveryRow2 as DeliveryRow, DecodedStxTransferPayload, DecodedStxTransfer, DecodedStxMintPayload, DecodedStxMint, DecodedStxBurnPayload, DecodedStxBurn, DecodedPrintValue, DecodedPrintPayload, DecodedPrint, DecodedNftTransferPayload, DecodedNftTransfer, DecodedNftMintPayload, DecodedNftMint, DecodedNftBurnPayload, DecodedNftBurn, DecodedFtTransferPayload, DecodedFtTransfer, DecodedFtMintPayload, DecodedFtMint, DecodedFtBurnPayload, DecodedFtBurn, DecodedEventRow, DecodedEventColumns, DeadRow2 as DeadRow, CreateSubscriptionResponse2 as CreateSubscriptionResponse, CreateSubscriptionRequest2 as CreateSubscriptionRequest, ContractCallsWalkParams, ContractCallsListParams, ContractCallsEnvelope, AuthError, ApiError };

package/dist/index.js

@@ -317,6 +317,14 @@ class Index extends BaseClient {
     list: (params = {}) => this.listNftTransfers(params),
     walk: (params = {}) => this.walkNftTransfers(params)
   };
+  events = {
+    list: (params) => this.listEvents(params),
+    walk: (params) => this.walkEvents(params)
+  };
+  contractCalls = {
+    list: (params = {}) => this.listContractCalls(params),
+    walk: (params = {}) => this.walkContractCalls(params)
+  };
   async listFtTransfers(params = {}) {
     const searchParams = new URLSearchParams;
     appendSearchParam(searchParams, "cursor", params.cursor);
@@ -394,6 +402,83 @@ class Index extends BaseClient {
       firstPage = false;
     }
   }
+  async listEvents(params) {
+    const searchParams = new URLSearchParams;
+    appendSearchParam(searchParams, "event_type", params.eventType);
+    appendSearchParam(searchParams, "cursor", params.cursor);
+    appendSearchParam(searchParams, "from_cursor", params.fromCursor);
+    appendSearchParam(searchParams, "limit", params.limit);
+    appendSearchParam(searchParams, "contract_id", params.contractId);
+    appendSearchParam(searchParams, "asset_identifier", params.assetIdentifier);
+    appendSearchParam(searchParams, "sender", params.sender);
+    appendSearchParam(searchParams, "recipient", params.recipient);
+    appendSearchParam(searchParams, "from_height", params.fromHeight);
+    appendSearchParam(searchParams, "to_height", params.toHeight);
+    return this.request("GET", `/v1/index/events?${searchParams.toString()}`);
+  }
+  async* walkEvents(params) {
+    const batchSize = params.batchSize ?? 200;
+    let cursor = params.cursor ?? params.fromCursor ?? null;
+    let firstPage = true;
+    while (!params.signal?.aborted) {
+      const envelope = await this.listEvents({
+        ...params,
+        limit: batchSize,
+        cursor: firstPage ? params.cursor : cursor,
+        fromCursor: firstPage ? params.fromCursor : undefined,
+        fromHeight: firstPage ? firstWalkFromHeight(params) : undefined
+      });
+      for (const event of envelope.events) {
+        if (params.signal?.aborted)
+          return;
+        yield event;
+      }
+      const nextCursor = envelope.next_cursor;
+      if (!nextCursor || nextCursor === cursor || envelope.events.length < batchSize) {
+        return;
+      }
+      cursor = nextCursor;
+      firstPage = false;
+    }
+  }
+  async listContractCalls(params = {}) {
+    const searchParams = new URLSearchParams;
+    appendSearchParam(searchParams, "cursor", params.cursor);
+    appendSearchParam(searchParams, "from_cursor", params.fromCursor);
+    appendSearchParam(searchParams, "limit", params.limit);
+    appendSearchParam(searchParams, "contract_id", params.contractId);
+    appendSearchParam(searchParams, "function_name", params.functionName);
+    appendSearchParam(searchParams, "sender", params.sender);
+    appendSearchParam(searchParams, "from_height", params.fromHeight);
+    appendSearchParam(searchParams, "to_height", params.toHeight);
+    const query = searchParams.toString();
+    return this.request("GET", `/v1/index/contract-calls${query ? `?${query}` : ""}`);
+  }
+  async* walkContractCalls(params = {}) {
+    const batchSize = params.batchSize ?? 200;
+    let cursor = params.cursor ?? params.fromCursor ?? null;
+    let firstPage = true;
+    while (!params.signal?.aborted) {
+      const envelope = await this.listContractCalls({
+        ...params,
+        limit: batchSize,
+        cursor: firstPage ? params.cursor : cursor,
+        fromCursor: firstPage ? params.fromCursor : undefined,
+        fromHeight: firstPage ? firstWalkFromHeight(params) : undefined
+      });
+      for (const call of envelope.contract_calls) {
+        if (params.signal?.aborted)
+          return;
+        yield call;
+      }
+      const nextCursor = envelope.next_cursor;
+      if (!nextCursor || nextCursor === cursor || envelope.contract_calls.length < batchSize) {
+        return;
+      }
+      cursor = nextCursor;
+      firstPage = false;
+    }
+  }
 }
 
 // src/streams/consumer.ts
@@ -1011,19 +1096,8 @@ function decodeNftBurn(event) {
     value: requireHexValue2(event.payload, "nft_burn")
   });
 }
-// src/streams/print.ts
+// src/clarity.ts
 import { cvToValue, deserializeCV } from "@secondlayer/stacks/clarity";
-function printValueHex(payload) {
-  if (typeof payload.raw_value === "string")
-    return payload.raw_value;
-  const value = payload.value;
-  if (typeof value === "string" && value.startsWith("0x"))
-    return value;
-  if (value && typeof value === "object" && typeof value.hex === "string") {
-    return value.hex;
-  }
-  return null;
-}
 function toJsonSafe(value) {
   if (typeof value === "bigint")
     return value.toString();
@@ -1038,6 +1112,27 @@ function toJsonSafe(value) {
   }
   return value;
 }
+function decodeClarityValue(hex) {
+  try {
+    const clean = hex.startsWith("0x") ? hex.slice(2) : hex;
+    return toJsonSafe(cvToValue(deserializeCV(clean)));
+  } catch {
+    return hex;
+  }
+}
+
+// src/streams/print.ts
+function printValueHex(payload) {
+  if (typeof payload.raw_value === "string")
+    return payload.raw_value;
+  const value = payload.value;
+  if (typeof value === "string" && value.startsWith("0x"))
+    return value;
+  if (value && typeof value === "object" && typeof value.hex === "string") {
+    return value.hex;
+  }
+  return null;
+}
 function isPrint(event) {
   return event.event_type === "print";
 }
@@ -1048,17 +1143,7 @@ function decodePrint(event) {
   const payload = event.payload;
   const topic = optionalString(payload.topic);
   const rawValue = printValueHex(payload);
-  let value;
-  if (rawValue) {
-    try {
-      const hex = rawValue.startsWith("0x") ? rawValue.slice(2) : rawValue;
-      value = toJsonSafe(cvToValue(deserializeCV(hex)));
-    } catch {
-      value = toJsonSafe(payload.value ?? null);
-    }
-  } else {
-    value = toJsonSafe(payload.value ?? null);
-  }
+  const value = rawValue ? decodeClarityValue(rawValue) : toJsonSafe(payload.value ?? null);
   return decodedRow(event, "print", {
     contract_id: event.contract_id ?? optionalString(payload.contract_id),
     payload: { topic, value, raw_value: rawValue }
@@ -1123,6 +1208,7 @@ function verifyWebhookSignature(rawBody, headers, secret, toleranceSeconds = 300
 }
 export {
   verifyWebhookSignature,
+  toJsonSafe,
   isStxTransfer,
   isStxMint,
   isStxBurn,
@@ -1144,6 +1230,7 @@ export {
   decodeFtTransfer,
   decodeFtMint,
   decodeFtBurn,
+  decodeClarityValue,
   createStreamsClient,
   VersionConflictError,
   ValidationError,
@@ -1157,5 +1244,5 @@ export {
   ApiError
 };
 
-//# debugId=CA72339C973F500764756E2164756E21
+//# debugId=9D4DDE30AE2D8C2F64756E2164756E21
 //# sourceMappingURL=index.js.map