bitxhub/README.md

2.7 KiB
Raw Blame History

build codecov Go Report Card

BitXHub is committed to building a scalable, robust, and pluggable inter-blockchain reference implementation, that can provide reliable technical support for the formation of a blockchain internet and intercommunication of value islands.

Architecture

The diagram above shows the overall architecture which is a service platform to handle the interaction among cross-layer heterogeneous chains.

For more details please visit our whitepaper | 白皮书.

Start BitXHub

Requirements

  • OS Support: Linux and Mac OS
  • Go 1.13.x or later
  • Tmux
  • Git

BitXHub start script relies on golang and tmux. Please install the software before start.

Use commands below to clone the project:

git clone https://git.trustie.net/openatom_foundation/bitxhub.git

BitXHub also relies on some small tools, use commands below to install:

cd bitxhub
bash scripts/prepare.sh 
git checkout -f v1.0.0-rc1

Finally, run the following commands to start a four nodes relay-chain.

make cluster

Noting: make cluster will use tmux to split the screen. Thus, during commands processing, better not switch the terminal.

Usage

Usage guide can be found in wiki.

Contributing

See CONTRIBUTING.md.

Contact

Email: bitxhub@hyperchain.cn

Wechat: If youre interested in BitXHub, please add the assistant to join our community group.

License

The BitXHub library (i.e. all code outside of the cmd and internal directory) is licensed under the GNU Lesser General Public License v3.0, also included in our repository in the COPYING.LESSER file.

The BitXHub binaries (i.e. all code inside of the cmd and internal directory) is licensed under the GNU General Public License v3.0, also included in our repository in the COPYING file.