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 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 #./autogen.sh
  51 #./configure --with-incompatible-bdb --with-gui
  52 # This command might finish with: configure: error: libgmp headers missing. This can be ignored. so can libsnark directory missing error
  53 ./zcutil/fetch-params.sh
  54
  55 # -j8 uses 8 threads - replace 8 with number of threads you want to use
  56 ./zcutil/build.sh -j8
  57 #This can take some time.
  58 ```
  59
  60 # to update an existing version, git checkout dPoW if not on that branch already
  61
  62 git pull
  63
  64 ./zcutil/fetch-params.sh
  65
  66 ./zcutil/build.sh -j8
  67
  68 To reset the blockchain, from ~/.komodo rm -rf blocks chainstate debug.log komodostate db.log
  69
  70 Create komodo.conf
  71 ------------------
  72
  73 ```
  74 cd ~
  75 mkdir .komodo
  76 cd .komodo
  77 pico komodo.conf
  78 #Add the following lines to the komodo.conf file:
  79
  80 rpcuser=bitcoinrpc
  81 rpcpassword=password
  82 txindex=1
  83 addnode=5.9.102.210
  84 addnode=78.47.196.146
  85 addnode=178.63.69.164
  86 addnode=88.198.65.74
  87 addnode=5.9.122.241
  88 addnode=144.76.94.38
  89 addnode=89.248.166.91
  90 ```
  91
  92 Start mining
  93 ------------
  94
  95 ```
  96 #iguana documentation shows how to get the btcpubkey and wifstrs that need to be used
  97
  98 #bitcoin also need to be installed with txindex=1 and with rpc enabled
  99
 100 cd ~
 101 cd komodo
 102
 103
 104 #This will return your pubkey eg. "0259e137e5594cf8287195d13aed816af75bd5c04ae673296b51f66e7e8346e8d8" for your address
 105 ./src/komodo-cli validateaddress <yourwalletaddres>
 106
 107 #This will give the privkey of your wallet address
 108 ./src/komodo-cli dumpprivkey <yourwalletaddres>
 109
 110 #This will import the privkey to be sure the mined coins are placed into your wallet address
 111 ./src/komodo-cli importprivkey <yourwalletprivkey>
 112
 113 #To stop the daemon:
 114 ./src/komodo-cli stop
 115
 116 #This starts komodo notary - replace genproclimit with number of threads you want to use and add your pubkey
 117 ./src/komodod -gen -genproclimit=2 -notary -pubkey="0259e137e5594cf8287195d13aed816af75bd5c04ae673296b51f66e7e8346e8d8" &
 118
 119 #This will get the stats:
 120 ./src/komodo-cli getinfo
 121
 122 #To view the process:
 123 ps -ef | grep komodod
 124
 125 #To stop the daemon:
 126 ./src/komodo-cli stop
 127
 128 #To view komodod output:
 129 tail -f ~/.komodo/debug.log
 130
 131 #To view all command
 132 ./src/komodo-cli help
 133
 134 ASSETCHAINS: -ac_name=name -ac_supply=nnnnn
 135
 136 Both komodod and komodo-cli recognize -ac_name=option so you can create a zcash fork from the commandline
 137
 138 ```
 139
 140 =======
 141
 142 **Zcash is unfinished and highly experimental.** Use at your own risk.
 143
 144 Where do I begin?
 145 -----------------
 146 We have a guide for joining the main Zcash network:
 147 https://github.com/zcash/zcash/wiki/1.0-User-Guide
 148
 149 ### Need Help?
 150
 151 * See the documentation at the [Zcash Wiki](https://github.com/zcash/zcash/wiki)
 152   for help and more information.
 153 * Ask for help on the [Zcash](https://forum.z.cash/) forum.
 154
 155 Participation in the Zcash project is subject to a
 156 [Code of Conduct](code_of_conduct.md).
 157
 158 Building
 159 --------
 160
 161 Build Zcash along with most dependencies from source by running
 162 ./zcutil/build.sh. Currently only Linux is officially supported.
 163
 164 License
 165 -------
 166
 167 For license information see the file [COPYING](COPYING).