@spirobel/monero-wallet-api 0.6.1 → 0.6.3

package/dist/scanning-syncing/scanSettings.js

@@ -1,338 +0,0 @@
-import { get_info } from "../api";
-import { atomicWrite } from "../io/atomicWrite";
-import { refreshEnvIndexedDB } from "../io/indexedDB";
-import { LOCAL_NODE_DEFAULT_URL } from "../node-interaction/nodeUrl";
-export const SCAN_SETTINGS_STORE_NAME_DEFAULT = "ScanSettings.json";
-// default value for subaddress highest minor index eg up to which minor index,
-// to add subaddresses to the scanner
-// (we never touch major index, having two values is just too confusing)
-export const SUB_ADDRESS_INDEX_DEFAULT_VALUE = 1;
-/**
- * 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 async function writeScanSettings(scan_settings, scan_settings_path = SCAN_SETTINGS_STORE_NAME_DEFAULT) {
-    return await atomicWrite(scan_settings_path, JSON.stringify(scan_settings, null, 2));
-}
-export async function writeScanSettingsFileDefaultLocation(params) {
-    let settings = await openScanSettingsFile(params.scan_settings_path);
-    if (!settings) {
-        // Create empty ScanSettings object with default values
-        settings = {
-            node_url: LOCAL_NODE_DEFAULT_URL,
-            wallets: [],
-            start_height: null,
-        };
-    }
-    await params.writeCallback(settings);
-    // write to settings file
-    await writeScanSettings(settings, params.scan_settings_path);
-}
-export async function writeStartHeightToScanSettings(start_height, scan_settings_path = SCAN_SETTINGS_STORE_NAME_DEFAULT) {
-    const scanSettings = (await openScanSettingsFile(scan_settings_path)) || {
-        node_url: LOCAL_NODE_DEFAULT_URL,
-        wallets: [],
-        start_height: null,
-    };
-    scanSettings.start_height = start_height;
-    return await atomicWrite(SCAN_SETTINGS_STORE_NAME_DEFAULT, JSON.stringify(scanSettings, null, 2));
-}
-export async function writeDaemonHeightAsStartHeightToScanSettings(node_url, scan_settings_path = SCAN_SETTINGS_STORE_NAME_DEFAULT) {
-    const getInfo = await get_info(node_url);
-    const scanSettings = (await openScanSettingsFile(scan_settings_path)) || {
-        node_url: LOCAL_NODE_DEFAULT_URL,
-        wallets: [],
-        start_height: null,
-    };
-    scanSettings.start_height = getInfo.height - 1;
-    await atomicWrite(scan_settings_path, JSON.stringify(scanSettings, null, 2));
-    return getInfo.height;
-}
-export async function cullTooLargeScanHeight(node_url, scan_settings_path = SCAN_SETTINGS_STORE_NAME_DEFAULT) {
-    const getInfo = await get_info(node_url);
-    const scanSettings = (await openScanSettingsFile(scan_settings_path)) || {
-        node_url: LOCAL_NODE_DEFAULT_URL,
-        wallets: [],
-        start_height: null,
-    };
-    if (scanSettings.start_height === null ||
-        scanSettings.start_height > getInfo.height - 1) {
-        scanSettings.start_height = getInfo.height - 1;
-        await atomicWrite(scan_settings_path, JSON.stringify(scanSettings, null, 2));
-    }
-    return scanSettings.start_height;
-}
-export async function writeNodeUrlToScanSettings(node_url, scan_settings_path = SCAN_SETTINGS_STORE_NAME_DEFAULT) {
-    const scanSettings = (await openScanSettingsFile(scan_settings_path)) || {
-        node_url: LOCAL_NODE_DEFAULT_URL,
-        wallets: [],
-        start_height: null,
-    };
-    scanSettings.node_url = node_url;
-    return await atomicWrite(scan_settings_path, JSON.stringify(scanSettings, null, 2));
-}
-export async function readNodeUrlFromScanSettings(scan_settings_path = SCAN_SETTINGS_STORE_NAME_DEFAULT) {
-    const scanSettings = await openScanSettingsFile(scan_settings_path);
-    return scanSettings?.node_url;
-}
-/**
- * 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 async function writeMerchantConfirmationsToScanSettings(merchant_confirmations, scan_settings_path = SCAN_SETTINGS_STORE_NAME_DEFAULT) {
-    const scanSettings = (await openScanSettingsFile(scan_settings_path)) || {
-        node_url: LOCAL_NODE_DEFAULT_URL,
-        wallets: [],
-        start_height: null,
-    };
-    scanSettings.merchant_confirmations = merchant_confirmations;
-    return await atomicWrite(scan_settings_path, JSON.stringify(scanSettings, null, 2));
-}
-/**
- * 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 async function readMerchantConfirmationsFromScanSettings(scan_settings_path = SCAN_SETTINGS_STORE_NAME_DEFAULT) {
-    const scanSettings = await openScanSettingsFile(scan_settings_path);
-    return scanSettings?.merchant_confirmations;
-}
-/**
- * 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 async function readScanSettings(scan_settings_path = SCAN_SETTINGS_STORE_NAME_DEFAULT) {
-    const scanSettings = await openScanSettingsFile(scan_settings_path);
-    if (!scanSettings)
-        return undefined;
-    const openScanSettings = Object.assign({}, scanSettings);
-    for (const [i, wallet] of scanSettings.wallets.entries()) {
-        if (!wallet.primary_address)
-            throw new Error("The entry ${i} in the wallet settings list in ${scan_settings_path} has no primary address");
-        const walletWithKeys = await walletSettingsPlusKeys({
-            ...wallet,
-            node_url: scanSettings.node_url,
-            start_height: scanSettings.start_height,
-        });
-        openScanSettings.wallets[i].secret_view_key =
-            walletWithKeys.secret_view_key;
-        openScanSettings.wallets[i].secret_spend_key =
-            walletWithKeys.secret_spend_key;
-    }
-    return openScanSettings;
-}
-export function readPrivateSpendKeyFromEnv(primary_address) {
-    return Bun.env["sk" + primary_address];
-}
-export function readPrivateViewKeyFromEnv(primary_address) {
-    return Bun.env["vk" + primary_address];
-}
-export async function readWalletFromScanSettings(primary_address, scan_settings_path = SCAN_SETTINGS_STORE_NAME_DEFAULT) {
-    const scanSettings = await openScanSettingsFile(scan_settings_path);
-    if (!scanSettings)
-        return undefined;
-    const walletSettings = scanSettings.wallets.find((wallet) => wallet?.primary_address === primary_address);
-    if (!walletSettings)
-        throw new Error(`wallet not found in settings. did you call openwallet with the right params?
-      Either wrong file name supplied to params.scan_settings_path: ${scan_settings_path}
-      Or wrong primary_address supplied params.primary_address: ${primary_address}`);
-    return {
-        ...walletSettings,
-        node_url: scanSettings.node_url,
-        start_height: scanSettings.start_height,
-    };
-}
-export async function readWalletsFromScanSettings(scan_settings_path = SCAN_SETTINGS_STORE_NAME_DEFAULT) {
-    const scanSettings = await openScanSettingsFile(scan_settings_path);
-    const scanSettingsOpened = [];
-    for (const wallet of scanSettings?.wallets || []) {
-        scanSettingsOpened.push({
-            ...wallet,
-            node_url: scanSettings?.node_url || LOCAL_NODE_DEFAULT_URL,
-            start_height: scanSettings?.start_height || null,
-        });
-    }
-    return scanSettingsOpened;
-}
-export async function walletSettingsPlusKeys(wallet_settings, secret_view_key, secret_spend_key) {
-    // read secret_view_key and secret_spend_key from env
-    if (!secret_view_key)
-        secret_view_key = Bun.env[`vk${wallet_settings.primary_address}`];
-    if (!secret_view_key) {
-        await refreshEnvIndexedDB();
-        secret_view_key = Bun.env[`vk${wallet_settings.primary_address}`];
-    }
-    if (!secret_view_key)
-        throw ("no secret_view_key provided and not found in env for address: " +
-            wallet_settings.primary_address);
-    if (!secret_spend_key)
-        secret_spend_key = Bun.env[`sk${wallet_settings.primary_address}`];
-    return {
-        ...wallet_settings,
-        secret_view_key,
-        secret_spend_key,
-    };
-}
-export async function writeWalletToScanSettings(params) {
-    if (!params.scan_settings_path)
-        params.scan_settings_path = SCAN_SETTINGS_STORE_NAME_DEFAULT;
-    if (!params.primary_address)
-        throw new Error("no primary address provided to writeWalletToScanSettings()");
-    const scanSettings = await openScanSettingsFile(params.scan_settings_path);
-    if (!scanSettings) {
-        if (!params.node_url)
-            params.node_url = LOCAL_NODE_DEFAULT_URL;
-        // case: no scan settings exist yet
-        return await writeScanSettings({
-            wallets: [
-                {
-                    primary_address: params.primary_address,
-                    subaddress_index: params.subaddress_index || SUB_ADDRESS_INDEX_DEFAULT_VALUE,
-                    halted: params.halted,
-                    wallet_route: params.wallet_route,
-                    wallet_name: params.wallet_name,
-                    wallet_slot: params.wallet_slot,
-                },
-            ],
-            node_url: params.node_url,
-            logs: params.logs,
-            logs_include: params.logs_include,
-            logs_exclude: params.logs_exclude,
-            start_height: params.start_height || null,
-        }, params.scan_settings_path);
-    }
-    scanSettings.node_url = params.node_url || scanSettings.node_url;
-    if (params.logs)
-        scanSettings.logs = params.logs;
-    if (params.logs_include)
-        scanSettings.logs_include = params.logs_include;
-    if (params.logs_exclude)
-        scanSettings.logs_exclude = params.logs_exclude;
-    scanSettings.start_height =
-        params.start_height === undefined
-            ? scanSettings.start_height
-            : params.start_height;
-    const already_has_settings = scanSettings.wallets.findIndex((wallet) => wallet?.primary_address === params.primary_address);
-    if (already_has_settings === -1) {
-        // wallet does not exist yet in settings
-        scanSettings.wallets.push({
-            primary_address: params.primary_address,
-            subaddress_index: params.subaddress_index || SUB_ADDRESS_INDEX_DEFAULT_VALUE,
-            halted: params.halted,
-            wallet_route: params.wallet_route,
-            wallet_name: params.wallet_name,
-            wallet_slot: params.wallet_slot,
-        });
-    }
-    else {
-        // wallet already exists
-        const wallet = scanSettings.wallets[already_has_settings];
-        if (wallet) {
-            wallet.subaddress_index =
-                params.subaddress_index ||
-                    wallet.subaddress_index ||
-                    SUB_ADDRESS_INDEX_DEFAULT_VALUE;
-            wallet.halted = params.halted || wallet.halted;
-            wallet.wallet_route = params.wallet_route || wallet.wallet_route;
-            wallet.wallet_name = params.wallet_name || wallet.wallet_name;
-            wallet.wallet_slot = params.wallet_slot || wallet.wallet_slot;
-        }
-    }
-    return await atomicWrite(params.scan_settings_path, JSON.stringify(scanSettings, null, 2));
-}
-export async function openScanSettingsFile(scan_settings_path = SCAN_SETTINGS_STORE_NAME_DEFAULT) {
-    const jsonString = await Bun.file(scan_settings_path)
-        .text()
-        .catch(() => undefined);
-    return jsonString ? JSON.parse(jsonString) : undefined;
-}
-export async function openNonHaltedWallets(scan_settings_path = SCAN_SETTINGS_STORE_NAME_DEFAULT) {
-    const scan_settings = await readWalletsFromScanSettings(scan_settings_path);
-    if (!scan_settings)
-        throw new Error("no scan settings file found at path: " + scan_settings_path);
-    if (!scan_settings)
-        throw new Error("no wallets in scan settings");
-    const nonHaltedWallets = scan_settings.filter((wallet) => !wallet?.halted);
-    if (!nonHaltedWallets.length)
-        throw new Error("no non halted wallets in scan settings");
-    return nonHaltedWallets;
-}
-export function getNonHaltedWallets(scan_settings) {
-    if (!scan_settings)
-        return [];
-    const nonHaltedWallets = scan_settings.wallets.filter((wallet) => !wallet?.halted);
-    return nonHaltedWallets;
-}
-export async function doesScanSettingsFileExist(scan_settings_path = SCAN_SETTINGS_STORE_NAME_DEFAULT) {
-    const scan_settings_file_content = await Bun.file(scan_settings_path)
-        .text()
-        .catch(() => "");
-    if (scan_settings_file_content.length) {
-        return true;
-    }
-    else {
-        return false;
-    }
-}
-/**
- * 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 function getPathPrefix(scan_settings_path = SCAN_SETTINGS_STORE_NAME_DEFAULT, pathPrefix) {
-    const parts = scan_settings_path.split("/");
-    const basename = parts.pop();
-    const dir = parts.join("/");
-    const prefix = dir ? `${dir}/` : "";
-    return pathPrefix ?? prefix;
-}

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

@@ -1,3 +0,0 @@
-import { type ScanResult } from "./scanResult";
-import type { CacheRange, ChangedOutput, ScanCache } from "./scanCache";
-export declare function handleReorg(current_range: CacheRange, result: ScanResult, cache: ScanCache, oldRange: CacheRange): [CacheRange, ChangedOutput[]];

package/dist/scanning-syncing/scanresult/reorg.js

@@ -1,101 +0,0 @@
-import { makeNewRange } from "./scanResult";
-export function handleReorg(current_range, result, cache, oldRange) {
-    let changed_outputs = [];
-    console.log("[handleReorg] oldRange hashes:", oldRange.block_hashes.map((h) => h.block_height + ":" + h.block_hash.slice(0, 8)));
-    console.log("[handleReorg] cache outputs:", Object.entries(cache.outputs).map(([id, o]) => "h=" + o.block_height + " spent=" + (o.spent_block_height ?? "no")));
-    console.log("[handleReorg] result infos:", result.block_infos.length +
-        " blocks, first=" +
-        result.block_infos[0]?.block_height, "last=" + result.block_infos.at(-1)?.block_height);
-    // we need to check where anchor candidate is and if not found, try the same for anchor
-    // if else throw on catastrophic reorg
-    for (const block_hash of oldRange.block_hashes) {
-        const split_height_index = result.block_infos.findIndex((b) => b.block_hash === block_hash.block_hash);
-        if (!(split_height_index > 0))
-            continue;
-        console.log("[handleReorg] trying hash", block_hash.block_height, block_hash.block_hash.slice(0, 8), "found at idx", split_height_index);
-        const split_height = result.block_infos[split_height_index];
-        // still a chance to find the split height, (could be candidate_anchor or anchor)
-        if (!split_height)
-            continue;
-        // we found the split height & do the reorg
-        console.log("[handleReorg] SPLIT FOUND at height", split_height.block_height);
-        if (!cache.reorg_info) {
-            cache.reorg_info = {
-                split_heights: [split_height],
-                removed_outputs: [],
-                reverted_spends: [],
-            };
-        }
-        else {
-            cache.reorg_info.split_heights.push(split_height);
-        }
-        // First, collect reverted spends from all outputs (before any removals)
-        // so that outputs with block_height < split_height but spent_block_height >= split_height are captured
-        const reverted_outputs = Object.entries(cache.outputs).filter(([id, output]) => output.spent_block_height !== undefined &&
-            output.spent_block_height >= split_height.block_height);
-        const removed_outputs = Object.entries(cache.outputs).filter(([id, output]) => output.block_height >= split_height.block_height);
-        console.log("[handleReorg] removed_outputs count:", removed_outputs.length, "reverted count:", reverted_outputs.length);
-        for (const [id, old_output_state] of removed_outputs) {
-            // 1. find key_image of output to be removed (as it was reorged)
-            const [key_image] = Object.entries(cache.own_key_images).find(([own_key_image, globalid]) => globalid === id) || [""]; // if this is viewonly the key_image will be empty
-            cache.reorg_info.removed_outputs.push({
-                old_output_state,
-                key_image,
-                split_height,
-            });
-            // 2. remove from outputs and own_key_images
-            delete cache.outputs[id];
-            delete cache.own_key_images[key_image];
-            changed_outputs.push({
-                output: old_output_state,
-                change_reason: "reorged",
-            });
-        }
-        for (const [id, old_output_state_pointer] of reverted_outputs) {
-            const [key_image] = Object.entries(cache.own_key_images).find(([own_key_image, globalid]) => globalid === id) || [""]; // if this is viewonly the key_image will be empty
-            const old_output_state = Object.assign({}, old_output_state_pointer);
-            cache.reorg_info.reverted_spends.push({
-                old_output_state,
-                key_image, // in this case key_image only used here, does not get removed
-                split_height,
-            });
-            // remove spend info from original cache (if output still exists
-            // it may have been deleted above in the removed_outputs loop)
-            if (cache.outputs[id]) {
-                delete cache.outputs[id].spent_relative_index;
-                delete cache.outputs[id].spent_in_tx_hash;
-                delete cache.outputs[id].spent_block_height;
-                delete cache.outputs[id].spent_block_timestamp;
-            }
-            changed_outputs.push({
-                output: old_output_state,
-                change_reason: "reorged_spent",
-            });
-        }
-        // find current range in scanned ranges and change its end value + latest_block_hash
-        oldRange.end = split_height.block_height;
-        oldRange.block_hashes[0] = split_height;
-        // fix current_range
-        let anchor = result.block_infos.slice(-100)[0]; // if we got lots of new blocks
-        const old_anchor = oldRange.block_hashes.at(-1);
-        if (!anchor &&
-            old_anchor &&
-            split_height.block_height > old_anchor.block_height //if we did not get many new blocks + split height was candidate anchor
-        ) {
-            anchor = old_anchor; // we keep the anchor the same
-        }
-        if (!anchor)
-            anchor = split_height;
-        let last_block_hash_of_result = result.block_infos.at(-1);
-        const end = last_block_hash_of_result.block_height;
-        const start = current_range.start > end ? end : current_range.start;
-        const newRange = {
-            start,
-            end,
-            block_hashes: [last_block_hash_of_result, anchor, anchor],
-        };
-        return [makeNewRange(newRange, cache), changed_outputs];
-    }
-    // we tried all the block hashes and could not find the split height
-    throw new Error("Could not find reorg split height. Most likely connected to faulty node / catastrophic reorg.");
-}

package/dist/scanning-syncing/scansettings/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;