Monero-TS

https://woodser.github.io/monero-ts/typedocs
Admin
A TypeScript library for creating Monero applications using RPC and WebAssembly bindings to Monero...
Tokens:38,238
Snippets:412
Trust Score:8.3
Update:1 month ago
Show doc for...
Tokens:
Raw
### Install and Import monero-ts

Source: https://woodser.github.io/monero-ts/typedocs/index.html

Commands to initialize a project, install the library, and import it into application code.

```bash
cd your_project
npm init
npm install monero-ts
```

```typescript
import moneroTs from "monero-ts"
```

--------------------------------

### startSyncing

Source: https://woodser.github.io/monero-ts/typedocs/classes/MoneroWalletKeys.html

Starts background synchronization.

```APIDOC
## startSyncing(syncPeriodInMs?)

### Description
Start background synchronizing with a maximum period between syncs.

### Parameters
- **syncPeriodInMs** (number) - Optional - maximum period between syncs in milliseconds (default is wallet-specific)

### Returns
- **Promise<void>**
```

--------------------------------

### startMining

Source: https://woodser.github.io/monero-ts/typedocs/classes/MoneroDaemon.html

Start mining.

```APIDOC
## startMining(address: string, numThreads?: number, isBackground?: boolean, ignoreBattery?: boolean)

### Description
Start mining.

### Parameters
- **address** (string) - Required - address given miner rewards if the daemon mines a block
- **numThreads** (number) - Optional - number of mining threads to run (default 1)
- **isBackground** (boolean) - Optional - specifies if the miner should run in the background or not (default false)
- **ignoreBattery** (boolean) - Optional - specifies if the battery state (e.g. on laptop) should be ignored or not (default false)

### Returns
- Promise<void>
```

--------------------------------

### Start Monero RPC Services

Source: https://woodser.github.io/monero-ts/typedocs/index.html

Commands to launch the Monero daemon and wallet RPC server for local development.

```bash
./monerod --stagenet
```

```bash
./monero-wallet-rpc --daemon-address http://localhost:38081 --stagenet --rpc-bind-port 38084 --rpc-login rpc_user:abc123 --wallet-dir ./
```

--------------------------------

### Start Daemon as Internal Process

Source: https://woodser.github.io/monero-ts/typedocs/functions/connectToDaemonRpc.html

Initializes a connection by launching monerod as an internal process using command-line arguments.

```typescript
// start monerod as an internal process
 let daemon = await moneroTs.connectToDaemonRpc({
   cmd: ["path/to/monerod", ...params...],
 });
```

--------------------------------

### getProcess

Source: https://woodser.github.io/monero-ts/typedocs/classes/MoneroWalletRpc.html

Get the internal process running monero-wallet-rpc.

```APIDOC
## getProcess()

### Description
Get the internal process running monero-wallet-rpc.

### Returns
- **ChildProcess** - the process running monero-wallet-rpc, undefined if not created from new process
```

--------------------------------

### Connect to Monero Daemon RPC

Source: https://woodser.github.io/monero-ts/typedocs/variables/default.html

Examples for establishing a connection to a monerod instance using different configuration methods.

```typescript
let daemon = await moneroTs.connectToDaemonRpc("http://localhost:38081");
```

```typescript
let daemon = await moneroTs.connectToDaemonRpc({
   uri: "http://localhost:38081",
   username: "superuser",
   password: "abctesting123"
});
```

```typescript
// start monerod as an internal process
let daemon = await moneroTs.connectToDaemonRpc({
   cmd: ["path/to/monerod", ...params...],
});
```

--------------------------------

### getPath

Source: https://woodser.github.io/monero-ts/typedocs/classes/MoneroWallet.html

Get the wallet's path.

```APIDOC
## getPath()

### Description
Get the wallet's path.

### Returns
- **Promise<string>** - The path the wallet can be opened with.
```

--------------------------------

### getListeners

Source: https://woodser.github.io/monero-ts/typedocs/classes/MoneroWalletRpc.html

Get the listeners registered with the wallet.

```APIDOC
## getListeners()

### Description
Get the listeners registered with the wallet.

### Returns
- **MoneroWalletListener[]** - the registered listeners
```

--------------------------------

### getDownloadLimit()

Source: https://woodser.github.io/monero-ts/typedocs/classes/MoneroDaemon.html

Get the download bandwidth limit.

```APIDOC
## getDownloadLimit()

### Description
Get the download bandwidth limit.

### Returns
- **Promise<number>** - download bandwidth limit
```

--------------------------------

### startPolling

Source: https://woodser.github.io/monero-ts/typedocs/classes/MoneroConnectionManager.html

Starts the polling process for Monero connections with configurable parameters for timing and selection logic.

```APIDOC
## startPolling(periodMs?, autoSwitch?, timeoutMs?, pollType?, excludedConnections?)

### Description
Starts polling connections based on the provided configuration. Returns the connection manager instance for method chaining.

### Parameters
- **periodMs** (number) - Optional - Poll period in milliseconds (default 20s)
- **autoSwitch** (boolean) - Optional - Specifies to automatically switch to the best connection (default true)
- **timeoutMs** (number) - Optional - Timeout to poll a single connection (default 5s)
- **pollType** (number) - Optional - One of PRIORITIZED, CURRENT, or ALL
- **excludedConnections** (MoneroRpcConnection[]) - Optional - Connections excluded from being polled

### Returns
- **MoneroConnectionManager** - The connection manager instance.
```

--------------------------------

### getMultisigInfo

Source: https://woodser.github.io/monero-ts/typedocs/classes/MoneroWalletRpc.html

Get multisig info about this wallet.

```APIDOC
## getMultisigInfo()

### Description
Get multisig info about this wallet.

### Returns
- **Promise<MoneroMultisigInfo>** - multisig info about this wallet
```

--------------------------------

### getInfo()

Source: https://woodser.github.io/monero-ts/typedocs/classes/MoneroDaemon.html

Get general information about the state of the node and the network.

```APIDOC
## getInfo()

### Description
Get general information about the state of the node and the network.

### Returns
- **Promise<MoneroDaemonInfo>** - general information about the node and network
```

--------------------------------

### getFeeEstimate(graceBlocks?)

Source: https://woodser.github.io/monero-ts/typedocs/classes/MoneroDaemon.html

Get mining fee estimates per kB.

```APIDOC
## getFeeEstimate(graceBlocks?)

### Description
Get mining fee estimates per kB.

### Parameters
- **graceBlocks** (number) - Optional - TODO

### Returns
- **Promise<MoneroFeeEstimate>** - mining fee estimates per kB
```

--------------------------------

### getBlockTemplate(walletAddress, reserveSize?)

Source: https://woodser.github.io/monero-ts/typedocs/classes/MoneroDaemon.html

Get a block template for mining a new block.

```APIDOC
## getBlockTemplate(walletAddress, reserveSize?)

### Description
Get a block template for mining a new block.

### Parameters
- **walletAddress** (string) - Required - address of the wallet to receive miner transactions if block is successfully mined
- **reserveSize** (number) - Optional - reserve size

### Returns
- **Promise<MoneroBlockTemplate>** - a block template for mining a new block
```

--------------------------------

### getOutputs

Source: https://woodser.github.io/monero-ts/typedocs/classes/MoneroWallet.html

Get outputs created from previous transactions that belong to the wallet.

```APIDOC
## getOutputs(query?)

### Description
Get outputs created from previous transactions that belong to the wallet (i.e. that the wallet can spend one time). Results can be filtered by passing a query object.

### Parameters
- **query** (Partial<MoneroOutputQuery>) - Optional - Configures the query.

### Returns
- **Promise<MoneroOutputWallet[]>** - The queried outputs.
```

--------------------------------

### getNewKeyImagesFromLastImport

Source: https://woodser.github.io/monero-ts/typedocs/classes/MoneroWalletRpc.html

Get new key images from the last imported outputs.

```APIDOC
## getNewKeyImagesFromLastImport()

### Description
Get new key images from the last imported outputs.

### Returns
- **Promise<MoneroKeyImage[]>** - the key images from the last imported outputs
```

--------------------------------

### getBlocksByHash(blockHashes, startHeight, prune?)

Source: https://woodser.github.io/monero-ts/typedocs/classes/MoneroDaemon.html

Get blocks by hash.

```APIDOC
## getBlocksByHash(blockHashes, startHeight, prune?)

### Description
Get blocks by hash.

### Parameters
- **blockHashes** (string[]) - Required - array of hashes; first 10 blocks hashes goes sequential, next goes in pow(2,n) offset, like 2, 4, 8, 16, 32, 64 and so on, and the last one is always genesis block
- **startHeight** (number) - Required - start height to get blocks by hash
- **prune** (boolean) - Optional - specifies if returned blocks should be pruned (defaults to false)

### Returns
- **Promise<MoneroBlock[]>** - retrieved blocks
```

--------------------------------

### Create a Full Monero Wallet

Source: https://woodser.github.io/monero-ts/typedocs/functions/createWalletFull.html

Initializes a wallet instance with basic configuration including path, password, network type, and seed.

```typescript
const wallet = await moneroTs.createWalletFull({  
 	 path: "./test_wallets/wallet1", // leave blank for in-memory wallet  
 	 password: "supersecretpassword",  
 	 networkType: moneroTs.MoneroNetworkType.STAGENET,  
 	 seed: "coexist igloo pamphlet lagoon...",  
 	 restoreHeight: 1543218,  
 	 server: "http://localhost:38081"  
 });
```

```typescript
const wallet = await moneroTs.createWalletFull({  
 	 path: "./test_wallets/wallet1", // leave blank for in-memory wallet  
 	 password: "supersecretpassword",  
 	 networkType: moneroTs.MoneroNetworkType.STAGENET,  
 	 seed: "coexist igloo pamphlet lagoon...",  
 	 restoreHeight: 1543218,  
 	 proxyToWorker: false, // override default  
 	 server: {  
 		 uri: "http://localhost:38081",  
 		 username: "daemon_user",  
 		 password: "daemon_password_123"  
 	 }  
 });
```

--------------------------------

### getSubaddress

Source: https://woodser.github.io/monero-ts/typedocs/classes/MoneroWallet.html

Get a subaddress.

```APIDOC
## getSubaddress(accountIdx, subaddressIdx)

### Description
Get a subaddress.

### Parameters
- **accountIdx** (number) - Required - Index of the subaddress's account.
- **subaddressIdx** (number) - Required - Index of the subaddress within the account.

### Returns
- **Promise<MoneroSubaddress>** - The retrieved subaddress.
```

--------------------------------

### Create a Monero Wallet

Source: https://woodser.github.io/monero-ts/typedocs/classes/MoneroWalletKeys.html

Initializes a new wallet instance using WebAssembly bindings with the provided configuration.

```javascript
 let wallet = await MoneroWalletKeys.createWallet({  
 		 password: "abc123",  
 		 networkType: MoneroNetworkType.STAGENET,  
 		 seed: "coexist igloo pamphlet lagoon..."  
 }); 
```

--------------------------------

### getBlocksByRange(startHeight?, endHeight?)

Source: https://woodser.github.io/monero-ts/typedocs/classes/MoneroDaemon.html

Get blocks in the given height range.

```APIDOC
## getBlocksByRange(startHeight?, endHeight?)

### Description
Get blocks in the given height range.

### Parameters
- **startHeight** (number) - Optional - start height lower bound inclusive
- **endHeight** (number) - Optional - end height upper bound inclusive

### Returns
- **Promise<MoneroBlock[]>** - blocks in the given height range
```

--------------------------------

### getMinerTxSum(height, numBlocks)

Source: https://woodser.github.io/monero-ts/typedocs/classes/MoneroDaemon.html

Gets the total emissions and fees from the genesis block to the current height.

```APIDOC
## getMinerTxSum(height, numBlocks)

### Description
Gets the total emissions and fees from the genesis block to the current height.

### Parameters
- **height** (number) - Required - height to start computing the miner sum
- **numBlocks** (number) - Required - number of blocks to include in the sum

### Returns
- **Promise<MoneroMinerTxSum>** - encapsulates the total emissions and fees since the genesis block
```

--------------------------------

### Opening a Full Monero Wallet

Source: https://woodser.github.io/monero-ts/typedocs/functions/openWalletFull.html

Initializes a wallet instance using a local path, password, network type, and daemon server configuration.

```typescript
const wallet = await moneroTs.openWalletFull({  
 	 path: "./wallets/wallet1",  
 	 password: "supersecretpassword",  
 	 networkType: moneroTs.MoneroNetworkType.STAGENET,  
 	 server: { // daemon configuration  
 		 uri: "http://localhost:38081",  
 		 username: "superuser",  
 		 password: "abctesting123"  
 	 }  
 });
```

--------------------------------

### getSubaddresses

Source: https://woodser.github.io/monero-ts/typedocs/classes/MoneroWallet.html

Get subaddresses in an account.

```APIDOC
## getSubaddresses(accountIdx, subaddressIndices?)

### Description
Get subaddresses in an account.

### Parameters
- **accountIdx** (number) - Required - Account to get subaddresses within.
- **subaddressIndices** (number[]) - Optional - Indices of subaddresses to get.

### Returns
- **Promise<MoneroSubaddress[]>** - The retrieved subaddresses.
```

--------------------------------

### getOutgoingTransfers

Source: https://woodser.github.io/monero-ts/typedocs/classes/MoneroWallet.html

Get outgoing transfers.

```APIDOC
## getOutgoingTransfers(query?)

### Description
Get outgoing transfers.

### Parameters
- **query** (Partial<MoneroTransferQuery>) - Optional - Configures the query.

### Returns
- **Promise<MoneroOutgoingTransfer[]>** - Outgoing transfers that meet the query.
```

--------------------------------

### Create and Open a Wallet with MoneroWalletRpc

Source: https://woodser.github.io/monero-ts/typedocs/classes/MoneroWalletRpc.html

Initialize a client connection to the RPC server and create or open a wallet using the provided configuration.

```javascript
// construct client to monero-wallet-rpc  
 let walletRpc = new MoneroWalletRpc("http://localhost:38084", "rpc_user", "abc123");  
  
 // create and open wallet on monero-wallet-rpc  
 await walletRpc.createWallet({  
 	 path: "mywallet",  
 	 password: "abc123",  
 	 seed: "coexist igloo pamphlet lagoon...",  
 	 restoreHeight: 1543218l  
 });
```

--------------------------------

### Interact with Monero Daemon and Wallets

Source: https://woodser.github.io/monero-ts/typedocs/index.html

Demonstrates connecting to a daemon, creating a WebAssembly-based wallet, synchronizing, listening for events, and performing RPC wallet operations.

```typescript
// import monero-ts (or import types individually)  
import moneroTs from "monero-ts";  
  
// connect to daemon  
let daemon = await moneroTs.connectToDaemonRpc("http://localhost:28081");  
let height = await daemon.getHeight();        // 1523651  
let txsInPool = await daemon.getTxPool();     // get transactions in the pool  
  
// create wallet from mnemonic phrase using WebAssembly bindings to monero-project  
let walletFull = await moneroTs.createWalletFull({  
  path: "sample_wallet_full",  
  password: "supersecretpassword123",  
  networkType: moneroTs.MoneroNetworkType.TESTNET,  
  seed: "hefty value scenic...",  
  restoreHeight: 573936,  
  server: { // provide url or MoneroRpcConnection  
    uri: "http://localhost:28081",  
    username: "superuser",  
    password: "abctesting123"  
  }  
});  
  
// synchronize with progress notifications  
await walletFull.sync(new class extends moneroTs.MoneroWalletListener {  
  async onSyncProgress(height: number, startHeight: number, endHeight: number, percentDone: number, message: string) {  
    // feed a progress bar?  
  }  
});  
  
// synchronize in the background every 5 seconds  
await walletFull.startSyncing(5000);  
  
// receive notifications when funds are received, confirmed, and unlocked  
let fundsReceived = false;  
await walletFull.addListener(new class extends moneroTs.MoneroWalletListener {  
  async onOutputReceived(output: moneroTs.MoneroOutputWallet) {  
    let amount = output.getAmount();  
    let txHash = output.getTx().getHash();  
    let isConfirmed = output.getTx().getIsConfirmed();  
    let isLocked = output.getTx().getIsLocked();  
    fundsReceived = true;  
  }  
});  
  
// connect to wallet RPC and open wallet  
let walletRpc = await moneroTs.connectToWalletRpc("http://localhost:28084", "rpc_user", "abc123");  
await walletRpc.openWallet("sample_wallet_rpc", "supersecretpassword123");  
let primaryAddress = await walletRpc.getPrimaryAddress(); // 555zgduFhmKd2o8rPUz...  
let balance = await walletRpc.getBalance();   // 533648366742  
let txs = await walletRpc.getTxs();           // get transactions containing transfers to/from the wallet  
  
// send funds from RPC wallet to WebAssembly wallet  
let createdTx = await walletRpc.createTx({  
  accountIndex: 0,  
  address: await walletFull.getAddress(1, 0),  
  amount: 250000000000n, // send 0.25 XMR (denominated in atomic units)  
  relay: false // create transaction and relay to the network if true  
});  
let fee = createdTx.getFee(); // "Are you sure you want to send... ?"  
await walletRpc.relayTx(createdTx); // relay the transaction  
  
// recipient receives unconfirmed funds within 5 seconds  
await new Promise(function(resolve) { setTimeout(resolve, 5000); });  
assert(fundsReceived);  
  
// save and close WebAssembly wallet  
await walletFull.close(true);  
  
// terminate any running resources (e.g. workers)  
await moneroTs.shutdown();
```

--------------------------------

### setUploadLimit

Source: https://woodser.github.io/monero-ts/typedocs/classes/MoneroDaemon.html

Set the upload bandwidth limit.

```APIDOC
## setUploadLimit(limit: number)

### Description
Set the upload bandwidth limit.

### Parameters
- **limit** (number) - Required - upload limit to set (-1 to reset to default)

### Returns
- Promise<number> - new upload limit after setting
```

--------------------------------

### constructor

Source: https://woodser.github.io/monero-ts/typedocs/classes/MoneroWalletConfig.html

Constructs a new MoneroWalletConfig instance to define parameters for opening or creating a wallet.

```APIDOC
## constructor

### Description
Constructs a configuration object to open or create a wallet.

### Signature
`new MoneroWalletConfig(config?: Partial<MoneroWalletConfig>): MoneroWalletConfig`

### Parameters
- **config** (Partial<MoneroWalletConfig>) - Optional - A configuration object containing wallet settings.
```

--------------------------------

### getPrimaryAddress

Source: https://woodser.github.io/monero-ts/typedocs/classes/MoneroWalletKeys.html

Get the wallet's primary address.

```APIDOC
## getPrimaryAddress()

### Description
Get the wallet's primary address.

### Returns
- **Promise<string>** - the wallet's primary address
```

--------------------------------

### Create a wallet using createWalletKeys

Source: https://woodser.github.io/monero-ts/typedocs/functions/createWalletKeys.html

Initializes a new wallet instance using a password, network type, and seed phrase.

```javascript
const wallet = await moneroTs.createWalletKeys({  
 	 password: "abc123",  
 	 networkType: moneroTs.MoneroNetworkType.STAGENET,  
 	 seed: "coexist igloo pamphlet lagoon..."  
 });
```

--------------------------------

### getLastBlockHeader()

Source: https://woodser.github.io/monero-ts/typedocs/classes/MoneroDaemon.html

Get the last block's header.

```APIDOC
## getLastBlockHeader()

### Description
Get the last block's header.

### Returns
- **Promise<MoneroBlockHeader>** - last block's header
```

--------------------------------

### sync(listenerOrStartHeight?, startHeight?)

Source: https://woodser.github.io/monero-ts/typedocs/classes/MoneroWallet.html

Synchronize the wallet with the daemon as a one-time synchronous process.

```APIDOC
## sync(listenerOrStartHeight?, startHeight?)

### Description
Synchronize the wallet with the daemon as a one-time synchronous process.

### Parameters
- **listenerOrStartHeight** (number | MoneroWalletListener) - Optional - Listener xor start height (defaults to no sync listener, the last synced block).
- **startHeight** (number) - Optional - StartHeight if not given in first arg (defaults to last synced block).

### Returns
- **Promise<MoneroSyncResult>**
```

--------------------------------

### getBlocksByHeight(heights)

Source: https://woodser.github.io/monero-ts/typedocs/classes/MoneroDaemon.html

Get blocks at the given heights.

```APIDOC
## getBlocksByHeight(heights)

### Description
Get blocks at the given heights.

### Parameters
- **heights** (number[]) - Required - heights of the blocks to get

### Returns
- **Promise<MoneroBlock[]>** - blocks at the given heights
```

--------------------------------

### Manage RPC connections with MoneroConnectionManager

Source: https://woodser.github.io/monero-ts/typedocs/classes/MoneroConnectionManager.html

Demonstrates how to initialize the manager, add connections with priorities, set the current connection, and configure polling and auto-switching.

```typescript
// imports  
 import { MoneroRpcConnection, MoneroConnectionManager, MoneroConnectionManagerListener } from "monero-ts";  
   
 // create connection manager  
 let connectionManager = new MoneroConnectionManager();  
   
 // add managed connections with priorities  
 await connectionManager.addConnection({uri: "http://localhost:38081", priority: 1}); // use localhost as first priority  
 await connectionManager.addConnection({uri: "http://example.com"}); // default priority is prioritized last  
   
 // set current connection  
 await connectionManager.setConnection({uri: "http://foo.bar", username: "admin", password: "password"}); // connection is added if new  
   
 // check connection status  
 await connectionManager.checkConnection();  
 console.log("Connection manager is connected: " + connectionManager.isConnected());  
 console.log("Connection is online: " + connectionManager.getConnection().getIsOnline());  
 console.log("Connection is authenticated: " + connectionManager.getConnection().getIsAuthenticated());  
   
  // receive notifications of any changes to current connection  
 connectionManager.addListener(new class extends MoneroConnectionManagerListener {  
 		 async onConnectionChanged(connection) {  
 			 console.log("Connection changed to: " + connection);  
 		 }  
 });  
   
 // start polling for best connection every 10 seconds and automatically switch  
 connectionManager.startPolling(10000);  
   
 // automatically switch to best available connection if disconnected  
 connectionManager.setAutoSwitch(true);  
   
 // get best available connection in order of priority then response time  
 let bestConnection = await connectionManager.getBestAvailableConnection();  
   
 // check status of all connections  
 await connectionManager.checkConnections();  
   
 // get connections in order of current connection, online status from last check, priority, and name  
 let connections = connectionManager.getConnections();  
   
 // clear connection manager  
 connectionManager.clear();
```

--------------------------------

### getSeed

Source: https://woodser.github.io/monero-ts/typedocs/classes/MoneroWalletKeys.html

Get the wallet's mnemonic phrase or seed.

```APIDOC
## getSeed()

### Description
Get the wallet's mnemonic phrase or seed.

### Returns
- **Promise<string>** - the wallet's mnemonic phrase or seed.
```

--------------------------------

### getPublicViewKey

Source: https://woodser.github.io/monero-ts/typedocs/classes/MoneroWalletKeys.html

Get the wallet's public view key.

```APIDOC
## getPublicViewKey()

### Description
Get the wallet's public view key.

### Returns
- **Promise<string>** - the wallet's public view key
```

--------------------------------

### Open a Wallet via RPC

Source: https://woodser.github.io/monero-ts/typedocs/classes/MoneroWalletRpc.html

Demonstrates opening a wallet using either a simple path and password or a full configuration object.

```typescript
let wallet = new MoneroWalletRpc("http://localhost:38084", "rpc_user", "abc123");  
 await wallet.openWallet("mywallet1", "supersecretpassword");  
   
 await wallet.openWallet({  
 	 path: "mywallet2",  
 	 password: "supersecretpassword",  
 	 server: "http://locahost:38081", // or object with uri, username, password, etc   
 	 rejectUnauthorized: false  
 });
```

--------------------------------

### getPublicSpendKey

Source: https://woodser.github.io/monero-ts/typedocs/classes/MoneroWalletKeys.html

Get the wallet's public spend key.

```APIDOC
## getPublicSpendKey()

### Description
Get the wallet's public spend key.

### Returns
- **Promise<string>** - the wallet's public spend key
```

--------------------------------

### Create Full Wallet

Source: https://woodser.github.io/monero-ts/typedocs/variables/default.html

Initialize a full wallet using WebAssembly bindings, supporting both in-memory and file-based storage.

```javascript
 const wallet = await moneroTs.createWalletFull({  
 	 path: "./test_wallets/wallet1", // leave blank for in-memory wallet  
 	 password: "supersecretpassword",  
 	 networkType: moneroTs.MoneroNetworkType.STAGENET,  
 	 seed: "coexist igloo pamphlet lagoon...",  
 	 restoreHeight: 1543218,  
 	 server: "http://localhost:38081"  
 }); 
```

```javascript
 const wallet = await moneroTs.createWalletFull({  
 	 path: "./test_wallets/wallet1", // leave blank for in-memory wallet  
 	 password: "supersecretpassword",  
 	 networkType: moneroTs.MoneroNetworkType.STAGENET,  
 	 seed: "coexist igloo pamphlet lagoon...",  
 	 restoreHeight: 1543218,  
 	 proxyToWorker: false, // override default  
 	 server: {  
 		 uri: "http://localhost:38081",  
 		 username: "daemon_user",  
 		 password: "daemon_password_123"  
 	 }  
 }); 
```

--------------------------------

### createWalletFull

Source: https://woodser.github.io/monero-ts/typedocs/variables/default.html

Creates a Monero wallet using client-side WebAssembly bindings to monero-project's wallet2 in C++.

```APIDOC
## createWalletFull(config)

### Description
Create a Monero wallet using client-side WebAssembly bindings to monero-project's wallet2 in C++.

### Parameters
- **config** (Partial<MoneroWalletConfig>) - Required - MoneroWalletConfig or equivalent config object.

### Returns
- **Promise<MoneroWalletFull>** - The created wallet.
```

--------------------------------

### getPrivateViewKey

Source: https://woodser.github.io/monero-ts/typedocs/classes/MoneroWalletKeys.html

Get the wallet's private view key.

```APIDOC
## getPrivateViewKey()

### Description
Get the wallet's private view key.

### Returns
- **Promise<string>** - the wallet's private view key
```

--------------------------------

### openWalletFull(config)

Source: https://woodser.github.io/monero-ts/typedocs/functions/openWalletFull.html

Opens an existing Monero wallet using client-side WebAssembly bindings.

```APIDOC
## openWalletFull(config)

### Description
Opens an existing Monero wallet using client-side WebAssembly bindings to monero-project's wallet2 in C++.

### Signature
`openWalletFull(config: Partial<MoneroWalletConfig>): Promise<MoneroWalletFull>`

### Parameters
- **config** (Partial<MoneroWalletConfig>) - Required - Configuration object to open a full wallet.

### Returns
- **Promise<MoneroWalletFull>** - The opened wallet instance.

### Example
```javascript
const wallet = await moneroTs.openWalletFull({
  path: "./wallets/wallet1",
  password: "supersecretpassword",
  networkType: moneroTs.MoneroNetworkType.STAGENET,
  server: {
    uri: "http://localhost:38081",
    username: "superuser",
    password: "abctesting123"
  }
});
```
```

--------------------------------

### getPrivateSpendKey

Source: https://woodser.github.io/monero-ts/typedocs/classes/MoneroWalletKeys.html

Get the wallet's private spend key.

```APIDOC
## getPrivateSpendKey()

### Description
Get the wallet's private spend key.

### Returns
- **Promise<string>** - the wallet's private spend key
```

--------------------------------

### waitForNextBlockHeader

Source: https://woodser.github.io/monero-ts/typedocs/classes/MoneroDaemon.html

Get the header of the next block added to the chain.

```APIDOC
## waitForNextBlockHeader()

### Description
Get the header of the next block added to the chain.

### Returns
- Promise<MoneroBlockHeader> - header of the next block added to the chain
```

--------------------------------

### Create Wallet Keys

Source: https://woodser.github.io/monero-ts/typedocs/variables/default.html

Create a wallet instance using only keys via WebAssembly bindings.

```javascript
 const wallet = await moneroTs.createWalletKeys({  
 	 password: "abc123",  
 	 networkType: moneroTs.MoneroNetworkType.STAGENET,  
 	 seed: "coexist igloo pamphlet lagoon..."  
 }); 
```

--------------------------------

### createWalletKeys(config)

Source: https://woodser.github.io/monero-ts/typedocs/functions/createWalletKeys.html

Creates a wallet using WebAssembly bindings to monero-project.

```APIDOC
## createWalletKeys(config)

### Description
Create a wallet using WebAssembly bindings to monero-project.

### Signature
`createWalletKeys(config): Promise<MoneroWalletKeys>`

### Parameters
- **config** (Partial<MoneroWalletConfig>) - Required - MoneroWalletConfig or equivalent config object

### Returns
- **Promise<MoneroWalletKeys>** - The created wallet

### Example
```javascript
const wallet = await moneroTs.createWalletKeys({  
  password: "abc123",  
  networkType: moneroTs.MoneroNetworkType.STAGENET,  
  seed: "coexist igloo pamphlet lagoon..."  
});
```
```

--------------------------------

### constructor

Source: https://woodser.github.io/monero-ts/typedocs/classes/MoneroConnectionManagerListener.html

Creates a new instance of the MoneroConnectionManagerListener.

```APIDOC
## constructor

### Description
Creates a new instance of the MoneroConnectionManagerListener.

### Signature
`new MoneroConnectionManagerListener(): MoneroConnectionManagerListener`

### Returns
- **MoneroConnectionManagerListener** - A new instance of the listener.
```

--------------------------------

### getNumBlocksToUnlock

Source: https://woodser.github.io/monero-ts/typedocs/classes/MoneroWalletRpc.html

Get the number of blocks until the next and last funds unlock.

```APIDOC
## getNumBlocksToUnlock()

### Description
Get the number of blocks until the next and last funds unlock. Ignores txs with unlock time as timestamp.

### Returns
- **Promise<number[]>** - the number of blocks until the next and last funds unlock in elements 0 and 1, respectively, or undefined if no balance
```

--------------------------------

### Open Full Wallet

Source: https://woodser.github.io/monero-ts/typedocs/variables/default.html

Open an existing full wallet from a specified path with daemon configuration.

```javascript
 const wallet = await moneroTs.openWalletFull({  
 	 path: "./wallets/wallet1",  
 	 password: "supersecretpassword",  
 	 networkType: moneroTs.MoneroNetworkType.STAGENET,  
 	 server: { // daemon configuration  
 		 uri: "http://localhost:38081",  
 		 username: "superuser",  
 		 password: "abctesting123"  
 	 }  
 }); 
```

--------------------------------

### createWalletFull(config)

Source: https://woodser.github.io/monero-ts/typedocs/functions/createWalletFull.html

Creates a new Monero wallet instance based on the provided configuration object.

```APIDOC
## createWalletFull(config)

### Description
Creates a Monero wallet using client-side WebAssembly bindings to monero-project's wallet2 in C++.

### Signature
`createWalletFull(config: Partial<MoneroWalletConfig>): Promise<MoneroWalletFull>`

### Parameters
- **config** (Partial<MoneroWalletConfig>) - Required - The configuration object for the wallet, including path, password, networkType, seed, restoreHeight, and server details.

### Returns
- **Promise<MoneroWalletFull>** - A promise that resolves to the created wallet instance.

### Example
```javascript
const wallet = await moneroTs.createWalletFull({  
   path: "./test_wallets/wallet1", 
   password: "supersecretpassword",  
   networkType: moneroTs.MoneroNetworkType.STAGENET,  
   seed: "coexist igloo pamphlet lagoon...",  
   restoreHeight: 1543218,  
   server: "http://localhost:38081"  
});
```
```

--------------------------------

### getSeedLanguage

Source: https://woodser.github.io/monero-ts/typedocs/classes/MoneroWalletKeys.html

Get the language of the wallet's mnemonic phrase or seed.

```APIDOC
## getSeedLanguage()

### Description
Get the language of the wallet's mnemonic phrase or seed.

### Returns
- **Promise<string>** - the language of the wallet's mnemonic phrase or seed.
```

--------------------------------

### connectToWalletRpc(uriOrConfig, username?, password?)

Source: https://woodser.github.io/monero-ts/typedocs/functions/connectToWalletRpc.html

Creates a client connected to a monero-wallet-rpc instance.

```APIDOC
## connectToWalletRpc(uriOrConfig, username?, password?)

### Description
Creates a client connected to monero-wallet-rpc. This function supports connecting via a URI, a configuration object, or by providing command-line arguments to launch an internal process.

### Parameters
- **uriOrConfig** (string | string[] | Partial<MoneroRpcConnection> | Partial<MoneroWalletConfig>) - Required - The URI, RPC connection details, configuration, or terminal parameters to connect to monero-wallet-rpc.
- **username** (string) - Optional - The username to authenticate with monero-wallet-rpc.
- **password** (string) - Optional - The password to authenticate with monero-wallet-rpc.

### Returns
- **Promise<MoneroWalletRpc>** - A promise that resolves to the wallet RPC client.

### Usage Examples

```javascript
// Connect via URI and credentials
let walletRpc = await moneroTs.connectToWalletRpc({
  uri: "http://localhost:38081",
  username: "superuser",
  password: "abctesting123",
  rejectUnauthorized: false
});

// Connect via internal process
let walletRpc = await moneroTs.connectToWalletRpc({cmd: [
  "/path/to/monero-wallet-rpc",
  "--stagenet",
  "--daemon-address", "http://localhost:38081",
  "--daemon-login", "superuser:abctesting123",
  "--rpc-bind-port", "38085",
  "--rpc-login", "rpc_user:abc123",
  "--wallet-dir", "/path/to/wallets",
  "--rpc-access-control-origins", "http://localhost:8080"
]});
```
```

--------------------------------

### getKeyImageSpentStatuses(keyImages)

Source: https://woodser.github.io/monero-ts/typedocs/classes/MoneroDaemon.html

Get the spent status of each given key image.

```APIDOC
## getKeyImageSpentStatuses(keyImages)

### Description
Get the spent status of each given key image.

### Parameters
- **keyImages** (string[]) - Required - hex key images to get the statuses of

### Returns
- **Promise<MoneroKeyImageSpentStatus[]>** - status for each key image
```

--------------------------------

### Connect to Wallet RPC

Source: https://woodser.github.io/monero-ts/typedocs/variables/default.html

Connect to a monero-wallet-rpc instance using either a configuration object or by spawning an internal process.

```javascript
 let walletRpc = await moneroTs.connectToWalletRpc({  
 	 uri: "http://localhost:38081",  
 	 username: "superuser",  
 	 password: "abctesting123",  
 	 rejectUnauthorized: false // e.g. local development  
 });  
```

```javascript
 // connect to monero-wallet-rpc running as internal process  
 let walletRpc = await moneroTs.connectToWalletRpc({cmd: [  
 	 "/path/to/monero-wallet-rpc",  
 	 "--stagenet",  
 	 "--daemon-address", "http://localhost:38081",  
 	 "--daemon-login", "superuser:abctesting123",  
 	 "--rpc-bind-port", "38085",  
 	 "--rpc-login", "rpc_user:abc123",  
 	 "--wallet-dir", "/path/to/wallets", // defaults to monero-wallet-rpc directory  
 	 "--rpc-access-control-origins", "http://localhost:8080"  
 	]}); 
```

--------------------------------

### getKeyImageSpentStatus(keyImage)

Source: https://woodser.github.io/monero-ts/typedocs/classes/MoneroDaemon.html

Get the spent status of the given key image.

```APIDOC
## getKeyImageSpentStatus(keyImage)

### Description
Get the spent status of the given key image.

### Parameters
- **keyImage** (string) - Required - key image hex to get the status of

### Returns
- **Promise<MoneroKeyImageSpentStatus>** - status of the key image
```

--------------------------------

### createWallet

Source: https://woodser.github.io/monero-ts/typedocs/classes/MoneroWalletRpc.html

Creates and opens a wallet on the monero-wallet-rpc server.

```APIDOC
## createWallet(config)

### Description
Create and open a wallet on the monero-wallet-rpc server.

### Parameters
- **config** (Partial<MoneroWalletConfig>) - Required - MoneroWalletConfig or equivalent JS object.

### Returns
- **Promise<MoneroWalletRpc>** - This wallet client.
```

--------------------------------

### getHeight()

Source: https://woodser.github.io/monero-ts/typedocs/classes/MoneroDaemon.html

Get the number of blocks in the longest chain known to the node.

```APIDOC
## getHeight()

### Description
Get the number of blocks in the longest chain known to the node.

### Returns
- **Promise<number>** - the number of blocks
```

--------------------------------

### Constructing a MoneroTransferQuery

Source: https://woodser.github.io/monero-ts/typedocs/classes/MoneroTransferQuery.html

Demonstrates how to initialize a transfer query to filter for incoming transfers to a specific account and subaddress.

```typescript
// get incoming transfers to account 0, subaddress 1  
 let transfers = await wallet.getTransfers({  
 		 accountIndex: 0,  
 		 subaddressIndex: 0  
 });
```

--------------------------------

### Connect to Daemon via URI

Source: https://woodser.github.io/monero-ts/typedocs/functions/connectToDaemonRpc.html

Establishes a connection to a local monerod instance using a simple URI string.

```typescript
let daemon = await moneroTs.connectToDaemonRpc("http://localhost:38081");
```

--------------------------------

### getTxPool

Source: https://woodser.github.io/monero-ts/typedocs/classes/MoneroDaemonRpc.html

Get valid transactions seen by the node but not yet mined into a block.

```APIDOC
## getTxPool()

### Description
Get valid transactions seen by the node but not yet mined into a block, as well as spent key image information for the tx pool.

### Returns
- **Promise<MoneroTx[]>** - are transactions in the transaction pool!
```

--------------------------------

### Initialize MoneroTxConfig

Source: https://woodser.github.io/monero-ts/typedocs/classes/MoneroTxConfig.html

Create a new transaction configuration instance with specific parameters like account index, destination address, amount, priority, and relay status.

```typescript
let config1 = new MoneroTxConfig({  
 		 accountIndex: 0,  
 		 address: "59aZULsUF3YN...",  
 		 amount: 500000n,  
 		 priority: MoneroTxPriority.NORMAL,  
 		 relay: true  
 });
```

--------------------------------

### Connect to monero-wallet-rpc as an internal process

Source: https://woodser.github.io/monero-ts/typedocs/functions/connectToWalletRpc.html

Spawns and connects to a monero-wallet-rpc instance as an internal process using command-line arguments.

```typescript
 // connect to monero-wallet-rpc running as internal process  
 let walletRpc = await moneroTs.connectToWalletRpc({cmd: [  
 	 "/path/to/monero-wallet-rpc",  
 	 "--stagenet",  
 	 "--daemon-address", "http://localhost:38081",  
 	 "--daemon-login", "superuser:abctesting123",  
 	 "--rpc-bind-port", "38085",  
 	 "--rpc-login", "rpc_user:abc123",  
 	 "--wallet-dir", "/path/to/wallets", // defaults to monero-wallet-rpc directory  
 	 "--rpc-access-control-origins", "http://localhost:8080"  
 	]}); 
```

--------------------------------

### getKnownPeers()

Source: https://woodser.github.io/monero-ts/typedocs/classes/MoneroDaemon.html

Get known peers including their last known online status.

```APIDOC
## getKnownPeers()

### Description
Get known peers including their last known online status.

### Returns
- **Promise<MoneroPeer[]>** - the daemon's known peers
```

--------------------------------

### setServer(server)

Source: https://woodser.github.io/monero-ts/typedocs/classes/MoneroWalletConfig.html

Configures the server connection for the wallet.

```APIDOC
## setServer(server)

### Description
Sets the server connection details for the Monero wallet configuration.

### Parameters
- **server** (string | Partial<MoneroRpcConnection>) - Required - The server connection string or connection object.

### Returns
- **MoneroWalletConfig** - The updated configuration instance.
```

--------------------------------

### createWallet

Source: https://woodser.github.io/monero-ts/typedocs/classes/MoneroWalletKeys.html

Creates a new wallet instance using WebAssembly bindings to the monero-project.

```APIDOC
## createWallet(config)

### Description
Create a wallet using WebAssembly bindings to monero-project.

### Parameters
- **config** (Partial<MoneroWalletConfig>) - Required - MoneroWalletConfig or equivalent config object

### Returns
- **Promise<any>** - The created wallet

### Example
```javascript
let wallet = await MoneroWalletKeys.createWallet({
  password: "abc123",
  networkType: MoneroNetworkType.STAGENET,
  seed: "coexist igloo pamphlet lagoon..."
});
```
```

--------------------------------

### getUniqueRandomInts

Source: https://woodser.github.io/monero-ts/typedocs/classes/GenUtils.html

Gets a given number of unique random integers within a specified range.

```APIDOC
## getUniqueRandomInts(min, max, count)

### Description
Gets a given number of unique random ints within a range.

### Parameters
- **min** (any) - The minimum range of the ints to generate, inclusive.
- **max** (any) - The maximum range of the ints to generate, inclusive.
- **count** (any) - The number of unique random ints to get.

### Returns
- **any[]** - An array of unique random integers.
```

--------------------------------

### openWallet

Source: https://woodser.github.io/monero-ts/typedocs/classes/MoneroWalletRpc.html

Opens an existing wallet on the monero-wallet-rpc server.

```APIDOC
## openWallet(pathOrConfig, password?)

### Description
Open an existing wallet on the monero-wallet-rpc server.

### Parameters
- **pathOrConfig** (string | Partial<MoneroWalletConfig>) - Required - the wallet's name or configuration to open
- **password** (string) - Optional - the wallet's password

### Returns
- **Promise<MoneroWalletRpc>** - this wallet client
```

--------------------------------

### Connect to Daemon with Authentication

Source: https://woodser.github.io/monero-ts/typedocs/functions/connectToDaemonRpc.html

Connects to a monerod instance using a configuration object that includes credentials.

```typescript
let daemon = await moneroTs.connectToDaemonRpc({
   uri: "http://localhost:38081",
   username: "superuser",
   password: "abctesting123"
 });
```

--------------------------------

### MoneroPeer Methods

Source: https://woodser.github.io/monero-ts/typedocs/classes/MoneroPeer.html

Methods for configuring MoneroPeer instances and serializing data.

```APIDOC
## setSendIdleTime(sendIdleTime: number)

Sets the idle time for sending data.

- **Parameters**: sendIdleTime (number)
- **Returns**: MoneroPeer

## setState(state: string)

Sets the state of the peer connection.

- **Parameters**: state (string)
- **Returns**: MoneroPeer

## setType(type: ConnectionType)

Sets the connection type for the peer.

- **Parameters**: type (ConnectionType)
- **Returns**: MoneroPeer

## toJson()

Serializes the peer object to a JSON representation.

- **Returns**: any
```

--------------------------------

### getBlocksByRangeChunked(startHeight?, endHeight?, maxChunkSize?)

Source: https://woodser.github.io/monero-ts/typedocs/classes/MoneroDaemon.html

Get blocks in the given height range as chunked requests.

```APIDOC
## getBlocksByRangeChunked(startHeight?, endHeight?, maxChunkSize?)

### Description
Get blocks in the given height range as chunked requests so that each request is not too big.

### Parameters
- **startHeight** (number) - Optional - start height lower bound inclusive
- **endHeight** (number) - Optional - end height upper bound inclusive
- **maxChunkSize** (number) - Optional - maximum chunk size in any one request (default 3,000,000 bytes)

### Returns
- **Promise<MoneroBlock[]>** - blocks in the given height range
```

--------------------------------

### Connect to monero-wallet-rpc via URI

Source: https://woodser.github.io/monero-ts/typedocs/functions/connectToWalletRpc.html

Connects to a running monero-wallet-rpc instance using connection details. Set rejectUnauthorized to false for local development environments.

```typescript
 let walletRpc = await moneroTs.connectToWalletRpc({  
 	 uri: "http://localhost:38081",  
 	 username: "superuser",  
 	 password: "abctesting123",  
 	 rejectUnauthorized: false // e.g. local development  
 });  
 
```

--------------------------------

### Construct a MoneroRpcConnection

Source: https://woodser.github.io/monero-ts/typedocs/classes/MoneroRpcConnection.html

Initialize a new RPC connection using either a URI string with credentials or a configuration object.

```typescript
let connection1 = new MoneroRpcConnection("http://localhost:38081", "daemon_user", "daemon_password_123")
```

```typescript
let connection2 = new MoneroRpcConnection({
 	 uri: http://localhost:38081,
 	 username: "daemon_user",
 	 password: "daemon_password_123",
 	 rejectUnauthorized: false, // accept self-signed certificates e.g. for local development
 	 proxyToWorker: true // proxy request to worker (default false)
 });
```

--------------------------------

### getNumBlocksToUnlock

Source: https://woodser.github.io/monero-ts/typedocs/classes/MoneroWallet.html

Get the number of blocks until the next and last funds unlock. Ignores txs with unlock time as timestamp.

```APIDOC
## getNumBlocksToUnlock()

### Description
Get the number of blocks until the next and last funds unlock. Ignores txs with unlock time as timestamp.

### Returns
- **Promise<number[]>** - The number of blocks until the next and last funds unlock in elements 0 and 1, respectively, or undefined if no balance.
```

--------------------------------

### Connection Configuration Methods

Source: https://woodser.github.io/monero-ts/typedocs/classes/MoneroRpcConnection.html

Methods to configure connection state, credentials, and network settings.

```APIDOC
## setAuthenticated(isAuthenticated)
Sets the connection's authenticated status.

## setCredentials(username, password)
Sets the credentials for the connection.

## setOnline(isOnline)
Sets the connection's online status.

## setPriority(priority?)
Sets the connection's priority relative to other connections (default 0 is lowest, 1 is highest).

## setTimeout(timeoutMs)
Sets the RPC request timeout in milliseconds (0 to disable, undefined for default).
```

--------------------------------

### Querying wallet outputs

Source: https://woodser.github.io/monero-ts/typedocs/classes/MoneroOutputQuery.html

Use this configuration to filter available, unlocked outputs within a specific account that meet a minimum amount requirement.

```typescript
// get available outputs in account 0 with a minimum amount  
 let outputs = await wallet.getOutputs({  
 	 isSpent: false,  
 	 isLocked: false,  
 	 accountIndex: 0,  
 	 minAmount: 750000n  
 });
```

--------------------------------

### new MoneroConnectionManager(proxyToWorker?)

Source: https://woodser.github.io/monero-ts/typedocs/classes/MoneroConnectionManager.html

Constructs a new connection manager instance.

```APIDOC
## new MoneroConnectionManager(proxyToWorker?)

### Description
Constructs a new connection manager instance.

### Parameters
- **proxyToWorker** (boolean) - Optional - Configure all connections to proxy to worker (default true).

### Returns
- **MoneroConnectionManager** - The constructed connection manager instance.
```

--------------------------------

### sweepOutput(config: Partial<MoneroTxConfig>)

Source: https://woodser.github.io/monero-ts/typedocs/classes/MoneroWalletRpc.html

Sweep an output by key image.

```APIDOC
## sweepOutput(config: Partial<MoneroTxConfig>)

### Description
Sweep an output by key image.

### Parameters
- **config** (Partial<MoneroTxConfig>) - Required - Configures the transaction to create

### Returns
- **Promise<MoneroTxWallet>** - The created transaction
```

--------------------------------

### addListener

Source: https://woodser.github.io/monero-ts/typedocs/classes/MoneroWallet.html

Registers a listener to receive wallet notifications.

```APIDOC
## addListener(listener)

### Description
Registers a listener to receive wallet notifications.

### Parameters
- **listener** (MoneroWalletListener) - Required - The listener to receive wallet notifications.

### Returns
- **Promise<void>**
```

--------------------------------

### moveTo

Source: https://woodser.github.io/monero-ts/typedocs/classes/MoneroWalletFull.html

Moves the wallet from its current path to the given path.

```APIDOC
## moveTo(path)

### Description
Move the wallet from its current path to the given path.

### Parameters
- **path** (string) - Required - the wallet's destination path

### Returns
- **Promise<void>**
```

--------------------------------

### connectToDaemonRpc(uriOrConfig, username?, password?)

Source: https://woodser.github.io/monero-ts/typedocs/functions/connectToDaemonRpc.html

Creates and returns a client connected to a monerod instance. This function supports connecting via a URI string, a configuration object with credentials, or by spawning an internal monerod process.

```APIDOC
## connectToDaemonRpc(uriOrConfig, username?, password?)

### Description
Creates a client connected to monerod. This function returns a promise that resolves to a MoneroDaemonRpc client.

### Parameters
- **uriOrConfig** (string | string[] | Partial<MoneroRpcConnection> | Partial<MoneroDaemonConfig>) - Required - The URI, RPC connection details, configuration, or terminal parameters to connect to monerod.
- **username** (string) - Optional - The username to authenticate with monerod.
- **password** (string) - Optional - The password to authenticate with monerod.

### Returns
- **Promise<MoneroDaemonRpc>** - The daemon RPC client.

### Examples
```typescript
// Connect via URI
let daemon = await moneroTs.connectToDaemonRpc("http://localhost:38081");

// Connect via configuration object
let daemon = await moneroTs.connectToDaemonRpc({
  uri: "http://localhost:38081",
  username: "superuser",
  password: "abctesting123"
});

// Start monerod as an internal process
let daemon = await moneroTs.connectToDaemonRpc({
  cmd: ["path/to/monerod", ...params...],
});
```
```
Tokens:
Raw