You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

122 lines
3.3 KiB

10 years ago
10 years ago
10 years ago
10 years ago
10 years ago
10 years ago
10 years ago
10 years ago
10 years ago
  1. [**Website**](http://tendermint.com) **|**
  2. [**Blog**](http://tendermint.com/posts/) **|**
  3. [**Forum**] (http://forum.tendermint.com) **|**
  4. [**IRC**] (http://webchat.freenode.net/?randomnick=1&channels=%23tendermint)
  5. Tendermint in Golang
  6. Tendermint is a completely decentralized byzantine consensus protocol suitable for use in cryptocurrencies.
  7. This project is a reference implementation of the protocol.
  8. ## Submodules
  9. * **[consensus](https://github.com/tendermint/tendermint/blob/master/consensus):** core consensus algorithm
  10. * **[state](https://github.com/tendermint/tendermint/blob/master/state):** application state; mutated by transactions
  11. * **[blocks](https://github.com/tendermint/tendermint/blob/master/blocks):** structures of the blockchain
  12. * **[mempool](https://github.com/tendermint/tendermint/blob/master/mempool):** gossip of new transactions
  13. * **[merkle](https://github.com/tendermint/tendermint/blob/master/merkle):** merkle hash trees
  14. * **[p2p](https://github.com/tendermint/tendermint/blob/master/p2p):** extensible P2P networking
  15. ## Requirements
  16. [Go](http://golang.org) 1.2 or newer.
  17. OpenSSL header files. `sudo apt-get install libssl-dev` on Debian/Ubuntu
  18. //TODO OpenSSL header files for other platforms
  19. ###Setting up Golang
  20. [Install Go for your platform](https://golang.org/doc/install)
  21. Set up environment variables. Go requires certain environment variables to compile code. Set these in your terminal, .profile or .zshrc as appropiate.
  22. ```
  23. export GOROOT=$HOME/go
  24. export PATH=$PATH:$GOROOT/bin
  25. export GOPATH=$HOME/gopkg
  26. ```
  27. ## Build
  28. [![Build Status](https://drone.io/github.com/tendermint/tendermint/status.png)](https://drone.io/github.com/tendermint/tendermint/latest)
  29. ```
  30. make get_deps
  31. make
  32. ```
  33. ## Run
  34. `./tendermint daemon --help`
  35. ### Editing your config.json
  36. The file will be create in ~/.tendermint/config.json
  37. There is not official or testnet SeedNode yet. Will updated with an official list of seed nodes.
  38. //TODO Explanation of other config.json fields
  39. ```
  40. {
  41. "Network": "tendermint_testnet0",
  42. "LAddr": "0.0.0.0:0",
  43. "SeedNode": "",
  44. "DB": {
  45. "Backend": "leveldb",
  46. "Dir": "/home/zaki/.tendermint/data"
  47. },
  48. "Alert": {
  49. "MinInterval": 0,
  50. "TwilioSid": "",
  51. "TwilioToken": "",
  52. "TwilioFrom": "",
  53. "TwilioTo": "",
  54. "EmailRecipients": null
  55. },
  56. "SMTP": {
  57. "User": "",
  58. "Password": "",
  59. "Host": "",
  60. "Port": 0
  61. },
  62. "RPC": {
  63. "HTTPLAddr": "0.0.0.0:0"
  64. }
  65. }
  66. ```
  67. You will also to need to have a genesis.json in ~/.tendermint/. This must be the common genesis.json as the network you are joining from the Seed Node
  68. ```
  69. {
  70. "Accounts": [
  71. {
  72. "Address": "6070ff17c39b2b0a64ca2bc431328037fa0f4760",
  73. "Amount": 200000000
  74. }
  75. ],
  76. "Validators": [
  77. {
  78. "PubKey": "01206bd490c212e701a2136eeea04f06fa4f287ee47e2b7a9b5d62edd84cd6ad9753",
  79. "Amount": 100000000,
  80. "UnbondTo": [
  81. {
  82. "Address": "6070ff17c39b2b0a64ca2bc431328037fa0f4760",
  83. "Amount": 100000000
  84. }
  85. ]
  86. }
  87. ]
  88. }
  89. ```
  90. ## Resources
  91. IRC Channel: #tendermint on freenode