Go to file
hyperchain 7897eac978 Merge pull request 'docs:update readme' (#1) from docs/update-readme into master
Reviewed-on: https://git.trustie.net/openatom_foundation/bitxhub/pulls/1
2021-05-08 12:12:47 +08:00
.github ci: add notice on Dingding when there is a pr opened 2021-04-19 16:42:52 +08:00
api Merge pull request #412 from meshplus/refactor/adapter-rbft 2021-04-30 18:28:00 +08:00
build feat(wasm):add macos libwasmer 2020-06-08 21:02:38 +08:00
cmd/bitxhub fix(*): fix bugs about governance 2021-04-28 18:02:01 +08:00
config fix(*): fix some bugs when invoking eth tx 2021-04-26 20:01:27 +08:00
dist ci: add release.yml and some scripts 2021-04-06 15:30:35 +08:00
docs docs:update readme 2021-05-08 11:54:09 +08:00
example/rule_example feat: add validation rule example 2020-05-15 13:37:53 +08:00
imports feat(*): move did out of ent 2021-04-07 17:41:00 +08:00
internal fix(appchain-mgr): appchain status not changed after updating appchain voted 2021-05-07 10:31:01 +08:00
pkg Merge pull request #412 from meshplus/refactor/adapter-rbft 2021-04-30 18:28:00 +08:00
scripts feat(rpc): add json rpc 2021-04-26 20:00:19 +08:00
tester fix(*): fix bugs about governance 2021-04-28 18:02:01 +08:00
.dockerignore build(docker): add wasm dep lib 2020-05-25 14:17:36 +08:00
.gitignore fix:Modified the properties of dist folder 2021-04-06 16:08:57 +08:00
.golangci.yml build(linter): add .golangci.yml 2020-03-30 22:57:55 +08:00
.goreleaser.yml ci: add release.yml and some scripts 2021-04-06 15:30:35 +08:00
CONTRIBUTING.md script(*): add config.sh 2020-03-30 16:34:30 +08:00
COPYING fix: change license name 2020-11-27 13:59:04 +08:00
COPYING.LESSER fix: change license name 2020-11-27 13:59:04 +08:00
Dockerfile feat/add bitxhub solo dockerfile 2020-05-27 19:12:25 +08:00
Dockerfile.solo feat/add bitxhub solo dockerfile 2020-05-27 19:12:25 +08:00
Makefile fix(ci):get app_version automatically 2021-04-26 11:07:57 +08:00
README.md docs:update readme 2021-05-08 11:54:09 +08:00
codecov.yml ci: add codecov patch disable 2020-12-01 21:18:03 +08:00
go.mod fix(*): fix bugs about governance 2021-04-28 18:02:01 +08:00
go.sum fix(*): fix bugs about governance 2021-04-28 18:02:01 +08:00
goent.diff feat(*): fix did registry init admin 2021-04-07 18:15:00 +08:00
package.json docs: add logo 2020-09-01 19:56:46 +08:00
version.go feat(*): init project 2020-03-30 00:11:21 +08:00

README.md

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.