@secondlayer/stacks 0.2.1 → 0.3.0

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

@@ -0,0 +1,144 @@
+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 structured message (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
+};
+/** 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>
+};
+/** Shared configuration for all transport types. */
+type TransportConfig = {
+	url?: string
+	timeout?: number
+	retryCount?: number
+	retryDelay?: number
+	fetchOptions?: RequestInit
+	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
+	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;
+}
+declare function createStacksTools(client: StacksReadClient): StacksTools;
+declare const getStxBalance: LooseTool;
+declare const getAccountInfo: LooseTool;
+declare const getBlock: LooseTool;
+declare const getBlockHeight: LooseTool;
+declare const readContract: LooseTool;
+declare const estimateFee: LooseTool;
+declare const bnsResolve: LooseTool;
+declare const bnsReverse: LooseTool;
+declare const getTransaction: LooseTool;
+declare const getAccountHistory: LooseTool;
+declare const getMempoolStats: LooseTool;
+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

@@ -0,0 +1,144 @@
+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 structured message (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
+};
+/** 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>
+};
+/** Shared configuration for all transport types. */
+type TransportConfig = {
+	url?: string
+	timeout?: number
+	retryCount?: number
+	retryDelay?: number
+	fetchOptions?: RequestInit
+	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
+	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;
+}
+declare function createStacksTools(client: StacksReadClient): StacksTools;
+declare const getStxBalance: LooseTool;
+declare const getAccountInfo: LooseTool;
+declare const getBlock: LooseTool;
+declare const getBlockHeight: LooseTool;
+declare const readContract: LooseTool;
+declare const estimateFee: LooseTool;
+declare const bnsResolve: LooseTool;
+declare const bnsReverse: LooseTool;
+declare const getTransaction: LooseTool;
+declare const getAccountHistory: LooseTool;
+declare const getMempoolStats: LooseTool;
+declare const getNftHoldings: LooseTool;
+export { readContract, getTransaction, getStxBalance, getNftHoldings, getMempoolStats, getBlockHeight, getBlock, getAccountInfo, getAccountHistory, estimateFee, createStacksTools, bnsReverse, bnsResolve, StacksTools };