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)
6 **Official golang implementation of the Bytom protocol.**
8 Automated builds are available for stable releases and the unstable master branch. Binary archives are published at https://github.com/Bytom/bytom/releases.
12 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.
14 In the current state `bytom` is able to:
16 - Manage key, account as well as asset
17 - Send transactions, i.e., issue, spend and retire asset
19 ## Installing with Homebrew
22 brew tap bytom/bytom && brew install bytom
25 ## Building from source
29 - [Go](https://golang.org/doc/install) version 1.8 or higher, with `$GOPATH` set to your preferred directory
33 Ensure Go with the supported version is installed properly:
37 $ go env GOROOT GOPATH
43 $ git clone https://github.com/Bytom/bytom.git $GOPATH/src/github.com/bytom/bytom
49 $ cd $GOPATH/src/github.com/bytom/bytom
50 $ make bytomd # build bytomd
51 $ make bytomcli # build bytomcli
54 When successfully building the project, the `bytomd` and `bytomcli` binary should be present in `cmd/bytomd` and `cmd/bytomcli` directory, respectively.
58 The Bytom project comes with several executables found in the `cmd` directory.
60 | Command | Description |
61 | ------------ | ------------------------------------------------------------ |
62 | **bytomd** | bytomd command can help to initialize and launch bytom domain by custom parameters. `bytomd --help` for command line options. |
63 | **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. |
67 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`.
71 First of all, initialize the node:
75 $ ./bytomd init --chain_id mainnet
78 There are three options for the flag `--chain_id`:
80 - `mainnet`: connect to the mainnet.
81 - `testnet`: connect to the testnet wisdom.
82 - `solonet`: standalone mode.
84 After that, you'll see `config.toml` generated, then launch the node.
92 available flags for `bytomd node`:
96 --auth.disable Disable rpc access authenticate
97 --chain_id string Select network type
98 -h, --help help for node
99 --log_file string Log output file (default "log")
100 --log_level string Select log level(debug, info, warn, error or fatal)
101 --mining Enable mining
102 --p2p.dial_timeout int Set dial timeout (default 3)
103 --p2p.handshake_timeout int Set handshake timeout (default 30)
104 --p2p.keep_dial string Peers addresses try keeping connecting to, separated by ',' (for example "1.1.1.1:46657;2.2.2.2:46658")
105 --p2p.laddr string Node listen address. (0.0.0.0:0 means any interface, any port) (default "tcp://0.0.0.0:46656")
106 --p2p.lan_discoverable Whether the node can be discovered by nodes in the LAN (default true)
107 --p2p.max_num_peers int Set max num peers (default 50)
108 --p2p.node_key string Node key for p2p communication
109 --p2p.proxy_address string Connect via SOCKS5 proxy (eg. 127.0.0.1:1086)
110 --p2p.proxy_password string Password for proxy server
111 --p2p.proxy_username string Username for proxy server
112 --p2p.seeds string Comma delimited host:port seed nodes
113 --p2p.skip_upnp Skip UPNP configuration
114 --prof_laddr string Use http to profile bytomd programs
115 --simd.enable Enable SIMD mechan for tensority
116 --vault_mode Run in the offline enviroment
117 --wallet.disable Disable wallet
118 --wallet.rescan Rescan wallet
119 --wallet.txindex Save global tx index
120 --web.closed Lanch web browser or not
121 --ws.max_num_concurrent_reqs int Max number of concurrent websocket requests that may be processed concurrently (default 20)
122 --ws.max_num_websockets int Max number of websocket connections (default 25)
125 --home string root directory for config and data
126 -r, --root string DEPRECATED. Use --home (default "/Users/zcc/Library/Application Support/Bytom")
127 --trace print out full stack trace on errors
130 Given the `bytomd` node is running, the general workflow is as follows:
132 - create key, then you can create account and asset.
133 - send transaction, i.e., build, sign and submit transaction.
134 - query all kinds of information, let's say, avaliable key, account, key, balances, transactions, etc.
138 You could enable the _simd_ feature to speed up the _PoW_ verification (e.g., during mining and block verification) by simply:
140 bytomd node --simd.enable
143 To enable this feature you will need to compile from the source code by yourself, and `make bytomd-simd`.
147 + if you are using _Mac_, please make sure _llvm_ is installed by `brew install llvm`.
148 + if you are using _Windows_, please make sure _mingw-w64_ is installed and set up the _PATH_ environment variable accordingly.
150 For more details about using `bytomcli` command please refer to [API Reference](https://github.com/Bytom/bytom/wiki/API-Reference)
154 Access the dashboard:
157 $ open http://localhost:9888/
162 Ensure your [Docker](https://www.docker.com/) version is 17.05 or higher.
165 $ docker build -t bytom .
168 For the usage please refer to [running-in-docker-wiki](https://github.com/Bytom/bytom/wiki/Running-in-Docker).
172 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!
174 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!