]> Git Repo - VerusCoin.git/blobdiff - README.md
Save build artifacts on deploy
[VerusCoin.git] / README.md
index 3b0e4d4f9dba1382d86274477765066c16236874..68f26cbde4cb5ff6a10db50d90ba9b2aab8b670f 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,15 +1,16 @@
-## VerusCoin version 0.4.0b
+## VerusCoin version 0.6+ unstable PBaaS branch
 
-VerusCoin is a new, mineable and stakeable cryptocurrency. It is a live fork of Komodo that retains its Zcash lineage and improves it. VerusCoin will leverage the Komodo platform and dPoW notarization for enhanced security and cross-chain interoperability. 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).
-- [VerusCoin web site https://veruscoin.io/ Wallets and CLI tools](https://veruscoin.io/)
-- [VerusCoin Explorer](https://explorer.veruscoin.io/)
+This branch cannot yet be expected to work, but it may.
 
+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.
 
-## Komodo with Bitcore
-This version of Komodo contains Bitcore support for komodo and all its assetchains.
+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).
+
+Also see our [VerusCoin web site](https://veruscoin.io/) and [VerusCoin Explorer](https://explorer.veruscoin.io/).
+
+## VerusCoin
+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.
 
-## Komodod
-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.
 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.
 
 ## Development Resources
@@ -41,13 +42,28 @@ The wallet downloads and stores the block chain or asset chain of the coin you s
 [See this article for more details](https://komodoplatform.atlassian.net/wiki/spaces/KPSD/pages/20480015/Claim+KMD+Interest+in+Agama)
 
 ## Tech Specification
-- Max Supply: 200 million KMD.
-- Block Time: 1M 2s
-- Block Reward: 3KMD
-- Mining Algorithm: Equihash
+- Launch Date May 21, 2018
+- Max Supply: 83,540,184 VRSC
+- Block Time: 1M
+- Block Reward: variable 24 on December 20, 2018
+- Mining Algorithm: VerusHash 2.0
+- Consensus 50% PoW, 50% PoS
+- Transaction Fee 0.0001
+- Privacy: Zcash Sprout
+- Komodo Platform with dPOW
+- CheatCatcher distributed stake cheating detector
 
 ## About this Project
-Komodo is based on Zcash and has been extended by our innovative consensus algorithm called dPoW which utilizes Bitcoin's hashrate to store Komodo blockchain information into the Bitcoin blockchain. Other new and native Komodo features are the privacy technology called JUMBLR, our assetchain capabilities (one click plug and play blockchain solutions) and a set of financial decentralization and interoperability technologies. More details are available under https://komodoplatform.com/ and https://blog.komodoplatform.com.
+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.
+
+Many VRSC innovations are now also available back in the Komodo fork:
+- Eras
+- Timelocking
+- VerusHash
+- VerusPoS
+- 50% PoS/50% PoW
+ More details including a link to our vision and white papers and client downloads are [available on our web site](https://veruscoin.io)
 
 ## Getting started
 
@@ -55,7 +71,7 @@ Komodo is based on Zcash and has been extended by our innovative consensus algor
 
 ```shell
 #The following packages are needed:
-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
+sudo apt-get install build-essential pkg-config libc6-dev m4 g++-multilib autoconf libcurl4-openssl-dev libtool ncurses-dev unzip git python python-zmq zlib1g-dev wget bsdmainutils automake curl
 ```
 
 
@@ -64,23 +80,23 @@ Building
 
 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:
 ```
-./zcutil/fetch-params.sh
+zcutil/fetch-params.sh
 ```
-Building for Ubunutu/Mint:
+Building for Linux:
 ```
-./zcutil/build.sh
+zcutil/build.sh
 ```
 Building for Mac OS/X (see README-MAC.md):
 ```
-./zcutil/build-mac.sh
+zcutil/build-mac.sh
 ```
 Building for Windows:
 ```
-./zcutil/build-win.sh
+zcutil/build-win.sh
 ```
 VerusCoin
 ------
-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 responsbility for any damage out of the usage of this software. 
+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. 
 
 Verus builds for all operating systems out of the same codebase. Follow the OS specific instructions from below.
 
@@ -95,34 +111,32 @@ cd VerusCoin
 #This can take some time.
 ```
 
-**The VerusCoin enhanced komodo is experimental and a work-in-progress.** Use at your own risk.
+**VerusCoin is experimental and a work-in-progress.** Use at your own risk.
 
+#To view all commands
+./src/verus help
 
 #To view komodod output:
 tail -f ~/.komodo/debug.log
 #To view VRSC output:
 tail -f ~/.komodo/VRSC/debug.log
-Note that this directory is correct for Linux, not Mac or Windows
-#To view all command
-./src/komodo-cli help
-**Zcash is unfinished and highly experimental.** Use at your own risk.
+Note that this directory is correct for Linux, not Mac or Windows. Coin info for Verus is stored in ~/.komodo/VRSC under Ubuntu/Linux.
 
-####  :ledger: Deprecation Policy
+For Windows coin info for Verus is stored under \Users<username>\AppData\Roaming\Komodo\VRSC
 
-This release is considered deprecated 16 weeks after the release day. There
-is an automatic deprecation shutdown feature which will halt the node some
-time after this 16 week time period. The automatic feature is based on block
-height.
+For Mac coin info for Verus is stored under ~/Library/Application\ Support/Komodo/VRSC
 
-#Older Komodo Details
-The remaining text is from the komodo source we forked when creating VerusCoin/Veruscoin.
+**Zcash is unfinished and highly experimental.** Use at your own risk.
 
-**To change modes:**
+Always back your wallets up carefully and securely, **especially before attempting the following process**
 
-a) backup all privkeys (launch komodod with `-exportdir=<path>` and `dumpwallet`)
-b) start a totally new sync including `wallet.dat`, launch with same `exportdir`
-c) stop it before it gets too far and import all the privkeys from a) using `komodo-cli importwallet filename`
-d) resume sync till it gets to chaintip
+In some cases, messed up wallets can be recovered using this process
+- backup wallet.dat safely and securely
+- backup all privkeys (launch komodod with `-exportdir=<path>` and `dumpwallet`)
+- start a totally new sync including `wallet.dat`, launch with same `exportdir`
+- stop it before it gets too far and import all the privkeys from a) using `verus importwallet filename`
+- resume sync till it gets to chaintip
 
 For example:
 ```shell
@@ -141,3 +155,4 @@ Permission is hereby granted, free of charge, to any person obtaining a copy of
 The above copyright notices and this permission notice shall be included in all copies or substantial portions of the Software.
 
 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.
+
This page took 0.027439 seconds and 4 git commands to generate.