@secondlayer/stacks 5.1.2 → 6.0.0

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

@@ -1,206 +0,0 @@
-import { Tool } from "ai";
-/** Account derived from a local private key (mnemonic or raw key). */
-type LocalAccount = {
-	type: "local"
-	address: string
-	/** Compressed public key (hex) */
-	publicKey: string
-	/** Raw ECDSA sign over a hash */
-	sign(hash: Uint8Array): Uint8Array
-	/** Sign a raw UTF-8 / byte message (`sha256(bytes)`). Not SIP-018. */
-	signMessage(message: string | Uint8Array): string
-};
-/** Account with a user-provided signing function (sync or async). */
-type CustomAccount = {
-	type: "custom"
-	address: string
-	publicKey: string
-	sign(hash: Uint8Array): Promise<Uint8Array> | Uint8Array
-};
-/** Browser wallet provider interface (e.g. Leather, Xverse). */
-type StacksProvider = {
-	request(method: string, params?: any): Promise<any>
-};
-/** Account backed by a browser wallet {@link StacksProvider}. */
-type ProviderAccount = {
-	type: "provider"
-	address: string
-	publicKey: string
-	provider: StacksProvider
-};
-/** Allocates mempool-safe sequential nonces across rapid broadcasts from one account. */
-type NonceManager = {
-	consume(params: {
-		client: Client
-		address: string
-	}): Promise<bigint>
-	reset(params: {
-		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
-		address: string
-	}): Promise<bigint | undefined>
-};
-/** Full chain descriptor used by clients and transports for network-aware operations. */
-type StacksChain = {
-	/** Chain ID (e.g. 0x00000001 for mainnet) */
-	id: number
-	/** Human-readable name */
-	name: string
-	/** Network type */
-	network: "mainnet" | "testnet"
-	/** Transaction version byte for serialization */
-	transactionVersion: number
-	/** Peer network ID for P2P broadcasting */
-	peerNetworkId: number
-	/** Address version bytes */
-	addressVersion: {
-		singleSig: number
-		multiSig: number
-	}
-	/** Magic bytes for network identification */
-	magicBytes: string
-	/** Boot address (system contracts deployer) */
-	bootAddress: string
-	/** Native currency info */
-	nativeCurrency: {
-		name: string
-		symbol: string
-		decimals: number
-	}
-	/** Default RPC URLs */
-	rpcUrls: {
-		default: {
-			http: string[]
-			ws?: string[]
-		}
-	}
-	/** Block explorer URLs */
-	blockExplorers?: {
-		default: {
-			name: string
-			url: string
-		}
-	}
-};
-/** Function that sends an HTTP request to a Stacks node API path. */
-type RequestFn = (path: string, options?: RequestOptions) => Promise<any>;
-/** Options for a transport-level HTTP request. */
-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. */
-type Transport = {
-	type: string
-	request: RequestFn
-	config: TransportConfig
-	destroy?: () => void
-};
-/** Union of all supported account types (local key, custom signer, or browser provider). */
-type Account = LocalAccount | CustomAccount | ProviderAccount;
-/**
-* Core client instance that holds chain context, transport, and extensible actions.
-* Created via {@link createClient}, {@link createPublicClient}, or {@link createWalletClient}.
-*/
-type Client<TExtended extends Record<string, unknown> = Record<string, unknown>> = {
-	chain?: StacksChain
-	account?: Account
-	transport: Transport
-	request: RequestFn
-	/** Optional nonce manager for mempool-safe sequential nonces across rapid broadcasts. */
-	nonceManager?: NonceManager
-	extend: <const TNew extends Record<string, unknown>>(fn: (client: Client<TExtended>) => TNew) => Client<TExtended & TNew> & TNew
-} & TExtended;
-/**
-* Any Stacks client that can perform read-only RPC requests. We only need
-* the base `Client.request` contract; public actions are invoked as
-* free functions in `tools/index.ts`, so we keep this loose.
-*/
-type StacksReadClient = Client<Record<string, unknown>>;
-type LooseTool = Tool<any, any>;
-interface StacksTools {
-	getStxBalance: LooseTool;
-	getAccountInfo: LooseTool;
-	getBlock: LooseTool;
-	getBlockHeight: LooseTool;
-	readContract: LooseTool;
-	estimateFee: LooseTool;
-	bnsResolve: LooseTool;
-	bnsReverse: LooseTool;
-	getTransaction: LooseTool;
-	getAccountHistory: LooseTool;
-	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

@@ -1,206 +0,0 @@
-import { Tool } from "ai";
-/** Account derived from a local private key (mnemonic or raw key). */
-type LocalAccount = {
-	type: "local"
-	address: string
-	/** Compressed public key (hex) */
-	publicKey: string
-	/** Raw ECDSA sign over a hash */
-	sign(hash: Uint8Array): Uint8Array
-	/** Sign a raw UTF-8 / byte message (`sha256(bytes)`). Not SIP-018. */
-	signMessage(message: string | Uint8Array): string
-};
-/** Account with a user-provided signing function (sync or async). */
-type CustomAccount = {
-	type: "custom"
-	address: string
-	publicKey: string
-	sign(hash: Uint8Array): Promise<Uint8Array> | Uint8Array
-};
-/** Browser wallet provider interface (e.g. Leather, Xverse). */
-type StacksProvider = {
-	request(method: string, params?: any): Promise<any>
-};
-/** Account backed by a browser wallet {@link StacksProvider}. */
-type ProviderAccount = {
-	type: "provider"
-	address: string
-	publicKey: string
-	provider: StacksProvider
-};
-/** Allocates mempool-safe sequential nonces across rapid broadcasts from one account. */
-type NonceManager = {
-	consume(params: {
-		client: Client
-		address: string
-	}): Promise<bigint>
-	reset(params: {
-		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
-		address: string
-	}): Promise<bigint | undefined>
-};
-/** Full chain descriptor used by clients and transports for network-aware operations. */
-type StacksChain = {
-	/** Chain ID (e.g. 0x00000001 for mainnet) */
-	id: number
-	/** Human-readable name */
-	name: string
-	/** Network type */
-	network: "mainnet" | "testnet"
-	/** Transaction version byte for serialization */
-	transactionVersion: number
-	/** Peer network ID for P2P broadcasting */
-	peerNetworkId: number
-	/** Address version bytes */
-	addressVersion: {
-		singleSig: number
-		multiSig: number
-	}
-	/** Magic bytes for network identification */
-	magicBytes: string
-	/** Boot address (system contracts deployer) */
-	bootAddress: string
-	/** Native currency info */
-	nativeCurrency: {
-		name: string
-		symbol: string
-		decimals: number
-	}
-	/** Default RPC URLs */
-	rpcUrls: {
-		default: {
-			http: string[]
-			ws?: string[]
-		}
-	}
-	/** Block explorer URLs */
-	blockExplorers?: {
-		default: {
-			name: string
-			url: string
-		}
-	}
-};
-/** Function that sends an HTTP request to a Stacks node API path. */
-type RequestFn = (path: string, options?: RequestOptions) => Promise<any>;
-/** Options for a transport-level HTTP request. */
-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. */
-type Transport = {
-	type: string
-	request: RequestFn
-	config: TransportConfig
-	destroy?: () => void
-};
-/** Union of all supported account types (local key, custom signer, or browser provider). */
-type Account = LocalAccount | CustomAccount | ProviderAccount;
-/**
-* Core client instance that holds chain context, transport, and extensible actions.
-* Created via {@link createClient}, {@link createPublicClient}, or {@link createWalletClient}.
-*/
-type Client<TExtended extends Record<string, unknown> = Record<string, unknown>> = {
-	chain?: StacksChain
-	account?: Account
-	transport: Transport
-	request: RequestFn
-	/** Optional nonce manager for mempool-safe sequential nonces across rapid broadcasts. */
-	nonceManager?: NonceManager
-	extend: <const TNew extends Record<string, unknown>>(fn: (client: Client<TExtended>) => TNew) => Client<TExtended & TNew> & TNew
-} & TExtended;
-/**
-* Any Stacks client that can perform read-only RPC requests. We only need
-* the base `Client.request` contract; public actions are invoked as
-* free functions in `tools/index.ts`, so we keep this loose.
-*/
-type StacksReadClient = Client<Record<string, unknown>>;
-type LooseTool = Tool<any, any>;
-interface StacksTools {
-	getStxBalance: LooseTool;
-	getAccountInfo: LooseTool;
-	getBlock: LooseTool;
-	getBlockHeight: LooseTool;
-	readContract: LooseTool;
-	estimateFee: LooseTool;
-	bnsResolve: LooseTool;
-	bnsReverse: LooseTool;
-	getTransaction: LooseTool;
-	getAccountHistory: LooseTool;
-	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 };