hyperledger/indy-plenum

Plenum Byzantine Fault Tolerant Protocol

• Announcements
  • April 12 2023
• Plenum Byzantine Fault Tolerant Protocol
• Technical Overview of Indy Plenum
• Other Documentation
• Indy Plenum Repository Structure
• Dependencies
• Contact Us
• How to Contribute
• How to Start Working with the Code

Announcements

April 12 2023

The project branches have changed.

The main branch now contains the Ubuntu 20.04 work stream, and the previous main branch containing the Ubuntu 16.04 work stream has been moved to the ubuntu-16.04 branch. We encourage everyone to switch to using the new code and appreciate your patience while we stabilize the work flows and documentation on this new branch.

The following changes were made to the branches:

• main (default) renamed to ubuntu-16.04
  • This retargeted the associated PRs.
• ubuntu-20.04-upgrade set as the default branch.
• ubuntu-20.04-upgrade (default) renamed to main

Plenum Byzantine Fault Tolerant Protocol

Plenum is the heart of the distributed ledger technology inside Hyperledger Indy. As such, it provides features somewhat similar in scope to those found in Fabric. However, it is special-purposed for use in an identity system, whereas Fabric is general purpose.

Technical Overview of Indy Plenum

Refer to our documentation site at indy.readthedocs.io for the most current documentation and walkthroughs.

Please find the general overview of the system in Overview of the system.

Plenum's consensus protocol which is based on RBFT is described in consensus protocol diagram.

More documentation can be found in docs.

Other Documentation

• Please have a look at aggregated documentation at indy-node-documentation which describes workflows and setup scripts common for both projects.

Indy Plenum Repository Structure

• plenum:
  • the main codebase for plenum including Byzantine Fault Tolerant Protocol based on RBFT
• common:
  • common and utility code
• crypto:
  • basic crypto-related code (in particular, indy-crypto wrappers)
• ledger:
  • Provides a simple, python-based, immutable, ordered log of transactions backed by a merkle tree.
  • This is an efficient way to generate verifiable proofs of presence and data consistency.
  • The scope of concerns here is fairly narrow; it is not a full-blown distributed ledger technology like Fabric, but simply the persistence mechanism that Plenum needs.
• state:
  • state storage using python 3 version of Ethereum's Patricia Trie
• stp:
  • secure transport abstraction
  • it has ZeroMQ implementations
• storage:
  • key-value storage abstractions
  • contains leveldb implementation as the main key-valued storage used in Plenum (for ledger, state, etc.)

Dependencies

• Plenum makes extensive use of coroutines and the async/await keywords in Python, and as such, requires Python version 3.5.0 or later.
• Plenum also depends on libsodium, an awesome crypto library. These need to be installed separately.
• Plenum uses ZeroMQ as a secure transport
• indy-crypto
  • A shared crypto library
  • It's based on AMCL
  • In particular, it contains BLS multi-signature crypto needed for state proofs support in Indy.

Contact Us

• Bugs, stories, and backlog for this codebase are managed in Hyperledger's Jira. Use project name INDY.
• Join us on Jira's Rocket.Chat at #indy and/or #indy-node channels to discuss.

How to Contribute

• We'd love your help; see these instructions on how to contribute.
• You may also want to read this info about maintainers.

How to Start Working with the Code

The preferred method of setting up the development environment is to use the devcontainers. All configuration files for VSCode and Gitpod are already placed in this repository. If you are new to the concept of devcontainers in combination with VSCode here is a good article about it.

Simply clone this repository and VSCode will most likely ask you to open it in the devcontainer, if you have the correct extension("ms-vscode-remote.remote-containers") installed. If VSCode didn't ask to open it, open the command palette and use the Remote-Containers: Rebuild and Reopen in Container command.

If you want to use Gitpod simply use this link or if you want to work with your fork, prefix the entire URL of your branch with gitpod.io/# so that it looks like https://gitpod.io/#https://github.com/hyperledger/indy-plenum/tree/main.

Note: Be aware that the config files for Gitpod and VSCode are currently only used in the main branch!

Please have a look at Dev Setup in indy-node repo. It contains common setup for both indy-plenum and indy-node.