@secondlayer/sdk 6.3.0 → 6.4.0

package/dist/index.d.ts

@@ -676,6 +676,61 @@ type StackingWalkParams = Omit<StackingListParams, "limit"> & {
 	batchSize?: number
 	signal?: AbortSignal
 };
+/** A pending (unconfirmed) transaction. Like a transaction document but
+*  pre-chain — no block_height/tx_index/result/events — with `received_at` and
+*  a sequence cursor instead of a block position. */
+type IndexMempoolTransaction = {
+	cursor: string
+	tx_id: string
+	tx_type: string
+	sender: string
+	received_at?: string | null
+	fee: string | null
+	nonce: string | null
+	sponsored: boolean | null
+	anchor_mode: string | null
+	post_condition_mode: string | null
+	post_conditions: IndexPostCondition[]
+	contract_call?: {
+		contract_id: string
+		function_name: string
+		function_args: unknown[]
+	}
+	token_transfer?: {
+		recipient: string
+		amount: string
+		memo: string
+	}
+	smart_contract?: {
+		clarity_version: number | null
+	}
+	coinbase?: {
+		alt_recipient: string | null
+	}
+	tenure_change?: {
+		cause: number
+	}
+};
+type MempoolEnvelope = {
+	mempool: IndexMempoolTransaction[]
+	next_cursor: string | null
+	tip: IndexTip
+};
+type MempoolTransactionEnvelope = {
+	transaction: IndexMempoolTransaction
+	tip: IndexTip
+};
+type MempoolListParams = {
+	cursor?: string | null
+	fromCursor?: string | null
+	limit?: number
+	sender?: string
+	type?: string
+};
+type MempoolWalkParams = Omit<MempoolListParams, "limit"> & {
+	batchSize?: number
+	signal?: AbortSignal
+};
 declare class Index extends BaseClient {
 	constructor(options?: Partial<SecondLayerOptions>);
 	readonly ftTransfers: {
@@ -720,6 +775,13 @@ declare class Index extends BaseClient {
 		list: (params?: StackingListParams) => Promise<StackingEnvelope>
 		walk: (params?: StackingWalkParams) => AsyncIterable<IndexStackingAction>
 	};
+	/** Pending (unconfirmed) transactions: paginated `list`/`walk`, plus `get` by
+	*  tx_id (resolves to null when the tx has confirmed or dropped). */
+	readonly mempool: {
+		list: (params?: MempoolListParams) => Promise<MempoolEnvelope>
+		walk: (params?: MempoolWalkParams) => AsyncIterable<IndexMempoolTransaction>
+		get: (txId: string) => Promise<MempoolTransactionEnvelope | null>
+	};
 	private listFtTransfers;
 	private listNftTransfers;
 	private walkFtTransfers;
@@ -738,6 +800,9 @@ declare class Index extends BaseClient {
 	private walkTransactions;
 	private listStacking;
 	private walkStacking;
+	private listMempool;
+	private getMempoolTx;
+	private walkMempool;
 }
 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];
@@ -1555,4 +1620,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, 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, TransactionsWalkParams, TransactionsListParams, TransactionsEnvelope, TransactionEnvelope, Subscriptions, SubscriptionSummary2 as SubscriptionSummary, SubscriptionStatus, SubscriptionRuntime, SubscriptionFormat, SubscriptionDetail2 as SubscriptionDetail, Subgraphs, SubgraphSpecOptions3 as SubgraphSpecOptions, SubgraphSpecFormat2 as SubgraphSpecFormat, SubgraphAgentSchema3 as SubgraphAgentSchema, StreamsTip, StreamsSignatureError, StreamsServerError, StreamsReorgsListParams, StreamsReorgsListEnvelope, StreamsReorgContext, StreamsReorg, StreamsEventsStreamParams, StreamsEventsListParams, StreamsEventsListEnvelope, StreamsEventsEnvelope, StreamsEventsConsumeResult, StreamsEventsConsumeParams, StreamsEventType, StreamsEventPayload, StreamsEvent, StreamsDumpsManifest, StreamsDumps, StreamsDumpFile, StreamsClient, StreamsCanonicalBlock, StreamsBatchContext, StackingWalkParams, StackingListParams, StackingEnvelope, SecondLayerOptions, SecondLayer, RotateSecretResponse2 as RotateSecretResponse, ReplayResult2 as ReplayResult, RateLimitError, Pox4CallsParams, NftTransfersWalkParams, NftTransfersListParams, NftTransfersEnvelope, NftTransferPayload, NftTransferEvent, NftTransfer, IndexTransaction, IndexTip, IndexStackingAction, IndexPostCondition, IndexEventType, IndexEvent, IndexContractCall, IndexCanonicalBlock, IndexBlock, 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, Datasets, DatasetRow, CursorListParams, CursorEnvelope, Cursor, CreateSubscriptionResponse2 as CreateSubscriptionResponse, CreateSubscriptionRequest2 as CreateSubscriptionRequest, ContractsListParams, ContractsEnvelope, Contracts, ContractSummary, ContractConformance, ContractCallsWalkParams, ContractCallsListParams, ContractCallsEnvelope, CanonicalWalkParams, CanonicalListParams, CanonicalEnvelope, CURSOR_SLUGS, BlocksWalkParams, BlocksListParams, BlocksEnvelope, BlockEnvelope, 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, TransactionsWalkParams, TransactionsListParams, TransactionsEnvelope, TransactionEnvelope, Subscriptions, SubscriptionSummary2 as SubscriptionSummary, SubscriptionStatus, SubscriptionRuntime, SubscriptionFormat, SubscriptionDetail2 as SubscriptionDetail, Subgraphs, SubgraphSpecOptions3 as SubgraphSpecOptions, SubgraphSpecFormat2 as SubgraphSpecFormat, SubgraphAgentSchema3 as SubgraphAgentSchema, StreamsTip, StreamsSignatureError, StreamsServerError, StreamsReorgsListParams, StreamsReorgsListEnvelope, StreamsReorgContext, StreamsReorg, StreamsEventsStreamParams, StreamsEventsListParams, StreamsEventsListEnvelope, StreamsEventsEnvelope, StreamsEventsConsumeResult, StreamsEventsConsumeParams, StreamsEventType, StreamsEventPayload, StreamsEvent, StreamsDumpsManifest, StreamsDumps, StreamsDumpFile, StreamsClient, StreamsCanonicalBlock, StreamsBatchContext, StackingWalkParams, StackingListParams, StackingEnvelope, SecondLayerOptions, SecondLayer, RotateSecretResponse2 as RotateSecretResponse, ReplayResult2 as ReplayResult, RateLimitError, Pox4CallsParams, NftTransfersWalkParams, NftTransfersListParams, NftTransfersEnvelope, NftTransferPayload, NftTransferEvent, NftTransfer, MempoolWalkParams, MempoolTransactionEnvelope, MempoolListParams, MempoolEnvelope, IndexTransaction, IndexTip, IndexStackingAction, IndexPostCondition, IndexMempoolTransaction, IndexEventType, IndexEvent, IndexContractCall, IndexCanonicalBlock, IndexBlock, 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, Datasets, DatasetRow, CursorListParams, CursorEnvelope, Cursor, CreateSubscriptionResponse2 as CreateSubscriptionResponse, CreateSubscriptionRequest2 as CreateSubscriptionRequest, ContractsListParams, ContractsEnvelope, Contracts, ContractSummary, ContractConformance, ContractCallsWalkParams, ContractCallsListParams, ContractCallsEnvelope, CanonicalWalkParams, CanonicalListParams, CanonicalEnvelope, CURSOR_SLUGS, BlocksWalkParams, BlocksListParams, BlocksEnvelope, BlockEnvelope, AuthError, ApiError };

package/dist/index.js

@@ -507,6 +507,11 @@ class Index extends BaseClient {
     list: (params = {}) => this.listStacking(params),
     walk: (params = {}) => this.walkStacking(params)
   };
+  mempool = {
+    list: (params = {}) => this.listMempool(params),
+    walk: (params = {}) => this.walkMempool(params),
+    get: (txId) => this.getMempoolTx(txId)
+  };
   async listFtTransfers(params = {}) {
     return this.request("GET", `/v1/index/ft-transfers${buildQuery({
       cursor: params.cursor,
@@ -818,6 +823,48 @@ class Index extends BaseClient {
       firstPage = false;
     }
   }
+  async listMempool(params = {}) {
+    return this.request("GET", `/v1/index/mempool${buildQuery({
+      cursor: params.cursor,
+      from_cursor: params.fromCursor,
+      limit: params.limit,
+      sender: params.sender,
+      type: params.type
+    })}`);
+  }
+  async getMempoolTx(txId) {
+    try {
+      return await this.request("GET", `/v1/index/mempool/${encodeURIComponent(txId)}`);
+    } catch (err) {
+      if (err instanceof ApiError && err.status === 404)
+        return null;
+      throw err;
+    }
+  }
+  async* walkMempool(params = {}) {
+    const batchSize = params.batchSize ?? 200;
+    let cursor = params.cursor ?? params.fromCursor ?? null;
+    let firstPage = true;
+    while (!params.signal?.aborted) {
+      const envelope = await this.listMempool({
+        ...params,
+        limit: batchSize,
+        cursor: firstPage ? params.cursor : cursor,
+        fromCursor: firstPage ? params.fromCursor : undefined
+      });
+      for (const tx of envelope.mempool) {
+        if (params.signal?.aborted)
+          return;
+        yield tx;
+      }
+      const nextCursor = envelope.next_cursor;
+      if (!nextCursor || nextCursor === cursor || envelope.mempool.length < batchSize) {
+        return;
+      }
+      cursor = nextCursor;
+      firstPage = false;
+    }
+  }
 }
 
 // src/streams/client.ts
@@ -1741,5 +1788,5 @@ export {
   ApiError
 };
 
-//# debugId=26B14752E7D837C264756E2164756E21
+//# debugId=795A191B3E98A82E64756E2164756E21
 //# sourceMappingURL=index.js.map