Class LibraryUtils

constructor

• new LibraryUtils(): LibraryUtils

• Returns LibraryUtils

Static FULL_LOADED

Static LOG_LEVEL

Static Readonly MUTEX

Static REJECT_UNAUTHORIZED_FNS

Static WASM_MODULE

Static WORKER

Static WORKER_DIST_PATH

Static WORKER_DIST_PATH_DEFAULT

Static Optional WORKER_LOADER

Static WORKER_OBJECTS

Static addWorkerCallback

• addWorkerCallback(objectId, callbackId, callbackArgs): void

• Parameters

  • objectId: any

  • callbackId: any

  • callbackArgs: any

  Returns void

Static exists

• exists(fs, path): Promise<boolean>

• Parameters

  • fs: any

  • path: string

  Returns Promise<boolean>

Static getLogLevel

• getLogLevel(): number

• Get the library's log level.

  Returns number

  the library's log level

Static getWasmMemoryUsed

• getWasmMemoryUsed(): Promise<number>

• Get the total memory used by WebAssembly.

  Returns Promise<number>

  the total memory used by WebAssembly

Static getWasmModule

• getWasmModule(): any

• Get the WebAssembly module in the current context (nodejs, browser main thread or worker).

  Returns any

Static getWorker

• getWorker(): Promise<any>

• Get a singleton instance of a worker to share.

  Returns Promise<any>

  a worker to share among wallet instances

Static invokeWorker

• invokeWorker(objectId, fnName, args?): Promise<unknown>

• Invoke a worker function and get the result with error handling.

  Parameters

  • objectId: any

    identifies the worker object to invoke (default random id)

  • fnName: any

    is the name of the function to invoke

  • Optional args: any

    are function arguments to invoke with

  Returns Promise<unknown>

  resolves with response payload from the worker or an error

Static isRejectUnauthorized

• isRejectUnauthorized(fnId): any

• Indicate if unauthorized requests should be rejected.

  Parameters

  • fnId: any

    uniquely identifies the function

  Returns any

Static loadWasmModule

• loadWasmModule(): Promise<any>

• Load the WebAssembly full module with caching.

  The full module is a superset of the keys module and overrides it.

  Returns Promise<any>

Static log

• log(level, msg): void

• Log a message.

  Parameters

  • level: any

    log level of the message

  • msg: any

    message to log

  Returns void

Static queueTask

• queueTask<T>(asyncFn): Promise<T>

• Type Parameters

  • T

  Parameters

  • asyncFn: (() => Promise<T>)

    • • (): Promise<T>

      • Returns Promise<T>

  Returns Promise<T>

Static removeWorkerCallback

• removeWorkerCallback(objectId, callbackId): void

• Parameters

  • objectId: any

  • callbackId: any

  Returns void

Static removeWorkerObject

• removeWorkerObject(objectId): void

• Parameters

  • objectId: any

  Returns void

Static serializeError

• serializeError(err): any

• Parameters

  • err: any

  Returns any

Static setLogLevel

• setLogLevel(level): Promise<void>

• Set the library's log level with 0 being least verbose.

  Parameters

  • level: any

    the library's log level

  Returns Promise<void>

Static setRejectUnauthorizedFn

• setRejectUnauthorizedFn(fnId, fn): void

• Register a function by id which informs if unauthorized requests (e.g. self-signed certificates) should be rejected.

  Parameters

  • fnId: any

    unique identifier for the function

  • fn: any

    function to inform if unauthorized requests should be rejected

  Returns void

Static setWorkerDistPath

• setWorkerDistPath(workerDistPath): void

• Set the path to load the worker. Defaults to "/monero.worker.js" in the browser and "./MoneroWebWorker.js" in node.

  Parameters

  • workerDistPath: any

    path to load the worker

  Returns void

Static setWorkerLoader

• setWorkerLoader(loader?): void

• Set the worker loader closure to customize worker loading. Takes precedence over default loading mechanisms.

  Could be as simple as () => new Worker(new URL("monero-ts/dist/monero.worker.js", import.meta.url)); for browsers.

  Parameters

  • Optional loader: (() => Worker)

    loader function which instantiates a worker

    • • (): Worker

      • Returns Worker

  Returns void

Static terminateWorker

• terminateWorker(): Promise<void>

• Terminate monero-ts's singleton worker.

  Returns Promise<void>