stellar-contracts-kit 0.1.0

package/dist/index.d.cts

@@ -0,0 +1,95 @@
+import { WalletAdapter, ConnectResult } from './wallets/index.cjs';
+export { CyphrasAdapter, FreighterAdapter, LobstrAdapter, SignAuthEntryOpts, SignTransactionOpts } from './wallets/index.cjs';
+
+interface NetworkConfig {
+    rpcUrl: string;
+    networkPassphrase: string;
+    horizonUrl: string;
+}
+type NetworkPreset = 'mainnet' | 'testnet' | 'futurenet';
+declare const NETWORKS: Record<NetworkPreset, NetworkConfig>;
+
+interface ReadResult<T = unknown> {
+    result: T;
+}
+interface WriteResult<T = unknown> {
+    txHash: string;
+    result: T | undefined;
+}
+/** A single contract method with auto/read/invoke call modes. Use ContractMethodFn<ReturnType, [arg: Type, ...]> to type each method. */
+type ContractMethodFn<TReturn = unknown, TArgs extends unknown[] = unknown[]> = {
+    (...args: TArgs): Promise<WriteResult<TReturn> | ReadResult<TReturn>>;
+    read(...args: TArgs): Promise<ReadResult<TReturn>>;
+    simulate(...args: TArgs): Promise<ReadResult<TReturn>>;
+    invoke(...args: TArgs): Promise<WriteResult<TReturn>>;
+};
+type ContractClient = Record<string, ContractMethodFn>;
+
+interface StellarContractsKitOptions {
+    network: NetworkPreset | NetworkConfig;
+    /** If omitted, connect() opens the built-in picker modal. */
+    wallet?: WalletAdapter;
+}
+declare class StellarContractsKit {
+    private readonly network;
+    private readonly server;
+    private wallet;
+    private readonly specCache;
+    constructor(options: StellarContractsKitOptions);
+    setWallet(wallet: WalletAdapter): void;
+    /** Returns the active wallet adapter, or null if none is set. */
+    getWallet(): WalletAdapter | null;
+    /** Connects to the configured wallet, or opens the built-in picker modal if none is set. */
+    connect(): Promise<ConnectResult>;
+    /** Disconnects the current wallet and clears the active adapter. */
+    disconnect(): Promise<void>;
+    isConnected(): boolean;
+    /** Returns the address of the connected wallet. Throws WALLET_NOT_CONNECTED if no wallet is set. */
+    getAddress(): Promise<string>;
+    getNetwork(): NetworkConfig;
+    /**
+     * Loads a typed contract client. Pass a generated interface as the type param for full autocomplete.
+     * No wallet required for read/simulate calls. A wallet is required before calling invoke.
+     * The spec is fetched once and cached; subsequent calls with the same ID are instant.
+     */
+    contract<T extends {
+        [K in keyof T]: ContractMethodFn<any, any[]>;
+    } = ContractClient>(contractId: string): Promise<T>;
+    /**
+     * Restores an expired contract's on-chain state.
+     * Call this when contract() or invoke() throws CONTRACT_RESTORE_REQUIRED.
+     */
+    restoreContract(contractId: string): Promise<{
+        txHash: string;
+    }>;
+    /** Clears the cached contract spec. Pass a contractId to clear one, or omit to clear all. */
+    clearSpecCache(contractId?: string): void;
+}
+
+interface PickResult {
+    adapter: WalletAdapter;
+    address: string;
+}
+declare class WalletPickerModal {
+    private overlay;
+    private onKeydown;
+    pick(): Promise<PickResult>;
+    private render;
+    private close;
+    private dismiss;
+}
+
+type ErrorCode = 'WALLET_NOT_FOUND' | 'WALLET_NOT_CONNECTED' | 'WALLET_REJECTED' | 'WALLET_NETWORK_MISMATCH' | 'CONTRACT_NOT_FOUND' | 'CONTRACT_SPEC_ERROR' | 'CONTRACT_SIMULATION_FAILED' | 'CONTRACT_RESTORE_REQUIRED' | 'INVALID_CONTRACT_ID' | 'INVALID_PARAMS' | 'TX_SUBMISSION_FAILED' | 'TX_TIMEOUT' | 'TX_FAILED' | 'RPC_ERROR' | 'UNKNOWN';
+interface ContractKitError {
+    code: ErrorCode;
+    message: string;
+    cause?: unknown;
+}
+declare class StellarContractError extends Error {
+    readonly code: ErrorCode;
+    readonly cause?: unknown;
+    constructor(code: ErrorCode, message: string, cause?: unknown);
+}
+declare function isContractKitError(err: unknown): err is StellarContractError;
+
+export { ConnectResult, type ContractClient, type ContractKitError, type ContractMethodFn, type ErrorCode, NETWORKS, type NetworkConfig, type NetworkPreset, type PickResult, type ReadResult, StellarContractError, StellarContractsKit, type StellarContractsKitOptions, WalletAdapter, WalletPickerModal, type WriteResult, isContractKitError };

package/dist/index.d.ts

@@ -0,0 +1,95 @@
+import { WalletAdapter, ConnectResult } from './wallets/index.js';
+export { CyphrasAdapter, FreighterAdapter, LobstrAdapter, SignAuthEntryOpts, SignTransactionOpts } from './wallets/index.js';
+
+interface NetworkConfig {
+    rpcUrl: string;
+    networkPassphrase: string;
+    horizonUrl: string;
+}
+type NetworkPreset = 'mainnet' | 'testnet' | 'futurenet';
+declare const NETWORKS: Record<NetworkPreset, NetworkConfig>;
+
+interface ReadResult<T = unknown> {
+    result: T;
+}
+interface WriteResult<T = unknown> {
+    txHash: string;
+    result: T | undefined;
+}
+/** A single contract method with auto/read/invoke call modes. Use ContractMethodFn<ReturnType, [arg: Type, ...]> to type each method. */
+type ContractMethodFn<TReturn = unknown, TArgs extends unknown[] = unknown[]> = {
+    (...args: TArgs): Promise<WriteResult<TReturn> | ReadResult<TReturn>>;
+    read(...args: TArgs): Promise<ReadResult<TReturn>>;
+    simulate(...args: TArgs): Promise<ReadResult<TReturn>>;
+    invoke(...args: TArgs): Promise<WriteResult<TReturn>>;
+};
+type ContractClient = Record<string, ContractMethodFn>;
+
+interface StellarContractsKitOptions {
+    network: NetworkPreset | NetworkConfig;
+    /** If omitted, connect() opens the built-in picker modal. */
+    wallet?: WalletAdapter;
+}
+declare class StellarContractsKit {
+    private readonly network;
+    private readonly server;
+    private wallet;
+    private readonly specCache;
+    constructor(options: StellarContractsKitOptions);
+    setWallet(wallet: WalletAdapter): void;
+    /** Returns the active wallet adapter, or null if none is set. */
+    getWallet(): WalletAdapter | null;
+    /** Connects to the configured wallet, or opens the built-in picker modal if none is set. */
+    connect(): Promise<ConnectResult>;
+    /** Disconnects the current wallet and clears the active adapter. */
+    disconnect(): Promise<void>;
+    isConnected(): boolean;
+    /** Returns the address of the connected wallet. Throws WALLET_NOT_CONNECTED if no wallet is set. */
+    getAddress(): Promise<string>;
+    getNetwork(): NetworkConfig;
+    /**
+     * Loads a typed contract client. Pass a generated interface as the type param for full autocomplete.
+     * No wallet required for read/simulate calls. A wallet is required before calling invoke.
+     * The spec is fetched once and cached; subsequent calls with the same ID are instant.
+     */
+    contract<T extends {
+        [K in keyof T]: ContractMethodFn<any, any[]>;
+    } = ContractClient>(contractId: string): Promise<T>;
+    /**
+     * Restores an expired contract's on-chain state.
+     * Call this when contract() or invoke() throws CONTRACT_RESTORE_REQUIRED.
+     */
+    restoreContract(contractId: string): Promise<{
+        txHash: string;
+    }>;
+    /** Clears the cached contract spec. Pass a contractId to clear one, or omit to clear all. */
+    clearSpecCache(contractId?: string): void;
+}
+
+interface PickResult {
+    adapter: WalletAdapter;
+    address: string;
+}
+declare class WalletPickerModal {
+    private overlay;
+    private onKeydown;
+    pick(): Promise<PickResult>;
+    private render;
+    private close;
+    private dismiss;
+}
+
+type ErrorCode = 'WALLET_NOT_FOUND' | 'WALLET_NOT_CONNECTED' | 'WALLET_REJECTED' | 'WALLET_NETWORK_MISMATCH' | 'CONTRACT_NOT_FOUND' | 'CONTRACT_SPEC_ERROR' | 'CONTRACT_SIMULATION_FAILED' | 'CONTRACT_RESTORE_REQUIRED' | 'INVALID_CONTRACT_ID' | 'INVALID_PARAMS' | 'TX_SUBMISSION_FAILED' | 'TX_TIMEOUT' | 'TX_FAILED' | 'RPC_ERROR' | 'UNKNOWN';
+interface ContractKitError {
+    code: ErrorCode;
+    message: string;
+    cause?: unknown;
+}
+declare class StellarContractError extends Error {
+    readonly code: ErrorCode;
+    readonly cause?: unknown;
+    constructor(code: ErrorCode, message: string, cause?: unknown);
+}
+declare function isContractKitError(err: unknown): err is StellarContractError;
+
+export { ConnectResult, type ContractClient, type ContractKitError, type ContractMethodFn, type ErrorCode, NETWORKS, type NetworkConfig, type NetworkPreset, type PickResult, type ReadResult, StellarContractError, StellarContractsKit, type StellarContractsKitOptions, WalletAdapter, WalletPickerModal, type WriteResult, isContractKitError };