Skip to content
This repository was archived by the owner on Aug 27, 2025. It is now read-only.
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 15 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,9 @@

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](https://dev.zilliqa.com/docs/contributors/contribute-buildzil).
* If you’re interested in mining Zilliqa, see here: https://dev.zilliqa.com/miners/mining/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/api/introduction/api-introduction/.
* If you’re interested more about the core protocol, see the [developer portal](https://dev.zilliqa.com/contributors/contributors/contribute-buildzil/).
* If you’re interested in hacking on the Zilliqa code base, see the [Coding Guidelines](https://github.com/Zilliqa/Zilliqa/wiki/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.
Expand Down Expand Up @@ -48,26 +48,26 @@ The Zilliqa Improvement Proposals (ZIPs) are the core protocol standards for the

The current release has the following features implemented:

* [Network sharding](https://dev.zilliqa.com/docs/basics/basics-zil-sharding#network-sharding)
* [Transaction sharding](https://dev.zilliqa.com/docs/basics/basics-zil-sharding#transaction-sharding)
* [Ethash Proof of Work (PoW) for joining the network](https://dev.zilliqa.com/docs/contributors/core-gossip)
* [GPU (OpenCL and CUDA) for PoW](https://dev.zilliqa.com/docs/contributors/core-pow#gpu-mine)
* [Block rewarding mechanism](https://dev.zilliqa.com/docs/basics/basics-zil-reward/)
* [Gas pricer](https://dev.zilliqa.com/docs/contributors/core-global-gas-price)
* [Coinbase rewards](https://dev.zilliqa.com/docs/contributors/core-coinbase)
* [Network sharding](https://dev.zilliqa.com/basics/zilliqa-architecture/basics-zil-sharding/)
* [Transaction sharding](https://dev.zilliqa.com/basics/zilliqa-architecture/basics-zil-sharding/#transaction-sharding)
* [Ethash Proof of Work (PoW) for joining the network](https://dev.zilliqa.com/contributors/core-protocol-design/network-layer/core-gossip/)
* [GPU (OpenCL and CUDA) for PoW](https://dev.zilliqa.com/contributors/core-protocol-design/mining/core-pow/#gpu-mine)
* [Block rewarding mechanism](https://dev.zilliqa.com/basics/zilliqa-architecture/basics-zil-reward/)
* [Gas pricer](https://dev.zilliqa.com/contributors/core-protocol-design/mining/core-gas-computation/)
* [Coinbase rewards](https://dev.zilliqa.com/contributors/core-protocol-design/mining/core-coinbase/)
* [EC-Schnorr signature](https://github.com/Zilliqa/schnorr)
* [pBFT Consensus mechanism](https://dev.zilliqa.com/docs/contributors/core-consensus)
* [pBFT Consensus mechanism](https://dev.zilliqa.com/contributors/core-protocol-design/consensus-layer/core-consensus/)
* Data layer and accounts store
* [Smart contract layer](https://scilla.readthedocs.io)
* 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](https://dev.zilliqa.com/docs/contributors/core-view-change)
* [View change mechanism](https://dev.zilliqa.com/contributors/core-protocol-design/mitigation-measures/core-view-change/)
* Node recovery mechanism
* Protocol upgrade mechanism
* [Gossip protocol for network message broadcasting](https://dev.zilliqa.com/docs/contributors/core-gossip)
* [Seed Node Staking](https://dev.zilliqa.com/docs/staking/staking-overview)
* [Gossip protocol for network message broadcasting](https://dev.zilliqa.com/contributors/core-protocol-design/network-layer/core-gossip/)
* [Seed Node Staking](https://dev.zilliqa.com/staking/zilliqa-seed-node-staking/overview/)

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

Expand All @@ -78,7 +78,7 @@ In the coming months, we plan to have the following features:

## Minimum System Requirements

To run Zilliqa, we recommend the minimum system requirements specified in our [Mining](https://dev.zilliqa.com/docs/miners/mining-zilclient#hardware-requirements) page.
To run Zilliqa, we recommend the minimum system requirements specified in our [Mining](https://dev.zilliqa.com/miners/mining/mining-zilclient/) page.

## Build from Source Code

Expand Down Expand Up @@ -181,4 +181,3 @@ You can find scripts which will set up an Ubuntu 22.04 machine in the cloud (or
| **Development discussion (discord)** | <a href="https://discord.gg/XMRE9tt" target="_blank"><img src="https://img.shields.io/discord/370992535725932544.svg" /></a> |
| **Bug report** | <a href="https://github.com/Zilliqa/zilliqa/issues" target="_blank"><img src="https://img.shields.io/github/issues/Zilliqa/zilliqa.svg" /></a> |
| **Security contact** | `security` :globe_with_meridians: `zilliqa.com` |
| **Security bug bounty** | <a href="https://hackerone.com/zilliqa" target="_blank">HackerOne bug bounty</a> |