BytomDAO•Mar 14, 2025
bytom
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
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:
Get the source code
Build source code
When successfully building the project, the bytomd 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:
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
available flags for bytomd node:
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.
Dashboard
Access the dashboard:
In Docker
Ensure your Docker version is 17.05 or higher.
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