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.
 
 
 
Rongjian Lan 3de4056de3
Merge pull request #1619 from rlan35/general_fix
5 years ago
.github/ISSUE_TEMPLATE Update issue templates (#782) 6 years ago
.hmy [Pangaea] Reset DNS Server and Bootnode (#1578) 5 years ago
accounts Migrate go-ethereum params into harmony/internal/params 5 years ago
api Merge pull request #1619 from rlan35/general_fix 5 years ago
block fixed cx txn with the change and added comments explanining the 3 differences between header.GetShardState vs core.GetShardState vs. chain.ReadShardState 5 years ago
cmd [rpc] listen to localhost by default 5 years ago
common/denominations Move networkType into internal config 5 years ago
consensus todo 5 years ago
contracts Merge conflicts 5 years ago
core use only one index for CXEntryLookup; use shardID instead of fromShardID in RPC returned results 5 years ago
crypto Move (core/)types.rlpHash -> (crypto/)hash.FromRLP 5 years ago
drand Merge remote-tracking branch 'origin/s3' 5 years ago
gomock_matchers Add gomock matcher utilities 6 years ago
hmy address some minor issues in comments and code 5 years ago
hmyclient Merge conflicts 5 years ago
internal Merge pull request #1612 from chaosma/rpc-leader 5 years ago
node Merge pull request #1619 from rlan35/general_fix 5 years ago
p2p [ping] display blskey in ping message 5 years ago
scripts [node.sh] uses separate options to download harmony db 5 years ago
shard Move header fields into private struct; expose them using getters/setters 5 years ago
specs Create nat-hole-punching-spike.md 6 years ago
test Cleanup state sync logic; fix explorer node sync wrong committee issue 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 [node] every node uses persistent DHT storage 5 years ago
.gitmodules Unvendor now that module mode is on 6 years ago
.travis.yml Peg s3 to Go 1.12 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
Makefile Simplify build process with Makefile 5 years ago
PULL_REQUEST_TEMPLATE.md Update PULL_REQUEST_TEMPLATE.md 6 years ago
README.md Simplify build process with Makefile 5 years ago
appspec.yml change benchmark to harmony 6 years ago
go.mod Merge pull request #1538 from harmony-ek/version_headers 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>

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
git clone git@github.com:harmony-one/bls.git
git clone git@github.com:harmony-one/harmony.git

cd harmony

make

Build

If you want to bypass the Makefile:

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
export GO111MODULE=on

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

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