]>
Commit | Line | Data |
---|---|---|
d7426190 | 1 | |
3ced9364 | 2 | ======= |
b8f737b3 | 3 | Zcash 1.0.5 |
998202ba | 4 | =========== |
559ab225 | 5 | |
293e4f01 | 6 | What is Zcash? |
c2ec2f53 | 7 | -------------- |
20d59455 | 8 | |
666a401f DH |
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 | |
eb2e2b70 SB |
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). | |
20d59455 | 14 | |
666a401f DH |
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 | |
c2b24ccd | 18 | blockchain has reached a significant size. |
254c16dd | 19 | |
8fb1005c TH |
20 | Security Warnings |
21 | ----------------- | |
d7426190 | 22 | |
8fb1005c TH |
23 | See important security warnings in |
24 | [doc/security-warnings.md](doc/security-warnings.md). | |
25 | ||
20d59455 CD |
26 | License |
27 | ------- | |
d7426190 | 28 | |
c2ec2f53 | 29 | Zcash is released under the terms of the MIT license. See [COPYING](COPYING) for more |
20d59455 | 30 | information or see http://opensource.org/licenses/MIT. |
d7426190 | 31 | |
32 | ||
33 | Komodo Specific Notes | |
34 | ===================== | |
35 | ||
d7426190 | 36 | Dependencies |
37 | ------------ | |
38 | ||
39 | ``` | |
40 | #The following packages are needed: | |
6b4a0103 | 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 |
d7426190 | 42 | ``` |
43 | ||
44 | Komodo | |
45 | ------ | |
46 | ||
47 | ``` | |
f3ae714c | 48 | git clone https://github.com/jl777/komodo |
49 | cd komodo | |
f3ae714c | 50 | ./zcutil/fetch-params.sh |
6c4dfa1c | 51 | |
52 | # -j8 uses 8 threads - replace 8 with number of threads you want to use | |
53 | ./zcutil/build.sh -j8 | |
d7426190 | 54 | #This can take some time. |
55 | ``` | |
56 | ||
3bb1d82c | 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 | ||
9f0df400 | 65 | To reset the blockchain, from ~/.komodo rm -rf blocks chainstate debug.log komodostate db.log |
3bb1d82c | 66 | |
d7426190 | 67 | Create komodo.conf |
68 | ------------------ | |
69 | ||
70 | ``` | |
71 | cd ~ | |
72 | mkdir .komodo | |
73 | cd .komodo | |
8aeb7db1 | 74 | pico komodo.conf |
d7426190 | 75 | #Add the following lines to the komodo.conf file: |
8aeb7db1 | 76 | |
f3ae714c | 77 | rpcuser=bitcoinrpc |
0032bbb5 | 78 | rpcpassword=password |
a0413d6a | 79 | txindex=1 |
8aeb7db1 | 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 | |
67e8ca1c | 86 | addnode=89.248.166.91 |
d7426190 | 87 | ``` |
88 | ||
89 | Start mining | |
90 | ------------ | |
91 | ||
92 | ``` | |
870e3556 | 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 | ||
d7426190 | 97 | cd ~ |
98 | cd komodo | |
c6444836 | 99 | |
c6444836 | 100 | |
c6444836 | 101 | #This will return your pubkey eg. "0259e137e5594cf8287195d13aed816af75bd5c04ae673296b51f66e7e8346e8d8" for your address |
67e8ca1c Y |
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> | |
af7b3566 | 109 | |
d5a5f0f3 | 110 | #To stop the daemon: |
af7b3566 | 111 | ./src/komodo-cli stop |
c6444836 | 112 | |
67e8ca1c | 113 | #This starts komodo notary - replace genproclimit with number of threads you want to use and add your pubkey |
c6444836 | 114 | ./src/komodod -gen -genproclimit=2 -notary -pubkey="0259e137e5594cf8287195d13aed816af75bd5c04ae673296b51f66e7e8346e8d8" & |
8aeb7db1 | 115 | |
116 | #This will get the stats: | |
117 | ./src/komodo-cli getinfo | |
118 | ||
d7426190 | 119 | #To view the process: |
8aeb7db1 | 120 | ps -ef | grep komodod |
6c4dfa1c | 121 | |
d2438574 | 122 | #To stop the daemon: |
af7b3566 | 123 | ./src/komodo-cli stop |
d7426190 | 124 | |
125 | #To view komodod output: | |
aae8f281 | 126 | tail -f ~/.komodo/debug.log |
67e8ca1c Y |
127 | |
128 | #To view all command | |
129 | ./src/komodo-cli help | |
9fc60fe3 | 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 | ||
0032bbb5 | 135 | ``` |
1e613927 | 136 | |
30853e4a | 137 | ======= |
138 | ||
666a401f DH |
139 | **Zcash is unfinished and highly experimental.** Use at your own risk. |
140 | ||
141 | Where do I begin? | |
142 | ----------------- | |
473ed951 CB |
143 | We have a guide for joining the main Zcash network: |
144 | https://github.com/zcash/zcash/wiki/1.0-User-Guide | |
666a401f DH |
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 | |
eb2e2b70 | 159 | ./zcutil/build.sh. Currently only Linux is officially supported. |
666a401f | 160 | |
20d59455 CD |
161 | License |
162 | ------- | |
163 | ||
666a401f | 164 | For license information see the file [COPYING](COPYING). |
a35f7eee | 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) | |
c9ef1c89 | 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 | |
a35f7eee | 175 | d) resume sync till it gets to chaintip |
176 | ||
c9ef1c89 | 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 & | |
02b02173 | 183 | ./komodo-cli importwallet /tmp/example |
c9ef1c89 | 184 | |
185 |