The core protocol of WoopChain
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
Minh Doan cc26461297 clean up service call in harmony 6 years ago
.github/ISSUE_TEMPLATE Ask to add references to the relevant code 6 years ago
api add support client to service list 6 years ago
cmd clean up service call in harmony 6 years ago
consensus make state syncing compatible with new BLS consensus code 6 years ago
contracts formatting and changing node name 6 years ago
core Fix lint 6 years ago
crypto Say goodbye to Schnorr sig and kyber package and mark BLS done 6 years ago
internal use a global BootNodes variable 6 years ago
node add support client to service list 6 years ago
p2p fix protocol not supported issue 6 years ago
scripts Add multi-sig check on validator commit phase 6 years ago
solidity add support client to service list 6 years ago
specs/p2p add peer discovery spec 6 years ago
test Merge pull request #337 from harmony-one/rj_misc 6 years ago
vendor/github.com add libp2p/go-libp2p-kad-dht to vendor 6 years ago
.coveralls.yml add coveralls 6 years ago
.gitignore avoid node_modules 6 years ago
.gitmodules add libp2p/go-libp2p-kad-dht to vendor 6 years ago
.travis.yml Merge remote-tracking branch 'refs/remotes/harmony-one/master' into goimports 6 years ago
CONTRIBUTING.md s/gofmt/goimports/ 6 years ago
FLA.md cla@ → licensing@ 6 years ago
LICENSE Add MIT License 6 years ago
PULL_REQUEST_TEMPLATE.md Update PULL_REQUEST_TEMPLATE.md 6 years ago
README.md Update readme for bls/mcl build 6 years ago
appspec.yml change benchmark to harmony 6 years ago
go.mod add go.mod for go v1.11 6 years ago

README.md

Harmony

Build Status gopherbadger-tag-do-not-edit Discord Coverage Status

Installation Requirements

GMP and OpenSSL

brew install gmp
brew install openssl

Dev Environment Setup

export GOPATH=$HOME/<path_of_your_choice>
export CGO_CFLAGS="-I$GOPATH/src/github.com/harmony-one/bls/include -I$GOPATH/src/github.com/harmony-one/mcl/include -I/usr/local/opt/openssl/include"
export CGO_LDFLAGS="-L$GOPATH/src/github.com/harmony-one/bls/lib -L/usr/local/opt/openssl/lib"
export LD_LIBRARY_PATH=$GOPATH/src/github.com/harmony-one/bls/lib:$GOPATH/src/github.com/harmony-one/mcl/lib:/usr/local/opt/openssl/lib
export LIBRARY_PATH=$LD_LIBRARY_PATH
export DYLD_LIBRARY_PATH=$LD_LIBRARY_PATH

mkdir -p $HOME/<path_of_your_choice>/src/github.com/harmony-one

cd $HOME/<path_of_your_choice>/src/github.com/harmony-one

git clone git@github.com:harmony-one/mcl.git

cd mcl && make -j4 && cd ..

git clone git@github.com:harmony-one/bls.git

cd bls && make -j4 && cd ..

git clone git@github.com:harmony-one/harmony.git

cd harmony

go get ./...

git submodule update --init --recursive

Build

Harmony server / main node:

go build -o bin/harmony cmd/harmony.go

Beacon node:

go build -o bin/beacon cmd/beaconchain/main.go

Wallet:

go build -o bin/wallet cmd/client/wallet/main.go

Tx Generator:

go build -o bin/txgen cmd/client/txgen/main.go

You can also run the script ./scripts/go_executable_build.sh to build all the executables.

Some of our scripts require bash 4.x support, please install bash 4.x on MacOS X.

Usage

You may build the src/harmony.go locally and run local test.

Running local test

The deploy.sh script creates a local environment of Harmony blockchain devnet based on the configuration file. The configuration file configures number of nodes and their IP/Port. The script starts one local beacon chain node, the blockchain nodes, and run a transactional generator program which generates and sends simulated transactions to the local blockchain.

./test/deploy.sh ./test/configs/local_config1.txt

Testing

Make sure you use the following command and make sure everything passed before submitting your code.

./test/test_before_submit.sh

License

Harmony is licensed under the MIT License. See LICENSE file for the terms and conditions.

Also please see our Fiduciary License Agreement if you are contributing to the project. By your submission of your contribution to us, you and we mutually agree to the terms and conditions of the agreement.

Contributing To Harmony

See CONTRIBUTING for details.

Development Status

Features Done

  • Basic consensus protocol with O(n) complexity
  • Basic validator server
  • P2p network connection and unicast
  • Account model and support for Solidity
  • Simple wallet program
  • Mock beacon chain with static sharding
  • Information disposal algorithm using erasure encoding (to be integrated)
  • Blockchain explorer with performance report and transaction lookup
  • Transaction generator for loadtesting

Features To Be Implemented

  • Full beacon chain with multiple validators
  • Resharding
  • Staking on beacon chain
  • Fast state synchronization
  • Distributed randomness generation with VRF and VDF
  • Kademlia routing
  • P2P network and gossiping
  • Full protocol of consensus with BLS multi-sig and view-change protocol
  • Integration with WASM
  • Cross-shard transaction