Rongjian Lan
738134a7da
|
5 years ago | |
---|---|---|
.github/ISSUE_TEMPLATE | 6 years ago | |
.hmy | 5 years ago | |
accounts | 5 years ago | |
api | 5 years ago | |
block | 5 years ago | |
cmd | 5 years ago | |
common/denominations | 5 years ago | |
consensus | 5 years ago | |
contracts | 5 years ago | |
core | 5 years ago | |
crypto | 5 years ago | |
drand | 5 years ago | |
gomock_matchers | 6 years ago | |
hmy | 5 years ago | |
hmyclient | 5 years ago | |
internal | 5 years ago | |
msgq | 5 years ago | |
node | 5 years ago | |
numeric | 5 years ago | |
p2p | 5 years ago | |
scripts | 5 years ago | |
shard | 5 years ago | |
specs | 5 years ago | |
staking | 5 years ago | |
test | 5 years ago | |
tools | 6 years ago | |
.bnkey | 6 years ago | |
.coveralls.yml | 6 years ago | |
.gitignore | 5 years ago | |
.gitmodules | 6 years ago | |
.travis.yml | 5 years ago | |
CONTRIBUTING.md | 6 years ago | |
FLA.md | 6 years ago | |
LICENSE | 6 years ago | |
Makefile | 5 years ago | |
PULL_REQUEST_TEMPLATE.md | 5 years ago | |
README.md | 5 years ago | |
appspec.yml | 6 years ago | |
go.mod | 5 years ago |
README.md
Harmony
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
Note: make sure to run scripts/install_build_tools.sh
to make sure build tools are of correct versions.
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