Nexus Wiki - User contributions [en]

Dev Page

2026-04-19T01:31:34Z

Nhelman64: Automated update of module versions

Dev Page

2026-04-12T01:31:05Z

Nhelman64: Automated update of module versions

Dev Page

2026-04-05T01:31:08Z

Nhelman64: Automated update of module versions

Dev Page

2026-03-29T01:31:11Z

Nhelman64: Automated update of module versions

Dev Page

2026-03-22T01:31:14Z

Nhelman64: Automated update of module versions

Dev Page

2026-03-15T01:31:28Z

Nhelman64: Automated update of module versions

Dev Page

2026-03-08T01:30:52Z

Nhelman64: Automated update of module versions

Dev Page

2026-03-01T01:30:57Z

Nhelman64: Automated update of module versions

Dev Page

2026-02-22T01:31:12Z

Nhelman64: Automated update of module versions

Dev Page

2026-02-15T01:31:12Z

Nhelman64: Automated update of module versions

Dev Page

2026-02-08T01:32:00Z

Nhelman64: Automated update of module versions

Dev Page

2026-02-01T01:31:12Z

Nhelman64: Automated update of module versions

Dev Page

2026-01-25T01:30:31Z

Nhelman64: Automated update of module versions

Dev Page

2026-01-18T01:30:18Z

Nhelman64: Automated update of module versions

Dev:Run a Mainnet Node - CLI

2026-01-12T10:56:35Z

Nhelman64: Changed verion 5.0.5 build to 5.1.5 build

''This guide is tailored for Debian / Ubuntu distributions.''

== Prerequisites ==

* A computer with a minimum of 1 CPU, 2 GB RAM and 64GB hard disk space, Raspberry Pi 4 with 2 GB RAM with 64 GB SD card.
* For VPS 1GB RAM is sufficient for normal usage, for dapp backend configuration contact here.
* Ubuntu server 20.04 LTS or Debian 11 for AMD/IA64 or Ubuntu IOT / Raspberry Pi OS 64 bit for Raspberry Pi.
* Etcher – To burn the image file to SD card
* Putty if using SSH via windows.

''To install the 5.0.5 stable core, use Ubuntu 20.04 LTS only and the newer versions of Ubuntu, Debian and Raspberry Pi OS( Previously Raspbian) are having issues compiling.''

''To install the merging / 5.1 branch, it is recommended to install Debian 11 or Ubuntu 20.04. Ubuntu 22.04 will require openssl downgrade to version 1.1.1 to compile successfully.''

''To build on Raspberry Pi 3 or 4 with 1 GB RAM, enable swap memory with instructions. Proceed after setting up [https://rayanfer32.medium.com/enable-swap-memory-on-ubuntu-on-raspberry-pi-a0f873a65e74 swap].''

‎<youtube>sA-DUX9KBNU</youtube>

== Prepare The Node ==

Install ubuntu server 20.04 LTS or distro of choice, install open-ssh server during the install and once the installation is complete restart the node. SSH in node and follow the below commands. Copy the commands and paste it in the terminal using keys CTRL+SHIFT+v. Update and upgrade the node:

sudo apt update; sudo apt upgrade -y

Open SSH port before enabling firewall:

sudo ufw allow ssh

Allow API port 8080:

sudo ufw allow 8080/tcp

Allow RPC port 9336:

sudo ufw allow 9336/tcp

Allow mining port 9325, only if connecting a miner:

sudo ufw allow 9325/tcp

Enable firewall:

sudo ufw enable

Check firewall status:

sudo ufw status

Set the node timezone:

sudo dpkg-reconfigure tzdata

To change the hostname – Optional

sudo hostnamectl set-hostname <newhostname>

Reboot node:

sudo reboot

The computer is ready to install the Nexus core.

== Compiling Nexus Core ==

Installs the dependencies required for compiling nexus core CLI, It will take some time to complete depending on your internet speed:

sudo apt-get install -y build-essential libssl-dev libdb-dev libdb++-dev libminiupnpc-dev git

Download the stable nexus core source code, and should only take a few seconds to complete,

git clone -b 5.1.5 https://github.com/Nexusoft/LLL-TAO

Change into the source code directory

cd LLL-TAO

Clean any previous builds:

make -f makefile.cli clean

Lastly run this command to compile from source. This begins compiling the nexus core, please be patient, as this can take a very long time depending on your CPU. Replace the 1 in ‘j1’to the number of cores / threads for compiling faster.

make -f makefile.cli -j1 AMD64=1

For compiling on Raspberry Pi use:

make -f makefile.cli -j1 ARM64=1

Will show “Finished building nexus” on a successful compile.

== Configure the Wallet (nexus.conf) ==

Create Nexus core data directory (it’s a hidden directory, Nexus daemon creates it automatically on first start. We are creating it manually to create the configuration file. If the directory is already available, skip this step.):

mkdir ~/.Nexus

The wallet configuration is stored in the nexus.conf file, located in the core data directory. Create the nexus.conf file

nano ~/.Nexus/nexus.conf

Copy the below code into the file. Provide a user and password for RPC and API and remove the # in the #stake=1 if you intend to stake.

# This is an example nexus.conf. Tailor it to your deployment.
#RPC credentials, change as needed
rpcuser=<user for RPC>
rpcpassword=<pw for RPC>
#API http authentication credtnials. Change as needed
apiuser=<user for API>
apipassword=<pw for API>
#To run the nexus core as a daemon
daemon=1
#To enable mining with the node,
#mining=1
#To enable staking
#stake=1

''<ipaddress> is IP address of the machine connecting to your node remotely, it may be the interface or dapp server IP address. You can also use '*' wildcard to allow all computers in a particular subnet. llpallowip=192.168.10.*:8080 allows all computers on the 192.168.10 local network.''

To access the wallet remotely (from a wallet interface on another machine), add the following lines in the config file:

#To enable RPC remote access
rpcremote=1
#To enable API authentication
apiauth=1
#To enable remote API access. Local API access will be revoked
apiremote=1
# Whitelist IP address for API & RPC
llpallowip=<ipaddress>:8080
llpallowip=<ipaddress>:9336

If testing the merging branch / 5.1:

# To index block data, required to access block data.
indexheight=1
# To index account addresses, required to access the account address.
indexaddress=1

Press Ctrl s and Ctrl x to save and exit the editor.

== Bootstrapping Tritium Database ==

This step will download the nexus database and then extract it to the data folder, alternatively you can skip this step if you choose to synchronise the data from peers which will be slow depending on your internet connection:

cd ~

This will download the database to the home folder. The file is about 5 GB in size:

wget -c http://bootstrap.nexus.io/tritium.tar.gz

This will extract the database to the Nexus core data directory:

tar -xvf tritium.tar.gz -C ~/.Nexus

== APIs to Control Node ==

To interact with the nexus core daemon, use API commands via the terminal. Change the location to ~/LLL-TAO folder for the API’s to work. To run the node, stake and transact we will only be using the system, users and finance APIs. If you have any doubts refer to the API documentation here.

=== Before we start ===

* Be careful as the login credentials in the terminal and can be seen by anyone around.
* Every transaction will need the PIN
* Every transaction on the Nexus blockchain is a debit to the sending account and credit to the receiving account, two transactions. (This will be useful to understand some API commands)

Change into the LLL-TAO directory to start nexus core (Change to the LLL-TAO folder to run the following commands):

cd LLL-TAO

=== Start the Daemon ===

./nexus

Nexus core will be running in the background as a daemon. It will detect peers and synchronize the blockchain. It will take a few minutes to find peers

=== Stop the Daemon ===

./nexus system/stop

=== To Get the Node Info ===

./nexus system/get/info

The output of the APIs are in JSON format. You can confirm if the node is synchronized by checking the “synchronising”: false and “synccomplete”: 100. Check the block height on the explorer here or here.

After the blockchain is fully synchronized, create a new user account (signature chain).

Username must be a minimum of 2 characters, passwords must be 8 characters and PIN 4 characters. The PIN can be a combination of letters/numbers/symbols.

./nexus users/create/user username= password= pin=

To log into the account (If the account was just created, wait for a few blocks to confirm new account)

./nexus users/login/user username= password= pin=

To unlock the account for staking and automatically credit incoming transactions set (notifications=1). If its not set, then manually credit the incoming transactions else it will be credited back to the sender’s account after 24 hrs. This is the reversible transaction function working as designed.

./nexus users/unlock/user pin= staking=1 notifications=1

To check stake info (works only after login and unlocking for staking).

./nexus finance/get/stakeinfo

To get details of the logged in user accounts and address (trust and default accounts are automatically created with new account):

./nexus users/list/accounts

This will list all the account and its details.

./nexus finance/list/accounts

This will list all transactions sent to a particular genesis or username. It is useful for identifying transactions that need to accept such as credits.

./nexus users/list/notifications

If automatic credit (notifications=1) is not specified as an option with unlock command that will reflect as a pending transaction and will be listed in notifications.

To credit a pending transaction, ‘txid’ is the debit transaction ID from notifications.

./nexus finance/credit/account pin= txid=

To send nexus coins, name is the account to be sent from and name_to is the recipient account, these can be changed to address and address_to.

./nexus finance/debit/account name=username:name/namespace:name amount= name_to=username:name/namespace:name pin=

To check the full Nexus blockchain metrics.

./nexus system/get/metrics

Hope this guide was helpful!

Dev Page

2026-01-11T01:30:22Z

Nhelman64: Automated update of module versions

Dev Page

2026-01-04T01:30:33Z

Nhelman64: Automated update of module versions

Dev Page

2025-12-28T01:30:23Z

Nhelman64: Automated update of module versions

Dev Page

2025-12-21T01:30:08Z

Nhelman64: Automated update of module versions

Dev Page

2025-12-14T01:29:53Z

Nhelman64: Automated update of module versions

Dev Page

2025-12-07T01:30:01Z

Nhelman64: Automated update of module versions

Dev Page

2025-11-30T01:30:03Z

Nhelman64: Automated update of module versions

Dev Page

2025-11-23T01:29:55Z

Nhelman64: Automated update of module versions

Dev Page

2025-11-16T01:29:51Z

Nhelman64: Automated update of module versions

Dev Page

2025-11-09T01:29:33Z

Nhelman64: Automated update of module versions

Dev Page

2025-11-02T01:29:44Z

Nhelman64: Automated update of module versions

Dev Page

2025-10-26T01:29:50Z

Nhelman64: Automated update of module versions

Dev Page

2025-10-19T01:29:41Z

Nhelman64: Automated update of module versions

Dev Page

2025-10-12T01:29:45Z

Nhelman64: Automated update of module versions

Dev Page

2025-10-05T02:25:03Z

Nhelman64: Automated update of module versions

Dev Page

2025-09-28T02:25:52Z

Nhelman64: Automated update of module versions

Dev Page

2025-09-21T02:25:11Z

Nhelman64: Automated update of module versions

Dev Page

2025-09-14T02:21:15Z

Nhelman64: Automated update of module versions

Dev Page

2025-09-07T02:21:43Z

Nhelman64: Automated update of module versions

Mining NXS with NexusMiner

2025-09-02T11:02:30Z

Nhelman64: Corrected Note

= Mining NXS with NexusMiner: Step-by-Step Guide =
version 9

Welcome to the NexusMiner documentation! This guide will help you get started mining Nexus (NXS) using NexusMiner on supported hardware (FPGA, GPU, CPU).
'''Note:''' The Prime pool is no longer maintained. You can still mine solo on the PRIME channel, or use the pool for HASH channel mining (mainnet only).

----

== 1. Downloading NexusMiner ==

'''Windows Users:'''
* Visit the [https://github.com/Nexusoft/NexusMiner/releases NexusMiner Releases page].
* Download the latest <code>NexusMiner.exe</code> and the default <code>miner.conf</code>.
* No build is required; you can run the executable directly.

'''Linux/Other Users:'''
* Clone the repository:
<pre>
git clone https://github.com/Nexusoft/NexusMiner.git
cd NexusMiner
</pre>
* Build using CMake (see section 6).

----

== 2. Setting Up <code>miner.conf</code> ==

Edit <code>miner.conf</code> (provided in releases or repo root) for your setup. Below are minimal examples:

; Pool Mining on the Hash Channel (Mainnet Only)
<pre>
{
"version" : 1,
"wallet_ip" : "hashpool.nexus.io",
"port" : 50000,
"mining_mode" : "HASH",
"pool" : {
"username" : "YOUR_NXS_ADDRESS",
"display_name" : "YOUR_DISPLAY_NAME",
"use_deprecated" : false
},
"workers" : [
{
"worker" : {
"id" : "myWorker0",
"mode" : { "hardware" : "gpu", "device": 0 }
}
}
]
}
</pre>

; Solo Mining on the Prime or Hash Channel (Mainnet)
<pre">
{
"version" : 1,
"wallet_ip" : "127.0.0.1",
"port" : 9325,
"mining_mode" : "PRIME", // or "HASH"
"workers" : [
{
"worker" : {
"id" : "myWorker0",
"mode" : { "hardware" : "gpu", "device": 0 }
}
}
]
}
</pre>

; Solo Mining on the Prime or Hash Channel (Testnet)
<pre>
{
"version" : 1,
"wallet_ip" : "127.0.0.1",
"port" : 8325,
"mining_mode" : "PRIME", // or "HASH"
"workers" : [
{
"worker" : {
"id" : "myWorker0",
"mode" : { "hardware" : "gpu", "device": 0 }
}
}
]
}
</pre>
'''Note: Do NOT use the <code>pool</code> section on testnet. Testnet mining is solo-only; pool mining is not supported or useful.'''<br/>'''CPU mining is no longer competitive on the main Nexus blockchain and is only recommended for private blockchains or testnets. For mainnet, use GPUs (or FPGAs) for best results.'''

* '''wallet_ip''': For solo mining, use <code>127.0.0.1</code> (or your core’s IP); for pool mining (mainnet), set to the pool address.
* '''port:'''
** Use '''9325''' for solo mining on mainnet.
** Use '''8325''' for solo mining on testnet.
** Use '''50000''' for hashpool (mainnet only).
* '''username''': Enter your '''Nexus wallet address''' to receive mining rewards (pool/mainnet only).
* '''workers''': Configure for your hardware.

'''Example: Enabling Logging'''
To enable detailed logging and statistics, add the following to your <code>miner.conf</code>:

<pre>
"logfile" : "miner.log",
"log_level" : 2,
"stats_printers" : [
{
"stats_printer" : {
"mode" : "console"
}
},
{
"stats_printer" : {
"mode" : "file",
"filename" : "stats.log"
}
}
],
<pre>

----

== 3. Setting Up Your Nexus Wallet or Headless Core ==

=== For '''Solo Mining (Prime or Hash Channel):''' ===
* Use Nexus Core version 5.1.5 or later.
* Unlock your wallet for mining.
* Edit <code>nexus.conf</code> to enable mining:
<pre>
mining=1
</pre>
* If mining '''locally (same machine)''': nothing else is required.
* If mining '''over LAN''': add to <code>nexus.conf</code>:
<pre>
llpallowip=<miner_ip>:<port>
</pre>
** On '''mainnet''', the default port is <code>9325</code>.
** On '''testnet''', the default port is <code>8325</code>.

Example: <code>llpallowip=192.168.0.100:9325</code>
* Ensure the port in <code>miner.conf</code> matches the port your wallet/core is listening on.

=== For '''Pool Mining (Hash Channel, Mainnet Only):''' ===
* No special changes are required to your wallet or <code>nexus.conf</code>.
* Just ensure the <code>username</code> field in <code>miner.conf</code> is set to your Nexus wallet address.

----

== 4. Running NexusMiner ==

'''Windows:'''
* Double-click <code>NexusMiner.exe</code> or run from the command line:
<pre>
NexusMiner.exe
</pre>

'''Linux:'''
* After building, run:
<pre>
./NexusMiner
</syntaxhighlight>

'''Command-line Options:'''
* Specify a config: <code>./NexusMiner my_miner.conf</code>
* Check config only: <code>./NexusMiner my_miner.conf -c</code>
* Show version: <code>./NexusMiner -v</code>

----

== 5. Monitoring and Logging ==

* Logs are written to <code>miner.log</code> (path and level set in <code>miner.conf</code> via <code>"logfile"</code> and <code>"log_level"</code>).
* Additional statistics can be printed to console or files as configured under <code>stats_printers</code>.
* '''Important:'''
'''Every time you run NexusMiner, it will overwrite the contents of both <code>miner.log</code> and any file specified for statistics logging (such as <code>stats.log</code>).'''
If you want to preserve logs from previous runs, be sure to copy or rename them before starting the miner again.

Example configuration for logging:
<pre>
"logfile" : "miner.log",
"log_level" : 2,
"stats_printers" : [
{
"stats_printer" : {
"mode" : "console"
}
},
{
"stats_printer" : {
"mode" : "file",
"filename" : "stats.log"
}
}
]
</pre>

----

== 6. Building NexusMiner (Linux/Advanced Users) ==

Build options are available if you want to compile from source:
* Requires CMake, C++ compiler, and optionally CUDA Toolkit (for Nvidia GPUs).
* From the repo directory:
<pre>
mkdir build
cd build
cmake .. -DWITH_GPU_CUDA=ON # Enable Nvidia GPU mining
make
</pre>
* See repository README for more advanced build options and FPGA instructions.

----

== 7. Additional Resources ==

* [https://github.com/Nexusoft/NexusMiner NexusMiner GitHub Repository]
* [https://github.com/Nexusoft/NexusMiner/blob/master/miner.conf Sample miner.conf]
* [http://hashpool.nexus.io Hash Pool] (mainnet only)
* [https://t.me/NexusOfficial Nexus mining topic on Telegram] (Join the Waiting Room to request access.)

----

== Troubleshooting ==

* Ensure your wallet address is correct in <code>miner.conf</code>.
* For solo mining, make sure your wallet/core is running, unlocked, and accessible with the correct port and IP.
* Refer to logs (<code>miner.log</code>) for error messages.

----

'''Happy Mining!'''

Mining NXS with NexusMiner

2025-09-02T10:59:29Z

Nhelman64: Replaced <syntaxhighlighting> with <pre>

= Mining NXS with NexusMiner: Step-by-Step Guide =
version 9

Welcome to the NexusMiner documentation! This guide will help you get started mining Nexus (NXS) using NexusMiner on supported hardware (FPGA, GPU, CPU).
'''Note:''' The Prime pool is no longer maintained. You can still mine solo on the PRIME channel, or use the pool for HASH channel mining (mainnet only).

----

== 1. Downloading NexusMiner ==

'''Windows Users:'''
* Visit the [https://github.com/Nexusoft/NexusMiner/releases NexusMiner Releases page].
* Download the latest <code>NexusMiner.exe</code> and the default <code>miner.conf</code>.
* No build is required; you can run the executable directly.

'''Linux/Other Users:'''
* Clone the repository:
<pre>
git clone https://github.com/Nexusoft/NexusMiner.git
cd NexusMiner
</pre>
* Build using CMake (see section 6).

----

== 2. Setting Up <code>miner.conf</code> ==

Edit <code>miner.conf</code> (provided in releases or repo root) for your setup. Below are minimal examples:

; Pool Mining on the Hash Channel (Mainnet Only)
<pre>
{
"version" : 1,
"wallet_ip" : "hashpool.nexus.io",
"port" : 50000,
"mining_mode" : "HASH",
"pool" : {
"username" : "YOUR_NXS_ADDRESS",
"display_name" : "YOUR_DISPLAY_NAME",
"use_deprecated" : false
},
"workers" : [
{
"worker" : {
"id" : "myWorker0",
"mode" : { "hardware" : "gpu", "device": 0 }
}
}
]
}
</pre>

; Solo Mining on the Prime or Hash Channel (Mainnet)
<pre">
{
"version" : 1,
"wallet_ip" : "127.0.0.1",
"port" : 9325,
"mining_mode" : "PRIME", // or "HASH"
"workers" : [
{
"worker" : {
"id" : "myWorker0",
"mode" : { "hardware" : "gpu", "device": 0 }
}
}
]
}
</pre>

; Solo Mining on the Prime or Hash Channel (Testnet)
<pre>
{
"version" : 1,
"wallet_ip" : "127.0.0.1",
"port" : 8325,
"mining_mode" : "PRIME", // or "HASH"
"workers" : [
{
"worker" : {
"id" : "myWorker0",
"mode" : { "hardware" : "gpu", "device": 0 }
}
}
]
}
</pre>
{{Note|'''Do NOT use the <code>pool</code> section on testnet. Testnet mining is solo-only; pool mining is not supported or useful.'''<br/>'''CPU mining is no longer competitive on the main Nexus blockchain and is only recommended for private blockchains or testnets. For mainnet, use GPUs (or FPGAs) for best results.'''}}

* '''wallet_ip''': For solo mining, use <code>127.0.0.1</code> (or your core’s IP); for pool mining (mainnet), set to the pool address.
* '''port:'''
** Use '''9325''' for solo mining on mainnet.
** Use '''8325''' for solo mining on testnet.
** Use '''50000''' for hashpool (mainnet only).
* '''username''': Enter your '''Nexus wallet address''' to receive mining rewards (pool/mainnet only).
* '''workers''': Configure for your hardware.

'''Example: Enabling Logging'''
To enable detailed logging and statistics, add the following to your <code>miner.conf</code>:

<pre>
"logfile" : "miner.log",
"log_level" : 2,
"stats_printers" : [
{
"stats_printer" : {
"mode" : "console"
}
},
{
"stats_printer" : {
"mode" : "file",
"filename" : "stats.log"
}
}
],
<pre>

----

== 3. Setting Up Your Nexus Wallet or Headless Core ==

=== For '''Solo Mining (Prime or Hash Channel):''' ===
* Use Nexus Core version 5.1.5 or later.
* Unlock your wallet for mining.
* Edit <code>nexus.conf</code> to enable mining:
<pre>
mining=1
</pre>
* If mining '''locally (same machine)''': nothing else is required.
* If mining '''over LAN''': add to <code>nexus.conf</code>:
<pre>
llpallowip=<miner_ip>:<port>
</pre>
** On '''mainnet''', the default port is <code>9325</code>.
** On '''testnet''', the default port is <code>8325</code>.

Example: <code>llpallowip=192.168.0.100:9325</code>
* Ensure the port in <code>miner.conf</code> matches the port your wallet/core is listening on.

=== For '''Pool Mining (Hash Channel, Mainnet Only):''' ===
* No special changes are required to your wallet or <code>nexus.conf</code>.
* Just ensure the <code>username</code> field in <code>miner.conf</code> is set to your Nexus wallet address.

----

== 4. Running NexusMiner ==

'''Windows:'''
* Double-click <code>NexusMiner.exe</code> or run from the command line:
<pre>
NexusMiner.exe
</pre>

'''Linux:'''
* After building, run:
<pre>
./NexusMiner
</syntaxhighlight>

'''Command-line Options:'''
* Specify a config: <code>./NexusMiner my_miner.conf</code>
* Check config only: <code>./NexusMiner my_miner.conf -c</code>
* Show version: <code>./NexusMiner -v</code>

----

== 5. Monitoring and Logging ==

* Logs are written to <code>miner.log</code> (path and level set in <code>miner.conf</code> via <code>"logfile"</code> and <code>"log_level"</code>).
* Additional statistics can be printed to console or files as configured under <code>stats_printers</code>.
* '''Important:'''
'''Every time you run NexusMiner, it will overwrite the contents of both <code>miner.log</code> and any file specified for statistics logging (such as <code>stats.log</code>).'''
If you want to preserve logs from previous runs, be sure to copy or rename them before starting the miner again.

Example configuration for logging:
<pre>
"logfile" : "miner.log",
"log_level" : 2,
"stats_printers" : [
{
"stats_printer" : {
"mode" : "console"
}
},
{
"stats_printer" : {
"mode" : "file",
"filename" : "stats.log"
}
}
]
</pre>

----

== 6. Building NexusMiner (Linux/Advanced Users) ==

Build options are available if you want to compile from source:
* Requires CMake, C++ compiler, and optionally CUDA Toolkit (for Nvidia GPUs).
* From the repo directory:
<pre>
mkdir build
cd build
cmake .. -DWITH_GPU_CUDA=ON # Enable Nvidia GPU mining
make
</pre>
* See repository README for more advanced build options and FPGA instructions.

----

== 7. Additional Resources ==

* [https://github.com/Nexusoft/NexusMiner NexusMiner GitHub Repository]
* [https://github.com/Nexusoft/NexusMiner/blob/master/miner.conf Sample miner.conf]
* [http://hashpool.nexus.io Hash Pool] (mainnet only)
* [https://t.me/NexusOfficial Nexus mining topic on Telegram] (Join the Waiting Room to request access.)

----

== Troubleshooting ==

* Ensure your wallet address is correct in <code>miner.conf</code>.
* For solo mining, make sure your wallet/core is running, unlocked, and accessible with the correct port and IP.
* Refer to logs (<code>miner.log</code>) for error messages.

----

'''Happy Mining!'''

Mining NXS with NexusMiner

2025-09-02T10:51:39Z

Nhelman64: Added version #

= Mining NXS with NexusMiner: Step-by-Step Guide =
version 9

Welcome to the NexusMiner documentation! This guide will help you get started mining Nexus (NXS) using NexusMiner on supported hardware (FPGA, GPU, CPU).
'''Note:''' The Prime pool is no longer maintained. You can still mine solo on the PRIME channel, or use the pool for HASH channel mining (mainnet only).

----

== 1. Downloading NexusMiner ==

'''Windows Users:'''
* Visit the [https://github.com/Nexusoft/NexusMiner/releases NexusMiner Releases page].
* Download the latest <code>NexusMiner.exe</code> and the default <code>miner.conf</code>.
* No build is required; you can run the executable directly.

'''Linux/Other Users:'''
* Clone the repository:
<syntaxhighlight lang="bash">
git clone https://github.com/Nexusoft/NexusMiner.git
cd NexusMiner
</syntaxhighlight>
* Build using CMake (see section 6).

----

== 2. Setting Up <code>miner.conf</code> ==

Edit <code>miner.conf</code> (provided in releases or repo root) for your setup. Below are minimal examples:

; Pool Mining on the Hash Channel (Mainnet Only)
<syntaxhighlight lang="json">
{
"version" : 1,
"wallet_ip" : "hashpool.nexus.io",
"port" : 50000,
"mining_mode" : "HASH",
"pool" : {
"username" : "YOUR_NXS_ADDRESS",
"display_name" : "YOUR_DISPLAY_NAME",
"use_deprecated" : false
},
"workers" : [
{
"worker" : {
"id" : "myWorker0",
"mode" : { "hardware" : "gpu", "device": 0 }
}
}
]
}
</syntaxhighlight>

; Solo Mining on the Prime or Hash Channel (Mainnet)
<syntaxhighlight lang="json">
{
"version" : 1,
"wallet_ip" : "127.0.0.1",
"port" : 9325,
"mining_mode" : "PRIME", // or "HASH"
"workers" : [
{
"worker" : {
"id" : "myWorker0",
"mode" : { "hardware" : "gpu", "device": 0 }
}
}
]
}
</syntaxhighlight>

; Solo Mining on the Prime or Hash Channel (Testnet)
<syntaxhighlight lang="json">
{
"version" : 1,
"wallet_ip" : "127.0.0.1",
"port" : 8325,
"mining_mode" : "PRIME", // or "HASH"
"workers" : [
{
"worker" : {
"id" : "myWorker0",
"mode" : { "hardware" : "gpu", "device": 0 }
}
}
]
}
</syntaxhighlight>
{{Note|'''Do NOT use the <code>pool</code> section on testnet. Testnet mining is solo-only; pool mining is not supported or useful.'''<br/>'''CPU mining is no longer competitive on the main Nexus blockchain and is only recommended for private blockchains or testnets. For mainnet, use GPUs (or FPGAs) for best results.'''}}

* '''wallet_ip''': For solo mining, use <code>127.0.0.1</code> (or your core’s IP); for pool mining (mainnet), set to the pool address.
* '''port:'''
** Use '''9325''' for solo mining on mainnet.
** Use '''8325''' for solo mining on testnet.
** Use '''50000''' for hashpool (mainnet only).
* '''username''': Enter your '''Nexus wallet address''' to receive mining rewards (pool/mainnet only).
* '''workers''': Configure for your hardware.

'''Example: Enabling Logging'''
To enable detailed logging and statistics, add the following to your <code>miner.conf</code>:

<syntaxhighlight lang="json">
"logfile" : "miner.log",
"log_level" : 2,
"stats_printers" : [
{
"stats_printer" : {
"mode" : "console"
}
},
{
"stats_printer" : {
"mode" : "file",
"filename" : "stats.log"
}
}
],
</syntaxhighlight>

----

== 3. Setting Up Your Nexus Wallet or Headless Core ==

=== For '''Solo Mining (Prime or Hash Channel):''' ===
* Use Nexus Core version 5.1.5 or later.
* Unlock your wallet for mining.
* Edit <code>nexus.conf</code> to enable mining:
<syntaxhighlight lang="ini">
mining=1
</syntaxhighlight>
* If mining '''locally (same machine)''': nothing else is required.
* If mining '''over LAN''': add to <code>nexus.conf</code>:
<syntaxhighlight lang="ini">
llpallowip=<miner_ip>:<port>
</syntaxhighlight>
** On '''mainnet''', the default port is <code>9325</code>.
** On '''testnet''', the default port is <code>8325</code>.

Example: <code>llpallowip=192.168.0.100:9325</code>
* Ensure the port in <code>miner.conf</code> matches the port your wallet/core is listening on.

=== For '''Pool Mining (Hash Channel, Mainnet Only):''' ===
* No special changes are required to your wallet or <code>nexus.conf</code>.
* Just ensure the <code>username</code> field in <code>miner.conf</code> is set to your Nexus wallet address.

----

== 4. Running NexusMiner ==

'''Windows:'''
* Double-click <code>NexusMiner.exe</code> or run from the command line:
<syntaxhighlight lang="bash">
NexusMiner.exe
</syntaxhighlight>

'''Linux:'''
* After building, run:
<syntaxhighlight lang="bash">
./NexusMiner
</syntaxhighlight>

'''Command-line Options:'''
* Specify a config: <code>./NexusMiner my_miner.conf</code>
* Check config only: <code>./NexusMiner my_miner.conf -c</code>
* Show version: <code>./NexusMiner -v</code>

----

== 5. Monitoring and Logging ==

* Logs are written to <code>miner.log</code> (path and level set in <code>miner.conf</code> via <code>"logfile"</code> and <code>"log_level"</code>).
* Additional statistics can be printed to console or files as configured under <code>stats_printers</code>.
* '''Important:'''
'''Every time you run NexusMiner, it will overwrite the contents of both <code>miner.log</code> and any file specified for statistics logging (such as <code>stats.log</code>).'''
If you want to preserve logs from previous runs, be sure to copy or rename them before starting the miner again.

Example configuration for logging:
<syntaxhighlight lang="json">
"logfile" : "miner.log",
"log_level" : 2,
"stats_printers" : [
{
"stats_printer" : {
"mode" : "console"
}
},
{
"stats_printer" : {
"mode" : "file",
"filename" : "stats.log"
}
}
]
</syntaxhighlight>

----

== 6. Building NexusMiner (Linux/Advanced Users) ==

Build options are available if you want to compile from source:
* Requires CMake, C++ compiler, and optionally CUDA Toolkit (for Nvidia GPUs).
* From the repo directory:
<syntaxhighlight lang="bash">
mkdir build
cd build
cmake .. -DWITH_GPU_CUDA=ON # Enable Nvidia GPU mining
make
</syntaxhighlight>
* See repository README for more advanced build options and FPGA instructions.

----

== 7. Additional Resources ==

* [https://github.com/Nexusoft/NexusMiner NexusMiner GitHub Repository]
* [https://github.com/Nexusoft/NexusMiner/blob/master/miner.conf Sample miner.conf]
* [http://hashpool.nexus.io Hash Pool] (mainnet only)
* [https://t.me/NexusOfficial Nexus mining topic on Telegram] (Join the Waiting Room to request access.)

----

== Troubleshooting ==

* Ensure your wallet address is correct in <code>miner.conf</code>.
* For solo mining, make sure your wallet/core is running, unlocked, and accessible with the correct port and IP.
* Refer to logs (<code>miner.log</code>) for error messages.

----

'''Happy Mining!'''

Mining NXS with NexusMiner

2025-09-02T10:49:26Z

Nhelman64: New page with instructions for how to mine Nexus

= Mining NXS with NexusMiner: Step-by-Step Guide =

Welcome to the NexusMiner documentation! This guide will help you get started mining Nexus (NXS) using NexusMiner on supported hardware (FPGA, GPU, CPU).
'''Note:''' The Prime pool is no longer maintained. You can still mine solo on the PRIME channel, or use the pool for HASH channel mining (mainnet only).

----

== 1. Downloading NexusMiner ==

'''Windows Users:'''
* Visit the [https://github.com/Nexusoft/NexusMiner/releases NexusMiner Releases page].
* Download the latest <code>NexusMiner.exe</code> and the default <code>miner.conf</code>.
* No build is required; you can run the executable directly.

'''Linux/Other Users:'''
* Clone the repository:
<syntaxhighlight lang="bash">
git clone https://github.com/Nexusoft/NexusMiner.git
cd NexusMiner
</syntaxhighlight>
* Build using CMake (see section 6).

----

== 2. Setting Up <code>miner.conf</code> ==

Edit <code>miner.conf</code> (provided in releases or repo root) for your setup. Below are minimal examples:

; Pool Mining on the Hash Channel (Mainnet Only)
<syntaxhighlight lang="json">
{
"version" : 1,
"wallet_ip" : "hashpool.nexus.io",
"port" : 50000,
"mining_mode" : "HASH",
"pool" : {
"username" : "YOUR_NXS_ADDRESS",
"display_name" : "YOUR_DISPLAY_NAME",
"use_deprecated" : false
},
"workers" : [
{
"worker" : {
"id" : "myWorker0",
"mode" : { "hardware" : "gpu", "device": 0 }
}
}
]
}
</syntaxhighlight>

; Solo Mining on the Prime or Hash Channel (Mainnet)
<syntaxhighlight lang="json">
{
"version" : 1,
"wallet_ip" : "127.0.0.1",
"port" : 9325,
"mining_mode" : "PRIME", // or "HASH"
"workers" : [
{
"worker" : {
"id" : "myWorker0",
"mode" : { "hardware" : "gpu", "device": 0 }
}
}
]
}
</syntaxhighlight>

; Solo Mining on the Prime or Hash Channel (Testnet)
<syntaxhighlight lang="json">
{
"version" : 1,
"wallet_ip" : "127.0.0.1",
"port" : 8325,
"mining_mode" : "PRIME", // or "HASH"
"workers" : [
{
"worker" : {
"id" : "myWorker0",
"mode" : { "hardware" : "gpu", "device": 0 }
}
}
]
}
</syntaxhighlight>
{{Note|'''Do NOT use the <code>pool</code> section on testnet. Testnet mining is solo-only; pool mining is not supported or useful.'''<br/>'''CPU mining is no longer competitive on the main Nexus blockchain and is only recommended for private blockchains or testnets. For mainnet, use GPUs (or FPGAs) for best results.'''}}

* '''wallet_ip''': For solo mining, use <code>127.0.0.1</code> (or your core’s IP); for pool mining (mainnet), set to the pool address.
* '''port:'''
** Use '''9325''' for solo mining on mainnet.
** Use '''8325''' for solo mining on testnet.
** Use '''50000''' for hashpool (mainnet only).
* '''username''': Enter your '''Nexus wallet address''' to receive mining rewards (pool/mainnet only).
* '''workers''': Configure for your hardware.

'''Example: Enabling Logging'''
To enable detailed logging and statistics, add the following to your <code>miner.conf</code>:

<syntaxhighlight lang="json">
"logfile" : "miner.log",
"log_level" : 2,
"stats_printers" : [
{
"stats_printer" : {
"mode" : "console"
}
},
{
"stats_printer" : {
"mode" : "file",
"filename" : "stats.log"
}
}
],
</syntaxhighlight>

----

== 3. Setting Up Your Nexus Wallet or Headless Core ==

=== For '''Solo Mining (Prime or Hash Channel):''' ===
* Use Nexus Core version 5.1.5 or later.
* Unlock your wallet for mining.
* Edit <code>nexus.conf</code> to enable mining:
<syntaxhighlight lang="ini">
mining=1
</syntaxhighlight>
* If mining '''locally (same machine)''': nothing else is required.
* If mining '''over LAN''': add to <code>nexus.conf</code>:
<syntaxhighlight lang="ini">
llpallowip=<miner_ip>:<port>
</syntaxhighlight>
** On '''mainnet''', the default port is <code>9325</code>.
** On '''testnet''', the default port is <code>8325</code>.

Example: <code>llpallowip=192.168.0.100:9325</code>
* Ensure the port in <code>miner.conf</code> matches the port your wallet/core is listening on.

=== For '''Pool Mining (Hash Channel, Mainnet Only):''' ===
* No special changes are required to your wallet or <code>nexus.conf</code>.
* Just ensure the <code>username</code> field in <code>miner.conf</code> is set to your Nexus wallet address.

----

== 4. Running NexusMiner ==

'''Windows:'''
* Double-click <code>NexusMiner.exe</code> or run from the command line:
<syntaxhighlight lang="bash">
NexusMiner.exe
</syntaxhighlight>

'''Linux:'''
* After building, run:
<syntaxhighlight lang="bash">
./NexusMiner
</syntaxhighlight>

'''Command-line Options:'''
* Specify a config: <code>./NexusMiner my_miner.conf</code>
* Check config only: <code>./NexusMiner my_miner.conf -c</code>
* Show version: <code>./NexusMiner -v</code>

----

== 5. Monitoring and Logging ==

* Logs are written to <code>miner.log</code> (path and level set in <code>miner.conf</code> via <code>"logfile"</code> and <code>"log_level"</code>).
* Additional statistics can be printed to console or files as configured under <code>stats_printers</code>.
* '''Important:'''
'''Every time you run NexusMiner, it will overwrite the contents of both <code>miner.log</code> and any file specified for statistics logging (such as <code>stats.log</code>).'''
If you want to preserve logs from previous runs, be sure to copy or rename them before starting the miner again.

Example configuration for logging:
<syntaxhighlight lang="json">
"logfile" : "miner.log",
"log_level" : 2,
"stats_printers" : [
{
"stats_printer" : {
"mode" : "console"
}
},
{
"stats_printer" : {
"mode" : "file",
"filename" : "stats.log"
}
}
]
</syntaxhighlight>

----

== 6. Building NexusMiner (Linux/Advanced Users) ==

Build options are available if you want to compile from source:
* Requires CMake, C++ compiler, and optionally CUDA Toolkit (for Nvidia GPUs).
* From the repo directory:
<syntaxhighlight lang="bash">
mkdir build
cd build
cmake .. -DWITH_GPU_CUDA=ON # Enable Nvidia GPU mining
make
</syntaxhighlight>
* See repository README for more advanced build options and FPGA instructions.

----

== 7. Additional Resources ==

* [https://github.com/Nexusoft/NexusMiner NexusMiner GitHub Repository]
* [https://github.com/Nexusoft/NexusMiner/blob/master/miner.conf Sample miner.conf]
* [http://hashpool.nexus.io Hash Pool] (mainnet only)
* [https://t.me/NexusOfficial Nexus mining topic on Telegram] (Join the Waiting Room to request access.)

----

== Troubleshooting ==

* Ensure your wallet address is correct in <code>miner.conf</code>.
* For solo mining, make sure your wallet/core is running, unlocked, and accessible with the correct port and IP.
* Refer to logs (<code>miner.log</code>) for error messages.

----

'''Happy Mining!'''

Dev Page

2025-08-31T02:24:58Z

Nhelman64: Automated update of module versions

Dev Page

2025-08-24T02:44:17Z

Nhelman64: Automated update of module versions

Dev Page

2025-08-17T02:50:17Z

Nhelman64: Automated update of module versions

Dev Page

2025-08-10T02:59:10Z

Nhelman64: Automated update of module versions

Dev Page

2025-08-03T03:04:38Z

Nhelman64: Automated update of module versions

Dev Page

2025-07-27T03:01:51Z

Nhelman64: Automated update of module versions

Dev Page

2025-07-25T12:46:00Z

Nhelman64: Automated update of module versions

Dev:Modules - GitHub List

2025-07-25T10:05:26Z

Nhelman64: Adding README.md and production-ready zip file links

== GitHub Links for Nexus Desktop Wallet Modules ==

Be aware that not all of the modules listed on this page have been made available for production yet.
----
'''''Nexus Transaction History module'''''
* version 1.2.0
* Approved for Production
* GitHub repository: https://github.com/Nexusoft/nexus-transaction-history-module
* README.md: https://github.com/Nexusoft/nexus-transaction-history-module/blob/master/README.md
* Download most recent release: https://github.com/Nexusoft/nexus-transaction-history-module/releases/download/v1.2.0/nexus-interface-history-module@1.2.0.zip
----
'''''Nexus Market Data module'''''
* version 1.4.0
* Approved for Production
* GitHub repository: https://github.com/Nexusoft/nexus-market-data-module
* Download most recent release: https://github.com/Nexusoft/nexus-market-data-module/releases/download/v1.4.0/nexus-market-data-module@1.4.0.zip
----
'''''Nexus Invoice module'''''
* version 1.2.0
* Approved for Production
* GitHub repository: https://github.com/Nexusoft/nexus-invoice-module
* Download most recent release: https://github.com/Nexusoft/nexus-invoice-module/releases/download/v1.2.0/nexus-invoice@1.2.0.zip
----
'''''Nexus Decentralized Exchange module'''''
* version 0.2.2
* Approved for Production
* GitHub repository: https://github.com/AkstonCap/DEX
* README.md: https://github.com/AkstonCap/DEX/blob/master/README.md
* Download most recent release: https://github.com/AkstonCap/DEX/releases/download/v0.2.2/dex_module@0.2.2.zip
----
'''''Nexus Community On-Chain Voting module'''''
* version 0.3.0-alpha
* Not Yet Submitted for Production Approval
* GitHub repository: https://github.com/NealHelman/nexus-voting-module
* README.md: https://github.com/NealHelman/nexus-voting-module/blob/main/README.md
* Download most recent release: N/A

----

Dev Page

2025-07-24T12:48:04Z

Nhelman64: Automated update of module versions

Dev Page

2025-07-23T12:48:16Z

Nhelman64: Automated update of module versions

Dev Page

2025-07-22T12:47:41Z

Nhelman64: Automated update of module versions

Dev Page

2025-07-21T12:48:28Z

Nhelman64: Automated update of module versions