@secondlayer/sdk 5.3.0 → 5.5.0

package/dist/index.d.ts

@@ -176,6 +176,146 @@ 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 IndexStxLock = IndexEventBase & {
+	event_type: "stx_lock"
+	sender: string
+	amount: string
+	payload: {
+		unlock_height: string | null
+	}
+};
+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 | IndexStxLock | 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 +326,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];
@@ -509,6 +662,27 @@ 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
@@ -635,7 +809,7 @@ type DecodedEventColumns = {
 	/** JSONB overflow for non-flat types (e.g. print's decoded value). */
 	payload?: unknown
 };
-type DecodedEventRow = DecodedFtTransfer | DecodedNftTransfer | DecodedStxTransfer | DecodedStxMint | DecodedStxBurn | DecodedFtMint | DecodedFtBurn | DecodedNftMint | DecodedNftBurn | DecodedPrint;
+type DecodedEventRow = DecodedFtTransfer | DecodedNftTransfer | DecodedStxTransfer | DecodedStxMint | DecodedStxBurn | DecodedStxLock | DecodedFtMint | DecodedFtBurn | DecodedNftMint | DecodedNftBurn | DecodedPrint;
 import { SubgraphAgentSchema as SubgraphAgentSchema3, SubgraphSpecFormat as SubgraphSpecFormat2, SubgraphSpecOptions as SubgraphSpecOptions3 } from "@secondlayer/shared/subgraphs/spec";
 /**
 * Error thrown by {@link SecondLayer} when an API request fails.
@@ -754,4 +928,4 @@ 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, 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 };
+export { verifyWebhookSignature, toJsonSafe, isStxTransfer, isStxMint, isStxLock, isStxBurn, isPrint, isNftTransfer, isNftMint, isNftBurn, isFtTransfer, isFtMint, isFtBurn, getSubgraph, decodeStxTransfer, decodeStxMint, decodeStxLock, 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, DecodedStxLockPayload, DecodedStxLock, 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
@@ -859,13 +944,16 @@ function requireString3(payload, field, eventType) {
 function optionalString(value) {
   return typeof value === "string" && value.length > 0 ? value : null;
 }
-function requireAmount(payload, eventType) {
-  const amount = requireString3(payload, "amount", eventType);
+function requireAmountField(payload, field, eventType) {
+  const amount = requireString3(payload, field, eventType);
   if (!/^(0|[1-9]\d*)$/.test(amount)) {
-    throw new Error(`${eventType} payload has malformed amount`);
+    throw new Error(`${eventType} payload has malformed ${field}`);
   }
   return amount;
 }
+function requireAmount(payload, eventType) {
+  return requireAmountField(payload, "amount", eventType);
+}
 function parseAssetIdentifier3(assetIdentifier, eventType) {
   const [contractId, tokenName] = assetIdentifier.split("::");
   if (!contractId) {
@@ -949,6 +1037,20 @@ function decodeStxBurn(event) {
     amount: requireAmount(payload, "stx_burn")
   });
 }
+function isStxLock(event) {
+  return event.event_type === "stx_lock";
+}
+function decodeStxLock(event) {
+  if (!isStxLock(event)) {
+    throw new Error(`Expected stx_lock event, got ${event.event_type}`);
+  }
+  const payload = event.payload;
+  return decodedRow(event, "stx_lock", {
+    sender: requireString3(payload, "locked_address", "stx_lock"),
+    amount: requireAmountField(payload, "locked_amount", "stx_lock"),
+    payload: { unlock_height: optionalString(payload.unlock_height) }
+  });
+}
 // src/streams/token-mint-burn.ts
 function assetFields(event, eventType) {
   const assetIdentifier = requireString3(event.payload, "asset_identifier", eventType);
@@ -1126,6 +1228,7 @@ export {
   toJsonSafe,
   isStxTransfer,
   isStxMint,
+  isStxLock,
   isStxBurn,
   isPrint,
   isNftTransfer,
@@ -1137,6 +1240,7 @@ export {
   getSubgraph,
   decodeStxTransfer,
   decodeStxMint,
+  decodeStxLock,
   decodeStxBurn,
   decodePrint,
   decodeNftTransfer,
@@ -1159,5 +1263,5 @@ export {
   ApiError
 };
 
-//# debugId=BEB990480FF963F864756E2164756E21
+//# debugId=4BB5ADD439A129B064756E2164756E21
 //# sourceMappingURL=index.js.map