Official Go implementation of the Bytom protocol
Permalink
Failed to load latest commit information.
accesstoken Dev wallet sa (#1238) Aug 7, 2018
account Bip44 wallet (#1409) Oct 23, 2018
api Dev ws notification (#1442) Nov 5, 2018
asset Bip44 wallet (#1409) Oct 23, 2018
blockchain add the other type of contract arguments include string, integer, boo… Oct 25, 2018
cmd Dev ws notification (#1442) Nov 5, 2018
common 🎨Refine code (#1315) Sep 4, 2018
config Dev ws notification (#1442) Nov 5, 2018
consensus update checkpoint (#1448) Nov 5, 2018
crypto Add wallet mnemonic function (#1323) Sep 6, 2018
dashboard update dashboard (#1371) Oct 1, 2018
database add cpu log Oct 26, 2018
docs/release-notes add 1.0.6 release log Oct 8, 2018
encoding Clean vendor (#1309) Sep 2, 2018
env Added env dir. Aug 23, 2017
equity fix error response for compile contract (#1424) Oct 25, 2018
errors modify error response (#1039) Jun 9, 2018
math/checked chain's log and math library. Jul 18, 2017
metrics Added metrics Aug 25, 2017
mining Refresh timestamp when get-work Oct 28, 2018
net Dev ws notification (#1442) Nov 5, 2018
netsync Fix typos Oct 30, 2018
node Dev ws notification (#1442) Nov 5, 2018
p2p Fix typos Oct 30, 2018
protocol add cpu log Oct 26, 2018
test Bip44 wallet (#1409) Oct 23, 2018
testutil fix for code review Apr 17, 2018
util add parse env for url Apr 16, 2018
vendor add websocket for vendor Nov 1, 2018
version add checkpoint and version Oct 8, 2018
wallet Support chain tx (#1365) Oct 2, 2018
.gitignore txpool handle orphan (#1228) Aug 8, 2018
.travis.yml add functional-test to ci Apr 18, 2018
Dockerfile update Dockerfile May 28, 2018
LICENSE Added LICENSE. Sep 23, 2017
Makefile add go install (#1416) Oct 19, 2018
README.md 📝 Update README (#1306) Aug 31, 2018

README.md

Bytom

Build Status AGPL v3

Official golang implementation of the Bytom protocol.

Automated builds are available for stable releases and the unstable master branch. Binary archives are published at https://github.com/Bytom/bytom/releases.

What is Bytom?

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 for more details.

In the current state bytom is able to:

  • Manage key, account as well as asset
  • Send transactions, i.e., issue, spend and retire asset

Building from source

Requirements

  • Go version 1.8 or higher, with $GOPATH set to your preferred directory

Installation

Ensure Go with the supported version is installed properly:

$ go version
$ go env GOROOT GOPATH
  • Get the source code
$ git clone https://github.com/Bytom/bytom.git $GOPATH/src/github.com/bytom
  • Build source code
$ cd $GOPATH/src/github.com/bytom
$ make bytomd    # build bytomd
$ make bytomcli  # build bytomcli

When successfully building the project, the bytom and bytomcli binary should be present in cmd/bytomd and cmd/bytomcli directory, respectively.

Executables

The Bytom project comes with several executables found in the cmd directory.

Command Description
bytomd bytomd command can help to initialize and launch bytom domain by custom parameters. bytomd --help for command line options.
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 for command line options.

Running bytom

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.

Initialize

First of all, initialize the node:

$ cd ./cmd/bytomd
$ ./bytomd init --chain_id mainnet

There are three options for the flag --chain_id:

  • mainnet: connect to the mainnet.
  • testnet: connect to the testnet wisdom.
  • solonet: standalone mode.

After that, you'll see config.toml generated, then launch the node.

launch

$ ./bytomd node

available flags for bytomd node:

      --auth.disable                Disable rpc access authenticate
      --chain_id string             Select network type
  -h, --help                        help for node
      --mining                      Enable mining
      --p2p.dial_timeout int        Set dial timeout (default 3)
      --p2p.handshake_timeout int   Set handshake timeout (default 30)
      --p2p.laddr string            Node listen address.
      --p2p.max_num_peers int       Set max num peers (default 50)
      --p2p.pex                     Enable Peer-Exchange  (default true)
      --p2p.seeds string            Comma delimited host:port seed nodes
      --p2p.skip_upnp               Skip UPNP configuration
      --prof_laddr string           Use http to profile bytomd programs
      --vault_mode                  Run in the offline enviroment
      --wallet.disable              Disable wallet
      --wallet.rescan               Rescan wallet
      --web.closed                  Lanch web browser or not
      --simd.enable                 Enable the _simd_ feature to speed up the _PoW_ verification (e.g., during mining and block verification)

Given the bytomd node is running, the general workflow is as follows:

  • create key, then you can create account and asset.
  • send transaction, i.e., build, sign and submit transaction.
  • query all kinds of information, let's say, avaliable key, account, key, balances, transactions, etc.

simd feature:

You could enable the simd feature to speed up the PoW verification (e.g., during mining and block verification) by simply:

bytomd node --simd.enable

To enable this feature you will need to compile from the source code by yourself, and make bytomd-simd.

What is more,

  • if you are using Mac, please make sure llvm is installed by brew install llvm.
  • if you are using Windows, please make sure mingw-w64 is installed and set up the PATH environment variable accordingly.

For more details about using bytomcli command please refer to API Reference

Dashboard

Access the dashboard:

$ open http://localhost:9888/

In Docker

Ensure your Docker version is 17.05 or higher.

$ docker build -t bytom .

For the usage please refer to running-in-docker-wiki.

Contributing

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!

If you run into an issue, feel free to bytom issues in this repository. We are glad to help!

License

AGPL v3