@secondlayer/stacks 4.3.1 → 5.0.0

package/dist/src/tools/index.d.cts

@@ -38,6 +38,15 @@ type NonceManager = {
 		client: Client
 		address: string
 	}): void | Promise<void>
+	/**
+	* Give back a nonce from {@link NonceManager.consume} whose transaction
+	* was never accepted by the node. No-op unless it is the latest issued.
+	*/
+	release(params: {
+		client: Client
+		address: string
+		nonce: bigint
+	}): void | Promise<void>
 	/** Next nonce that {@link NonceManager.consume} would return without consuming it, or `undefined` if untracked. */
 	peek(params: {
 		client: Client
@@ -93,14 +102,32 @@ type RequestOptions = {
 	method?: "GET" | "POST" | "PUT" | "DELETE"
 	body?: unknown
 	headers?: Record<string, string>
+	/**
+	* Cancel the request from the caller's side. An aborted signal rejects
+	* with the signal's reason immediately and never retries; it is combined
+	* with the transport's own per-attempt timeout.
+	*/
+	signal?: AbortSignal
+	/**
+	* Override the transport's retry budget for this one request. Broadcasts
+	* pass `0`: re-sending a transaction the node may already hold trades a
+	* transient failure for a confusing nonce conflict.
+	*/
+	retryCount?: number
 };
 /** Shared configuration for all transport types. */
 type TransportConfig = {
 	url?: string
+	/**
+	* Per-attempt deadline in ms covering headers AND body. A stalled body
+	* rejects with `TimeoutError` instead of hanging. Default 30_000.
+	*/
 	timeout?: number
 	retryCount?: number
 	retryDelay?: number
 	fetchOptions?: RequestInit
+	/** Sent as `x-api-key`. Held in the request closure and stripped from
+	*  `Transport.config` so it never prints with the client. */
 	apiKey?: string
 };
 /** A resolved transport instance with a bound request function. */
@@ -146,17 +173,34 @@ interface StacksTools {
 	getMempoolStats: LooseTool;
 	getNftHoldings: LooseTool;
 }
+/**
+* Bind the tool set to an explicit client.
+*
+* @deprecated Use `@secondlayer/mcp` for agent access to Stacks reads.
+*/
 declare function createStacksTools(client: StacksReadClient): StacksTools;
+/** @deprecated Use `@secondlayer/mcp`. */
 declare const getStxBalance: LooseTool;
+/** @deprecated Use `@secondlayer/mcp`. */
 declare const getAccountInfo: LooseTool;
+/** @deprecated Use `@secondlayer/mcp`. */
 declare const getBlock: LooseTool;
+/** @deprecated Use `@secondlayer/mcp`. */
 declare const getBlockHeight: LooseTool;
+/** @deprecated Use `@secondlayer/mcp`. */
 declare const readContract: LooseTool;
+/** @deprecated Use `@secondlayer/mcp`. */
 declare const estimateFee: LooseTool;
+/** @deprecated Use `@secondlayer/mcp`. */
 declare const bnsResolve: LooseTool;
+/** @deprecated Use `@secondlayer/mcp`. */
 declare const bnsReverse: LooseTool;
+/** @deprecated Use `@secondlayer/mcp`. */
 declare const getTransaction: LooseTool;
+/** @deprecated Use `@secondlayer/mcp`. */
 declare const getAccountHistory: LooseTool;
+/** @deprecated Use `@secondlayer/mcp`. */
 declare const getMempoolStats: LooseTool;
+/** @deprecated Use `@secondlayer/mcp`. */
 declare const getNftHoldings: LooseTool;
 export { readContract, getTransaction, getStxBalance, getNftHoldings, getMempoolStats, getBlockHeight, getBlock, getAccountInfo, getAccountHistory, estimateFee, createStacksTools, bnsReverse, bnsResolve, StacksTools };

package/dist/src/tools/index.d.ts

@@ -38,6 +38,15 @@ type NonceManager = {
 		client: Client
 		address: string
 	}): void | Promise<void>
+	/**
+	* Give back a nonce from {@link NonceManager.consume} whose transaction
+	* was never accepted by the node. No-op unless it is the latest issued.
+	*/
+	release(params: {
+		client: Client
+		address: string
+		nonce: bigint
+	}): void | Promise<void>
 	/** Next nonce that {@link NonceManager.consume} would return without consuming it, or `undefined` if untracked. */
 	peek(params: {
 		client: Client
@@ -93,14 +102,32 @@ type RequestOptions = {
 	method?: "GET" | "POST" | "PUT" | "DELETE"
 	body?: unknown
 	headers?: Record<string, string>
+	/**
+	* Cancel the request from the caller's side. An aborted signal rejects
+	* with the signal's reason immediately and never retries; it is combined
+	* with the transport's own per-attempt timeout.
+	*/
+	signal?: AbortSignal
+	/**
+	* Override the transport's retry budget for this one request. Broadcasts
+	* pass `0`: re-sending a transaction the node may already hold trades a
+	* transient failure for a confusing nonce conflict.
+	*/
+	retryCount?: number
 };
 /** Shared configuration for all transport types. */
 type TransportConfig = {
 	url?: string
+	/**
+	* Per-attempt deadline in ms covering headers AND body. A stalled body
+	* rejects with `TimeoutError` instead of hanging. Default 30_000.
+	*/
 	timeout?: number
 	retryCount?: number
 	retryDelay?: number
 	fetchOptions?: RequestInit
+	/** Sent as `x-api-key`. Held in the request closure and stripped from
+	*  `Transport.config` so it never prints with the client. */
 	apiKey?: string
 };
 /** A resolved transport instance with a bound request function. */
@@ -146,17 +173,34 @@ interface StacksTools {
 	getMempoolStats: LooseTool;
 	getNftHoldings: LooseTool;
 }
+/**
+* Bind the tool set to an explicit client.
+*
+* @deprecated Use `@secondlayer/mcp` for agent access to Stacks reads.
+*/
 declare function createStacksTools(client: StacksReadClient): StacksTools;
+/** @deprecated Use `@secondlayer/mcp`. */
 declare const getStxBalance: LooseTool;
+/** @deprecated Use `@secondlayer/mcp`. */
 declare const getAccountInfo: LooseTool;
+/** @deprecated Use `@secondlayer/mcp`. */
 declare const getBlock: LooseTool;
+/** @deprecated Use `@secondlayer/mcp`. */
 declare const getBlockHeight: LooseTool;
+/** @deprecated Use `@secondlayer/mcp`. */
 declare const readContract: LooseTool;
+/** @deprecated Use `@secondlayer/mcp`. */
 declare const estimateFee: LooseTool;
+/** @deprecated Use `@secondlayer/mcp`. */
 declare const bnsResolve: LooseTool;
+/** @deprecated Use `@secondlayer/mcp`. */
 declare const bnsReverse: LooseTool;
+/** @deprecated Use `@secondlayer/mcp`. */
 declare const getTransaction: LooseTool;
+/** @deprecated Use `@secondlayer/mcp`. */
 declare const getAccountHistory: LooseTool;
+/** @deprecated Use `@secondlayer/mcp`. */
 declare const getMempoolStats: LooseTool;
+/** @deprecated Use `@secondlayer/mcp`. */
 declare const getNftHoldings: LooseTool;
 export { readContract, getTransaction, getStxBalance, getNftHoldings, getMempoolStats, getBlockHeight, getBlock, getAccountInfo, getAccountHistory, estimateFee, createStacksTools, bnsReverse, bnsResolve, StacksTools };