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.
 
 
 
Richard Liu a15a43df36
Merge pull request #1217 from lzl124631x/ricl-hmy-client
5 years ago
.github/ISSUE_TEMPLATE Update issue templates (#782) 6 years ago
.hmy [wallet] support new localnet 5 years ago
accounts Replaced loggers in `accounts/` with custom shared logger 5 years ago
api Replace all logs in api module to use zerolog 5 years ago
cmd block 5 years ago
common/denominations Move networkType into internal config 5 years ago
consensus Log common.Hash with hex instead of TerminalString/Bytes() 5 years ago
contracts Integrate swapped bls into core protocol 5 years ago
core add hmyclient 5 years ago
crypto add nil pointer protection when deserialize pubkey 5 years ago
drand Replace all logs in drand module to use zerolog 5 years ago
gomock_matchers Add gomock matcher utilities 6 years ago
hmy update comments 5 years ago
hmyclient eth not found 5 years ago
internal Merge pull request #1218 from lzl124631x/ricl-timestamp 5 years ago
node add minting demo addresses to local test 5 years ago
p2p Replaced loggers in `p2p/` with custom shared logger 5 years ago
scripts [node] add option to not download binaries in node.sh 5 years ago
specs Create nat-hole-punching-spike.md 6 years ago
test add minting demo addresses to local test 5 years ago
tools Add github.com/golangci/golangci-lint/cmd/golangci-lint@v1.15.0 as a build tool 6 years ago
.bnkey [bootnode] add a default bootnode key locally 6 years ago
.coveralls.yml add coveralls 6 years ago
.gitignore [misc] ignore local test db and blspass.txt 5 years ago
.gitmodules Unvendor now that module mode is on 6 years ago
.travis.yml update travis to compile SWAPPED BLS 5 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 [doc] fixed Readme 5 years ago
appspec.yml change benchmark to harmony 6 years ago
go.mod Add ZeroLogger to utils 5 years ago

README.md

Harmony

Build Status gopherbadger-tag-do-not-edit Discord Coverage Status Go Report Card

Installation Requirements

GMP and OpenSSL

brew install gmp
brew install openssl

Dev Environment Setup

The required go version is: go1.12

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_FALLBACK_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 BLS_SWAP_G=1 -j4 && cd ..

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

cd harmony

export GO111MODULE=on

./scripts/go_executable_build.sh

Build

Note : Some of our scripts require bash 4.x support, please install bash 4.x on MacOS X. Make sure you set export GO111MODULE=on.

Build all executables

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

Build individual executables

Harmony server / main node:

./scripts/go_executable_build.sh harmony

Wallet:

./scripts/go_executable_build.sh wallet

Tx Generator:

./scripts/go_executable_build.sh txgen

Usage

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

Running local test

The debug.sh script calls test/deploy.sh script to create 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 2 shards and 7 nodes in each shard.

./test/debug.sh

Test local blockchain

source scripts/setup_bls_build_flags.sh
./bin/wallet list
./bin/wallet -p local balances

Terminate the local blockchain

./test/kill_nodes.sh

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.

Harmony includes third-party open source code. In general, a source subtree with a LICENSE or COPYRIGHT file is from a third party, and our modifications thereto are licensed under the same third-party open source license.

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

  • Fully sharded network with beacon chain and shard chains
  • Cuckoo-rule based resharding
  • Staking on beacon chain
  • Distributed randomness generation with VRF and VDF (Proof-of-Concept VDF)
  • Sharded P2P network and P2P gossiping
  • FBFT (Fast Byzantine Fault Tolerance) Consensus with BLS multi-signature
  • Account model and support for Solidity
  • Simple wallet program
  • 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

  • Secure VDF
  • Consensus view-change protocol
  • Cross-shard transaction

Features Planned after Mainnet

  • Integration with WASM
  • Fast state synchronization
  • Kademlia routing