hyperledger / indy-plenum

Plenum Byzantine Fault Tolerant Protocol
https://wiki.hyperledger.org/display/indy
Apache License 2.0
215 stars 370 forks source link
indy

logo

Open in Gitpod

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:

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

Indy Plenum Repository Structure

Dependencies

Contact Us

How to Contribute

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.