Difference between revisions of "HowTo run NodeCore"

From Veriblock Wiki
Jump to: navigation, search
 
(22 intermediate revisions by 5 users not shown)
Line 1: Line 1:
See: [[Main_Page]]
+
<languages/>
 +
<translate>
 +
<!--T:1-->
 +
See: [[Main_Page]], [[NodeCore_QuickStart]], [[NodeCore_Operations]], [[Nodecore.properties]], [[TestNet]]
  
 +
<!--T:2-->
 
__TOC__
 
__TOC__
  
== Overview ==
+
== Overview == <!--T:3-->
NodeCore is the service that runs the VBK blockchain. It is written in Java, and runs on Windows, Linux, and mac.
+
NodeCore is the service that runs the VBK blockchain. It is written in Java, and runs on Windows, Linux, and Mac.
  
== Steps ==
+
<!--T:4-->
 +
To see an operations guide for installing NodeCore, see: [[NodeCore_Operations]]
  
 +
<!--T:48-->
 +
To see a quickstart to get NC running fast, see: [[NodeCore_QuickStart]]
 +
 +
<!--T:49-->
 +
To modify the nodecore.properties file, see: [[Nodecore.properties]]
 +
 +
== Steps == <!--T:5-->
 +
 +
<!--T:6-->
 
Unzip the package:
 
Unzip the package:
  
 +
<!--T:7-->
 
{| class="wikitable"
 
{| class="wikitable"
 
! Windows
 
! Windows
Line 17: Line 32:
 
| Unzip to your preferred directory, then run nodecore.
 
| Unzip to your preferred directory, then run nodecore.
  
 +
<!--T:8-->
 
Note: On Linux & Mac systems, you may need to make the nodecore shell script executable by running the following command:
 
Note: On Linux & Mac systems, you may need to make the nodecore shell script executable by running the following command:
  
<pre>chmod a+x nodecore</pre>
+
<!--T:9-->
 
|}
 
|}
  
When you first run NodeCore, it will create several other files in a new testnet folder (nodecore.properties, veriblock.nodecore.log, nodecore.dat, etc...), and load the existing blockchain.
+
<!--T:10-->
 +
When you first run NodeCore, it will create several other files in a new mainnet folder (nodecore.properties, veriblock.nodecore.log, nodecore.dat, etc...), and load the existing blockchain.
 +
 
 +
<!--T:11-->
 +
NodeCore may take several minutes to load all the blocks in the blockchain. See the highest block at https://explore.veriblock.org/network-stats. This shows the number of blocks your local instance must load to be in sync with the chain. NodeCore will create a cache file such that when you restart it they will load faster next time.
 +
 
 +
== FAQ == <!--T:12-->
 +
 
 +
=== What startup flags are available ===
 +
<pre>
 +
-d, description: The data directory where NodeCore generated files reside
 +
-c, description: The configuration file location
 +
</pre>
 +
 
 +
=== How to set NodeCore Log Path ===
 +
 
 +
You can specify log path with an environmental variable "NODECORE_LOG_PATH".
  
NodeCore may take several minutes to load all the blocks in the blockchain. See the highest block at https://TestNet.Explore.Veriblock.org. This shows the number of blocks your local instance must load. NodeCore will create a cache file such that when you restart it they will load faster next time.
+
Example for linux:
  
== FAQ ==
+
<pre>
 +
export NODECORE_LOG_PATH=/home/user/nodecore_logs/
 +
</pre>
  
=== How can block times be negative? ===
+
=== How can block times be negative? === <!--T:13-->
  
 +
<!--T:14-->
 
A negative age indicates the miner's clock was ahead.
 
A negative age indicates the miner's clock was ahead.
  
 +
<!--T:15-->
 
For more background, see: https://en.bitcoin.it/wiki/Block_timestamp
 
For more background, see: https://en.bitcoin.it/wiki/Block_timestamp
  
=== How to upgrade NodeCore and keep your wallet ===
+
=== How to upgrade NodeCore and keep your wallet === <!--T:16-->
  
As a testnet, new versions of NodeCore will be released. Upgrading is relatively fast.
+
<!--T:17-->
 +
Since mainnet is now live, updating is very fast.
  
If you do NOT have a previous wallet/address/balance, then this is easy, just download and run the new NodeCore.
+
<!--T:18-->
 +
If you do NOT have a previous wallet/address/balance download the latest nodecore found here https://explore.veriblock.org/api/stats/download.
  
If you do have a wallet/address/balance that you want to carry over, this is still easy, just make sure you do the following:
+
<!--T:19-->
 +
If you do have a wallet/address/balance that you want to carry over make sure you do the following:
  
# Make sure you have a backup of your wallet! You could copy the testnet folder, or use the [[NodeCore_CommandLine#importwallet]] command from the NC_CLI.
+
<!--T:20-->
# Unzip NodeCore to a new folder location - do not overwrite your previous version
+
# Make sure you have a backup of your wallet! You can copy the mainnet folder which contains your wallet.dat, or use the [[NodeCore_CommandLine#importwallet]] command from the NC_CLI.
 +
# Ensure that you unzip your newlyl downloaded NodeCore to a new folder location - do not overwrite your previous version
 
# In the new version:
 
# In the new version:
## Create a testnet folder (probably in "nodecore-0.X.X\bin")
+
## Create a mainnet folder most likely in the "nodecore-0.X.X/bin" directory.
## Copy in your previous wallet.dat and walletconfig.dat files into "nodecore-0.X.X\bin\testnet".
+
## Copy in your previous wallet.dat and walletconfig.dat files into the "nodecore-0.X.X/bin/mainnet" directory.
# When you run NC_CLI getinfo on the new version, you should see your previous wallet and balance
+
# Run your new version of nodecore and start to sync.
 
+
# When you run NC_CLI getinfo on the new version of the running nodecore, you should see your previous wallet and balance.
[[File:Nodecore_import_1.png|400px]]
 
  
=== How to upgrade NodeCore PoW and keep your Bitcoin testnet wallet ===
+
=== How to upgrade NodeCore PoW and keep your Bitcoin wallet === <!--T:22-->
  
When upgrading your PoP miner, you can copy the file "bitcoin-pop-testnet.wallet" from the bin folder of your current PoP miner directory to the bin folder of your new PoP miner.
+
<!--T:23-->
 +
When upgrading your PoP miner, you can copy the file "bitcoin-pop.wallet" from the bin folder of your current PoP miner directory to the bin folder of your new PoP miner.
  
=== How to specify a data directory for NodeCore ===
+
=== How to specify a data directory for NodeCore === <!--T:24-->
  
NodeCore can take a data directory ~d as part of the startup.
+
<!--T:25-->
 +
NodeCore can take a data directory -d as part of the startup.
  
 +
<!--T:26-->
 
Example for Linux:
 
Example for Linux:
  
 +
<!--T:27-->
 
<pre>
 
<pre>
cd /<myDir>/nodecore-0.1.7/bin
+
cd /<myDir>/nodecore-0.4.10/bin
./nodecore -d ~/data/ > /dev/null 2>&1 &
+
./nodecore -d /home/user/data/
 
</pre>
 
</pre>
  
# nodecore.properties will be in ~/data/nodecore.properties
+
<!--T:28-->
# /testnet folder will be in ~/data/testnet
+
# nodecore.properties will be in /home/user/data/nodecore.properties
 +
# /mainnet folder will be in /home/user/data/mainnet
 
</pre>
 
</pre>
  
 +
<!--T:29-->
 
Example for Windows
 
Example for Windows
  
 +
<!--T:30-->
 
<pre>
 
<pre>
cd <myDir>\nodecore-0.2.1-r2\bin
+
cd <myDir>\nodecore-0.4.10\bin
 
nodecore.bat -d C:\data
 
nodecore.bat -d C:\data
  
 +
<!--T:31-->
 
# nodecore.properties will be in C:\data\nodecore.properties
 
# nodecore.properties will be in C:\data\nodecore.properties
# /testnet folder will be in C:\data\testnet
+
# /mainnet folder will be in C:\data\mainnet
 +
</pre>
 +
 
 +
=== How to send from a specific address? === <!--T:32-->
 +
https://wiki.veriblock.org/index.php?title=NodeCore_CommandLine#send <br />
 +
<pre>
 +
send <amount> <destinationAddress> [sourceAddress]
 
</pre>
 
</pre>
  
== Troubleshooting ==
+
===How to set NodeCore log level=== <!--T:50-->
  
=== NodeCore is stuck on a block ===
+
<!--T:51-->
 +
Currently NodeCore log level can be set through the NODECORE_LOG_LEVEL process environmental variable. Once set, NodeCore needs to be restarted.
  
 +
<!--T:52-->
 +
The default is "INFO", which can create very large log files.
 +
 +
<!--T:53-->
 +
This impacts the "veriblock.nodecore.*.log" (which is the biggest log file). It does not affect the other, much smaller, log files.
 +
 +
<!--T:54-->
 +
WINDOWS
 +
 +
<!--T:55-->
 +
This is an example of setting it in Windows, and then starting NodeCore:
 +
 +
<!--T:56-->
 +
<pre>
 +
set NODECORE_LOG_LEVEL=WARN
 +
echo %NODECORE_LOG_LEVEL%
 +
nodecore.bat
 +
</pre>
 +
 +
<!--T:57-->
 +
LINUX
 +
 +
<!--T:58-->
 +
Run in same session, such as a screen:
 +
 +
<!--T:59-->
 +
<pre>
 +
export NODECORE_LOG_LEVEL=WARN
 +
echo $NODECORE_LOG_LEVEL
 +
./nodecore
 +
</pre>
 +
 +
== Troubleshooting == <!--T:36-->
 +
 +
=== NodeCore is stuck on a block === <!--T:37-->
 +
 +
<!--T:38-->
 
Ideally this should not happen, but if it does first try restarting NodeCore.
 
Ideally this should not happen, but if it does first try restarting NodeCore.
  
=== Java out-of-memory ===
+
=== Java out-of-memory === <!--T:39-->
  
 +
<!--T:40-->
 
It is possible that you only have a 32-bit version of Java installed. 64-bit is highly recommended.
 
It is possible that you only have a 32-bit version of Java installed. 64-bit is highly recommended.
  
 +
<!--T:41-->
 
Modify the start file (nodecore.bat for windows, nodecore for linux) to increase the memory limit. Pass in a value, such as "1024 MB" into the DEFAULT_JVM_OPTS variable:
 
Modify the start file (nodecore.bat for windows, nodecore for linux) to increase the memory limit. Pass in a value, such as "1024 MB" into the DEFAULT_JVM_OPTS variable:
  
 +
<!--T:42-->
 
<pre>
 
<pre>
 
DEFAULT_JVM_OPTS=-Xmx1024m
 
DEFAULT_JVM_OPTS=-Xmx1024m
 
</pre>
 
</pre>
  
=== NodeCore keeps turning off with "Application exit"  ===
+
=== NodeCore keeps turning off with "Application exit"  === <!--T:43-->
  
 +
<!--T:44-->
 
If messages like:
 
If messages like:
 
<pre>
 
<pre>
Line 103: Line 198:
 
</pre>
 
</pre>
  
 +
<!--T:45-->
 
Then something external is shutting off NodeCore (such as a server restart, external process kill, or something else).
 
Then something external is shutting off NodeCore (such as a server restart, external process kill, or something else).
  
=== Having trouble on a mac ===
+
=== Having trouble on a mac === <!--T:46-->
 +
 
 +
<!--T:47-->
 +
On a Mac, you need to install OpenJDK, our releases are tested on the LTS versions here -> https://adoptopenjdk.net/
  
On a Mac, you need to install the JDK (Java Development Kit) instead of just the JRE: http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html
+
</translate>

Latest revision as of 21:20, 5 November 2020

Other languages:

See: Main_Page, NodeCore_QuickStart, NodeCore_Operations, Nodecore.properties, TestNet

Overview

NodeCore is the service that runs the VBK blockchain. It is written in Java, and runs on Windows, Linux, and Mac.

To see an operations guide for installing NodeCore, see: NodeCore_Operations

To see a quickstart to get NC running fast, see: NodeCore_QuickStart

To modify the nodecore.properties file, see: Nodecore.properties

Steps

Unzip the package:

Windows Mac and Linux
Unzip the nodecore-*.zip file In the bin folder, then run nodecore.bat Unzip to your preferred directory, then run nodecore.

Note: On Linux & Mac systems, you may need to make the nodecore shell script executable by running the following command:

When you first run NodeCore, it will create several other files in a new mainnet folder (nodecore.properties, veriblock.nodecore.log, nodecore.dat, etc...), and load the existing blockchain.

NodeCore may take several minutes to load all the blocks in the blockchain. See the highest block at https://explore.veriblock.org/network-stats. This shows the number of blocks your local instance must load to be in sync with the chain. NodeCore will create a cache file such that when you restart it they will load faster next time.

FAQ

What startup flags are available

-d, description: The data directory where NodeCore generated files reside
-c, description: The configuration file location

How to set NodeCore Log Path

You can specify log path with an environmental variable "NODECORE_LOG_PATH".

Example for linux:

export NODECORE_LOG_PATH=/home/user/nodecore_logs/

How can block times be negative?

A negative age indicates the miner's clock was ahead.

For more background, see: https://en.bitcoin.it/wiki/Block_timestamp

How to upgrade NodeCore and keep your wallet

Since mainnet is now live, updating is very fast.

If you do NOT have a previous wallet/address/balance download the latest nodecore found here https://explore.veriblock.org/api/stats/download.

If you do have a wallet/address/balance that you want to carry over make sure you do the following:

  1. Make sure you have a backup of your wallet! You can copy the mainnet folder which contains your wallet.dat, or use the NodeCore_CommandLine#importwallet command from the NC_CLI.
  2. Ensure that you unzip your newlyl downloaded NodeCore to a new folder location - do not overwrite your previous version
  3. In the new version:
    1. Create a mainnet folder most likely in the "nodecore-0.X.X/bin" directory.
    2. Copy in your previous wallet.dat and walletconfig.dat files into the "nodecore-0.X.X/bin/mainnet" directory.
  4. Run your new version of nodecore and start to sync.
  5. When you run NC_CLI getinfo on the new version of the running nodecore, you should see your previous wallet and balance.

How to upgrade NodeCore PoW and keep your Bitcoin wallet

When upgrading your PoP miner, you can copy the file "bitcoin-pop.wallet" from the bin folder of your current PoP miner directory to the bin folder of your new PoP miner.

How to specify a data directory for NodeCore

NodeCore can take a data directory -d as part of the startup.

Example for Linux:

cd /<myDir>/nodecore-0.4.10/bin
./nodecore -d /home/user/data/
  1. nodecore.properties will be in /home/user/data/nodecore.properties
  2. /mainnet folder will be in /home/user/data/mainnet

Example for Windows

cd <myDir>\nodecore-0.4.10\bin
nodecore.bat -d C:\data

# nodecore.properties will be in C:\data\nodecore.properties
# /mainnet folder will be in C:\data\mainnet

How to send from a specific address?

https://wiki.veriblock.org/index.php?title=NodeCore_CommandLine#send

send <amount> <destinationAddress> [sourceAddress]

How to set NodeCore log level

Currently NodeCore log level can be set through the NODECORE_LOG_LEVEL process environmental variable. Once set, NodeCore needs to be restarted.

The default is "INFO", which can create very large log files.

This impacts the "veriblock.nodecore.*.log" (which is the biggest log file). It does not affect the other, much smaller, log files.

WINDOWS

This is an example of setting it in Windows, and then starting NodeCore:

set NODECORE_LOG_LEVEL=WARN
echo %NODECORE_LOG_LEVEL%
nodecore.bat

LINUX

Run in same session, such as a screen:

export NODECORE_LOG_LEVEL=WARN
echo $NODECORE_LOG_LEVEL
./nodecore

Troubleshooting

NodeCore is stuck on a block

Ideally this should not happen, but if it does first try restarting NodeCore.

Java out-of-memory

It is possible that you only have a 32-bit version of Java installed. 64-bit is highly recommended.

Modify the start file (nodecore.bat for windows, nodecore for linux) to increase the memory limit. Pass in a value, such as "1024 MB" into the DEFAULT_JVM_OPTS variable:

DEFAULT_JVM_OPTS=-Xmx1024m

NodeCore keeps turning off with "Application exit"

If messages like:

INFO [main] n.Program [Program.java:133] Application exit

Then something external is shutting off NodeCore (such as a server restart, external process kill, or something else).

Having trouble on a mac

On a Mac, you need to install OpenJDK, our releases are tested on the LTS versions here -> https://adoptopenjdk.net/