Mining NXS with NexusMiner - Revision history

Nhelman64: Corrected Note

2025-09-02T11:02:30Z

Corrected Note

← Older revision		Revision as of 11:02, 2 September 2025
Line 86:		Line 86:
	}		}
	</pre>		</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.'''}}		'''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.		* '''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.

Nhelman64: Replaced with

2025-09-02T10:59:29Z

Replaced <syntaxhighlighting> with <pre>

← Older revision		Revision as of 10:59, 2 September 2025
Line 16:		Line 16:
	'''Linux/Other Users:'''		'''Linux/Other Users:'''
	* Clone the repository:		* Clone the repository:
	<~~syntaxhighlight lang="bash"~~>		<pre>
	git clone https://github.com/Nexusoft/NexusMiner.git		git clone https://github.com/Nexusoft/NexusMiner.git
	cd NexusMiner		cd NexusMiner
	</~~syntaxhighlight~~>		</pre>
	* Build using CMake (see section 6).		* Build using CMake (see section 6).

Line 29:		Line 29:

	; Pool Mining on the Hash Channel (Mainnet Only)		; Pool Mining on the Hash Channel (Mainnet Only)
	<~~syntaxhighlight lang="json"~~>		<pre>
	{		{
	"version" : 1,		"version" : 1,
Line 49:		Line 49:
	]		]
	}		}
	</~~syntaxhighlight~~>		</pre>

	; Solo Mining on the Prime or Hash Channel (Mainnet)		; Solo Mining on the Prime or Hash Channel (Mainnet)
	<~~syntaxhighlight lang="json~~">		<pre">
	{		{
	"version" : 1,		"version" : 1,
Line 67:		Line 67:
	]		]
	}		}
	</~~syntaxhighlight~~>		</pre>

	; Solo Mining on the Prime or Hash Channel (Testnet)		; Solo Mining on the Prime or Hash Channel (Testnet)
	<~~syntaxhighlight lang="json"~~>		<pre>
	{		{
	"version" : 1,		"version" : 1,
Line 85:		Line 85:
	]		]
	}		}
	</~~syntaxhighlight~~>		</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.'''}}		{{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.'''}}

Line 99:		Line 99:
	To enable detailed logging and statistics, add the following to your <code>miner.conf</code>:		To enable detailed logging and statistics, add the following to your <code>miner.conf</code>:

	<~~syntaxhighlight lang="json"~~>		<pre>
	"logfile" : "miner.log",		"logfile" : "miner.log",
	"log_level" : 2,		"log_level" : 2,
Line 115:		Line 115:
	}		}
	],		],
	<~~/syntaxhighlight~~>		<pre>

	----		----
Line 125:		Line 125:
	* Unlock your wallet for mining.		* Unlock your wallet for mining.
	* Edit <code>nexus.conf</code> to enable mining:		* Edit <code>nexus.conf</code> to enable mining:
	<~~syntaxhighlight lang="ini"~~>		<pre>
	mining=1		mining=1
	</~~syntaxhighlight~~>		</pre>
	* If mining '''locally (same machine)''': nothing else is required.		* If mining '''locally (same machine)''': nothing else is required.
	* If mining '''over LAN''': add to <code>nexus.conf</code>:		* If mining '''over LAN''': add to <code>nexus.conf</code>:
	<~~syntaxhighlight lang="ini"~~>		<pre>
	llpallowip=<miner_ip>:<port>		llpallowip=<miner_ip>:<port>
	</~~syntaxhighlight~~>		</pre>
	** On '''mainnet''', the default port is <code>9325</code>.		** On '''mainnet''', the default port is <code>9325</code>.
	** On '''testnet''', the default port is <code>8325</code>.		** On '''testnet''', the default port is <code>8325</code>.
Line 149:		Line 149:
	'''Windows:'''		'''Windows:'''
	* Double-click <code>NexusMiner.exe</code> or run from the command line:		* Double-click <code>NexusMiner.exe</code> or run from the command line:
	<~~syntaxhighlight lang="bash"~~>		<pre>
	NexusMiner.exe		NexusMiner.exe
	</~~syntaxhighlight~~>		</pre>

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

	Example configuration for logging:		Example configuration for logging:
	<~~syntaxhighlight lang="json"~~>		<pre>
	"logfile" : "miner.log",		"logfile" : "miner.log",
	"log_level" : 2,		"log_level" : 2,
Line 191:		Line 191:
	}		}
	]		]
	</~~syntaxhighlight~~>		</pre>

	----		----
Line 200:		Line 200:
	* Requires CMake, C++ compiler, and optionally CUDA Toolkit (for Nvidia GPUs).		* Requires CMake, C++ compiler, and optionally CUDA Toolkit (for Nvidia GPUs).
	* From the repo directory:		* From the repo directory:
	<~~syntaxhighlight lang="bash"~~>		<pre>
	mkdir build		mkdir build
	cd build		cd build
	cmake .. -DWITH_GPU_CUDA=ON # Enable Nvidia GPU mining		cmake .. -DWITH_GPU_CUDA=ON # Enable Nvidia GPU mining
	make		make
	</~~syntaxhighlight~~>		</pre>
	* See repository README for more advanced build options and FPGA instructions.		* See repository README for more advanced build options and FPGA instructions.

Nhelman64: Added version #

2025-09-02T10:51:39Z

Added version #

← Older revision		Revision as of 10:51, 2 September 2025
Line 1:		Line 1:
	= Mining NXS with NexusMiner: Step-by-Step Guide =		= 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).		Welcome to the NexusMiner documentation! This guide will help you get started mining Nexus (NXS) using NexusMiner on supported hardware (FPGA, GPU, CPU).

Nhelman64: New page with instructions for how to mine Nexus

2025-09-02T10:49:26Z

New page with instructions for how to mine Nexus

New page

= 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!'''