@1sat/wallet 0.0.3 → 0.0.4

package/dist/OneSatWallet.d.ts

@@ -0,0 +1,222 @@
+import { OneSatServices } from '@1sat/client';
+import type { Indexer, ParseContext, SyncOutput, Txo } from '@1sat/types';
+import { type PrivateKey, Transaction } from '@bsv/sdk';
+import { Wallet, type WalletStorageManager, type sdk as mobileSdk } from '@bsv/wallet-toolbox-mobile';
+import { Outpoint } from './indexers/Outpoint';
+type Chain = mobileSdk.Chain;
+type EventCallback<T> = (event: T) => void;
+/**
+ * Result of ingestTransaction including parse context for debugging
+ */
+export interface IngestResult {
+    parseContext: ParseContext;
+    internalizedCount: number;
+}
+/**
+ * Events emitted by OneSatWallet during sync operations
+ */
+export interface OneSatWalletEvents {
+    'sync:start': {
+        address: string;
+        fromScore: number;
+    };
+    'sync:output': {
+        address: string;
+        output: SyncOutput;
+    };
+    'sync:skipped': {
+        address: string;
+        outpoint: string;
+        reason: string;
+    };
+    'sync:parsed': {
+        address: string;
+        txid: string;
+        parseContext: ParseContext;
+        internalizedCount: number;
+    };
+    'sync:error': {
+        address: string;
+        error: Error;
+    };
+    'sync:complete': {
+        address: string;
+    };
+    'syncAll:start': {
+        addresses: string[];
+        fromScore: number;
+    };
+    'syncAll:output': {
+        output: SyncOutput;
+    };
+    'syncAll:skipped': {
+        outpoint: string;
+        reason: string;
+    };
+    'syncAll:parsed': {
+        txid: string;
+        parseContext: ParseContext;
+        internalizedCount: number;
+    };
+    'syncAll:error': {
+        error: Error;
+    };
+    'syncAll:complete': {
+        addresses: string[];
+    };
+}
+export interface OneSatWalletArgs {
+    /**
+     * Either a public key hex string (read-only mode) or a PrivateKey (full signing).
+     */
+    rootKey: string | PrivateKey;
+    /**
+     * The storage manager for the wallet.
+     */
+    storage: WalletStorageManager;
+    /**
+     * Network: 'main' or 'test'
+     */
+    chain: Chain;
+    /**
+     * Addresses owned by this wallet, used for filtering indexed outputs.
+     */
+    owners?: Set<string>;
+    /**
+     * Indexers to use for parsing transactions.
+     * If not provided, default indexers will be used.
+     */
+    indexers?: Indexer[];
+    /**
+     * Custom 1Sat API URL (default: based on chain - mainnet or testnet)
+     */
+    onesatUrl?: string;
+    /**
+     * Automatically start syncing all owner addresses on construction.
+     */
+    autoSync?: boolean;
+}
+/**
+ * OneSatWallet extends the BRC-100 Wallet with 1Sat-specific indexing and services.
+ *
+ * Can be instantiated with either:
+ * - A public key (read-only mode for queries)
+ * - A private key (full signing capability)
+ */
+export declare class OneSatWallet extends Wallet {
+    private readonly isReadOnly;
+    private readonly indexers;
+    readonly services: OneSatServices;
+    private owners;
+    private listeners;
+    private activeSyncs;
+    private activeMultiSync;
+    constructor(args: OneSatWalletArgs);
+    /**
+     * Returns true if this wallet was created with only a public key.
+     * Read-only wallets can query but not sign transactions.
+     */
+    get readOnly(): boolean;
+    /**
+     * Subscribe to wallet events
+     */
+    on<K extends keyof OneSatWalletEvents>(event: K, callback: EventCallback<OneSatWalletEvents[K]>): void;
+    /**
+     * Unsubscribe from wallet events
+     */
+    off<K extends keyof OneSatWalletEvents>(event: K, callback: EventCallback<OneSatWalletEvents[K]>): void;
+    /**
+     * Emit a wallet event
+     */
+    private emit;
+    /**
+     * Add an address to the set of owned addresses.
+     * Outputs to these addresses will be indexed.
+     */
+    addOwner(address: string): void;
+    /**
+     * Parse a transaction through indexers without internalizing.
+     *
+     * This is useful for debugging/testing to see what the indexers produce
+     * without actually storing the transaction in the wallet.
+     */
+    parseTransaction(txOrTxid: Transaction | string, isBroadcasted?: boolean): Promise<ParseContext>;
+    /**
+     * Parse a single output without full transaction context.
+     * Runs all indexers' parse() methods but NOT summarize().
+     */
+    parseOutput(output: Transaction['outputs'][0], outpoint: Outpoint): Promise<Txo>;
+    /**
+     * Load and parse a single output by outpoint.
+     * Loads the transaction, extracts the output, and runs indexers on it.
+     */
+    loadTxo(outpoint: string): Promise<Txo>;
+    /**
+     * Run all indexers on a single Txo and populate its data/owner/basket
+     */
+    runIndexersOnTxo(txo: Txo): Promise<void>;
+    /**
+     * Parse all inputs - run indexers on source outputs to populate ctx.spends
+     */
+    private parseInputs;
+    /**
+     * Load a transaction by txid.
+     * Checks storage first, falls back to beef service.
+     */
+    loadTransaction(txid: string): Promise<Transaction>;
+    /**
+     * Load and attach source transactions for all inputs (1 level deep).
+     * Modifies the transaction in place.
+     */
+    hydrateSourceTransactions(tx: Transaction): Promise<void>;
+    /**
+     * Build minimal parse context from transaction
+     */
+    buildParseContext(tx: Transaction): ParseContext;
+    /**
+     * Ingest a transaction by running it through indexers and writing directly to storage.
+     */
+    ingestTransaction(tx: Transaction, description: string, labels?: string[], isBroadcasted?: boolean): Promise<IngestResult>;
+    /**
+     * Broadcast a transaction and ingest it into the wallet if successful.
+     */
+    broadcast(tx: Transaction, description: string, labels?: string[]): Promise<IngestResult>;
+    /**
+     * Sync a single address from the 1Sat indexer using Server-Sent Events.
+     * Runs in the background - use stopSync() or close() to stop.
+     */
+    syncAddress(address: string, fromScore?: number): void;
+    /**
+     * Process a spend transaction during sync.
+     * Only marks our output as spent - doesn't ingest the spend tx.
+     */
+    private processSpendTx;
+    /**
+     * Stop syncing a specific address.
+     */
+    stopSync(address: string): void;
+    /**
+     * Close the wallet and cleanup all active sync connections.
+     */
+    close(): void;
+    /**
+     * Start syncing all owner addresses using a single multi-owner SSE connection.
+     * This is more efficient than syncing each address individually.
+     */
+    syncAll(fromScore?: number): void;
+    /**
+     * Process a spend transaction during multi-owner sync.
+     */
+    private processSpendTxMulti;
+    /**
+     * Stop the multi-owner sync.
+     */
+    stopSyncAll(): void;
+    /**
+     * Start syncing each owner address individually.
+     * For most cases, use syncAll() instead which uses a single connection.
+     */
+    syncEach(): void;
+}
+export {};
+//# sourceMappingURL=OneSatWallet.d.ts.map

package/dist/OneSatWallet.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"OneSatWallet.d.ts","sourceRoot":"","sources":["../src/OneSatWallet.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,cAAc,CAAA;AAC7C,OAAO,KAAK,EAAE,OAAO,EAAE,YAAY,EAAE,UAAU,EAAE,GAAG,EAAE,MAAM,aAAa,CAAA;AACzE,OAAO,EAGN,KAAK,UAAU,EAEf,WAAW,EAEX,MAAM,UAAU,CAAA;AACjB,OAAO,EACN,MAAM,EACN,KAAK,oBAAoB,EACzB,KAAK,GAAG,IAAI,SAAS,EACrB,MAAM,4BAA4B,CAAA;AAanC,OAAO,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAA;AAG9C,KAAK,KAAK,GAAG,SAAS,CAAC,KAAK,CAAA;AAG5B,KAAK,aAAa,CAAC,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC,KAAK,IAAI,CAAA;AAE1C;;GAEG;AACH,MAAM,WAAW,YAAY;IAC5B,YAAY,EAAE,YAAY,CAAA;IAC1B,iBAAiB,EAAE,MAAM,CAAA;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IAClC,YAAY,EAAE;QAAE,OAAO,EAAE,MAAM,CAAC;QAAC,SAAS,EAAE,MAAM,CAAA;KAAE,CAAA;IACpD,aAAa,EAAE;QAAE,OAAO,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,UAAU,CAAA;KAAE,CAAA;IACtD,cAAc,EAAE;QAAE,OAAO,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,CAAA;IACrE,aAAa,EAAE;QACd,OAAO,EAAE,MAAM,CAAA;QACf,IAAI,EAAE,MAAM,CAAA;QACZ,YAAY,EAAE,YAAY,CAAA;QAC1B,iBAAiB,EAAE,MAAM,CAAA;KACzB,CAAA;IACD,YAAY,EAAE;QAAE,OAAO,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,KAAK,CAAA;KAAE,CAAA;IAC/C,eAAe,EAAE;QAAE,OAAO,EAAE,MAAM,CAAA;KAAE,CAAA;IACpC,eAAe,EAAE;QAAE,SAAS,EAAE,MAAM,EAAE,CAAC;QAAC,SAAS,EAAE,MAAM,CAAA;KAAE,CAAA;IAC3D,gBAAgB,EAAE;QAAE,MAAM,EAAE,UAAU,CAAA;KAAE,CAAA;IACxC,iBAAiB,EAAE;QAAE,QAAQ,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,CAAA;IACvD,gBAAgB,EAAE;QACjB,IAAI,EAAE,MAAM,CAAA;QACZ,YAAY,EAAE,YAAY,CAAA;QAC1B,iBAAiB,EAAE,MAAM,CAAA;KACzB,CAAA;IACD,eAAe,EAAE;QAAE,KAAK,EAAE,KAAK,CAAA;KAAE,CAAA;IACjC,kBAAkB,EAAE;QAAE,SAAS,EAAE,MAAM,EAAE,CAAA;KAAE,CAAA;CAC3C;AAED,MAAM,WAAW,gBAAgB;IAChC;;OAEG;IACH,OAAO,EAAE,MAAM,GAAG,UAAU,CAAA;IAC5B;;OAEG;IACH,OAAO,EAAE,oBAAoB,CAAA;IAC7B;;OAEG;IACH,KAAK,EAAE,KAAK,CAAA;IACZ;;OAEG;IACH,MAAM,CAAC,EAAE,GAAG,CAAC,MAAM,CAAC,CAAA;IACpB;;;OAGG;IACH,QAAQ,CAAC,EAAE,OAAO,EAAE,CAAA;IACpB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAA;CAClB;AAED;;;;;;GAMG;AACH,qBAAa,YAAa,SAAQ,MAAM;IACvC,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAS;IACpC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAW;IACpC,QAAQ,CAAC,QAAQ,EAAE,cAAc,CAAA;IACjC,OAAO,CAAC,MAAM,CAAa;IAC3B,OAAO,CAAC,SAAS,CAKX;IACN,OAAO,CAAC,WAAW,CAAgC;IACnD,OAAO,CAAC,eAAe,CAA4B;gBAEvC,IAAI,EAAE,gBAAgB;IA2ClC;;;OAGG;IACH,IAAI,QAAQ,IAAI,OAAO,CAEtB;IAED;;OAEG;IACH,EAAE,CAAC,CAAC,SAAS,MAAM,kBAAkB,EACpC,KAAK,EAAE,CAAC,EACR,QAAQ,EAAE,aAAa,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC,GAC5C,IAAI;IAWP;;OAEG;IACH,GAAG,CAAC,CAAC,SAAS,MAAM,kBAAkB,EACrC,KAAK,EAAE,CAAC,EACR,QAAQ,EAAE,aAAa,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC,GAC5C,IAAI;IAQP;;OAEG;IACH,OAAO,CAAC,IAAI;IAcZ;;;OAGG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI;IAI/B;;;;;OAKG;IACG,gBAAgB,CACrB,QAAQ,EAAE,WAAW,GAAG,MAAM,EAC9B,aAAa,UAAO,GAClB,OAAO,CAAC,YAAY,CAAC;IAoBxB;;;OAGG;IACG,WAAW,CAChB,MAAM,EAAE,WAAW,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,EACjC,QAAQ,EAAE,QAAQ,GAChB,OAAO,CAAC,GAAG,CAAC;IAMf;;;OAGG;IACG,OAAO,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAU7C;;OAEG;IACG,gBAAgB,CAAC,GAAG,EAAE,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC;IAkB/C;;OAEG;YACW,WAAW;IAkBzB;;;OAGG;IACG,eAAe,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC;IAazD;;;OAGG;IACG,yBAAyB,CAAC,EAAE,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC;IAe/D;;OAEG;IACH,iBAAiB,CAAC,EAAE,EAAE,WAAW,GAAG,YAAY;IAgBhD;;OAEG;IACG,iBAAiB,CACtB,EAAE,EAAE,WAAW,EACf,WAAW,EAAE,MAAM,EACnB,MAAM,CAAC,EAAE,MAAM,EAAE,EACjB,aAAa,UAAO,GAClB,OAAO,CAAC,YAAY,CAAC;IAiNxB;;OAEG;IACG,SAAS,CACd,EAAE,EAAE,WAAW,EACf,WAAW,EAAE,MAAM,EACnB,MAAM,CAAC,EAAE,MAAM,EAAE,GACf,OAAO,CAAC,YAAY,CAAC;IAaxB;;;OAGG;IACH,WAAW,CAAC,OAAO,EAAE,MAAM,EAAE,SAAS,SAAI,GAAG,IAAI;IA+EjD;;;OAGG;YACW,cAAc;IAmF5B;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI;IAQ/B;;OAEG;IACH,KAAK,IAAI,IAAI;IASb;;;OAGG;IACH,OAAO,CAAC,SAAS,SAAI,GAAG,IAAI;IAkF5B;;OAEG;YACW,mBAAmB;IA8EjC;;OAEG;IACH,WAAW,IAAI,IAAI;IAOnB;;;OAGG;IACH,QAAQ,IAAI,IAAI;CAKhB"}