Difference between revisions of "NodeCore QuickStart"

From Veriblock Wiki
Jump to: navigation, search
m (missed a couple more 'test', changed to 'main')
(→‎General Process: added NOTE for when copying a new bootstrap file into mainnet folder to delete all other files there but wallet.dat)
Line 39: Line 39:
 
## Note: you could also run "start" or "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" or "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 moving/copying a more up-to-date nodecore.dat bootstrap file into the mainnet folder, all other files other than your wallet.dat file should be deleted from the mainnet folder (i.e. delete 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'' and your wallet file ''wallet.dat'' prior to starting nodecore
  
 
===For LINUX===
 
===For LINUX===

Revision as of 03:44, 19 April 2019

See: HowTo_run_NodeCore, NodeCore_Operations, NodeCore_Bootstrap_File

How to Install

NodeCore should run on any OS that supports Java 1.8 (Linux, Windows, Mac...)

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 10GB and growing). See exact details here: NodeCore_Operations


General Process

  1. Ensure the correct software installed from here: NodeCore_Operations (this is standard software, and may already exist)
  2. Get the latest links: https://explore.veriblock.org/api/stats/download
  3. nodecore_all_zip --> 100mb. Unzip this.
    1. The download file looks something like https://github.com/VeriBlock/nodecore-releases/releases/download/v0.XX/veriblock-nodecore-all-0.XX.zip
  4. bootstrapfile_zip --> several GB. Unzip this, it creates a "nodecore.dat" file, place it in the nodecore\bin\mainnet folder. If "mainnet" doesn't exist in "bin", then create it. (See: NodeCore_Bootstrap_File for more details)
    1. The download file looks something like: http://mirror1.veriblock.org/nodecore-bootstrap-XXXXXX.zip
    2. The end result, there will be a file like "nodecore\bin\mainnet\nodecore.dat"
    3. 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
  5. Run the startup script (such as "nodecore-0.X.X\bin\nodecore.bat" for Windows)
    1. Note: you could also run "start" or "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 moving/copying a more up-to-date nodecore.dat bootstrap file into the mainnet folder, all other files other than your wallet.dat file should be deleted from the mainnet folder (i.e. delete 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 and your wallet file wallet.dat prior to starting nodecore

For LINUX

A community member committed this script (thank you OverCookedPanda) [DISCLAIMER: this is a community script]:

https://github.com/overcookedpanda/veriblock-scripts/blob/master/vbkinstall.sh

Besides checking hardware requirements and ensuring necessary software is installed (lie Java 8), 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 file, also reading from the above url (you could sync from scratch, but it will be *much* faster to download the bootstrap file)
  3. Unzip the bootstrap file and put the nodecore.dat in the bin\mainnet folder
  4. Set file "nodecore" to have execute permissions
  5. Run "nodecore" in a screen

For WINDOWS

A community member committed this powershell script (thank you KernelPanick) [DISCLAIMER: this is a community script]:

https://gist.github.com/gsxryan/20795e55d1e8ef079e42062656cc7eea

Manual Windows steps:

  1. Ensure the correct software installed from here: NodeCore_Operations (this is standard software, and may already exist)
  2. Get the latest links: https://explore.veriblock.org/api/stats/download
  3. nodecore_all_zip --> 100mb. Unzip this.
    1. The download file looks something like https://github.com/VeriBlock/nodecore-releases/releases/download/v0.XX/veriblock-nodecore-all-0.XX.zip
  4. bootstrapfile_zip --> several GB. Unzip this, it creates a "nodecore.dat" file, place it in the nodecore\bin\mainnet folder. If "mainnet" doesn't exist in "bin", then create it. (See: NodeCore_Bootstrap_File for more details)
    1. The download file looks something like: http://mirror1.veriblock.org/nodecore-bootstrap-XXXXXX.zip
    2. The end result, there will be a file like "nodecore\bin\mainnet\nodecore.dat"
    3. 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
  5. 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.

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
    },

Get more involved

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