README.md

   1 Bytom
   2 ====
   3 Official golang implementation of the Bytom protocol.
   4 [![Build Status](https://travis-ci.org/Bytom/bytom.svg)](https://travis-ci.org/Bytom/bytom)[![AGPL v3](https://img.shields.io/badge/license-AGPL%20v3-brightgreen.svg)](./LICENSE)
   5
   6 Automated builds are available for stable releases and the unstable master branch. Binary archives are published at https://github.com/Bytom/bytom/releases.
   7
   8 ## What is Bytom?
   9
  10 Bytom is software designed to operate and connect to highly scalable blockchain networks confirming to the Bytom Blockchain Protocol, which allows partipicants to define, issue and transfer digitial assets on a multi-asset shared ledger. Please refer to the [White Paper](https://github.com/Bytom/wiki/blob/master/White-Paper/%E6%AF%94%E5%8E%9F%E9%93%BE%E6%8A%80%E6%9C%AF%E7%99%BD%E7%9A%AE%E4%B9%A6-%E8%8B%B1%E6%96%87%E7%89%88.md) for more details.
  11
  12 In the current state `bytom` is able to:
  13
  14 - Manage key, account as well as asset
  15 - Send transactions, i.e., issue, spend and retire asset
  16
  17
  18 ## Building from source
  19
  20 ### Requirements
  21
  22 - [Go](https://golang.org/doc/install) version 1.8 or higher, with `$GOPATH` set to your preferred directory
  23
  24 ### Installation
  25
  26 Ensure Go with the supported version is installed properly:
  27
  28 ```bash
  29 $ go version
  30 $ go env GOROOT GOPATH
  31 ```
  32
  33 - Get the source code
  34
  35 ``` bash
  36 $ git clone https://github.com/Bytom/bytom.git $GOPATH/src/github.com/bytom
  37 ```
  38
  39 - Build source code
  40
  41 ``` bash
  42 $ cd $GOPATH/src/github.com/bytom
  43 $ make bytomd    # build bytomd
  44 $ make bytomcli  # build bytomcli
  45 ```
  46
  47 When successfully building the project, the `bytom` and `bytomcli` binary should be present in `cmd/bytomd` and `cmd/bytomcli` directory, respectively.
  48
  49 __simd feature:__
  50
  51 You could enable the _simd_ feature to speed up the _PoW_ verification (e.g., during mining and block verification) by simply:
  52 ```
  53 bytomd node --simd.enable
  54 ```
  55
  56 To enable this feature you will need to compile from the source code by yourself, and `make bytomd-simd`.
  57
  58 What is more,
  59
  60 + if you are using _Mac_, please make sure _llvm_ is installed by `brew install llvm`.
  61 + if you are using _Windows_, please make sure _mingw-w64_ is installed and set up the _PATH_ environment variable accordingly.
  62
  63 ### Executables
  64
  65 The Bytom project comes with several executables found in the `cmd` directory.
  66
  67 | Command      | Description                                                  |
  68 | ------------ | ------------------------------------------------------------ |
  69 | **bytomd**   | bytomd command can help to initialize and launch bytom domain by custom parameters. `bytomd --help` for command line options. |
  70 | **bytomcli** | Our main Bytom CLI client. It is the entry point into the Bytom network (main-, test- or private net), capable of running as a full node archive node (retaining all historical state). It can be used by other processes as a gateway into the Bytom network via JSON RPC endpoints exposed on top of HTTP, WebSocket and/or IPC transports. `bytomcli --help` and the [bytomcli Wiki page](https://github.com/Bytom/bytom/wiki/Command-Line-Options) for command line options. |
  71
  72 ## Running bytom
  73
  74 Currently, bytom is still in active development and a ton of work needs to be done, but we also provide the following content for these eager to do something with `bytom`. This section won't cover all the commands of `bytomd` and `bytomcli` at length, for more information, please the help of every command, e.g., `bytomcli help`.
  75
  76 ### Initialize
  77
  78 First of all, initialize the node:
  79
  80 ```bash
  81 $ cd ./cmd/bytomd
  82 $ ./bytomd init --chain_id mainnet
  83 ```
  84
  85 There are three options for the flag `--chain_id`:
  86
  87 - `mainnet`: connect to the mainnet.
  88 - `testnet`: connect to the testnet wisdom.
  89 - `solonet`: standalone mode.
  90
  91 After that, you'll see `config.toml` generated, then launch the node.
  92
  93 ### launch
  94
  95 ``` bash
  96 $ ./bytomd node
  97 ```
  98
  99 available flags for `bytomd node`:
 100
 101 ```
 102       --auth.disable                Disable rpc access authenticate
 103       --chain_id string             Select network type
 104   -h, --help                        help for node
 105       --mining                      Enable mining
 106       --p2p.dial_timeout int        Set dial timeout (default 3)
 107       --p2p.handshake_timeout int   Set handshake timeout (default 30)
 108       --p2p.laddr string            Node listen address.
 109       --p2p.max_num_peers int       Set max num peers (default 50)
 110       --p2p.pex                     Enable Peer-Exchange  (default true)
 111       --p2p.seeds string            Comma delimited host:port seed nodes
 112       --p2p.skip_upnp               Skip UPNP configuration
 113       --prof_laddr string           Use http to profile bytomd programs
 114       --vault_mode                  Run in the offline enviroment
 115       --wallet.disable              Disable wallet
 116       --wallet.rescan               Rescan wallet
 117       --web.closed                  Lanch web browser or not
 118 ```
 119
 120 Given the `bytomd` node is running, the general workflow is as follows:
 121
 122 - create key, then you can create account and asset.
 123 - send transaction, i.e., build, sign and submit transaction.
 124 - query all kinds of information, let's say, avaliable key, account, key, balances, transactions, etc.
 125
 126 For more details about using `bytomcli` command please refer to [API Reference](https://github.com/Bytom/bytom/wiki/API-Reference)
 127
 128 ### Dashboard
 129
 130 Access the dashboard:
 131
 132 ```
 133 $ open http://localhost:9888/
 134 ```
 135
 136 ### In Docker
 137
 138 Ensure your [Docker](https://www.docker.com/) version is 17.05 or higher.
 139
 140 ```bash
 141 $ docker build -t bytom .
 142 ```
 143
 144 For the usage please refer to [running-in-docker-wiki](https://github.com/Bytom/bytom/wiki/Running-in-Docker).
 145
 146 ## Contributing
 147
 148 Thank you for considering helping out with the source code! Any contributions are highly appreciated, and we are grateful for even the smallest of fixes!
 149
 150 If you run into an issue, feel free to [bytom issues](https://github.com/Bytom/bytom/issues/) in this repository. We are glad to help!
 151
 152 ## License
 153
 154 [AGPL v3](./LICENSE)