danielchudc/zilliqa

Zilliqa is the world's first high-throughput public blockchain platform - designed to scale to thousands ​of transactions per second.

Zilliqa

Overview

Zilliqa is a scalable smart contract platform that aims to tackle the congestion issue plaguing the blockchain industry. Zilliqa utilises a unique sharded architecture to achieve parallel processing of transactions while maintaining a large number of public nodes. Hence, Zilliqa is a blockchain capable of reaching high throughput and processing more complex computations while remaining decentralised and secure.

• If you’re interested in mining Zilliqa, see here: https://dev.zilliqa.com/docs/miners/mining-getting-started/.
• If you’d like to use the interface with Zilliqa nodes to transfer ZIL and deploy/call smart contracts, see here: https://dev.zilliqa.com/docs/apis/api-introduction.
• If you’re interested more about the core protocol, see the developer portal.
• If you’re interested in hacking on the Zilliqa code base, see the Coding Guidelines.

NOTE: The master branch is not for production as development is currently being worked constantly, please use the tag releases if you wish to work on the version of Zilliqa client that is running live on the Zilliqa blockchain.

Zilliqa Mainnet

The current live version on the Zilliqa Mainnet is Zilliqa v7.2.0 and Scilla v0.9.1.

	URL(s)
API URL	https://api.zilliqa.com/
Block Explorer	Viewblock DEVEX

Developer Testnet

The current live version on the Developer Testnet is Zilliqa v7.2.0 and Scilla v0.9.1.

	URL(s)
API URL	https://dev-api.zilliqa.com/
Block Explorer	Viewblock DEVEX
Faucet	Link

Zilliqa Improvement Proposal (ZIP)

The Zilliqa Improvement Proposals (ZIPs) are the core protocol standards for the Zilliqa platform.To view or contribute to ZIP, please visit https://github.com/Zilliqa/zip

Available Features

The current release has the following features implemented:

• Network sharding
• Transaction sharding
• Ethash Proof of Work (PoW) for joining the network
• GPU (OpenCL and CUDA) for PoW
• Block rewarding mechanism
• Gas pricer
• Coinbase rewards
• EC-Schnorr signature
• pBFT Consensus mechanism
• Data layer and accounts store
• Smart contract layer
• State delta forwarding
• Lookup nodes and Seed nodes for receiving and dispatching transactions
• Persistent storage for transactions and state
• S3 storage retrieval from archival nodes
• View change mechanism
• Node recovery mechanism
• Protocol upgrade mechanism
• Gossip protocol for network message broadcasting
• Seed Node Staking

In the coming months, we plan to have the following features:

• Further unit and integration tests
• Enhancement of existing features
• More operating system support
• And much more...

Minimum System Requirements

To run Zilliqa, we recommend the minimum system requirements specified in our Mining page.

Build Dependencies

The officially supported operating system is Ubuntu 16.04, until Zilliqa v6.4.2.

Effective Zilliqa v7.0.0, the officially supported operating system is Ubuntu 18.04. Although Zilliqa continues to be backward compatible with Ubuntu 16.04, we recommend users to upgrade to Ubuntu 18.04 moving forward.

Run the following to install the build dependencies:

sudo apt-get update
sudo apt-get install git libboost-system-dev libboost-filesystem-dev libboost-test-dev \
    libssl-dev libleveldb-dev libjsoncpp-dev libsnappy-dev libmicrohttpd-dev \
    libjsonrpccpp-dev build-essential pkg-config libevent-dev libminiupnpc-dev \
    libcurl4-openssl-dev libboost-program-options-dev libboost-python-dev python3-dev \
    python3-setuptools python3-pip gawk

Run the following to install latest version of cmake.We suggest to install cmake 3.19 or any version >=3.16:

wget https://github.com/Kitware/CMake/releases/download/v3.19.3/cmake-3.19.3-Linux-x86_64.sh
mkdir -p "${HOME}"/.local
bash ./cmake-3.19.3-Linux-x86_64.sh --skip-license --prefix="${HOME}"/.local/
export PATH=$HOME/.local/bin:$PATH
cmake --version
rm cmake-3.19.3-Linux-x86_64.sh

Additional Requirements for Contributors

If you intend to contribute to the code base, please perform these additional steps:

1. Install pyyaml:

   pip install pyyaml

2. Create file /etc/apt/sources.list.d/llvm-7.list with the following contents (reference):

   deb http://apt.llvm.org/xenial/ llvm-toolchain-xenial-7 main
   deb-src http://apt.llvm.org/xenial/ llvm-toolchain-xenial-7 main
   

3. Run the following:

   curl https://apt.llvm.org/llvm-snapshot.gpg.key | sudo apt-key add -
   sudo apt-get update
   sudo apt-get install clang-format-7 clang-tidy-7 -y

Build from Source Code

Build Zilliqa from the source:

# download the lastest stable Zilliqa source code
$ git clone https://github.com/Zilliqa/Zilliqa.git
$ cd Zilliqa && git checkout tags/v7.2.0

# build Zilliqa binary
$ ./build.sh

If you want to build the development branch instead, do:

$ git checkout master

If you want to contribute by submitting code changes in a pull request, perform the build with clang-format and clang-tidy enabled by doing:

$ ./build.sh style

Build Scilla for Smart Contract Execution

The Zilliqa client works together with Scilla for executing smart contracts. Please refer to the Scilla repository for build and installation instructions.

Boot Up a Local Testnet for Development

1. Run the local testnet script in build directory:

   $ cd build && ./tests/Node/pre_run.sh && ./tests/Node/test_node_lookup.sh && ./tests/Node/test_node_simple.sh

2. Logs of each node can be found at ./local_run.

3. To terminate Zilliqa:

   $ pkill zilliqa

Further Enquiries

	Link(s)
Development discussion (discord)
Bug report
Security contact	security 🌐 zilliqa.com
Security bug bounty	Contact security:globe_with_meridians:zilliqa.com` for early access to our new security bug bounty program