@spirobel/monero-wallet-api 0.5.1 → 0.5.3

package/dist/actionlog/actionLog.d.ts

@@ -0,0 +1,4 @@
+export type ActionLog = {
+    action: string;
+    data: string;
+};

package/dist/actionlog/actionLog.js

@@ -0,0 +1,9 @@
+// the actionlog datastructure records three types of actions:
+// 1. actions that the user has performed (external choice)
+// 2. actions as the result of business logic during the execution of a tool call
+// 3. actions as the result of business logic during the execution of an automated agreement
+//
+// tool call: privacy preserving interface between wallet and
+//  services that manage interaction with other users / wallets,
+//  set in motion by a user action (external choice to the whole (distributed, concurrent) system)
+export {};

package/dist/actionlog/actionLogOpened.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/actionlog/actionLogOpened.js

@@ -0,0 +1 @@
+export {};

package/dist/api.d.ts

@@ -8,7 +8,6 @@ export * from "./node-interaction/jsonEndpoints";
 export * from "./io/readDir";
 export * from "./io/atomicWrite";
 export * from "./io/sleep";
-export { writeScanSettings, readScanSettings, } from "./scanning-syncing/scanSettings";
 export { signTransaction, parseAddress, type ParsedAddress, type ParseAddressError, } from "./send-functionality/transactionBuilding";
 export { computeKeyImage } from "./scanning-syncing/scanresult/computeKeyImage";
 export * from "./multisig/multisig";
@@ -21,7 +20,9 @@ export { openWallets, openWallet } from "./scanning-syncing/openWallet";
 export * from "./scanning-syncing/blocksbuffer/blocksBufferFetchLoop";
 export * from "./scanning-syncing/blocksbuffer/blocksbufferCoordination";
 export * from "./scanning-syncing/connectionStatus";
-export * from "./scanning-syncing/scanSettings";
+export { ConnectionStatusOpened } from "./scanning-syncing/connectionStatusOpened";
+export * from "./scansettings/scanSettings";
+export { ScanSettingsOpened } from "./scansettings/scanSettingsOpened";
 export * from "./scanning-syncing/scanresult/scanResult";
 export * from "./scanning-syncing/scanresult/scanStats";
 export * from "./scanning-syncing/scanresult/scanCache";

package/dist/api.js

@@ -7,7 +7,6 @@ export * from "./node-interaction/jsonEndpoints";
 export * from "./io/readDir";
 export * from "./io/atomicWrite";
 export * from "./io/sleep";
-export { writeScanSettings, readScanSettings, } from "./scanning-syncing/scanSettings";
 export { signTransaction, parseAddress, } from "./send-functionality/transactionBuilding";
 export { computeKeyImage } from "./scanning-syncing/scanresult/computeKeyImage";
 export * from "./multisig/multisig";
@@ -20,7 +19,9 @@ export { openWallets, openWallet } from "./scanning-syncing/openWallet";
 export * from "./scanning-syncing/blocksbuffer/blocksBufferFetchLoop";
 export * from "./scanning-syncing/blocksbuffer/blocksbufferCoordination";
 export * from "./scanning-syncing/connectionStatus";
-export * from "./scanning-syncing/scanSettings";
+export { ConnectionStatusOpened } from "./scanning-syncing/connectionStatusOpened";
+export * from "./scansettings/scanSettings";
+export { ScanSettingsOpened } from "./scansettings/scanSettingsOpened";
 export * from "./scanning-syncing/scanresult/scanResult";
 export * from "./scanning-syncing/scanresult/scanStats";
 export * from "./scanning-syncing/scanresult/scanCache";

package/dist/scanning-syncing/backgroundWorker.js

@@ -1,6 +1,6 @@
 import { LOCAL_NODE_DEFAULT_URL } from "../node-interaction/nodeUrl";
 import {} from "./scanresult/scanCache";
-import { openScanSettingsFile, SCAN_SETTINGS_STORE_NAME_DEFAULT, } from "./scanSettings";
+import { openScanSettingsFile, SCAN_SETTINGS_STORE_NAME_DEFAULT } from "../api";
 import { log, setupLoggingPath } from "../io/logging";
 import { workerMainCode } from "./worker-entrypoints/worker";
 export const CPU_POOL_SIZE = 4;

package/dist/scanning-syncing/blocksbuffer/blocksBufferFetchLoop.js

@@ -9,7 +9,12 @@ connection_status, // we make a local copy of this and pass last_packet and sync
 max_blocks_buffer_size = MAX_BLOCKS_BUFFER_SIZE, anchor_range, stopSync) {
     connection_status = structuredClone(connection_status);
     const nodeUrl = await NodeUrl.create(node_url);
-    log("blocksBufferFetchLoop", ["NodeUrl:", nodeUrl.node_url, "start:", start_height]);
+    log("blocksBufferFetchLoop", [
+        "NodeUrl:",
+        nodeUrl.node_url,
+        "start:",
+        start_height,
+    ]);
     start_height = await reduceStartHeightToTip(start_height, nodeUrl.node_url);
     // initialise ranges on first call
     let { current_range, scanned_ranges } = await initScannedRanges(nodeUrl.node_url, start_height, anchor_range ? [anchor_range] : []);
@@ -39,15 +44,36 @@ max_blocks_buffer_size = MAX_BLOCKS_BUFFER_SIZE, anchor_range, stopSync) {
             await sleep(5000);
             continue;
         }
-        log("blocksBufferFetchLoop", ["fetching", nodeUrl.node_url, current_range.start, "->", current_range.end]);
-        const get_blocks_bin = await doRPCrequest(nodeUrl, current_range, stopSync);
+        log("blocksBufferFetchLoop", [
+            "fetching",
+            nodeUrl.node_url,
+            current_range.start,
+            "->",
+            current_range.end,
+        ]);
+        let get_blocks_bin;
+        try {
+            get_blocks_bin = await doRPCrequest(nodeUrl, current_range, stopSync);
+        }
+        catch (error) {
+            connection_status.last_packet = {
+                status: "connection_failed",
+                bytes_read: 0,
+                node_url,
+                timestamp: new Date().toISOString(),
+            };
+            yield connection_status.last_packet;
+            throw error;
+        }
         const result_meta = await nodeUrl.loadGetBlocksBinResponse(get_blocks_bin);
         log("blocksBufferFetchLoop", "response: " + result_meta.block_infos.length + " blocks");
+        connection_status.sync.daemon_height = result_meta.daemon_height;
         connection_status.last_packet = {
             status: "OK",
             bytes_read: get_blocks_bin.length,
             node_url: node_url,
             timestamp: new Date().toISOString(),
+            daemon_height: result_meta.daemon_height,
         };
         yield connection_status.last_packet;
         // no new blocks: at tip, sleep and retry

package/dist/scanning-syncing/blocksbuffer/blocksbufferCoordination.js

@@ -19,10 +19,13 @@ export async function handleConnectionStatusChanges(event, scanSettingsPath) {
         }
     }
     if ("scanned_ranges" in event) {
-        //TODO: only write this to disk after blocks_buffer_changed has been handled by wallets.
-        //look for same comment in blocksBufferFetchLoop.ts
         await readWriteConnectionStatusFile((cs2) => {
-            cs2.sync = event;
+            cs2.sync = {
+                ...event,
+                // preserve eta and current_scan_height from file
+                eta: cs2.sync.eta || event.eta,
+                current_scan_height: cs2.sync.current_scan_height || event.current_scan_height,
+            };
         }, scanSettingsPath);
     }
 }

package/dist/scanning-syncing/connectionStatus.d.ts

@@ -5,6 +5,7 @@ export type ConnectionSatusLastPacket = {
     bytes_read: number;
     node_url: string;
     timestamp: string;
+    daemon_height?: number;
 };
 export type ConnectionStatusSync = {
     reorg_info?: ReorgInfo;
@@ -21,10 +22,6 @@ export type ConnectionStatus = {
 export declare const DEFAULT_CONNECTION_STATUS_PREFIX = "ConnectionStatus-";
 export declare function msToHHMM(ms: number): string;
 export declare function emptyConnectionStatus(overrides?: Partial<ConnectionStatus>): ConnectionStatus;
-export declare function updateSyncETA(daemon_height: number, current_scan_height: number, last_height: number | null, last_timestamp: number | null, scan_settings_path?: string): Promise<{
-    last_height: number;
-    last_timestamp: number;
-}>;
 export declare function connectionStatusFilePath(scan_settings_path?: string): string;
 export declare function readConnectionStatusDefaultLocation(scan_settings_path?: string): Promise<ConnectionStatus | undefined>;
 export declare function readConnectionStatusFile(connectionStatusFilePath: string): Promise<ConnectionStatus | undefined>;

package/dist/scanning-syncing/connectionStatus.js

@@ -1,5 +1,5 @@
 import { atomicWrite, } from "../api";
-import { SCAN_SETTINGS_STORE_NAME_DEFAULT } from "./scanSettings";
+import { SCAN_SETTINGS_STORE_NAME_DEFAULT } from "../api";
 export const DEFAULT_CONNECTION_STATUS_PREFIX = "ConnectionStatus-";
 export function msToHHMM(ms) {
     const totalSeconds = Math.floor(ms / 1000);
@@ -31,36 +31,6 @@ export function emptyConnectionStatus(overrides) {
     };
     return overrides ? { ...defaultStatus, ...overrides } : defaultStatus;
 }
-export async function updateSyncETA(daemon_height, current_scan_height, last_height, last_timestamp, scan_settings_path) {
-    const blocks_till_tip = daemon_height - current_scan_height;
-    let blocks_since_last_update = null;
-    let duration = null;
-    if (typeof last_height === "number") {
-        blocks_since_last_update = current_scan_height - last_height;
-    }
-    if (typeof last_timestamp === "number") {
-        duration = Date.now() - last_timestamp;
-    }
-    let eta = "00:00";
-    if (blocks_since_last_update !== null &&
-        duration !== null &&
-        duration > 0 &&
-        blocks_till_tip > 0) {
-        const blocks_per_ms = blocks_since_last_update / duration;
-        const eta_ms = blocks_till_tip / blocks_per_ms;
-        eta = msToHHMM(eta_ms);
-    }
-    await readWriteConnectionStatusFile((cs) => {
-        cs.sync = {
-            ...cs.sync,
-            daemon_height,
-            current_scan_height,
-            eta,
-            timestamp: new Date().toISOString(),
-        };
-    }, scan_settings_path);
-    return { last_height: current_scan_height, last_timestamp: Date.now() };
-}
 export function connectionStatusFilePath(scan_settings_path = SCAN_SETTINGS_STORE_NAME_DEFAULT) {
     const parts = scan_settings_path.split("/");
     const basename = parts.pop();

package/dist/scanning-syncing/connectionStatusOpened.d.ts

@@ -0,0 +1,15 @@
+import { type ConnectionStatus } from "../api";
+export declare class ConnectionStatusOpened {
+    private _onChange?;
+    private _timer;
+    private _cached;
+    private _prevConnected;
+    private _path;
+    constructor(scan_settings_path: string, _onChange?: ((status: ConnectionStatus | null) => void) | null | undefined);
+    watch(intervalMs?: number): void;
+    unwatch(): void;
+    get connectionStatus(): ConnectionStatus | null;
+    get isConnected(): boolean;
+    get daemonHeight(): number | undefined;
+    private _poll;
+}

package/dist/scanning-syncing/connectionStatusOpened.js

@@ -0,0 +1,51 @@
+import { readConnectionStatusFile, connectionStatusFilePath, } from "../api";
+export class ConnectionStatusOpened {
+    _onChange;
+    _timer;
+    _cached = null;
+    _prevConnected = false;
+    _path;
+    constructor(scan_settings_path, _onChange) {
+        this._onChange = _onChange;
+        this._path = connectionStatusFilePath(scan_settings_path);
+    }
+    watch(intervalMs = 2500) {
+        if (this._timer)
+            return;
+        this._poll();
+        this._timer = setInterval(() => this._poll(), intervalMs);
+    }
+    unwatch() {
+        if (this._timer) {
+            clearInterval(this._timer);
+            this._timer = undefined;
+        }
+    }
+    get connectionStatus() {
+        return this._cached;
+    }
+    get isConnected() {
+        const cs = this._cached;
+        if (!cs?.last_packet)
+            return false;
+        const { status, timestamp } = cs.last_packet;
+        if (status !== "OK" && status !== "blocks_buffer_full")
+            return false;
+        if (!timestamp)
+            return false;
+        const age = Date.now() - new Date(timestamp).getTime();
+        return age >= 0 && age <= 10_000;
+    }
+    get daemonHeight() {
+        return this._cached?.last_packet?.daemon_height;
+    }
+    async _poll() {
+        this._cached =
+            (await readConnectionStatusFile(this._path).catch(() => null)) || null;
+        const now = this.isConnected;
+        if (now !== this._prevConnected) {
+            this._prevConnected = now;
+            this._onChange?.(this._cached);
+        }
+    }
+}

package/dist/scanning-syncing/openWallet.js

@@ -1,5 +1,5 @@
 import { ManyScanCachesOpened, ScanCacheOpened, } from "./scanresult/scanCacheOpened";
-import { openScanSettingsFile, writeWalletToScanSettings, } from "./scanSettings";
+import { openScanSettingsFile, writeWalletToScanSettings } from "../api";
 /**
  * Opens all **non halted wallets listed in ScanSettings.json** for scanning.
  *

package/dist/scanning-syncing/scanresult/scanCacheOpened.d.ts

@@ -1,7 +1,10 @@
 import { ViewPair, type FeeEstimateResponse, type Output, type SendRawTransactionResult } from "../../api";
 import { type Payment } from "../../send-functionality/inputSelection";
+import { ConnectionStatusOpened } from "../connectionStatusOpened";
+import type { LogSetting, PossibleLogs } from "../../io/logging";
 import { type CacheChangedCallback, type CacheChangedCallbackParameters, type ScanCache, type Subaddress, type TxLog } from "./scanCache";
 import { type FoundTransaction, type PrePendingTx } from "./scanStats";
+import { type ConnectionStatus } from "../connectionStatus";
 export type SlaveScanCache = boolean;
 export type ScanCacheOpenedCreateParams = {
     primary_address: string;
@@ -18,6 +21,7 @@ export type CreateTransactionParams = {
     no_fee_circuit_breaker?: boolean;
 };
 export declare class ScanCacheOpened {
+    private _scanSettings;
     readonly view_pair: ViewPair;
     readonly wallet_route: string | undefined;
     readonly wallet_name: string | undefined;
@@ -56,8 +60,17 @@ export declare class ScanCacheOpened {
     get primary_address(): string;
     get node_url(): string;
     private set node_url(value);
+    get merchant_confirmations(): number | null | undefined;
+    get cpu_worker_count(): number | undefined;
+    get logs(): LogSetting | undefined;
+    get logs_include(): PossibleLogs[] | undefined;
+    get logs_exclude(): PossibleLogs[] | undefined;
     changeNodeUrlAndStartHeight(node_url?: string, start_height?: number | null): Promise<void>;
     changeNodeUrl(node_url: string): Promise<void>;
+    setMerchantConfirmations(merchant_confirmations: number | null): Promise<void>;
+    setCpuWorkerCount(cpu_worker_count: number | undefined): Promise<void>;
+    setLogSettings(logs?: LogSetting | null, logs_include?: PossibleLogs[] | null, logs_exclude?: PossibleLogs[] | null): Promise<void>;
+    setWalletName(name?: string): Promise<void>;
     retry(): Promise<boolean>;
     sendTransaction(signedTx: string): Promise<SendRawTransactionResult>;
     signTransaction(unsignedTx: string): Promise<string>;
@@ -115,9 +128,9 @@ export declare class ScanCacheOpened {
     notify(callback: CacheChangedCallback): {
         remove: () => null;
     };
-    pause(): Promise<number>;
+    pause(): Promise<void>;
     stopWorker(): void;
-    unpause(): Promise<number>;
+    unpause(): Promise<void>;
     /**
      * selectInputs returns array of inputs, whose sum is larger than amount
      * adds approximate fee for 10kb transaction to amount if feePerByte is supplied
@@ -160,9 +173,15 @@ export type ManyScanCachesOpenedCreateOptions = {
     notifyMasterChanged?: CacheChangedCallback;
     no_stats?: boolean;
     workerError?: (error: unknown) => void;
+    autoRetry?: boolean;
+    retryDelayMs?: number;
+    connectionStatusIntervalMs?: number;
+    onConnectionStatusChange?: ((status: ConnectionStatus | null) => void) | null;
 };
 export declare class ManyScanCachesOpened {
-    readonly wallets: ScanCacheOpened[];
+    readonly connectionStatusOpened: ConnectionStatusOpened;
+    private _scanSettings;
+    private _options;
     get start_height(): number | null;
     get current_height(): number | null;
     get node_url(): string;
@@ -170,11 +189,40 @@ export declare class ManyScanCachesOpened {
     retry(): Promise<boolean>;
     stopWorker(): void;
     changeNodeUrl(node_url: string): Promise<void>;
+    get merchant_confirmations(): number | null | undefined;
+    get cpu_worker_count(): number | undefined;
+    get logs(): LogSetting | undefined;
+    get logs_include(): PossibleLogs[] | undefined;
+    get logs_exclude(): PossibleLogs[] | undefined;
+    get connectionStatus(): ConnectionStatus | null;
+    get daemonHeight(): number | undefined;
+    watchConnectionStatus(intervalMs?: number): void;
+    unwatchConnectionStatus(): void;
+    setMerchantConfirmations(merchant_confirmations: number | null): Promise<void>;
+    setCpuWorkerCount(cpu_worker_count: number | undefined): Promise<void>;
+    setLogSettings(logs?: LogSetting | null, logs_include?: PossibleLogs[] | null, logs_exclude?: PossibleLogs[] | null): Promise<void>;
+    setWalletName(primary_address: string, name?: string): Promise<void>;
     changeStartHeight(start_height: number | null): Promise<void>;
-    static create({ scan_settings_path, pathPrefix, no_worker, notifyMasterChanged, no_stats, workerError, }: ManyScanCachesOpenedCreateOptions): Promise<ManyScanCachesOpened | undefined>;
-    /**
-     * feed the master wallet and therefore all wallets
-     */
+    private static _buildWallets;
+    static create(options: ManyScanCachesOpenedCreateOptions): Promise<ManyScanCachesOpened | undefined>;
+    buildWallets(): Promise<void>;
+    addViewWallet(primary_address: string, view_key: string, fields?: {
+        wallet_name?: string;
+        wallet_slot?: number;
+        wallet_route?: string;
+        subaddress_index?: number;
+        halted?: boolean;
+    }): Promise<void>;
+    addSpendWallet(wallet_secret: Uint8Array, fields?: {
+        wallet_name?: string;
+        wallet_slot?: number;
+        wallet_route?: string;
+        subaddress_index?: number;
+        halted?: boolean;
+    }): Promise<void>;
+    removeWallet(primary_address: string): Promise<void>;
     feed(params: CacheChangedCallbackParameters): Promise<void>;
+    private _wallets;
+    get wallets(): ScanCacheOpened[];
     private constructor();
 }