README.md

   1 ## VerusCoin version 0.6+ unstable PBaaS branch
   2
   3 This branch cannot yet be expected to work, but it may.
   4
   5 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.
   6
   7 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).
   8
   9 Also see our [VerusCoin web site](https://veruscoin.io/) and [VerusCoin Explorer](https://explorer.veruscoin.io/).
  10
  11 ## VerusCoin
  12 This software is the VerusCoin enhanced Komodo 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.
  13
  14 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.
  15
  16 ## Development Resources
  17 - VerusCoin:[https://veruscoin.io/](https://veruscoin.io/) Wallets and CLI tools
  18 - Komodo Web: [https://komodoplatform.com/](https://komodoplatform.com/)
  19 - Organization web: [https://komodoplatform.com/](https://komodoplatform.com/)
  20 - Forum: [https://forum.komodoplatform.com/](https://forum.komodoplatform.com/)
  21 - Mail: [[email protected]](mailto:[email protected])
  22 - Support: [https://support.komodoplatform.com/support/home](https://support.komodoplatform.com/support/home)
  23 - Knowledgebase & How-to: [https://komodoplatform.atlassian.net/wiki/spaces/KPSD/pages](https://komodoplatform.atlassian.net/wiki/spaces/KPSD/pages)
  24 - API references: [http://docs.komodoplatform.com/](http://docs.komodoplatform.com/)
  25 - Blog: [http://blog.komodoplatform.com/](http://blog.komodoplatform.com/)
  26 - Whitepaper: [Komodo Whitepaper](https://komodoplatform.com/wp-content/uploads/2018/03/2018-03-12-Komodo-White-Paper-Full.pdf)
  27 - Komodo Platform public material: [Komodo Platform public material](https://docs.google.com/document/d/1AbhWrtagu4vYdkl-vsWz-HSNyNvK-W-ZasHCqe7CZy0)
  28
  29 ## List of Komodo Platform Technologies
  30
  31 - Delayed Proof of Work (dPoW) - Additional security layer and Komodos own consensus algorithm.
  32 - zk-SNARKs - Komodo Platform's privacy technology for shielded transactions
  33 - Tokens/Assets Technology - create "colored coins" on the Komodo Platform and use them as a layer for securites
  34 - Reward API - Komodo CC technology for securities
  35 - CC - Crypto Conditions to realize "smart contract" logic on top of the Komodo Platform
  36 - Jumblr - Decentralized tumbler for KMD and other cryptocurrencies
  37 - Assetchains - Create your own Blockchain that inherits all Komodo Platform functionalities and blockchain interoperability
  38 - Pegged Assets - Chains that maintain a peg to fiat currencies
  39 - Peerchains - Scalability solution where sibling chains form a network of blockchains
  40 - More in depth covered [here](https://docs.google.com/document/d/1AbhWrtagu4vYdkl-vsWz-HSNyNvK-W-ZasHCqe7CZy0)
  41 - Also note you receive 5% APR on your holdings.
  42 [See this article for more details](https://komodoplatform.atlassian.net/wiki/spaces/KPSD/pages/20480015/Claim+KMD+Interest+in+Agama)
  43
  44 ## Tech Specification
  45 - Launch Date May 21, 2018
  46 - Max Supply: 83,540,184 VRSC
  47 - Block Time: 1M
  48 - Block Reward: variable 24 on December 20, 2018
  49 - Mining Algorithm: VerusHash 2.0
  50 - Consensus 50% PoW, 50% PoS
  51 - Transaction Fee 0.0001
  52 - Privacy: Zcash Sprout
  53 - Komodo Platform with dPOW
  54 - CheatCatcher distributed stake cheating detector
  55
  56 ## About this Project
  57 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.
  58
  59 Many VRSC innovations are now also available back in the Komodo fork:
  60 - Eras
  61 - Timelocking
  62 - VerusHash
  63 - VerusPoS
  64 - 50% PoS/50% PoW
  65
  66  More details including a link to our vision and white papers and client downloads are [available on our web site](https://veruscoin.io)
  67
  68 ## Getting started
  69
  70 ### Dependencies
  71
  72 ```shell
  73 #The following packages are needed:
  74 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 libcurl4-gnutls-dev bsdmainutils automake curl
  75 ```
  76
  77
  78 Building
  79 --------
  80
  81 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:
  82 ```
  83 zcutil/fetch-params.sh
  84 ```
  85 Building for Ubuntu/Mint/Debian:
  86 ```
  87 zcutil/build.sh
  88 ```
  89 Building for Mac OS/X (see README-MAC.md):
  90 ```
  91 zcutil/build-mac.sh
  92 ```
  93 Building for Windows:
  94 ```
  95 zcutil/build-win.sh
  96 ```
  97 VerusCoin
  98 ------
  99 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.
 100
 101 Verus builds for all operating systems out of the same codebase. Follow the OS specific instructions from below.
 102
 103 #### Linux
 104 ```shell
 105 git clone https://github.com/VerusCoin/VerusCoin
 106 cd VerusCoin
 107 #you might want to: git checkout <branch>; git pull
 108 ./zcutil/fetch-params.sh
 109 # -j8 = using 8 threads for the compilation - replace 8 with number of threads you want to use
 110 ./zcutil/build.sh -j8
 111 #This can take some time.
 112 ```
 113
 114 **The VerusCoin enhanced komodo is experimental and a work-in-progress.** Use at your own risk.
 115
 116 #To view all commands
 117 ./src/komodo-cli help
 118
 119 #To view komodod output:
 120 tail -f ~/.komodo/debug.log
 121 #To view VRSC output:
 122 tail -f ~/.komodo/VRSC/debug.log
 123 Note that this directory is correct for Linux, not Mac or Windows. Coin info for Verus is stored in ~/.komodo/VRSC under Ubuntu/Linux.
 124
 125 For Windows coin info for Verus is stored under \Users<username>\AppData\Roaming\Komodo\VRSC
 126
 127 For Mac coin info for Verus is stored under ~/Library/Application\ Support/Komodo/VRSC
 128
 129 **Zcash is unfinished and highly experimental.** Use at your own risk.
 130
 131 Always back your wallets up carefully and securely, **especially before attempting the following process**
 132
 133 In some cases, messed up wallets can be recovered using this process
 134
 135 - backup wallet.dat safely and securely
 136 - backup all privkeys (launch komodod with `-exportdir=<path>` and `dumpwallet`)
 137 - start a totally new sync including `wallet.dat`, launch with same `exportdir`
 138 - stop it before it gets too far and import all the privkeys from a) using `komodo-cli importwallet filename`
 139 - resume sync till it gets to chaintip
 140
 141 For example:
 142 ```shell
 143 ./verusd -exportdir=/tmp &
 144 ./verus dumpwallet example
 145 ./verus stop
 146 mv ~/.komodo/VRSC ~/.komodo/VRSC.old && mkdir ~/.komodo/VRSC && cp ~/.komodo/VRSC.old/VRSC.conf ~/.komodo/VRSC.old/peers.dat ~/.komodo/VRSC
 147 ./verusd -exchange -exportdir=/tmp &
 148 ./verus importwallet /tmp/example
 149 ```
 150 ---
 151
 152
 153 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:
 154
 155 The above copyright notices and this permission notice shall be included in all copies or substantial portions of the Software.
 156
 157 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.
 158