@spirobel/monero-wallet-api 0.5.2 → 0.5.3

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

@@ -70,6 +70,7 @@ export declare class ScanCacheOpened {
     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>;
@@ -200,6 +201,7 @@ export declare class ManyScanCachesOpened {
     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>;
     private static _buildWallets;
     static create(options: ManyScanCachesOpenedCreateOptions): Promise<ManyScanCachesOpened | undefined>;

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

@@ -208,6 +208,9 @@ export class ScanCacheOpened {
         await this._scanSettings.setLogSettings(logs, logs_include, logs_exclude);
         await this.unpause();
     }
+    async setWalletName(name) {
+        await this._scanSettings.setWalletName(this.view_pair.primary_address, name);
+    }
     async retry() {
         if (this.worker) {
             this.worker.terminate();
@@ -798,6 +801,9 @@ export class ManyScanCachesOpened {
             throw new Error("no wallets");
         return await this.wallets[0].setLogSettings(logs, logs_include, logs_exclude);
     }
+    async setWalletName(primary_address, name) {
+        await this._scanSettings.setWalletName(primary_address, name);
+    }
     async changeStartHeight(start_height) {
         if (this.wallets.length === 0)
             throw new Error("no wallets");

package/dist/scansettings/scanSettingsOpened.d.ts

@@ -93,6 +93,17 @@ export declare class ScanSettingsOpened {
      * throws if any entry is invalid.
      */
     private static _validateLogOptions;
+    private static _validateAddress;
+    private static _validateViewKey;
+    private static _validateNodeUrl;
+    private static _validateStartHeight;
+    private static _validateCpuWorkerCount;
+    private static _validateMerchantConfirmations;
+    private static _validateWalletName;
+    private static _validateWalletSlot;
+    private static _validateSubaddressIndex;
+    private static _validateWalletRoute;
+    private static _validateHalted;
     private _settings;
     private constructor();
     /**
@@ -100,3 +111,17 @@ export declare class ScanSettingsOpened {
      */
     private _persist;
 }
+export declare function walletRouteFromString(input: string): {
+    ok: boolean;
+    error: string;
+    route?: undefined;
+} | {
+    ok: boolean;
+    route: {
+        identity: string;
+        domain: string;
+        wallet_type: string;
+        wallet_slot: string;
+    };
+    error?: undefined;
+};

package/dist/scansettings/scanSettingsOpened.js

@@ -1,5 +1,5 @@
 import { LOCAL_NODE_DEFAULT_URL } from "../node-interaction/nodeUrl";
-import { LOGGING_FUNCTIONS } from "../io/logging";
+import { LOGGING_FUNCTIONS, } from "../io/logging";
 import { getPathPrefix, makeSpendKeyFromSeed, makeViewKey, openScanSettingsFile, SCAN_SETTINGS_STORE_NAME_DEFAULT, SUB_ADDRESS_INDEX_DEFAULT_VALUE, walletSettingsPlusKeys, writeEnvLineToDotEnvRefresh, writeScanSettings, writeViewKeyToDotEnv, } from "../api";
 export class ScanSettingsOpened {
     _scan_settings_path;
@@ -55,27 +55,34 @@ export class ScanSettingsOpened {
     }
     async setNodeUrl(node_url) {
         await this.reload();
-        this._settings.node_url = node_url;
+        this._settings.node_url = ScanSettingsOpened._validateNodeUrl(node_url);
         await this._persist();
     }
     async setStartHeight(start_height) {
         await this.reload();
+        ScanSettingsOpened._validateStartHeight(start_height);
         this._settings.start_height = start_height;
         await this._persist();
     }
     async setMerchantConfirmations(merchant_confirmations) {
         await this.reload();
-        this._settings.merchant_confirmations = merchant_confirmations;
-        if (merchant_confirmations === null)
+        if (merchant_confirmations === undefined ||
+            merchant_confirmations === null) {
             delete this._settings.merchant_confirmations;
+        }
+        else {
+            ScanSettingsOpened._validateMerchantConfirmations(merchant_confirmations);
+            this._settings.merchant_confirmations = merchant_confirmations;
+        }
         await this._persist();
     }
     async setCpuWorkerCount(cpu_worker_count) {
         await this.reload();
-        if (cpu_worker_count === null) {
+        if (cpu_worker_count === null || cpu_worker_count === undefined) {
             delete this._settings.cpu_worker_count;
         }
         else {
+            ScanSettingsOpened._validateCpuWorkerCount(cpu_worker_count);
             this._settings.cpu_worker_count = cpu_worker_count;
         }
         await this._persist();
@@ -154,13 +161,20 @@ export class ScanSettingsOpened {
      * if the wallet already exists, updates it instead.
      */
     async addViewWallet(primary_address, view_key, fields) {
+        primary_address = primary_address.trim();
+        view_key = view_key.trim();
+        ScanSettingsOpened._validateAddress(primary_address);
+        ScanSettingsOpened._validateViewKey(view_key);
+        ScanSettingsOpened._validateWalletName(fields?.wallet_name);
+        ScanSettingsOpened._validateWalletSlot(fields?.wallet_slot);
+        ScanSettingsOpened._validateWalletRoute(fields?.wallet_route);
+        ScanSettingsOpened._validateSubaddressIndex(fields?.subaddress_index);
+        ScanSettingsOpened._validateHalted(fields?.halted);
         await this.reload();
         const existing = this.getWallet(primary_address);
         if (existing) {
             throw new Error(`wallet already exists: ${primary_address} in ${this._scan_settings_path}`);
         }
-        primary_address = primary_address.trim();
-        view_key = view_key.trim();
         // write view key to env first
         await writeViewKeyToDotEnv(primary_address, view_key);
         const subaddress_index = fields?.subaddress_index ?? SUB_ADDRESS_INDEX_DEFAULT_VALUE;
@@ -180,6 +194,11 @@ export class ScanSettingsOpened {
         const spend_key = await makeSpendKeyFromSeed(wallet_secret.toHex());
         const view_pair = await makeViewKey(spend_key);
         const primary_address = view_pair.mainnet_primary;
+        ScanSettingsOpened._validateWalletName(fields?.wallet_name);
+        ScanSettingsOpened._validateWalletSlot(fields?.wallet_slot);
+        ScanSettingsOpened._validateWalletRoute(fields?.wallet_route);
+        ScanSettingsOpened._validateSubaddressIndex(fields?.subaddress_index);
+        ScanSettingsOpened._validateHalted(fields?.halted);
         await this.reload();
         const existing = this.getWallet(primary_address);
         if (existing) {
@@ -214,6 +233,11 @@ export class ScanSettingsOpened {
         const wallet = this.getWallet(primary_address);
         if (!wallet)
             throw new Error(`wallet not found: ${primary_address} in ${this._scan_settings_path}`);
+        ScanSettingsOpened._validateWalletName(fields.wallet_name);
+        ScanSettingsOpened._validateWalletSlot(fields.wallet_slot);
+        ScanSettingsOpened._validateSubaddressIndex(fields.subaddress_index);
+        ScanSettingsOpened._validateWalletRoute(fields.wallet_route);
+        ScanSettingsOpened._validateHalted(fields.halted);
         wallet.wallet_name = fields.wallet_name ?? wallet.wallet_name;
         wallet.wallet_slot = fields.wallet_slot ?? wallet.wallet_slot;
         wallet.wallet_route = fields.wallet_route ?? wallet.wallet_route;
@@ -284,6 +308,89 @@ export class ScanSettingsOpened {
                 `valid options are: ${[...valid].join(", ")}`);
         }
     }
+    static _validateAddress(address) {
+        if (!isValidMoneroAddress(address)) {
+            throw new Error(`invalid monero address: ${address}`);
+        }
+    }
+    static _validateViewKey(key) {
+        if (!isValidMoneroPrivateKey(key)) {
+            throw new Error(`invalid secret view key: ${key}`);
+        }
+    }
+    static _validateNodeUrl(url) {
+        let parsed;
+        try {
+            parsed = new URL(url);
+        }
+        catch {
+            throw new Error(`invalid node URL: ${url}`);
+        }
+        if (!["http:", "https:"].includes(parsed.protocol)) {
+            throw new Error(`unsupported protocol: ${parsed.protocol}`);
+        }
+        if (!parsed.hostname) {
+            throw new Error(`invalid node URL, missing hostname: ${url}`);
+        }
+        return url;
+    }
+    static _validateStartHeight(start_height) {
+        if (start_height !== null &&
+            (typeof start_height !== "number" || start_height < 0)) {
+            throw new Error(`invalid start height: ${start_height}. must be null or a number >= 0`);
+        }
+    }
+    static _validateCpuWorkerCount(cpu_worker_count) {
+        if (cpu_worker_count !== null &&
+            (typeof cpu_worker_count !== "number" || cpu_worker_count < 0)) {
+            throw new Error(`invalid cpu_worker_count: ${cpu_worker_count}. must be null or a number >= 0`);
+        }
+    }
+    static _validateMerchantConfirmations(merchant_confirmations) {
+        if (merchant_confirmations !== null &&
+            (typeof merchant_confirmations !== "number" || merchant_confirmations < 0)) {
+            throw new Error(`invalid merchant_confirmations: ${merchant_confirmations}. must be null or a number >= 0`);
+        }
+    }
+    static _validateWalletName(name) {
+        if (name === undefined || name === null)
+            return;
+        if (name.length > 100) {
+            throw new Error(`wallet name must be 100 characters or less, got ${name.length}`);
+        }
+        if (!/^[a-zA-Z0-9 _.-]+$/.test(name)) {
+            throw new Error(`wallet name must be alphanumeric with spaces, hyphens, underscores, or dots, got: ${name}`);
+        }
+    }
+    static _validateWalletSlot(slot) {
+        if (slot === undefined || slot === null)
+            return;
+        if (typeof slot !== "number" || slot < 0 || !Number.isInteger(slot)) {
+            throw new Error(`wallet slot must be a number >= 0, got: ${slot}`);
+        }
+    }
+    static _validateSubaddressIndex(index) {
+        if (index === undefined || index === null)
+            return;
+        if (typeof index !== "number" || index < 0 || !Number.isInteger(index)) {
+            throw new Error(`subaddress index must be a number >= 0, got: ${index}`);
+        }
+    }
+    static _validateWalletRoute(route) {
+        if (route === undefined || route === null)
+            return;
+        const result = walletRouteFromString(route);
+        if (!result.ok) {
+            throw new Error(result.error);
+        }
+    }
+    static _validateHalted(halted) {
+        if (halted === undefined || halted === null)
+            return;
+        if (typeof halted !== "boolean") {
+            throw new Error(`halted must be a boolean, got: ${halted}`);
+        }
+    }
     _settings;
     constructor(settings, _scan_settings_path, _pathPrefix) {
         this._scan_settings_path = _scan_settings_path;
@@ -297,3 +404,72 @@ export class ScanSettingsOpened {
         await writeScanSettings(this._settings, this._scan_settings_path);
     }
 }
+function isValidMoneroAddress(address) {
+    // basic sanity check
+    return (address.length >= 95 && address.length <= 106 && isAlphaNumeric(address));
+}
+function isValidMoneroPrivateKey(key) {
+    return key.length === 64 && isAlphaNumeric(key);
+}
+function isAlphaNumeric(str) {
+    return str.match(/^[a-z0-9]+$/i) !== null;
+}
+// strictly speaking according to the RFC 1035
+// there is a limit of 63 chars per label
+// and other rules like no leading or trailing hyphens, no dots in a row
+function isValidDomainName(str) {
+    if (!str || str.length === 0 || str.length > 253) {
+        return false;
+    }
+    return str.match(/^[a-z0-9.\-_]+$/i) !== null;
+}
+// copied from seedphrase package to not introduce a dependency
+export function walletRouteFromString(input) {
+    const parts = input.split("/");
+    if (parts.length < 1 || !parts[0]) {
+        return { ok: false, error: "missing identity" };
+    }
+    if (parts.length < 2 || !parts[1]) {
+        return { ok: false, error: "missing domain" };
+    }
+    if (parts.length < 3 || !parts[2]) {
+        return { ok: false, error: "missing wallet_type" };
+    }
+    if (parts.length < 4 || !parts[3]) {
+        return { ok: false, error: "missing wallet_slot" };
+    }
+    if (parts.length > 4) {
+        return {
+            ok: false,
+            error: "wallet route should only have 4 parts separated by /",
+        };
+    }
+    const [identity, domain, wallet_type, wallet_slot] = parts;
+    if (wallet_type !== "single" &&
+        wallet_type !== "sa_multi" &&
+        wallet_type !== "pl_multi") {
+        return { ok: false, error: `invalid wallet_type: "${wallet_type}"` };
+    }
+    if (Number.isNaN(parseInt(wallet_slot))) {
+        return { ok: false, error: `invalid wallet_slot: "${wallet_slot}"` };
+    }
+    if (parseInt(wallet_slot) < 0) {
+        return { ok: false, error: `invalid wallet_slot: "${wallet_slot} < 0"` };
+    }
+    if (!isAlphaNumeric(identity)) {
+        return {
+            ok: false,
+            error: `invalid identity, not alpha numeric: "${identity}"`,
+        };
+    }
+    if (!isValidDomainName(domain)) {
+        return {
+            ok: false,
+            error: `invalid domain, : "${domain}"`,
+        };
+    }
+    return {
+        ok: true,
+        route: { identity, domain, wallet_type, wallet_slot },
+    };
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@spirobel/monero-wallet-api",
-  "version": "0.5.2",
+  "version": "0.5.3",
   "main": "dist/api.js",
   "module": "dist/api.js",
   "devDependencies": {