• Stars
    star
    209
  • Rank 188,325 (Top 4 %)
  • Language
    Python
  • License
    Apache License 2.0
  • Created almost 9 years ago
  • Updated over 1 year ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Plenum Byzantine Fault Tolerant Protocol

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:

  • 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

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.

More Repositories

1

fabric

Hyperledger Fabric is an enterprise-grade permissioned distributed ledger framework for developing solutions and applications. Its modular and versatile design satisfies a broad range of industry use cases. It offers a unique approach to consensus that enables performance at scale while preserving privacy.
Go
14,808
star
2

hyperledger

Hyperledger is a Collaborative Project at The Linux Foundation.
3,702
star
3

fabric-samples

Samples for Hyperledger Fabric
Go
2,611
star
4

besu

An enterprise-grade Java-based, Apache 2.0 licensed Ethereum client https://wiki.hyperledger.org/display/besu
Java
1,314
star
5

solang

Solidity Compiler for Solana and Polkadot
Rust
1,180
star
6

fabric-sdk-java

Java
1,098
star
7

fabric-sdk-go

Go
885
star
8

cello

Operating System for Enterprise Blockchain
Python
850
star
9

fabric-sdk-node

Hyperledger Fabric SDK for Node https://wiki.hyperledger.org/display/fabric
JavaScript
777
star
10

indy-node

The server portion of a distributed ledger purpose-built for decentralized identity.
Python
647
star
11

caliper

A blockchain benchmark framework to measure performance of multiple blockchain solutions https://wiki.hyperledger.org/display/caliper
JavaScript
605
star
12

fabric-ca

Go
426
star
13

firefly

Hyperledger FireFly is the first open source Supernode: a complete stack for enterprises to build and scale secure Web3 applications. The FireFly API for digital assets, data flows, and blockchain transactions makes it radically faster to build production-ready apps on popular chains and protocols.
Go
423
star
14

iroha

Iroha - A simple, enterprise-grade decentralized ledger
C++
395
star
15

fabric-sdk-py

Hyperledger Fabric Python SDK
Python
394
star
16

aries-cloudagent-python

Hyperledger Aries Cloud Agent Python (ACA-Py) is a foundation for building decentralized identity applications and services running in non-mobile environments.
Python
373
star
17

bevel

An automation framework for rapidly and consistently deploying production-ready DLT platforms
Smarty
317
star
18

aries-rfcs

Hyperledger Aries is infrastructure for blockchain-rooted, peer-to-peer interactions
Python
311
star
19

fabric-chaincode-java

Hyperledger Fabric Contract and Chaincode implementation for Java https://wiki.hyperledger.org/display/fabric
Java
290
star
20

cacti

Hyperledger Cacti is a new approach to the blockchain interoperability problem
TypeScript
289
star
21

aries

Hyperledger Aries is infrastructure for blockchain-rooted, peer-to-peer interactions
257
star
22

bevel-operator-fabric

Hyperledger Fabric Kubernetes operator - Hyperledger Fabric operator for Kubernetes (v2.3, v2.4 and v2.5)
Go
239
star
23

fabric-chaincode-node

Hyperledger Fabric Node.js Smart Contracts
JavaScript
229
star
24

aries-framework-javascript

Aries Framework JavaScript (Built using TypeScript)
TypeScript
208
star
25

fabric-gateway-java

Hyperledger Fabric Gateway SDK for Java https://wiki.hyperledger.org/display/fabric
Java
201
star
26

fabric-contract-api-go

Packages for the implementation of the contract API for use in Go chaincode
Go
192
star
27

fabric-test

A collection of utilities used to test the core Hyperledger Fabric projects
Go
150
star
28

fabric-private-chaincode

FPC enables Confidential Chaincode Execution for Hyperledger Fabric using Intel SGX.
Go
147
star
29

fabric-chaincode-go

Hyperledger Fabric Packages for Go Chaincode
Go
130
star
30

aries-mobile-agent-react-native

Aries Mobile Agent React Native - Part of the Aries Bifold effort to provide SSI capabilities in a production ready app.
TypeScript
125
star
31

fabric-gateway

Go, Node and Java client API for Hyperledger Fabric v2.4+
Java
121
star
32

iroha-python

Python library for Hyperledger Iroha, a simple distributed ledger.
Python
104
star
33

caliper-benchmarks

Sample benchmark files for Hyperledger Caliper https://wiki.hyperledger.org/display/caliper
JavaScript
96
star
34

iroha-javascript

JavaScript library for Iroha, a Distributed Ledger Technology (blockchain) platform.
JavaScript
93
star
35

iroha-ios

iOS Swift library for Iroha, a simple distributed ledger
Objective-C
91
star
36

fabric-docs-i18n

Hyperledger Fabric is an enterprise-grade permissioned distributed ledger framework for developing solutions and applications. Its modular and versatile design satisfies a broad range of industry use cases. It offers a unique approach to consensus that enables performance at scale while preserving privacy.
Makefile
85
star
37

firefly-ethconnect

Ethereum connectivity bridge for Web Services & async Messaging APIs - familiar to Enterprise Apps
Go
72
star
38

indy-hipe

Hyperledger Indy Project Enhancements
TeX
71
star
39

web3j-evm

A library for running an embedded Ethereum EVM in-process on a JVM
Kotlin
61
star
40

aries-vcx

aries-vcx is set of crates to work with DIDs, DID Documents, DIDComm, Verifiable Credentials and Hyperledger Aries.
Rust
61
star
41

besu-docs

Documentation for Hyperledger Besu enterprise-grade Java-based, Apache 2.0 licensed Ethereum client https://wiki.hyperledger.org/display/besu
CSS
56
star
42

aries-agent-test-harness

Aries agent test framework, with agent backchannel support
Python
56
star
43

anoncreds-rs

anoncreds-rs
Rust
53
star
44

web3j-cli

Command-line interface for web3j
Java
53
star
45

aries-askar

Secure storage designed for Hyperledger Aries agents.
Rust
49
star
46

firefly-cli

FireFly Command Line Interface (CLI)
Go
47
star
47

indy-vdr

A library and proxy server for interacting with Hyperledger Indy Node ledger instances
Rust
47
star
48

aries-acapy-controllers

Web controllers for the Aries Cloud Agent - Python (ACA-Py)
HTML
44
star
49

fabric-protos-go

Generated Go bindings for fabric-protos
Go
44
star
50

anoncreds-spec

The specification for AnonCreds verifiable credential exchange.
CSS
39
star
51

fabric-protos

Makefile
38
star
52

web3j-docs

Web3j documentation repository.
35
star
53

firefly-ui

FireFly UI
TypeScript
31
star
54

toc

Hyperledger TOC documents
29
star
55

firefly-fabconnect

REST API to interact with a Fabric network and event streaming via websocket
Go
29
star
56

aries-mediator-service

HTML
29
star
57

fabric-rfcs

RFC process for Hyperledger Fabric. The RFC (request for comments) process is intended to provide a consistent and controlled path for major changes to Fabric and other official project components. https://wiki.hyperledger.org/display/fabric
29
star
58

iroha-java

Kotlin
28
star
59

iroha-ed25519

RFC8032 compatible Ed25519 implementation with pluggable hash (sha2-512, sha3-512)
Assembly
28
star
60

aries-framework-javascript-ext

Extension libraries for Aries Framework JavaScript
TypeScript
25
star
61

fabric-config

Hyperledger Fabric Packages for channel configuration transactions. Documentation at https://pkg.go.dev/github.com/hyperledger/fabric-config/configtx.
Go
24
star
62

web3j-unit

Smart contract testing framework via integrated EVM and various Ethereum clients
Kotlin
22
star
63

firefly-tokens-erc1155

ERC1155 token integration
TypeScript
21
star
64

aries-staticagent-python

Aries Static Agent library for Python
Python
20
star
65

firefly-transaction-manager

Blockchain transaction manager for Hyperledger FireFly. Integrates public blockchains through a pluggable FireFly Connector API framework. Extensible policy engine for managing gas & resubmission. Confirmation manager for managing finality on both transactions and event streams.
Go
20
star
66

fabric-cli

Go
19
star
67

indy-node-container

Providing Containers to run Indy Node
Shell
19
star
68

fabric-admin-sdk

Fabric SDK for Admin Capability services
Go
19
star
69

firefly-samples

Samples for FireFly
TypeScript
18
star
70

firefly-tokens-erc20-erc721

ERC20 and ERC721 token integration
TypeScript
18
star
71

indy-did-method

Indy DID Method Specification
CSS
17
star
72

indy-node-monitor

Python
14
star
73

firefly-helm-charts

Firefly Helm Charts
Smarty
14
star
74

aries-framework-swift

A Swift framework for Aries.
Swift
14
star
75

aries-javascript-docs

A documentation site for the Aries JavaScript ecosystem.
TypeScript
13
star
76

indy-shared-rs

Shared Rust data types and utility functions for Hyperledger Indy.
Rust
13
star
77

firefly-evmconnect

Firefly EVM Connect
Go
12
star
78

firefly-sdk-nodejs

FireFly SDK for Node.js
TypeScript
11
star
79

anoncreds-v2-rs

Anonymous Credential Exchange 2.0
Rust
11
star
80

firefly-sandbox

Hyperledger FireFly Sandbox
TypeScript
10
star
81

firefly-dataexchange-https

TypeScript
10
star
82

aries-mobile-test-harness

An acceptance test framework for testing mobile Aries wallets utilizing Python, Behave, Appium, and a mobile device cloud service.
Python
10
star
83

besu-native

Java
8
star
84

indy-test-automation

Automation tools for testing of Indy Project components.
Python
8
star
85

aries-socketdock

Websocket Relay Service for use with clustered Mediators
Python
8
star
86

anoncreds-tex

anoncreds
TeX
7
star
87

anoncreds-spec-v2

CSS
7
star
88

firefly-signer

Signing, Keystore, ABI and RLP encoding utilities for EVM / Ethereum / secp256k1 based blockchains. Written in Go with an enterprise friendly Apache 2.0 license, and a runtime JSON/RPC proxy server. Part of the Hyperledger FireFly project
Go
7
star
89

aries-framework-kotlin

aries-framework-kotlin
Kotlin
6
star
90

firefly-cordaconnect

Java
6
star
91

iroha-2-docs

TypeScript
6
star
92

hyperledger.github.io

HTML
6
star
93

hyperledger-hip

Hyperledger Improvement Proposal (HIP)
6
star
94

aries-acapy-tools

Hyperledger Aries
Python
6
star
95

firefly-fir

5
star
96

indy-did-networks

indy-did-networks
5
star
97

governance

5
star
98

aries-endorser-service

endorser-service
Python
5
star
99

fabric-amcl

Go
4
star
100

anoncreds-revocation

JavaScript
4
star