@spirobel/monero-wallet-api 0.6.0 → 0.6.2

package/dist/actionlog/sqliteBackend.js

@@ -1,105 +0,0 @@
-import { OpenInvocationMaps } from "./openMaps";
-/** bun-only sqlite backend. do not import from browser worker graphs. */
-export class ActionLogSqliteBackend {
-    open = new OpenInvocationMaps();
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    sql;
-    constructor(sql) {
-        this.sql = sql;
-    }
-    static async open(filename) {
-        const { SQL } = await import("bun");
-        const sql = new SQL({
-            adapter: "sqlite",
-            filename,
-            create: true,
-        });
-        await sql `PRAGMA journal_mode = WAL`;
-        await sql `
-      CREATE TABLE IF NOT EXISTS actionlog_events (
-        id TEXT PRIMARY KEY,
-        timestamp TEXT NOT NULL,
-        invocationId TEXT NOT NULL,
-        stage TEXT NOT NULL,
-        type TEXT NOT NULL,
-        toolId TEXT NOT NULL,
-        body TEXT NOT NULL
-      )
-    `;
-        await sql `
-      CREATE INDEX IF NOT EXISTS idx_actionlog_invocation
-      ON actionlog_events (invocationId)
-    `;
-        await sql `
-      CREATE INDEX IF NOT EXISTS idx_actionlog_tool
-      ON actionlog_events (toolId)
-    `;
-        await sql `
-      CREATE INDEX IF NOT EXISTS idx_actionlog_invocation_ts
-      ON actionlog_events (invocationId, timestamp)
-    `;
-        const backend = new ActionLogSqliteBackend(sql);
-        await backend.rebuildOpenMaps();
-        return backend;
-    }
-    async rebuildOpenMaps() {
-        this.open.clear();
-        const rows = (await this.sql `
-      SELECT body FROM actionlog_events ORDER BY rowid ASC
-    `);
-        if (!Array.isArray(rows))
-            return;
-        for (const row of rows) {
-            this.open.apply(JSON.parse(row.body));
-        }
-    }
-    async append(event) {
-        const body = JSON.stringify(event);
-        await this.sql `
-      INSERT INTO actionlog_events (id, timestamp, invocationId, stage, type, toolId, body)
-      VALUES (
-        ${event.id},
-        ${event.timestamp},
-        ${event.invocationId},
-        ${event.stage},
-        ${event.type},
-        ${event.toolId},
-        ${body}
-      )
-    `;
-        this.open.apply(event);
-    }
-    async getBranch(invocationId) {
-        const rows = (await this.sql `
-      SELECT body FROM actionlog_events
-      WHERE invocationId = ${invocationId}
-      ORDER BY rowid ASC
-    `);
-        if (!Array.isArray(rows))
-            return [];
-        return rows.map((r) => JSON.parse(r.body));
-    }
-    async getTip(invocationId) {
-        const branch = await this.getBranch(invocationId);
-        return branch.length ? branch[branch.length - 1] : null;
-    }
-    async getOpenByToolId(toolId) {
-        return this.open.getOpenByToolId(toolId);
-    }
-    async getOpenInvocations() {
-        return this.open.getOpenInvocations();
-    }
-    async feed(events) {
-        for (const event of events) {
-            try {
-                await this.append(event);
-            }
-            catch {
-                // skip duplicate
-            }
-        }
-    }
-    async reload() {
-        await this.rebuildOpenMaps();
-    }
-}

package/dist/actionlog/toolContext.d.ts

@@ -1,36 +0,0 @@
-import type { ActionLogEvent, ActionLogOpened } from "./actionLogOpened";
-import type { ToolPermission } from "./types";
-/** durable plate notice — title/message are tool-owned STE text */
-export type ToolNotice = {
-    id: string;
-    permission: ToolPermission;
-    /** short STE title for the notice plate hole */
-    title: string;
-    /** full STE body for the notice plate hole */
-    message: string;
-    context_domain?: string;
-    context_href?: string;
-    wallet_slot?: number;
-    timestamp?: number | string;
-};
-/** static STE strings for open-invocation plate holes */
-export type ToolUiCopy = {
-    openTitle: string;
-    acceptLabel?: string;
-    dismissLabel?: string;
-};
-/**
- * context ActionLog passes into per-tool actionlog writers.
- * lives next to ActionLog — tools import this, not the other way around for placement.
- */
-export type ToolActionLogContext = {
-    log: ActionLogOpened;
-    getWallets?: () => unknown;
-    /** host reopens wallets after tool changes scan settings */
-    reloadWallets?: () => void | Promise<void>;
-    getPort: (invocationId: string) => {
-        postMessage: (msg: unknown) => void;
-    } | undefined;
-    postToPort: (invocationId: string, msg: unknown) => void;
-    broadcast: (events: ActionLogEvent[]) => void;
-};

package/dist/actionlog/toolContext.js

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

package/dist/actionlog/types.d.ts

@@ -1,62 +0,0 @@
-import type { ToolId } from "../tools/monero-tools";
-import type { ExtensionPort, ToolInvocationValidity, ToolPermission } from "../tools/globals";
-import type { ActionLogOpened } from "./actionLogOpened";
-export type { ToolPermission };
-export type ActionLogEventType = "session_start" | "validate_start" | "validate_result" | "accept" | "dismiss" | "execute_start" | "execute_error" | "execute_result" | "aborted";
-export type ActionLogStage = "recognized" | "invoked" | "validated" | "accepted" | "executed";
-export type ActionLogEvent = {
-    type: ActionLogEventType;
-    id: string;
-    timestamp: string;
-    invocationId: string;
-    stage: ActionLogStage;
-    toolId: ToolId;
-    valid?: ToolInvocationValidity;
-    amount?: string;
-    address?: string;
-    no_check?: boolean;
-    wallet_slot?: number;
-    context_domain?: string;
-    destination_domain?: string;
-    context_href?: string;
-    found_in?: "link" | "linkText";
-    link?: string;
-    linkText?: string;
-    wallet_to_send_from_pa?: string;
-    ok?: boolean;
-    error?: string;
-    [key: string]: unknown;
-};
-export type OpenInvocationState = {
-    invocationId: string;
-    toolId: ToolId;
-    stage: ActionLogStage;
-    lastType: ActionLogEventType;
-    valid?: ToolInvocationValidity;
-    amount?: string;
-    address?: string;
-    no_check?: boolean;
-    wallet_slot?: number;
-    context_domain?: string;
-    destination_domain?: string;
-    context_href?: string;
-    found_in?: "link" | "linkText";
-    link?: string;
-    linkText?: string;
-    timestamp?: string;
-    wallet_to_send_from_pa?: string;
-    ok?: boolean;
-    error?: string;
-};
-export declare const TERMINAL_EVENT_TYPES: ReadonlySet<ActionLogEventType>;
-export declare function isTerminalEventType(type: ActionLogEventType): boolean;
-export declare function newEventId(): string;
-export declare function nowTimestamp(): string;
-export type ToolWorkerContext = {
-    log: ActionLogOpened;
-    getWallets?: () => unknown;
-    reloadWallets?: () => void | Promise<void>;
-    getPort: (invocationId: string) => ExtensionPort | undefined;
-};
-export declare function applyEventToState(prev: OpenInvocationState | null, event: ActionLogEvent): OpenInvocationState;
-export declare function isOpenState(state: OpenInvocationState): boolean;

package/dist/actionlog/types.js

@@ -1,62 +0,0 @@
-export const TERMINAL_EVENT_TYPES = new Set([
-    "dismiss",
-    "execute_result",
-    "aborted",
-]);
-export function isTerminalEventType(type) {
-    return TERMINAL_EVENT_TYPES.has(type);
-}
-export function newEventId() {
-    return crypto.randomUUID();
-}
-export function nowTimestamp() {
-    return new Date().toISOString();
-}
-export function applyEventToState(prev, event) {
-    const base = prev ?? {
-        invocationId: event.invocationId,
-        toolId: event.toolId,
-        stage: event.stage,
-        lastType: event.type,
-    };
-    const next = {
-        ...base,
-        invocationId: event.invocationId,
-        toolId: event.toolId,
-        stage: event.stage,
-        lastType: event.type,
-        timestamp: event.timestamp,
-    };
-    if (event.valid !== undefined)
-        next.valid = event.valid;
-    if (event.amount !== undefined)
-        next.amount = event.amount;
-    if (event.address !== undefined)
-        next.address = event.address;
-    if (event.no_check !== undefined)
-        next.no_check = event.no_check;
-    if (event.wallet_slot !== undefined)
-        next.wallet_slot = event.wallet_slot;
-    if (event.context_domain !== undefined)
-        next.context_domain = event.context_domain;
-    if (event.destination_domain !== undefined)
-        next.destination_domain = event.destination_domain;
-    if (event.context_href !== undefined)
-        next.context_href = event.context_href;
-    if (event.found_in !== undefined)
-        next.found_in = event.found_in;
-    if (event.link !== undefined)
-        next.link = event.link;
-    if (event.linkText !== undefined)
-        next.linkText = event.linkText;
-    if (event.wallet_to_send_from_pa !== undefined)
-        next.wallet_to_send_from_pa = event.wallet_to_send_from_pa;
-    if (event.ok !== undefined)
-        next.ok = event.ok;
-    if (event.error !== undefined)
-        next.error = event.error;
-    return next;
-}
-export function isOpenState(state) {
-    return !isTerminalEventType(state.lastType);
-}

package/dist/scanning-syncing/blocksbuffer/getBlocksbinBuffer.d.ts

@@ -1,28 +0,0 @@
-import type { BlockInfo, GetBlocksBinRequest, ViewPair } from "../../api";
-import type { ScanSetting } from "../scanSettings";
-import { type CacheRange } from "../scanresult/scanCache";
-export declare function writeGetblocksBinBuffer(getBlocksBinResponseContent: Uint8Array, block_infos: BlockInfo[], pathPrefix?: string): Promise<GetBlocksBinBufferItemFilename | undefined>;
-export type GetBlocksBinBufferItemFilename = {
-    start: number;
-    end: number;
-    filename: string;
-    date: string;
-    last_block_hash: string;
-};
-export declare function readGetblocksBinBuffer(current_height: number, pathPrefix?: string): Promise<GetBlocksBinBufferItemFilename[]>;
-export type BlocksGenerator = AsyncGenerator<Uint8Array>;
-export type SlaveViewPair = {
-    viewpair: ViewPair;
-    current_range: CacheRange;
-    secret_spend_key?: string;
-};
-declare module "bun" {
-    interface BunFile {
-        delete(): Promise<void>;
-    }
-}
-export declare function trimGetBlocksBinBuffer(nonHaltedWallets: ScanSetting[], pathPrefix?: string): Promise<void>;
-export declare function readGetblocksBinBufferItems(pathPrefix?: string): Promise<GetBlocksBinBufferItemFilename[]>;
-export interface HasGetBlocksBinExecuteRequestMethod {
-    getBlocksBinExecuteRequest: (params: GetBlocksBinRequest, stopSync?: AbortSignal) => Promise<Uint8Array>;
-}

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

@@ -1,54 +0,0 @@
-import { atomicWrite } from "../../io/atomicWrite";
-import { readDir } from "../../io/readDir";
-import { readCacheFileDefaultLocation, } from "../scanresult/scanCache";
-export async function writeGetblocksBinBuffer(getBlocksBinResponseContent, block_infos, pathPrefix) {
-    if (!block_infos.length)
-        return;
-    const start = block_infos[0].block_height;
-    const end = block_infos.at(-1).block_height;
-    const block_hash = block_infos.at(-1).block_hash;
-    const bufferItems = await readGetblocksBinBufferItems(pathPrefix);
-    if (bufferItems.find((bi) => bi.last_block_hash === block_hash))
-        return;
-    const date = Date.now().toString();
-    const filename = `${date}-${start}-${end}-${block_hash}-getblocks.bin`;
-    await atomicWrite(`${pathPrefix ?? ""}getblocksbinbuffer/${filename}`, getBlocksBinResponseContent);
-    return { start, end, filename, date, last_block_hash: block_hash };
-}
-export async function readGetblocksBinBuffer(current_height, pathPrefix) {
-    const bufferItems = await readGetblocksBinBufferItems(pathPrefix);
-    const start_buffer = bufferItems.find((r) => current_height >= r.start && current_height <= r.end) ?? null;
-    if (start_buffer)
-        return [
-            start_buffer,
-            ...bufferItems.filter((r) => r.date > start_buffer?.date),
-        ];
-    return [];
-}
-export async function trimGetBlocksBinBuffer(nonHaltedWallets, pathPrefix) {
-    const snail = Math.min(...(await Promise.all(nonHaltedWallets
-        .slice(1)
-        .map(async (wallet) => (await readCacheFileDefaultLocation(wallet.primary_address, pathPrefix))?.scanned_ranges[0]?.end))).filter((x) => x !== undefined));
-    // if all wallets have  higher start than end of blocksbufferitem, delete
-    const bufferItems = await readGetblocksBinBufferItems(pathPrefix);
-    for (const bufferItem of bufferItems) {
-        if (bufferItem.end <= snail) {
-            await Bun.file(`${pathPrefix ?? ""}getblocksbinbuffer/${bufferItem.filename}`).delete();
-        }
-    }
-}
-export async function readGetblocksBinBufferItems(pathPrefix) {
-    const bufferItems = await readDir(`${pathPrefix ?? ""}getblocksbinbuffer/`).catch(() => []);
-    const ranges = [];
-    for (const filename of bufferItems) {
-        const [date, start, end, last_block_hash] = filename.split("-");
-        ranges.push({
-            start: parseInt(start),
-            end: parseInt(end),
-            filename,
-            date,
-            last_block_hash,
-        });
-    }
-    return ranges;
-}

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

@@ -1,165 +0,0 @@
-import type { LogSetting, PossibleLogs } from "../io/logging";
-export declare const SCAN_SETTINGS_STORE_NAME_DEFAULT = "ScanSettings.json";
-export declare const SUB_ADDRESS_INDEX_DEFAULT_VALUE = 1;
-export type ScanSetting = {
-    primary_address: string;
-    subaddress_index?: number;
-    halted?: boolean;
-    wallet_route?: string;
-    wallet_name?: string;
-    wallet_slot?: number;
-};
-export type WriteScanSettingParams = {
-    primary_address: string;
-    start_height?: number | null;
-    subaddress_index?: number;
-    halted?: boolean;
-    scan_settings_path?: string;
-    node_url?: string;
-    wallet_route?: string;
-    wallet_name?: string;
-    wallet_slot?: number;
-    logs?: LogSetting;
-    logs_include?: PossibleLogs[];
-    logs_exclude?: PossibleLogs[];
-};
-export type ScanSettingOpened = {
-    primary_address: string;
-    start_height: number | null;
-    node_url: string;
-    subaddress_index?: number;
-    secret_view_key?: string;
-    halted?: boolean;
-    secret_spend_key?: string;
-    wallet_route?: string;
-    wallet_name?: string;
-    wallet_slot?: number;
-};
-export type ScanSettings = {
-    wallets: ScanSetting[];
-    node_url: string;
-    start_height: number | null;
-    merchant_confirmations?: number | null;
-    cpu_worker_count?: number;
-    logs?: LogSetting;
-    logs_include?: PossibleLogs[];
-    logs_exclude?: PossibleLogs[];
-};
-export type ScanSettingsOpened = {
-    wallets: (ScanSettingOpened | undefined)[];
-    node_url: string;
-    start_height: number | null;
-    merchant_confirmations?: number | null;
-    cpu_worker_count?: number;
-    logs?: LogSetting;
-    logs_include?: PossibleLogs[];
-    logs_exclude?: PossibleLogs[];
-};
-/**
- * Writes scan settings to the default or specified storage file in json.
- *
- * @example
- * ```
- * const settings: ScanSettings = {
- *   wallets: [{
- *     primary_address: "5dsf...",
- *     start_height: 1741707,
- *   }],
- *   node_urls: ["https://monerooo.roooo"]
- * };
- * await writeScanSettings(settings);
- * ```
- *
- * @param scan_settings - The complete {@link ScanSettings} configuration to persist.
- * @param scan_settings_path - Optional path for the settings file. Defaults to `SCAN_SETTINGS_STORE_NAME_DEFAULT`.
- * @returns A promise that resolves when the file is successfully written.
- * @throws Will throw if file writing fails (e.g., permissions, disk space).
- */
-export declare function writeScanSettings(scan_settings: ScanSettings, scan_settings_path?: string): Promise<number>;
-export type WriteScanSettingsFileParams = {
-    scan_settings_path?: string;
-    writeCallback: (settings: ScanSettings) => void | Promise<void>;
-};
-export declare function writeScanSettingsFileDefaultLocation(params: WriteScanSettingsFileParams): Promise<void>;
-export declare function writeStartHeightToScanSettings(start_height: number | null, scan_settings_path?: string): Promise<number>;
-export declare function writeDaemonHeightAsStartHeightToScanSettings(node_url: string, scan_settings_path?: string): Promise<number>;
-export declare function cullTooLargeScanHeight(node_url: string, scan_settings_path?: string): Promise<number>;
-export declare function writeNodeUrlToScanSettings(node_url: string, scan_settings_path?: string): Promise<number>;
-export declare function readNodeUrlFromScanSettings(scan_settings_path?: string): Promise<string | undefined>;
-/**
- * Writes the merchant confirmation threshold to scan settings.
- *
- * This setting only has effect when the wallet is run as part of a checkout system,
- * that accepts payments.
- * It determines after how many confirmations a transaction is accepted
- * for a payment. The actual enforcement of this policy is left to the
- * custom payment-system code that consumes this library.
- *
- * @param merchant_confirmations - Number of confirmations required before
- *   accepting a payment, or `null` to leave it unset.
- * @param scan_settings_path - Optional path for the settings file.
- *   Defaults to `SCAN_SETTINGS_STORE_NAME_DEFAULT`.
- * @returns A promise that resolves when the file is successfully written.
- */
-export declare function writeMerchantConfirmationsToScanSettings(merchant_confirmations: number | null, scan_settings_path?: string): Promise<number>;
-/**
- * Reads the merchant confirmation threshold from scan settings.
- *
- * This setting only has effect when the wallet is run as part of a checkout system,
- * that accepts payments.
- *
- * It determines after how many confirmations a transaction is accepted
- * for a payment. The actual enforcement of this policy is left to the
- * custom payment-system code that consumes this library.
- *
- * @param scan_settings_path - Optional path for the settings file.
- *   Defaults to `SCAN_SETTINGS_STORE_NAME_DEFAULT`.
- * @returns The configured number of confirmations, null, or `undefined`
- *   if the setting has not been persisted yet.
- */
-export declare function readMerchantConfirmationsFromScanSettings(scan_settings_path?: string): Promise<number | null | undefined>;
-/**
- * Reads scan settings from the default or specified storage file.
- * secret_view_key and spend_private_key are read from environment variables
- *
- * @example
- * ```
- * const settings = await readScanSettings();
- * if (settings) {
- *   console.log(settings.wallets?.primary_address);
- * }
- * ```
- *
- * @param scan_settings_path - Path to the settings file. Defaults to `SCAN_SETTINGS_STORE_NAME_DEFAULT`.
- * @returns The parsed {@link ScanSettings} object if file exists and is valid JSON, otherwise `undefined`.
- */
-export declare function readScanSettings(scan_settings_path?: string): Promise<ScanSettingsOpened | undefined>;
-export declare function readPrivateSpendKeyFromEnv(primary_address: string): string | undefined;
-export declare function readPrivateViewKeyFromEnv(primary_address: string): string | undefined;
-export declare function readWalletFromScanSettings(primary_address: string, scan_settings_path?: string): Promise<ScanSettingOpened | undefined>;
-export declare function readWalletsFromScanSettings(scan_settings_path?: string): Promise<ScanSettingOpened[]>;
-export declare function walletSettingsPlusKeys(wallet_settings: ScanSettingOpened, secret_view_key?: string, secret_spend_key?: string): Promise<{
-    secret_view_key: string;
-    secret_spend_key: string | undefined;
-    primary_address: string;
-    start_height: number | null;
-    node_url: string;
-    subaddress_index?: number;
-    halted?: boolean;
-    wallet_route?: string;
-    wallet_name?: string;
-    wallet_slot?: number;
-}>;
-export declare function writeWalletToScanSettings(params: WriteScanSettingParams): Promise<number>;
-export declare function openScanSettingsFile(scan_settings_path?: string): Promise<ScanSettings | undefined>;
-export declare function openNonHaltedWallets(scan_settings_path?: string): Promise<ScanSettingOpened[]>;
-export declare function getNonHaltedWallets(scan_settings?: ScanSettings): ScanSetting[];
-export declare function doesScanSettingsFileExist(scan_settings_path?: string): Promise<boolean>;
-/**
- * Either 1. the consumer explicitly sets a pathprefix, we extract it from the scan_settings_path
- * or we pick the default which is nothing
- * @param scan_settings_path optional scan settings path
- * @param pathPrefix optional path prefix
- * @returns definite path prefix
- */
-export declare function getPathPrefix(scan_settings_path?: string, pathPrefix?: string): string;