README
¶
Bytom
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
Installing with Homebrew
brew tap bytom/bytom && brew install bytom
Building from source
Requirements
- Go version 1.8 or higher, with
$GOPATHset 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
Directories
¶
| Path | Synopsis |
|---|---|
|
Package accesstoken provides storage and validation of Chain Core credentials.
|
Package accesstoken provides storage and validation of Chain Core credentials. |
|
Package account stores and tracks accounts within a Bytom Core.
|
Package account stores and tracks accounts within a Bytom Core. |
|
blockchain
|
|
|
pseudohsm
Package pseudohsm provides a pseudo HSM for development environments.
|
Package pseudohsm provides a pseudo HSM for development environments. |
|
signers
Package signers associates signers and their corresponding keys.
|
Package signers associates signers and their corresponding keys. |
|
txbuilder
Package txbuilder builds a Chain Protocol transaction from a list of actions.
|
Package txbuilder builds a Chain Protocol transaction from a list of actions. |
|
cmd
|
|
|
Package common contains various helper functions.
|
Package common contains various helper functions. |
|
bech32
Package bech32 provides a Go implementation of the bech32 format specified in BIP 173.
|
Package bech32 provides a Go implementation of the bech32 format specified in BIP 173. |
|
ed25519
Package ed25519 implements the Ed25519 signature algorithm.
|
Package ed25519 implements the Ed25519 signature algorithm. |
|
ed25519/chainkd
Package chainkd This is an extension to ed25519.Sign that is compatible with NaCl `crypto_sign` function taking 64-byte expanded private key (where the left part is a pre-multiplied scalar and the right part is "prefix" used for generating a nonce).
|
Package chainkd This is an extension to ed25519.Sign that is compatible with NaCl `crypto_sign` function taking 64-byte expanded private key (where the left part is a pre-multiplied scalar and the right part is "prefix" used for generating a nonce). |
|
scrypt
import "golang.org/x/crypto/scrypt"
|
import "golang.org/x/crypto/scrypt" |
|
sha3pool
Package sha3pool is a freelist for SHA3-256 hash objects.
|
Package sha3pool is a freelist for SHA3-256 hash objects. |
|
sm2
crypto/x509 add sm2 support
|
crypto/x509 add sm2 support |
|
database
|
|
|
storage
Package storage is a generated protocol buffer package.
|
Package storage is a generated protocol buffer package. |
|
encoding
|
|
|
base32
Package base32 implements base32 encoding as specified by RFC 4648.
|
Package base32 implements base32 encoding as specified by RFC 4648. |
|
blockchain
Package blockchain provides the tools for encoding data primitives in blockchain structures
|
Package blockchain provides the tools for encoding data primitives in blockchain structures |
|
bufpool
Package bufpool is a freelist for bytes.Buffer objects.
|
Package bufpool is a freelist for bytes.Buffer objects. |
|
Package env provides a convenient way to convert environment variables into Go data.
|
Package env provides a convenient way to convert environment variables into Go data. |
|
compiler
Package equity provides a compiler for Bytom's Equity contract language.
|
Package equity provides a compiler for Bytom's Equity contract language. |
|
Package errors implements a basic error wrapping pattern, so that errors can be annotated with additional information without losing the original error.
|
Package errors implements a basic error wrapping pattern, so that errors can be annotated with additional information without losing the original error. |
|
Package event deals with subscriptions to real-time events.
|
Package event deals with subscriptions to real-time events. |
|
lib
|
|
|
math
|
|
|
checked
Package checked implements basic arithmetic operations with underflow and overflow checks.
|
Package checked implements basic arithmetic operations with underflow and overflow checks. |
|
net
|
|
|
http/httperror
Package httperror defines the format for HTTP error responses from Chain services.
|
Package httperror defines the format for HTTP error responses from Chain services. |
|
http/httpjson
Package httpjson creates HTTP handlers to map request and response formats onto Go function signatures.
|
Package httpjson creates HTTP handlers to map request and response formats onto Go function signatures. |
|
http/reqid
Package reqid creates request IDs and stores them in Contexts.
|
Package reqid creates request IDs and stores them in Contexts. |
|
http/static
Package static provides a handler for serving static assets from an in-memory map.
|
Package static provides a handler for serving static assets from an in-memory map. |
|
discover
Package discv5 implements the RLPx v5 Topic Discovery Protocol.
|
Package discv5 implements the RLPx v5 Topic Discovery Protocol. |
|
netutil
Package netutil contains extensions to the net package.
|
Package netutil contains extensions to the net package. |
|
upnp
Taken from taipei-torrent Just enough UPnP to be able to forward ports
|
Taken from taipei-torrent Just enough UPnP to be able to forward ports |
|
bc
Package bc is a generated protocol buffer package.
|
Package bc is a generated protocol buffer package. |
|
mnemonic
Package bip39 is the official Golang implementation of the BIP39 spec.
|
Package bip39 is the official Golang implementation of the BIP39 spec. |