README.md

   1 ## VerusCoin version 0.6.5-dev-42
   2
   3 Arguably the world's most advanced technology, zero knowledge privacy-centric blockchain, Verus Coin brings Sapling performance and zero knowledge features to an intelligent system with interchain smart contracts and a completely original, combined proof of stake/proof of work consensus algorithm that solves the nothing at stake problem. With this and its approach towards CPU mining and ASICs, Verus Coin strives to be one of the most naturally decentralizing and attack resistant blockchains in existence.
   4
   5 We have added a variation of a zawy12, lwma difficulty algorithm, a new CPU-optimized hash algorithm and a new algorithm for fair proof of stake. We describe these changes and vision going forward in a [our Phase I white paper](http://185.25.51.16/papers/VerusPhaseI.pdf) and [our Vision](http://185.25.51.16/papers/VerusVision.pdf).
   6
   7 Also see our [VerusCoin web site](https://veruscoin.io/) and [VerusCoin Explorer](https://explorer.veruscoin.io/).
   8
   9 ## VerusCoin
  10 This software is the VerusCoin client. Generally, you will use this if you want to mine VRSC or setup a full node. When you run the wallet it launches komodod automatically. On first launch it downloads Zcash parameters, roughly 1GB, which is mildly slow.
  11
  12 The wallet downloads and stores the block chain or asset chain of the coin you select. It downloads and stores the entire history of the coins transactions; depending on the speed of your computer and network connection, the synchronization process could take a day or more once the blockchain has reached a significant size.
  13
  14 ## Development Resources
  15 - VerusCoin:[https://veruscoin.io/](https://veruscoin.io/) Wallets and CLI tools
  16 - Komodo Web: [https://komodoplatform.com/](https://komodoplatform.com/)
  17 - Organization web: [https://komodoplatform.com/](https://komodoplatform.com/)
  18 - Forum: [https://forum.komodoplatform.com/](https://forum.komodoplatform.com/)
  19 - Mail: [[email protected]](mailto:[email protected])
  20 - Support: [https://support.komodoplatform.com/support/home](https://support.komodoplatform.com/support/home)
  21 - Knowledgebase & How-to: [https://komodoplatform.atlassian.net/wiki/spaces/KPSD/pages](https://komodoplatform.atlassian.net/wiki/spaces/KPSD/pages)
  22 - API references: [http://docs.komodoplatform.com/](http://docs.komodoplatform.com/)
  23 - Blog: [http://blog.komodoplatform.com/](http://blog.komodoplatform.com/)
  24 - Whitepaper: [Komodo Whitepaper](https://komodoplatform.com/wp-content/uploads/2018/03/2018-03-12-Komodo-White-Paper-Full.pdf)
  25 - Komodo Platform public material: [Komodo Platform public material](https://docs.google.com/document/d/1AbhWrtagu4vYdkl-vsWz-HSNyNvK-W-ZasHCqe7CZy0)
  26
  27 ## List of Komodo Platform Technologies
  28
  29 - Delayed Proof of Work (dPoW) - Additional security layer and Komodos own consensus algorithm.
  30 - zk-SNARKs - Komodo Platform's privacy technology for shielded transactions
  31 - Tokens/Assets Technology - create "colored coins" on the Komodo Platform and use them as a layer for securites
  32 - Reward API - Komodo CC technology for securities
  33 - CC - Crypto Conditions to realize "smart contract" logic on top of the Komodo Platform
  34 - Jumblr - Decentralized tumbler for KMD and other cryptocurrencies
  35 - Assetchains - Create your own Blockchain that inherits all Komodo Platform functionalities and blockchain interoperability
  36 - Pegged Assets - Chains that maintain a peg to fiat currencies
  37 - Peerchains - Scalability solution where sibling chains form a network of blockchains
  38 - More in depth covered [here](https://docs.google.com/document/d/1AbhWrtagu4vYdkl-vsWz-HSNyNvK-W-ZasHCqe7CZy0)
  39 - Also note you receive 5% APR on your holdings.
  40 [See this article for more details](https://komodoplatform.atlassian.net/wiki/spaces/KPSD/pages/20480015/Claim+KMD+Interest+in+Agama)
  41
  42 ## Tech Specification
  43 - Launch Date May 21, 2018
  44 - Max Supply: 83,540,184 VRSC
  45 - Block Time: 1M
  46 - Block Reward: variable 24 on December 20, 2018
  47 - Mining Algorithm: VerusHash 2.0
  48 - Consensus 50% PoW, 50% PoS
  49 - Transaction Fee 0.0001
  50 - Privacy: Zcash Sprout
  51 - Komodo Platform with dPOW
  52 - CheatCatcher distributed stake cheating detector
  53
  54 ## About this Project
  55 VerusCoin is based on Komodo which is based on Zcash and has been extended by our innovative consensus staking and mining algorithms and a novel 50% PoW/50% PoS approach.
  56
  57 Many VRSC innovations are now also available back in the Komodo fork:
  58 - Eras
  59 - Timelocking
  60 - VerusHash
  61 - VerusPoS
  62 - 50% PoS/50% PoW
  63
  64  More details including a link to our vision and white papers and client downloads are [available on our web site](https://veruscoin.io)
  65
  66 ## Getting started
  67
  68 ### Dependencies
  69
  70 ```shell
  71 #The following packages are needed:
  72 sudo apt-get install build-essential pkg-config libc6-dev m4 g++-multilib autoconf libtool ncurses-dev unzip git python python-zmq zlib1g-dev wget bsdmainutils automake curl
  73 ```
  74
  75 ARMv8 cross-compile
  76 ```shell
  77 #The following packages are needed:
  78 sudo apt-get install build-essential pkg-config linux-libc-dev-arm64-cross m4 autoconf g++-aarch64-linux-gnu binutils-aarch64-linux-gnu libtool ncurses-dev unzip git python python-zmq zlib1g-dev wget bsdmainutils automake curl
  79 ```
  80 Windows cross-compile
  81 ```shell
  82 #The following packages are needed:
  83 sudo apt-get install autoconf automake autogen bsdmainutils cmake curl git libc6-dev libcap-dev libdb++-dev libqrencode-dev libprotobuf-dev libssl-dev libtool libz-dev libbz2-dev m4 make mingw-w64 ncurses-dev pkg-config protobuf-compiler python python-zmq unzip wget zip zlib1g-dev
  84 ```
  85
  86 Building
  87 --------
  88
  89 First time you'll need to get assorted startup values downloaded. This takes a moderate amount of time once but then does not need to be repeated unless you bring a new system up. The command is:
  90 ```
  91 zcutil/fetch-params.sh
  92 ```
  93 Building for Linux:
  94 ```
  95 zcutil/build.sh
  96 ```
  97 Building for Mac OS/X (see README-MAC.md):
  98 ```
  99 zcutil/build-mac.sh
 100 ```
 101 Building for Windows:
 102 ```
 103 zcutil/build-win.sh
 104 ```
 105 VerusCoin
 106 ------
 107 We develop on dev and some other branches and produce releases of of the master branch, using pull requests to manage what goes into master. The dev branch is considered the bleeding edge codebase, and may even be oncompatible from time to time, while the master-branch is considered tested (unit tests, runtime tests, functionality). At no point of time do the Komodo Platform developers or Verus Developers take any responsibility for any damage out of the usage of this software.
 108
 109 Verus builds for all operating systems out of the same codebase. Follow the OS specific instructions from below.
 110
 111 #### Linux
 112 ```shell
 113 git clone https://github.com/VerusCoin/VerusCoin
 114 cd VerusCoin
 115 #you might want to: git checkout <branch>; git pull
 116 ./zcutil/fetch-params.sh
 117 # -j8 = using 8 threads for the compilation - replace 8 with number of threads you want to use
 118 ./zcutil/build.sh -j8
 119 #This can take some time.
 120 ```
 121 #### Linux ARMv8 Cross-compile
 122 ```shell
 123 git clone https://github.com/VerusCoin/VerusCoin
 124 cd VerusCoin
 125 #you might want to: git checkout <branch>; git pull
 126 ./zcutil/fetch-params.sh
 127 # -j8 = using 8 threads for the compilation - replace 8 with number of threads you want to use
 128 HOST= aarch64-linux-gnu ./zcutil/build.sh -j8
 129 #This can take some time.
 130 ```
 131 **The VerusCoin project and protocol is experimental and a work-in-progress.** Use this source code and software at your own risk.
 132
 133 #To view all commands
 134 ./src/verus help
 135
 136 #To view komodod output:
 137 tail -f ~/.komodo/debug.log
 138 #To view VRSC output:
 139 tail -f ~/.komodo/VRSC/debug.log
 140 Note that this directory is correct for Linux, not Mac or Windows. Coin info for Verus is stored in ~/.komodo/VRSC under Ubuntu/Linux.
 141
 142 For Windows coin info for Verus is stored under \Users<username>\AppData\Roaming\Komodo\VRSC
 143
 144 For Mac coin info for Verus is stored under ~/Library/Application\ Support/Komodo/VRSC
 145
 146 **Zcash is unfinished and highly experimental.** Use at your own risk.
 147
 148 Always back your wallets up carefully and securely, **especially before attempting the following process**
 149
 150 In some cases, messed up wallets can be recovered using this process
 151
 152 - backup wallet.dat safely and securely
 153 - backup all privkeys (launch komodod with `-exportdir=<path>` and `dumpwallet`)
 154 - start a totally new sync including `wallet.dat`, launch with same `exportdir`
 155 - stop it before it gets too far and import all the privkeys from a) using `verus importwallet filename`
 156 - resume sync till it gets to chaintip
 157
 158 For example:
 159 ```shell
 160 ./verusd -exportdir=/tmp &
 161 ./verus dumpwallet example
 162 ./verus stop
 163 mv ~/.komodo/VRSC ~/.komodo/VRSC.old && mkdir ~/.komodo/VRSC && cp ~/.komodo/VRSC.old/VRSC.conf ~/.komodo/VRSC.old/peers.dat ~/.komodo/VRSC
 164 ./verusd -exchange -exportdir=/tmp &
 165 ./verus importwallet /tmp/example
 166 ```
 167 ---
 168
 169
 170 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 171
 172 The above copyright notices and this permission notice shall be included in all copies or substantial portions of the Software.
 173
 174 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 175