Difference between revisions of "HowTo run SPV"

From Veriblock Wiki
Jump to: navigation, search
Line 1: Line 1:
  
 
__TOC__
 
__TOC__
 
SPV is currently in BETA, and is not part of an official release.
 
 
Assume there are bugs.
 
  
 
== Overview ==
 
== Overview ==
 
 
NodeCore SPV (Simple Payment Verification) is a light wallet that allows a user to see their balance and send VBK without downloading, syncing, and running a full node.
 
NodeCore SPV (Simple Payment Verification) is a light wallet that allows a user to see their balance and send VBK without downloading, syncing, and running a full node.
  
SPV can run as a separate process, and the NC_CLI can connect to an SPV node.
+
DOWNLOAD: https://mirror1.veriblock.org/veriblock-spv-0.4.9-rc.4.dev.62.zip
 
 
For convenience, a separate package is created by modifying the NC_CLI package that allows one to directly run the SPV.
 
  
== How to Install ==
+
Run veriblock-spv.bat
 
 
Download BETA from here:
 
 
 
* https://mirror.veriblock.org/veriblock-nodecore-spv-0.4.9-dev.79.tar.gz
 
* https://mirror.veriblock.org/veriblock-nodecore-spv-0.4.9-dev.79.zip
 
  
 
Tested on OpenJDK 8, 11, 14, for Windows and Ubuntu Linux
 
Tested on OpenJDK 8, 11, 14, for Windows and Ubuntu Linux
  
== How to Run SPV ==
+
[[File:Spv download 2.png|800px]]
  
# Unzip the package to its own folder
+
== Commands ==
# Run "veriblock-spv.bat" (Windows) or "veriblock-spv" (Linux/Mac)
 
# Wait for the SPV to sync (generally 10 minutes for every 1 million blocks; time will vary)
 
  
This means SPV is ready:
+
SPV has a subset of commands: https://wiki.veriblock.org/index.php/NodeCore_CommandLine
 
 
<pre>
 
SPV is ready. Current blockchain height: 1004200
 
</pre>
 
 
 
Run "help" to see available commands (see [[NodeCore_CommandLine]] for detail on each command):
 
  
 
<pre>
 
<pre>
 +
help
 
Commands:
 
Commands:
 
+
    clear
     disconnect
+
    quit|leave|close|exit
 +
    help|?|/?|h|/h|h?|showcommands
 +
    getbalance|getbal|bal
 +
    getstateinfo|stateinfo|state|getstate
 +
    send|sendtoaddress|sendtoaddr
 +
    lockwallet
 +
    unlockwallet
 +
    decryptwallet
 +
     encryptwallet
 
     importwallet
 
     importwallet
     importprivatekey
+
     backupwallet
    encryptWallet
 
 
     getnewaddress
 
     getnewaddress
    exit
 
    lockWallet
 
    unlockWallet
 
    getstateinfo
 
    getbalance
 
    backupwallet
 
    send
 
    decryptWallet
 
 
</pre>
 
</pre>
  
For example:
+
=== Configuration ===
 
 
<pre>
 
send <amount> <destinationAddress>
 
</pre>
 
  
== Sample Output ==
+
File: application.conf
  
 
<pre>
 
<pre>
Copyright 2017-2020 Xenios SEZC
+
# Default Configuration of VeriBlock SPV
All rights reserved.
+
# Options: mainnet | testnet | alphanet
Distributed under the MIT software license, see the accompanying
+
network: mainnet
file LICENSE or http://www.opensource.org/licenses/mit-license.php.
 
 
 
===[ VeriBlock NodeCore SPV v0.4.9-dev.79 ]===
 
                https://www.veriblock.org/
 
To see available commands, type: help
 
To stay up to date on the status of the VeriBlock Network and
 
ensure you are running the latest software, frequently check:
 
        Discord: https://discord.gg/wJZEjry
 
        VeriBlock Explorer: https://explore.veriblock.org
 
 
 
Waiting for peers response.
 
Waiting for peers response.
 
...
 
Waiting for peers response.
 
Blockchain is downloading. 5899 / 1004234
 
Blockchain is downloading. 15699 / 1004234
 
...
 
Blockchain is downloading. 987859 / 1004254
 
Blockchain is downloading. 995699 / 1004254
 
Blockchain is downloading. 1002559 / 1004254
 
Blockchain is ready. Current height 1004256
 
 
 
Connected to node on 127.0.0.1:10500
 
 
 
(VBK_CLI rpc (127.0.0.1:10500)) > getbalance
 
getbalance
 
{
 
  "confirmed": [
 
    {
 
      "address": "V3t6uFPjRLv9zB5inXdwJqh59fmvad",
 
      "totalAmount": "0.00000000",
 
      "unlockedAmount": "0.00000000",
 
      "lockedAmount": "0.00000000"
 
    }
 
  ],
 
  "total_confirmed": "0.00000000",
 
  "unconfirmed": [],
 
  "total_unconfirmed": "0.00000000"
 
}
 
 
</pre>
 
</pre>
  
== File Structure ==
+
== Appendix ==
  
Running the SPV will create a "data" folder, as well as log and wallet files.
+
=== Known Issues ===
 
 
== Known Issues ==
 
  
 
This is a BETA, and there are several known issues.
 
This is a BETA, and there are several known issues.
 
Ensure that a NodeCore full node is not already running, as it will interfere with NC_CLI connecting to SPV.
 
  
 
SPV does not show locked coins (from MainNet launch). If you have a locked-coin balance, SPV will still show as zero.
 
SPV does not show locked coins (from MainNet launch). If you have a locked-coin balance, SPV will still show as zero.
  
 
Running importwallet may take a few minutes to sync the new wallet.
 
Running importwallet may take a few minutes to sync the new wallet.

Revision as of 19:47, 12 June 2020

Overview

NodeCore SPV (Simple Payment Verification) is a light wallet that allows a user to see their balance and send VBK without downloading, syncing, and running a full node.

DOWNLOAD: https://mirror1.veriblock.org/veriblock-spv-0.4.9-rc.4.dev.62.zip

Run veriblock-spv.bat

Tested on OpenJDK 8, 11, 14, for Windows and Ubuntu Linux

Spv download 2.png

Commands

SPV has a subset of commands: https://wiki.veriblock.org/index.php/NodeCore_CommandLine

help
Commands:
    clear
    quit|leave|close|exit
    help|?|/?|h|/h|h?|showcommands
    getbalance|getbal|bal
    getstateinfo|stateinfo|state|getstate
    send|sendtoaddress|sendtoaddr
    lockwallet
    unlockwallet
    decryptwallet
    encryptwallet
    importwallet
    backupwallet
    getnewaddress

Configuration

File: application.conf

# Default Configuration of VeriBlock SPV
# Options: mainnet | testnet | alphanet 
network: mainnet

Appendix

Known Issues

This is a BETA, and there are several known issues.

SPV does not show locked coins (from MainNet launch). If you have a locked-coin balance, SPV will still show as zero.

Running importwallet may take a few minutes to sync the new wallet.