README.md

   1
   2 ## Komodod
   3 This software is Komodo client, generally you will use this if you want to mine KMD or setup a full node.
   4 It downloads and stores the entire history of Komodo 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.
   5 ## Development Resources
   6 - Komodo Web: [https://komodoplatform.com/](https://komodoplatform.com/)
   7 - Organization web: [https://www.supernet.org](https://www.supernet.org)
   8 - Forum: [https://forum.supernet.org/](https://forum.supernet.org/)
   9 - Mail: [[email protected]](mailto:[email protected])
  10 - Support & Guides: [https://support.supernet.org/support/home](https://support.supernet.org/support/home)
  11 - API references: [http://docs.supernet.org/](http://docs.supernet.org/) #Not up to date.
  12 - Komodo Platform public material: [Komodo Platform public material](https://docs.google.com/document/d/1AbhWrtagu4vYdkl-vsWz-HSNyNvK-W-ZasHCqe7CZy0)
  13 ## List of Komodo Platform Technologies
  14 Delayed Proof of Work (dPoW) - Additional security layer.
  15 zk-SNARKs - Komodo Platform's privacy technology
  16 Jumblr - Decentralized tumbler for KMD and other cryptocurrencies
  17 Assetchains - Easy way to fork Komodo coin
  18 Pegged Assets - Chains that maintain a peg to fiat currencies
  19 Peerchains - Scalability solution where sibling chains form a network of blockchains
  20 More in depth covered [here](https://docs.google.com/document/d/1AbhWrtagu4vYdkl-vsWz-HSNyNvK-W-ZasHCqe7CZy0)
  21 Also note you receive 5% APR on your holdings.
  22 [See this article for more details](https://supernet.org/en/resources/articles/receive-free-coins-quaranteed-kmd-interest)
  23 ## Tech Specification
  24 Max Supply: 200 million KMD.
  25 Block Time: 1M 2s
  26 Block Reward: 3KMD
  27 Mining Algorithm: Equihash
  28 ## About this Project
  29 Komodo is based on Zcash and has been  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 or our assetchain capabilities (one click plug and play blockchain solutions). More details are available under https://komodoplatform.com/.
  30 ## Getting started
  31 Dependencies
  32 ------------
  33
  34 ```
  35 #The following packages are needed:
  36 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 libcurl3-gnutls-dev bsdmainutils automake
  37 ```
  38
  39 Komodo
  40 ------
  41 We have a release process that goes through several stages before it reaches master. This allows the most conservative users just use the master branch, which is only updated after the other branches have signed off on a release.
  42
  43 99% of the activity is in the dev branch, this is where I am testing each change one by one and there are literally thousands of updates. Only use this branch if you really want to be on the bleeding edge. I try to keep things stable, but there are times where necessarily there are bugs in the dev branch, since I am actively developing and debugging here. A good rule is to wait for at least 4 hours from the last update before using the dev branch (unless you know what you are doing)
  44
  45 After things look good in the dev branch, it is propagated to the beta branch, this is the version the notary nodes use. They are knowledegable command line server guys and so they have a keen eye for anything that wasnt caught during the dev cycle.
  46
  47 After the notary nodes verify things are working and the latest release is deemed stable, it is propagated to the dPoW branch. From here an automated Jenkins process builds it for all OS, and since the notary nodes are all unix, it is possible for some issues to be caught at this stage. The dPoW branch is what goes into the GUI installers.
  48
  49 After the GUI are updated and released and it is verified that no significant support issues were created, the master branch is finally updated.
  50
  51 Master branch: exchanges and users that build from the repo without changing branches
  52 dPoW branch: autobuild into GUI installers, unix, osx, windows
  53 beta branch: notary nodes, command line unix
  54 dev branch: bleeding edge, possibly wont even compile, multiple updates per hour
  55
  56 ```
  57 git clone https://github.com/jl777/komodo
  58 cd komodo
  59 #you might want to: git checkout <branch>; git pull
  60 ./zcutil/fetch-params.sh
  61 # -j8 uses 8 threads - replace 8 with number of threads you want to use
  62 ./zcutil/build.sh -j8
  63 #This can take some time.
  64 ```
  65
  66 # to update an existing version, git checkout dPoW if not on that branch already
  67 git pull
  68 ./zcutil/fetch-params.sh
  69 ./zcutil/build.sh -j8
  70 To reset the blockchain, from ~/.komodo rm -rf blocks chainstate debug.log komodostate db.log
  71 Create komodo.conf
  72 ------------------
  73
  74 ```
  75 cd ~
  76 mkdir .komodo
  77 cd .komodo
  78 pico komodo.conf
  79 #Add the following lines to the komodo.conf file:
  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 #bitcoin also need to be installed with txindex=1 and with rpc enabled
  98 cd ~
  99 cd komodo
 100 #This will return your pubkey eg. "0259e137e5594cf8287195d13aed816af75bd5c04ae673296b51f66e7e8346e8d8" for your address
 101 ./src/komodo-cli validateaddress <yourwalletaddres>
 102 #This will give the privkey of your wallet address
 103 ./src/komodo-cli dumpprivkey <yourwalletaddres>
 104 #This will import the privkey to be sure the mined coins are placed into your wallet address
 105 ./src/komodo-cli importprivkey <yourwalletprivkey>
 106 #To stop the daemon:
 107 ./src/komodo-cli stop
 108 #This starts komodo notary - replace genproclimit with number of threads you want to use and add your pubkey
 109 ./src/komodod -gen -genproclimit=2 -notary -pubkey="0259e137e5594cf8287195d13aed816af75bd5c04ae673296b51f66e7e8346e8d8" &
 110 #This will get the stats:
 111 ./src/komodo-cli getinfo
 112 #To view the process:
 113 ps -ef | grep komodod
 114 #To stop the daemon:
 115 ./src/komodo-cli stop
 116
 117 #To view komodod output:
 118 tail -f ~/.komodo/debug.log
 119 #To view all command
 120 ./src/komodo-cli help
 121 ASSETCHAINS: -ac_name=name -ac_supply=nnnnn
 122 Both komodod and komodo-cli recognize -ac_name=option so you can create fork from the commandline
 123 ```
 124 =======
 125 **Zcash is unfinished and highly experimental.** Use at your own risk.
 126 Where do I begin?
 127 -----------------
 128 We have a guide for joining the main Zcash network:
 129 https://github.com/zcash/zcash/wiki/1.0-User-Guide
 130 ### Need Help?
 131 * See the documentation at the [Zcash Wiki](https://github.com/zcash/zcash/wiki)
 132 for help and more information.
 133 * Ask for help on the [Zcash](https://forum.z.cash/) forum.
 134 Participation in the Zcash project is subject to a
 135 [Code of Conduct](code_of_conduct.md).
 136 Building
 137 --------
 138 Build Zcash along with most dependencies from source by running
 139 ./zcutil/build.sh. Currently only Linux is officially supported.
 140 License
 141 -------
 142 For license information see the file [COPYING](COPYING).
 143 NOTE TO EXCHANGES:
 144 https://bitcointalk.org/index.php?topic=1605144.msg17732151#msg17732151
 145 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.
 146 To change modes:
 147 a) backup all privkeys (launch komodod with -exportdir=<path> and dumpwallet)
 148 b) start a totally new sync including wallet.dat, launch with same exportdir
 149 c) stop it before it gets too far and import all the privkeys from a) using komodo-cli importwallet filename
 150 d) resume sync till it gets to chaintip
 151 For example:
 152 ./komodod -exportdir=/tmp &
 153 ./komodo-cli dumpwallet example
 154 ./komodo-cli stop
 155 mv ~/.komodo ~/.komodo.old && mkdir ~/.komodo && cp ~/.komodo.old/komodo.conf ~/.komodo.old/peers.dat ~/.komodo
 156 ./komodod -exchange -exportdir=/tmp &
 157 ./komodo-cli importwallet /tmp/example
 158 ############## JUMBLR
 159 komodod now has jumblr_deposit and jumblr_secret RPC calls.
 160 Jumblr works like described previously where all the nodes with jumblr active synchronize their tx activity during the same block to maximize the mixing effect. However, unlike all other mixers/tumblers, you never give up control of your coins to anybody else. JUMBLR uses a one to many allocation of funds, ie. one deposit address and many secret addresses. You can always run multiple komodod daemons to get multiple active deposit addresses.
 161 JUMBLR implements t -> z, z -> z and z -> t transactions to maximize privacy of the destination t (transparent) address. So while it is transparent, its first activity is funds coming from an untracable z address.
 162 Which of the three stages is done is randomly selected at each turn. Also when there is more than one possible transaction at the selected stage, a random one is selected. This randomization prevents analyzing incoming z ->t transactions by its size to correlate it to the originating address.
 163 jumblr_deposit <depositaddr> designates the deposit address as the jumblr deposit address for that session. You can select an address that already has funds in it and it will immediately start jumblr process. If there are no funds, it will wait until you send funds to it.
 164 There are three sizes of a jumblr transaction: 10 KMD, 100 KMD and 1000 KMD. There is also a fixed interval of blocks where all jumblr nodes are active. Currently it is set to be 10, but this is subject to change. Only during every 10*10 blocks are the largest 1000 KMD transactions processed, so this concentrates all the large transactions every N*N blocks.
 165 jumblr_secret <secretaddress> notifies JUMBLR where to send the final z -> t transactions. In order to allow larger accounts to obtain privacy, up to 777 secret addresses are supported. Whenever a z -> t stage is activated, a random secret address from the list of the then active secret addresses is selected.
 166 Practical Advice:
 167 Obtaining privacy used to be very difficult. JUMBLR makes it as simple as issuing two command line calls. Higher level layers can be added to help manage the addresses, ie. linking them at the passphrase level. Such matters are left to each implementation.
 168 Once obtained, it is very easy to lose all the privacy. With a single errant transaction that combines some previously used address and the secretaddress, well, the secretaddress is no longer so private.
 169 The advice is to setup a totally separate node!
 170 This might seem a bit drastic, but if you want to maintain privacy, it is best to make it look like all the transactions are coming from a different node. The easiest way for most people to do this is to actually have a different node.
 171 It can be a dedicated laptop (recommended) or a VPS (for smaller amounts) with a totally fresh komodod wallet. Generate an address on this wallet and use that as the jumblr_secret address on your main node. As the JUMBLR operates funds will teleport into your secret node's address. If you are careful and never use the same IP address for both your nodes, you will be able to maintain very good privacy.
 172 Of course, don't send emails that link the two accounts together! Dont use secret address funds for home delivery purchases! Etc. There are many ways to lose the privacy, just think about what linkages can be dont at the IP and blockchain level and that should be a useful preparation.
 173 What if you have 100,000 KMD and you dont want others to know you are such a whale?
 174 Instead of generating 1 secret address, generate 100 and make a script file with:
 175 ./komodo-cli jumblr_secret <addr0>
 176 ./komodo-cli jumblr_secret <addr1>
 177 ...
 178 ./komodo-cli jumblr_secret <addr99>
 179 And make sure to delete all traces of this when the JUMBLR is finished. You will end up with 100 addresses that have an average of 1000 KMD each. So as long as you are careful and dont do a 10,000 KMD transaction (that will link 10 of your secret addresses together), you can appear as 100 different people each with 1000 KMD.
 180
 181