Difference between revisions of "NodeCore QuickStart"

From Veriblock Wiki
Jump to: navigation, search
 
(28 intermediate revisions by 4 users not shown)
Line 1: Line 1:
−
See: [[HowTo_run_NodeCore]], [[NodeCore_Operations]], [[NodeCore_Bootstrap_File]]
+
See: [[NodeCore_Operations]], [[NodeCore_Bootstrap_File]], [[TestNet]]
 +
 
 +
See: More details [[HowTo_run_NodeCore]]
  
 
__TOC__
 
__TOC__
  
−
== How to Install ==
+
== Overview ==
  
−
NodeCore should run on ANY OS that supports Java 1.8 (Linux, Windows, Mac...)
+
NodeCore should run on any OS that supports Java 1.8 (Linux, Windows, Mac...) NodeCore is currently supported on Java versions 8 - 14.
  
 
NodeCore is the full node daemon for VeriBlock. Because many common tasks require NodeCore, it should be as easy to get started as possible.
 
NodeCore is the full node daemon for VeriBlock. Because many common tasks require NodeCore, it should be as easy to get started as possible.
Line 23: Line 25:
 
|}
 
|}
  
−
NodeCore has basic hardware needs that most machines will have. It will require disk space to store the full node (say 10GB and growing). See exact details here: [[NodeCore_Operations]]
+
NodeCore has basic hardware needs that most machines will have. It will require disk space to store the full node (say 60GB and growing). See exact details here: [[NodeCore_Operations]]
  
−
===For LINUX===
+
== How to Install ==
−
Download and run this install script (thank you OverCookedPanda):
 
  
−
https://github.com/VeriBlock/nodecore-releases/releases/download/vSetupScripts/nodecore_install.sh
+
===For LINUX (Ubuntu & CentOS) ===
  
−
Besides checking hardware requirements and ensuring necessary software is installed (lie Java 8), the script will automatically:
+
https://github.com/VeriBlock/samples/blob/master/scripts/nodecore-install.sh
 +
 
 +
Besides checking hardware requirements and ensuring necessary software is installed (like Java), the script will automatically:
 +
 
 +
# Get the latest NodeCore software, reading from this url: https://explore.veriblock.org/api/stats/download
 +
# Get the latest Bootstrap block files (you could sync from scratch, but it will be *much* faster to download the bootstrap files)
 +
# Run "nodecore" in a screen using the ~/VeriBlock data directory
  
−
# Get the latest NodeCore software, reading from this url: https://testnet.explore.veriblock.org/api/stats/download
 
−
# Get the latest Bootstrap file, also reading from the above url (you could sync from scratch, but it will be *much* faster to download the bootstrap file)
 
−
# Unzip the bootstrap file and put the nodecore.dat in the bin\testnet folder
 
−
# Set file "nodecore" to have execute permissions
 
−
# Run "nodecore" in a screen
 
  
 
===For WINDOWS===
 
===For WINDOWS===
  
−
There is not yet a one-stop install script, so the above steps will need to be done manually. But it can be done fast:
+
Option 1: Run single automated script. This prompts the correct version of Java, runs the bootstrap downloader, and then kicks off NodeCore and the CLI.
−
# Ensure the correct software installed from here: [[NodeCore_Operations]] (this is standard software, and may already exist)
+
 
−
# Get the latest links: https://testnet.explore.veriblock.org/api/stats/download
+
<pre>
−
# '''nodecore_all_zip''' --> 100mb. Unzip this.
+
initialize_nodecore_with_bootstrap.bat
−
## The download file looks something like https://github.com/VeriBlock/nodecore-releases/releases/download/v0.XX/veriblock-nodecore-all-0.XX.zip
+
</pre>
−
# '''bootstrapfile_zip''' --> several GB. Unzip this, it creates a "nodecore.dat" file, place it in the nodecore\bin\testnet folder. If "testnet" doesn't exist in "bin", then create it. (See: [[NodeCore_Bootstrap_File]] for more details)
+
 
−
## The download file looks something like: http://mirror1.veriblock.org/nodecore-bootstrap-XXXXXX.zip
+
Option 2: Run the manual windows steps:
−
## The end result, there will be a file like "nodecore\bin\testnet\nodecore.dat"
+
 
−
## Reminder that the bootstrap file is not needed - you could sync from scratch - but it will be much faster to sync using the latest bootstrap file
+
# Ensure the correct software installed from here: [[NodeCore_Operations#Windows]] (this is standard software, and may already exist)
 +
# Get the latest package either from https://veriblock.org/#wallet, or download the link from the API:
 +
## https://explore.veriblock.org/api/stats/download
 +
## Get the corresponding link for '''nodecore_all_zip''', such as https://github.com/VeriBlock/nodecore-releases/releases/download/v0.XX/veriblock-nodecore-all-0.XX.zip
 +
# Run '''bootstrapfile_zip''' --> (See: [[Bootstrap_Downloader]] for more details)
 +
## Reminder that the bootstrap block files are not needed - you could sync from scratch - but it will be much faster to sync using the latest bootstrap files
 
# Run nodecore-0.X.X\bin\'''nodecore.bat'''
 
# Run nodecore-0.X.X\bin\'''nodecore.bat'''
 
## Note: you could also run "start.bat", which kicks off the NodeCore_CLI, and run the "startnodecore" command. Both ways do the same thing.
 
## Note: you could also run "start.bat", which kicks off the NodeCore_CLI, and run the "startnodecore" command. Both ways do the same thing.
 +
 +
''NOTE'' - If mainnet folder already exists and you're updating to the more up-to-date bootstrap block files, all other files other than your wallet.dat file should be deleted from the mainnet folder (i.e. delete nodecore.dat, nodecore.dat-shm, nodecore-dat-wal, poolwallet.dat, tcache2.csh, wallet.csh-shm, wallet.csh-wal).  The only files in the mainnet folder should be the new bootstrap file ''nodecore.dat'', ''blocks/'' folder, and your wallet file ''wallet.dat'' prior to starting nodecore.
  
 
===For Mac ===
 
===For Mac ===
Line 72: Line 81:
 
You could run either the NC_CLI or GUI Wallet and connect. For example, click "start.bat" (windows) or "start" (linux) to run the NC_CLI:
 
You could run either the NC_CLI or GUI Wallet and connect. For example, click "start.bat" (windows) or "start" (linux) to run the NC_CLI:
  
−
# connect "connect 127.0.0.1:10501"
+
# connect "connect 127.0.0.1:10500"
 
# run getstateinfo
 
# run getstateinfo
  
Line 81: Line 90:
 
== What Next? ==
 
== What Next? ==
  
−
* Run the [[GUI Wallet]]
+
=== View your wallet ===
−
* Start PoW Mining with a GPU
+
 
−
* Start PoP Mining
+
Note that NodeCore creates a new wallet/address by default. If you run getinfo in the NC_CLI, you'll see the default address ([[NodeCore_CommandLine#getinfo]]).
−
* Start a Community Pool
+
 
 +
# In the NodeCore suite: "veriblock-nodecore-all-0.X.XX", run "start" (linux) or "start.bat" (windows)
 +
# connect to your running instance of NodeCore, such as typing "connect 127.0.0.1:10500"
 +
# type "getinfo"
 +
# By default, a new wallet address is created, and it will have zero balance
 +
 
 +
If this is a new install (bin\mainnet folder is empty), then the NC_CLI should be able to connect to NodeCore within about 10 seconds - i.e. it does not need to fully sync.
 +
 
 +
If restarting NodeCore (bin\mainnet folder has a nodecore.dat file), then it must sync before NC_CLI can connect.
 +
 
 +
<pre>
 +
getinfo
 +
 
 +
#returns info for a specific command
 +
rpc (77.46.106.162:10500) > {
 +
  "payload": {
 +
    "default_address": {
 +
      "address": "VazUQm9TaPmbhTWEi6FYUUPp28Eynq",
 +
      "amount": 187457753607875
 +
    },
 +
</pre>
 +
 
 +
You can also use an offline wallet: [[Offline Wallet CLI]]
 +
 
 +
=== Get more involved ===
 +
 
 +
* Run the GUI Wallet ([[GUI Wallet]])
 +
* Start PoW Mining with a GPU ([[HowTo PoW Mine VeriBlock]])
 +
* Start PoP Mining ([[HowTo_run_PoP_Miner]])
 +
* Start a Community Pool ([[HowTo_run_and_connect_to_PoW_Miner_pool]])
 
* Join the community and help others! https://discord.gg/wJZEjry
 
* Join the community and help others! https://discord.gg/wJZEjry

Latest revision as of 02:13, 11 April 2022

See: NodeCore_Operations, NodeCore_Bootstrap_File, TestNet

See: More details HowTo_run_NodeCore

Overview

NodeCore should run on any OS that supports Java 1.8 (Linux, Windows, Mac...) NodeCore is currently supported on Java versions 8 - 14.

NodeCore is the full node daemon for VeriBlock. Because many common tasks require NodeCore, it should be as easy to get started as possible.

You need NodeCore for You do NOT need NodeCore for
  • Sending coins
  • Creating an address for mining
  • Using a client like the NC_CLI or GUI Wallet
  • Hosting a pool
  • Viewing your address or transactions on the web explorer
  • GPU Mining

NodeCore has basic hardware needs that most machines will have. It will require disk space to store the full node (say 60GB and growing). See exact details here: NodeCore_Operations

How to Install

For LINUX (Ubuntu & CentOS)

https://github.com/VeriBlock/samples/blob/master/scripts/nodecore-install.sh

Besides checking hardware requirements and ensuring necessary software is installed (like Java), the script will automatically:

  1. Get the latest NodeCore software, reading from this url: https://explore.veriblock.org/api/stats/download
  2. Get the latest Bootstrap block files (you could sync from scratch, but it will be *much* faster to download the bootstrap files)
  3. Run "nodecore" in a screen using the ~/VeriBlock data directory


For WINDOWS

Option 1: Run single automated script. This prompts the correct version of Java, runs the bootstrap downloader, and then kicks off NodeCore and the CLI. 

initialize_nodecore_with_bootstrap.bat

Option 2: Run the manual windows steps:

  1. Ensure the correct software installed from here: NodeCore_Operations#Windows (this is standard software, and may already exist)
  2. Get the latest package either from https://veriblock.org/#wallet, or download the link from the API:
    1. https://explore.veriblock.org/api/stats/download
    2. Get the corresponding link for nodecore_all_zip, such as https://github.com/VeriBlock/nodecore-releases/releases/download/v0.XX/veriblock-nodecore-all-0.XX.zip
  3. Run bootstrapfile_zip --> (See: Bootstrap_Downloader for more details)
    1. Reminder that the bootstrap block files are not needed - you could sync from scratch - but it will be much faster to sync using the latest bootstrap files
  4. Run nodecore-0.X.X\bin\nodecore.bat
    1. Note: you could also run "start.bat", which kicks off the NodeCore_CLI, and run the "startnodecore" command. Both ways do the same thing.

NOTE - If mainnet folder already exists and you're updating to the more up-to-date bootstrap block files, all other files other than your wallet.dat file should be deleted from the mainnet folder (i.e. delete nodecore.dat, nodecore.dat-shm, nodecore-dat-wal, poolwallet.dat, tcache2.csh, wallet.csh-shm, wallet.csh-wal). The only files in the mainnet folder should be the new bootstrap file nodecore.dat, blocks/ folder, and your wallet file wallet.dat prior to starting nodecore.

For Mac

There is not yet a one-stop install script, so the above steps will need to be done manually.

Basically, follow the install steps listed above for Windows, namely ensure your system has the software specs (Java), download NodeCore (and optionally the bootstrap file), and execute the bin\nodecore script.


See: HowTo_run_NodeCore for more details

What Success Looks like

A "nodecore" process should be running,

Your NodeCore instance should have created files:

Nodecore quickstart1b.png

You could run either the NC_CLI or GUI Wallet and connect. For example, click "start.bat" (windows) or "start" (linux) to run the NC_CLI:

  1. connect "connect 127.0.0.1:10500"
  2. run getstateinfo

You should see something like so, i.e. a JSON response showing relevant info like the local height and network height:

Nodecore quickstart2.png

What Next?

View your wallet

Note that NodeCore creates a new wallet/address by default. If you run getinfo in the NC_CLI, you'll see the default address (NodeCore_CommandLine#getinfo).

  1. In the NodeCore suite: "veriblock-nodecore-all-0.X.XX", run "start" (linux) or "start.bat" (windows)
  2. connect to your running instance of NodeCore, such as typing "connect 127.0.0.1:10500"
  3. type "getinfo"
  4. By default, a new wallet address is created, and it will have zero balance

If this is a new install (bin\mainnet folder is empty), then the NC_CLI should be able to connect to NodeCore within about 10 seconds - i.e. it does not need to fully sync.

If restarting NodeCore (bin\mainnet folder has a nodecore.dat file), then it must sync before NC_CLI can connect. 

getinfo

#returns info for a specific command
rpc (77.46.106.162:10500) > {
  "payload": {
    "default_address": {
      "address": "VazUQm9TaPmbhTWEi6FYUUPp28Eynq",
      "amount": 187457753607875
    },

You can also use an offline wallet: Offline Wallet CLI

Get more involved

Retrieved from "http://wiki.veriblock.org/index.php?title=NodeCore_QuickStart&oldid=3995"