@1sat/wallet-toolbox 0.0.1 → 0.0.2

package/dist/services/client/OwnerClient.d.ts

@@ -0,0 +1,58 @@
+import type { BalanceResponse, ClientOptions, IndexedOutput, SyncOutput, TxoQueryOptions } from "../types";
+import { BaseClient } from "./BaseClient";
+/**
+ * Client for /api/owner/* routes.
+ * Provides owner (address) queries and sync.
+ *
+ * Routes:
+ * - GET /:owner/txos - Get TXOs for owner
+ * - GET /:owner/balance - Get balance
+ * - GET /:owner/sync - SSE stream of outputs for sync
+ */
+export declare class OwnerClient extends BaseClient {
+    constructor(baseUrl: string, options?: ClientOptions);
+    /**
+     * Get TXOs owned by an address/owner
+     */
+    getTxos(owner: string, opts?: TxoQueryOptions & {
+        refresh?: boolean;
+    }): Promise<IndexedOutput[]>;
+    /**
+     * Get balance for an address/owner
+     */
+    getBalance(owner: string): Promise<BalanceResponse>;
+    /**
+     * Sync outputs for an owner via SSE stream.
+     * Returns an EventSource that emits SyncOutput events.
+     *
+     * @param owner - Address/owner to sync
+     * @param onOutput - Callback for each output
+     * @param from - Starting score (for pagination/resumption)
+     * @param onDone - Callback when sync completes (client should retry after delay)
+     * @param onError - Callback for errors
+     * @returns Unsubscribe function
+     */
+    sync(owner: string, onOutput: (output: SyncOutput) => void, from?: number, onDone?: () => void, onError?: (error: Error) => void): () => void;
+    /**
+     * Sync outputs for multiple owners via SSE stream.
+     * The server merges results from all owners in score order.
+     *
+     * @param owners - Array of addresses/owners to sync
+     * @param onOutput - Callback for each output
+     * @param from - Starting score (for pagination/resumption)
+     * @param onDone - Callback when sync completes (client should retry after delay)
+     * @param onError - Callback for errors
+     * @returns Unsubscribe function
+     */
+    syncMulti(owners: string[], onOutput: (output: SyncOutput) => void, from?: number, onDone?: () => void, onError?: (error: Error) => void): () => void;
+    /**
+     * Sync outputs as an async iterator.
+     * Yields SyncOutput objects until the stream is done.
+     */
+    syncIterator(owner: string, from?: number): AsyncGenerator<SyncOutput, void, unknown>;
+    /**
+     * Sync outputs for multiple owners as an async iterator.
+     * Yields SyncOutput objects until the stream is done.
+     */
+    syncMultiIterator(owners: string[], from?: number): AsyncGenerator<SyncOutput, void, unknown>;
+}

package/dist/services/client/TxoClient.d.ts

@@ -0,0 +1,46 @@
+import type { ClientOptions, IndexedOutput, SearchRequest, TxoQueryOptions } from "../types";
+import { BaseClient } from "./BaseClient";
+/**
+ * Client for /api/txo/* routes.
+ * Provides TXO (transaction output) lookup and search.
+ *
+ * Routes:
+ * - GET /outpoint/:outpoint - Get single TXO
+ * - GET /outpoint/:outpoint/spend - Get spend info
+ * - POST /outpoints - Get multiple TXOs
+ * - POST /outpoints/spends - Get multiple spends
+ * - GET /tx/:txid - Get all TXOs for a transaction
+ * - GET /search/:key - Search by single key
+ * - POST /search - Search by multiple keys
+ */
+export declare class TxoClient extends BaseClient {
+    constructor(baseUrl: string, options?: ClientOptions);
+    /**
+     * Get a single TXO by outpoint
+     */
+    get(outpoint: string, opts?: TxoQueryOptions): Promise<IndexedOutput>;
+    /**
+     * Get multiple TXOs by outpoints
+     */
+    getBatch(outpoints: string[], opts?: TxoQueryOptions): Promise<(IndexedOutput | null)[]>;
+    /**
+     * Get spend info for an outpoint
+     */
+    getSpend(outpoint: string): Promise<string | null>;
+    /**
+     * Get spend info for multiple outpoints
+     */
+    getSpends(outpoints: string[]): Promise<(string | null)[]>;
+    /**
+     * Get all TXOs for a transaction
+     */
+    getByTxid(txid: string, opts?: TxoQueryOptions): Promise<IndexedOutput[]>;
+    /**
+     * Search TXOs by a single key
+     */
+    search(key: string, opts?: TxoQueryOptions): Promise<IndexedOutput[]>;
+    /**
+     * Search TXOs by multiple keys
+     */
+    searchMultiple(req: SearchRequest): Promise<IndexedOutput[]>;
+}

package/dist/services/client/index.d.ts

@@ -0,0 +1,8 @@
+export { BaseClient } from "./BaseClient";
+export { ChaintracksClient } from "./ChaintracksClient";
+export { BeefClient } from "./BeefClient";
+export { ArcadeClient } from "./ArcadeClient";
+export { TxoClient } from "./TxoClient";
+export { OwnerClient } from "./OwnerClient";
+export { OrdfsClient } from "./OrdfsClient";
+export { Bsv21Client } from "./Bsv21Client";

package/dist/services/types.d.ts

@@ -0,0 +1,226 @@
+/**
+ * Consolidated type definitions for 1sat-stack API clients.
+ * These types mirror the structures returned by the 1sat-stack server.
+ */
+/**
+ * Options for configuring API clients
+ */
+export interface ClientOptions {
+    /** Request timeout in milliseconds (default: 30000) */
+    timeout?: number;
+    /** Custom fetch implementation */
+    fetch?: typeof fetch;
+}
+/**
+ * Server capabilities returned by /api/capabilities endpoint.
+ * These match the actual capability names from 1sat-stack.
+ */
+export type Capability = "beef" | "pubsub" | "txo" | "owner" | "indexer" | "bsv21" | "ordfs" | "chaintracks" | "arcade" | "overlay";
+/**
+ * Block header data returned by chaintracks endpoints
+ */
+export interface BlockHeader {
+    height: number;
+    hash: string;
+    version: number;
+    prevHash: string;
+    merkleRoot: string;
+    time: number;
+    bits: number;
+    nonce: number;
+}
+/**
+ * Transaction status values from arcade
+ */
+export type TxStatus = "UNKNOWN" | "RECEIVED" | "SENT_TO_NETWORK" | "ACCEPTED_BY_NETWORK" | "SEEN_ON_NETWORK" | "DOUBLE_SPEND_ATTEMPTED" | "REJECTED" | "MINED" | "IMMUTABLE";
+/**
+ * Transaction status response from arcade
+ */
+export interface TransactionStatus {
+    txid: string;
+    txStatus: TxStatus;
+    timestamp: string;
+    blockHash?: string;
+    blockHeight?: number;
+    merklePath?: string;
+    extraInfo?: string;
+    competingTxs?: string[];
+}
+/**
+ * Options for submitting transactions to arcade
+ */
+export interface SubmitOptions {
+    /** URL for status callbacks */
+    callbackUrl?: string;
+    /** Token for authenticating callbacks */
+    callbackToken?: string;
+    /** Receive all status updates, not just final */
+    fullStatusUpdates?: boolean;
+    /** Skip fee validation */
+    skipFeeValidation?: boolean;
+    /** Skip script validation */
+    skipScriptValidation?: boolean;
+}
+/**
+ * Mining policy from arcade
+ */
+export interface Policy {
+    maxscriptsizepolicy: number;
+    maxtxsigopscountspolicy: number;
+    maxtxsizepolicy: number;
+    miningFee: {
+        satoshis: number;
+        bytes: number;
+    };
+}
+/**
+ * Indexed transaction output
+ */
+export interface IndexedOutput {
+    outpoint: string;
+    satoshis: number;
+    script?: string;
+    height?: number;
+    idx?: number;
+    owners?: string[];
+    events?: string[];
+    data?: Record<string, unknown>;
+    spend?: string;
+    score: number;
+}
+/**
+ * Spend information response
+ */
+export interface SpendResponse {
+    spendTxid: string | null;
+}
+/**
+ * Options for querying TXOs
+ */
+export interface TxoQueryOptions {
+    /** Tags to include in response data */
+    tags?: string[];
+    /** Include script in response */
+    script?: boolean;
+    /** Starting score for pagination */
+    from?: number;
+    /** Maximum results to return */
+    limit?: number;
+    /** Reverse order */
+    rev?: boolean;
+    /** Filter for unspent only */
+    unspent?: boolean;
+}
+/**
+ * Search request for multiple keys
+ */
+export interface SearchRequest {
+    keys: string[];
+    limit?: number;
+    from?: number;
+    reverse?: boolean;
+    unspent?: boolean;
+    tags?: string[];
+}
+/**
+ * Balance response from owner endpoint
+ */
+export interface BalanceResponse {
+    balance: number;
+    count: number;
+}
+/**
+ * Sync output streamed via SSE
+ */
+export interface SyncOutput {
+    outpoint: string;
+    score: number;
+    spendTxid?: string;
+}
+/**
+ * Indexed output from parse/ingest operations
+ */
+export interface IndexedTxo {
+    outpoint: string;
+    satoshis: number;
+    script?: string;
+    owners?: string[];
+    events?: string[];
+    data?: Record<string, unknown>;
+}
+/**
+ * Index context returned by parse/ingest
+ */
+export interface IndexContext {
+    txid: string;
+    score: number;
+    outputs: IndexedTxo[];
+}
+/**
+ * OrdFS metadata for an inscription
+ */
+export interface OrdfsMetadata {
+    outpoint: string;
+    origin?: string;
+    sequence: number;
+    contentType: string;
+    contentLength: number;
+    parent?: string;
+    map?: Record<string, unknown>;
+}
+/**
+ * BSV21 token details (deploy data)
+ */
+export interface Bsv21TokenDetails {
+    id: string;
+    txid: string;
+    vout: number;
+    op: string;
+    amt: string;
+    sym?: string;
+    dec: number;
+    icon?: string;
+}
+/**
+ * BSV21 token data structure from overlay API
+ */
+export interface Bsv21TokenData {
+    id: string;
+    op: string;
+    amt: string;
+    sym?: string;
+    dec?: number;
+    icon?: string;
+    address?: string;
+}
+/**
+ * BSV21 output data from overlay API
+ */
+export interface Bsv21OutputData {
+    txid: string;
+    vout: number;
+    data: {
+        bsv21: Bsv21TokenData;
+    };
+    script: string;
+    satoshis: number;
+    spend: string | null;
+    score: number;
+}
+/**
+ * BSV21 transaction data from overlay API
+ */
+export interface Bsv21TransactionData {
+    txid: string;
+    inputs: Bsv21OutputData[];
+    outputs: Bsv21OutputData[];
+    beef?: string;
+}
+/**
+ * Event from SSE subscription
+ */
+export interface SseEvent {
+    topic: string;
+    data: string;
+    score?: number;
+}

package/dist/signers/ReadOnlySigner.d.ts

@@ -1,4 +1,4 @@
-import { type KeyDeriverApi, type PrivateKey, type WalletProtocol, type Counterparty } from "@bsv/sdk";
+import { type Counterparty, type KeyDeriverApi, type PrivateKey, type WalletProtocol } from "@bsv/sdk";
 /**
  * A read-only KeyDeriver that exposes an identity key but throws on any signing/derivation operation.
  * Used when the wallet is instantiated with only a public key.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@1sat/wallet-toolbox",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "description": "BSV wallet library extending @bsv/wallet-toolbox with 1Sat Ordinals protocol support",
   "author": "1Sat Team",
   "license": "MIT",
@@ -32,10 +32,13 @@
     "dev": "tsc --watch",
     "lint": "biome check src",
     "lint:fix": "biome check --write src",
-    "test": "bun test"
+    "test": "bun test",
+    "tester:build": "bun build ./tester/src/entry.ts --outdir ./tester/dist --target browser --splitting --define 'process.env={}' --define 'global=globalThis' --sourcemap=inline",
+    "tester": "bun run build && bun run tester:build && bun ./tester/server.ts"
   },
   "dependencies": {
-    "@bsv/sdk": "^1.9.24",
+    "@bopen-io/ts-templates": "^1.1.0",
+    "@bsv/sdk": "1.9.24",
     "@bsv/wallet-toolbox": "^1.7.14",
     "buffer": "^6.0.3"
   },

package/dist/indexers/TransactionParser.d.ts

@@ -1,53 +0,0 @@
-import { Transaction } from "@bsv/sdk";
-import type { Indexer } from "./types";
-import type { OneSatServices } from "../services/OneSatServices";
-/**
- * Represents the result of parsing a single output
- */
-export interface ParsedOutput {
-    vout: number;
-    basket: string;
-    tags: string[];
-    customInstructions?: unknown;
-}
-/**
- * Represents the result of parsing an entire transaction
- */
-export interface ParseResult {
-    outputs: ParsedOutput[];
-    summary?: unknown;
-}
-/**
- * TransactionParser runs indexers over a transaction to extract
- * basket, tags, and custom instructions for wallet-toolbox.
- *
- * This is a stripped-down version of TxoStore.ingest() that only
- * handles parsing without SPV verification or storage.
- */
-export declare class TransactionParser {
-    indexers: Indexer[];
-    owners: Set<string>;
-    private services;
-    constructor(indexers: Indexer[], owners: Set<string>, services: OneSatServices);
-    /**
-     * Parse a transaction and extract wallet-toolbox metadata
-     */
-    parse(tx: Transaction, isBroadcasted: boolean): Promise<ParseResult>;
-    /**
-     * Parse all inputs - run indexers on source outputs to populate ctx.spends
-     */
-    private parseInputs;
-    /**
-     * Load source transactions for all inputs and set them on tx.inputs[].sourceTransaction
-     */
-    private loadSourceTransactions;
-    /**
-     * Build minimal parse context from transaction
-     */
-    private buildContext;
-    /**
-     * Convert parsed context to wallet-toolbox format with baskets and tags
-     * Filters outputs to only return those owned by addresses in the owners set
-     */
-    private convertToWalletToolboxFormat;
-}