README.md

   1
   2 =======
   3 Zcash 1.0.5
   4 ===========
   5
   6 What is Zcash?
   7 --------------
   8
   9 [Zcash](https://z.cash/) is an implementation of the "Zerocash" protocol.
  10 Based on Bitcoin's code, it intends to offer a far higher standard of privacy
  11 through a sophisticated zero-knowledge proving scheme that preserves
  12 confidentiality of transaction metadata. Technical details are available
  13 in our [Protocol Specification](https://github.com/zcash/zips/raw/master/protocol/protocol.pdf).
  14
  15 This software is the Zcash client. It downloads and stores the entire history
  16 of Zcash transactions; depending on the speed of your computer and network
  17 connection, the synchronization process could take a day or more once the
  18 blockchain has reached a significant size.
  19
  20 Security Warnings
  21 -----------------
  22
  23 See important security warnings in
  24 [doc/security-warnings.md](doc/security-warnings.md).
  25
  26 License
  27 -------
  28
  29 Zcash is released under the terms of the MIT license. See [COPYING](COPYING) for more
  30 information or see http://opensource.org/licenses/MIT.
  31
  32
  33 Komodo Specific Notes
  34 =====================
  35
  36 Dependencies
  37 ------------
  38
  39 ```
  40 #The following packages are needed:
  41 sudo apt-get install build-essential pkg-config libcurl-gnutls-dev libc6-dev m4 g++-multilib autoconf libtool ncurses-dev unzip git python zlib1g-dev wget bsdmainutils automake libboost-all-dev libssl-dev libprotobuf-dev protobuf-compiler libqt4-dev libqrencode-dev libdb++-dev ntp ntpdate
  42 ```
  43
  44 Komodo
  45 ------
  46
  47 ```
  48 git clone https://github.com/jl777/komodo
  49 cd komodo
  50 ./zcutil/fetch-params.sh
  51
  52 # -j8 uses 8 threads - replace 8 with number of threads you want to use
  53 ./zcutil/build.sh -j8
  54 #This can take some time.
  55 ```
  56
  57 # to update an existing version, git checkout dPoW if not on that branch already
  58
  59 git pull
  60
  61 ./zcutil/fetch-params.sh
  62
  63 ./zcutil/build.sh -j8
  64
  65 To reset the blockchain, from ~/.komodo rm -rf blocks chainstate debug.log komodostate db.log
  66
  67 Create komodo.conf
  68 ------------------
  69
  70 ```
  71 cd ~
  72 mkdir .komodo
  73 cd .komodo
  74 pico komodo.conf
  75 #Add the following lines to the komodo.conf file:
  76
  77 rpcuser=bitcoinrpc
  78 rpcpassword=password
  79 txindex=1
  80 addnode=5.9.102.210
  81 addnode=78.47.196.146
  82 addnode=178.63.69.164
  83 addnode=88.198.65.74
  84 addnode=5.9.122.241
  85 addnode=144.76.94.38
  86 addnode=89.248.166.91
  87 ```
  88
  89 Start mining
  90 ------------
  91
  92 ```
  93 #iguana documentation shows how to get the btcpubkey and wifstrs that need to be used
  94
  95 #bitcoin also need to be installed with txindex=1 and with rpc enabled
  96
  97 cd ~
  98 cd komodo
  99
 100
 101 #This will return your pubkey eg. "0259e137e5594cf8287195d13aed816af75bd5c04ae673296b51f66e7e8346e8d8" for your address
 102 ./src/komodo-cli validateaddress <yourwalletaddres>
 103
 104 #This will give the privkey of your wallet address
 105 ./src/komodo-cli dumpprivkey <yourwalletaddres>
 106
 107 #This will import the privkey to be sure the mined coins are placed into your wallet address
 108 ./src/komodo-cli importprivkey <yourwalletprivkey>
 109
 110 #To stop the daemon:
 111 ./src/komodo-cli stop
 112
 113 #This starts komodo notary - replace genproclimit with number of threads you want to use and add your pubkey
 114 ./src/komodod -gen -genproclimit=2 -notary -pubkey="0259e137e5594cf8287195d13aed816af75bd5c04ae673296b51f66e7e8346e8d8" &
 115
 116 #This will get the stats:
 117 ./src/komodo-cli getinfo
 118
 119 #To view the process:
 120 ps -ef | grep komodod
 121
 122 #To stop the daemon:
 123 ./src/komodo-cli stop
 124
 125 #To view komodod output:
 126 tail -f ~/.komodo/debug.log
 127
 128 #To view all command
 129 ./src/komodo-cli help
 130
 131 ASSETCHAINS: -ac_name=name -ac_supply=nnnnn
 132
 133 Both komodod and komodo-cli recognize -ac_name=option so you can create a zcash fork from the commandline
 134
 135 ```
 136
 137 =======
 138
 139 **Zcash is unfinished and highly experimental.** Use at your own risk.
 140
 141 Where do I begin?
 142 -----------------
 143 We have a guide for joining the main Zcash network:
 144 https://github.com/zcash/zcash/wiki/1.0-User-Guide
 145
 146 ### Need Help?
 147
 148 * See the documentation at the [Zcash Wiki](https://github.com/zcash/zcash/wiki)
 149   for help and more information.
 150 * Ask for help on the [Zcash](https://forum.z.cash/) forum.
 151
 152 Participation in the Zcash project is subject to a
 153 [Code of Conduct](code_of_conduct.md).
 154
 155 Building
 156 --------
 157
 158 Build Zcash along with most dependencies from source by running
 159 ./zcutil/build.sh. Currently only Linux is officially supported.
 160
 161 License
 162 -------
 163
 164 For license information see the file [COPYING](COPYING).
 165
 166
 167 NOTE TO EXCHANGES:
 168 https://bitcointalk.org/index.php?topic=1605144.msg17732151#msg17732151
 169 There is a small chance that an outbound transaction will give an error due to mismatched values in wallet calculations. There is a -exchange option that you can run komodod with, but make sure to have the entire transaction history under the same -exchange mode. Otherwise you will get wallet conflicts.
 170
 171 To change modes:
 172 a) backup all privkeys (launch komodod with -exportdir=<path> and dumpwallet)
 173 b) start a totally new sync including wallet.dat, launch with same exportdir
 174 c) stop it before it gets too far and import all the privkeys from a) using komodo-cli importwallet filename
 175 d) resume sync till it gets to chaintip
 176
 177 For example:
 178 ./komodod -exportdir=/tmp &
 179 ./komodo-cli dumpwallet example
 180 ./komodo-cli stop
 181 mv ~/.komodo ~/.komodo.old && mkdir ~/.komodo && cp ~/.komodo.old/komodo.conf ~/.komodo.old/peers.dat ~/.komodo
 182 ./komodod -exchange -exportdir=/tmp &
 183 ./komodo-cli importwallet /tmp/example
 184
 185