Add a contribution guide

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 v9.2.3 and Scilla v0.13.3.

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

Developer Testnet

The current live version on the Developer Testnet is Zilliqa v9.2.5 and Scilla v0.13.3.

	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 from Source Code

Starting with Zilliqa v8.6.0, the officially supported operating system is Ubuntu 22.04.

If you'd like to experiment with a different distro (including the previously supported Ubuntu 18.04), please make sure to install gcc >= 11.

Run the following to install the build dependencies:

sudo apt-get update
sudo apt-get install autoconf \
    build-essential \
    ccache \
    clang-format \
    clang-tidy \
    git \
    lcov \
    libcurl4-openssl-dev \
    libssl-dev \
    libtool \
    libxml2-utils \
    ninja-build \
    ocl-icd-opencl-dev \
    pkg-config \
    python3-dev \
    python3-pip \
    libgmp-dev \
    bison \
    gawk
git submodule update --init --recursive

Run the following to install latest version of cmake. CMake version >= 3.19 must be used:

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

To install, clone vcpkg to a separate location (do not use brew on macos):

$ git clone https://github.com/Microsoft/vcpkg.git /path/to/vcpkg
$ cd /path/to/vcpkg && git checkout 2022.09.27 && ./bootstrap-vcpkg.sh
$ cd /path/to/zilliqa
$ export VCPKG_ROOT=/path/to/vcpkg

As part of building our source code, we patch websocketpp 0.8.2 to compile on C++20; please see the license: https://github.com/zaphoyd/websocketpp/blob/master/COPYING.

Build Zilliqa from the source:

# build Zilliqa binary
$ ./build.sh

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

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

Logs of each node can be found at ./local_run
To terminate Zilliqa:
```
$ pkill zilliqa
```

Start a local network development environment

This is similar to the above, but deploys a local testnet to a local minikube cluster.

You can find documentation on how to do this on your local machine in docs/localdev.md.

You can find scripts which will set up an Ubuntu 22.04 machine in the cloud (or install necessary dependencies on your machine) in docs/setup/README.md.

Further Enquiries

	Link(s)
Development discussion (discord)
Bug report
Security contact	`security` 🌐 `zilliqa.com`
Security bug bounty	HackerOne bug bounty

	bool isVacuousEpoch = (m_consensusID >= (NUM_FINAL_BLOCK_PER_POW - NUM_VACUOUS_EPOCHS));

	{
	unique_lock<mutex> g(m_mediator.m_node->m_mutexUnavailableMicroBlocks, defer_lock);
	unique_lock<mutex> g2(m_mediator.m_node->m_mutexAllMicroBlocksRecvd, defer_lock);
	lock(g, g2);

	if(isVacuousEpoch && !m_mediator.m_node->m_allMicroBlocksRecvd)

	void AddJob(const std::function<void()>& job)
	{
	// scoped lock
	{
	std::lock_guard<std::mutex> lock(_queueMutex);
	#if CONTIGUOUS_JOBS_MEMORY
	_queue.push_back(job);
	#else
	_queue.push(job);
	#endif
	}
	// scoped lock
	{
	std::lock_guard<std::mutex> lock(_jobsLeftMutex);
	++_jobsLeft;
	}
	_jobAvailableVar.notify_one();
	}

	CMAKE_SOURCE_DIR = /home/junhao/Desktop/octcoin/other_br/production/zilliqa

	# The top-level build directory on which CMake was run.
	CMAKE_BINARY_DIR = /home/junhao/Desktop/octcoin/other_br/production/zilliqa

	map<PubKey, Peer> & shard = m_shards.at(i % numOfComms);
	shard.insert(make_pair(key, m_allPoWConns.at(key)));
	m_publicKeyToShardIdMap.insert(make_pair(key, i % numOfComms));

	using namespace std;
	using namespace boost::multiprecision;

zilliqa / zilliqa Goto Github PK

zilliqa's Introduction

Zilliqa

Overview

Zilliqa Mainnet

Developer Testnet

Zilliqa Improvement Proposal (ZIP)

Available Features

Minimum System Requirements

Build from Source Code

Build Scilla for Smart Contract Execution

Boot Up a Local Testnet for Development

Start a local network development environment

Further Enquiries

zilliqa's People

Contributors

Stargazers

Watchers

Forkers

zilliqa's Issues

Compilation(warnings and enhancements)

Runtime

Recommend Projects

Recommend Topics

Recommend Org

Jobs