Class: MoneroWalletConfig

MoneroWalletConfig(config)

Configuration to create a Monero wallet.

Constructor

new MoneroWalletConfig(config)

Construct a configuration to open or create a wallet.
Parameters:
Name Type Description
config object | MoneroWalletConfig MoneroWalletConfig or equivalent config object
Properties
Name Type Description
path string path of the wallet to open or create
password string password of the wallet to open
networkType string | number network type of the wallet to open (one of "mainnet", "testnet", "stagenet" or MoneroNetworkType.MAINNET|TESTNET|STAGENET)
seed string seed of the wallet to create (optional, random wallet created if neither seed nor keys given)
seedOffset string the offset used to derive a new seed from the given seed to recover a secret wallet from the seed phrase
isMultisig boolean restore multisig wallet from seed
primaryAddress string primary address of the wallet to create (only provide if restoring from keys)
privateViewKey string private view key of the wallet to create (optional)
privateSpendKey string private spend key of the wallet to create (optional)
restoreHeight number block height to start scanning from (defaults to 0 unless generating random wallet)
language string language of the wallet's seed phrase (defaults to "English" or auto-detected)
accountLookahead number number of accounts to scan (optional)
subaddressLookahead number number of subaddresses to scan per account (optional)
serverUri string uri of the wallet's server (optional)
serverUsername string username of the wallet's server (optional)
serverPassword string password of the wallet's server (optional)
rejectUnauthorized boolean reject self-signed server certificates if true (default true)
server MoneroRpcConnection | object MoneroRpcConnection or equivalent JS object configuring the server connection (optional)
keysData Uint8Array wallet keys data to open (optional)
cacheData Uint8Array wallet cache data to open (optional)
proxyToWorker boolean proxies wallet operations to a worker in order to not block the main thread (default true)
fs fs Node.js compatible file system to use (defaults to disk or in-memory FS if browser)
saveCurrent boolean specifies if the current RPC wallet should be saved before being closed
accountLookahead number number of accounts to scan (optional)
subaddressLookahead number number of subaddresses to scan per account (optional)
Source:

Methods

copy()

Source:

getAccountLookahead()

Source:

getCacheData()

Source:

getFs()

Source:

getKeysData()

Source:

getLanguage()

Source:

getNetworkType()

Source:

getPassword()

Source:

getPath()

Source:

getPrimaryAddress()

Source:

getPrivateSpendKey()

Source:

getPrivateViewKey()

Source:

getProxyToWorker()

Source:

getRejectUnauthorized()

Source:

getRestoreHeight()

Source:

getSaveCurrent()

Source:

getSeed()

Source:

getSeedOffset()

Source:

getServer()

Source:

getServerPassword()

Source:

getServerUri()

Source:

getServerUsername()

Source:

getSubaddressLookahead()

Source:

isMultisig()

Source:

setAccountLookahead()

Source:

setCacheData()

Source:

setFs()

Source:

setIsMultisig()

Source:

setKeysData()

Source:

setLanguage()

Source:

setNetworkType()

Source:

setPassword()

Source:

setPath()

Source:

setPrimaryAddress()

Source:

setPrivateSpendKey()

Source:

setPrivateViewKey()

Source:

setProxyToWorker()

Source:

setRejectUnauthorized()

Source:

setRestoreHeight()

Source:

setSaveCurrent()

Source:

setSeed()

Source:

setSeedOffset()

Source:

setServer()

Source:

setServerPassword()

Source:

setServerUri()

Source:

setServerUsername()

Source:

setSubaddressLookahead()

Source:

toJson()

Source: