por_consensus

README

por-consensus

Byzantine-Fault Tolerant State Machine Replication. Or Blockchain, for short.

Branch	Tests	Linting
main
v1.x
v0.38.x

por-consensus is a Byzantine Fault Tolerant (BFT) middleware that takes a state transition machine - written in any programming language - and securely replicates it on many machines. In modular blockchain terminology, por-consensus can be thought of as a sequencer layer and is indeed used in modern decentralized (shared) sequencer implementations.

por-consensus is the canonical implementation of the Tendermint consensus algorithm and is a primary building block for the Interchain Stack. Historically, por-consensus originated as a fork of Tendermint Core in early 2023 (announcement here) and since then it diverged significantly by adopting modern features such as PBTS or ABCI v2. por-consensus provides optimistic responsiveness guarantees.

For protocol details, please take a look at the por-consensus Specification.

For a detailed analysis of the Tendermint consensus protocol, including safety and liveness proofs, read our paper, "The latest gossip on BFT consensus".

For general links, including communications and announcements: linktr.ee/por-consensus

Documentation

Complete documentation can be found on the website.

Releases

Please do not depend on main as your production branch, as it may receive significant breaking changes at any time. Use releases instead.

If you intend to run por-consensus in production, we're happy to help. To contact us, in order of preference:

• Create a new discussion on GitHub
• Reach out to us via Telegram
• Join the Cosmos Network Discord and discuss in #por-consensus

More on how releases are conducted can be found here.

Support Policy

por-consensus aligns with other components of the Interchain Stack and we offer long-term support (LTS) guarantees for certain releases. The complete End of Life (EOL) schedule, LTS plans, and the general support policy is in documented and regularly updated in the discussion Support policy for por-consensus releases #590.

Security

Please see SECURITY.md.

Minimum requirements

por-consensus version	Requirement	Version	Tested with
main	Go version	1.23 or higher	up to 1.23.6
v1.x	Go version	1.23 or higher	up to 1.23.1
v0.38.x	Go version	1.22 or higher	up to 1.22

Install

See the install guide.

Quick Start

• Single node

Contributing

Please abide by the Code of Conduct in all interactions.

Before contributing to the project, please take a look at the contributing guidelines and the style guide. You may also find it helpful to read the specifications, and familiarize yourself with our Architectural Decision Records (ADRs) and Request For Comments (RFCs).

Versioning

As of v1, por-consensus uses the following approach to versioning:

• Major version bumps, such as v1.0.0 to v2.0.0, would generally involve changes that force users to perform a coordinated upgrade in order to use the new version, such as protocol-breaking changes (e.g. changes to how block hashes are computed and thus what the network considers to be "valid blocks", or how the consensus protocol works, or changes that affect network-level compatibility between nodes, etc.).
• Minor version bumps, such as v1.1.0 to v1.2.0, are reserved for rolling out new features or substantial changes that do not force a coordinated upgrade (i.e. not protocol-breaking), but could potentially break Go APIs.
• Patch version bumps, such as v1.0.0 to v1.0.1, are reserved for bug/security fixes that are not protocol- or Go API-breaking.

Upgrades

We do not guarantee compatibility between major releases of por-consensus. Minor releases of the same major release series (v1.1, v1.2, etc.) should, unless otherwise specified, be compatible with each other. Patch releases of the same minor release series (v1.0.1, v1.0.2, etc.) are guaranteed to be compatible with each other.

For more detailed information on upgrading from one version to another, see UPGRADING.md.

Supported Versions

Because we are a small core team, we have limited capacity to ship patch updates, including security updates. Consequently, we strongly recommend keeping por-consensus up-to-date. Upgrading instructions can be found in UPGRADING.md.

Currently supported versions include:

• v1.x: Currently in pre-release with no guarantees as to API stability until a release candidate is cut. See RELEASES.md for details on our process as to API stability guarantees that can be expected of por-consensus pre-releases.
• v0.38.x: por-consensus v0.38 introduces ABCI 2.0, which implements the entirety of ABCI++

Resources

Libraries

• Cosmos SDK: A framework for building high-value public blockchain applications in Go
• Tendermint in Rust
• ABCI Tower

Applications

• Cosmos Hub
• Celestia
• Anoma
• Vocdoni

Research

Below are links to the original Tendermint consensus algorithm and relevant whitepapers, which por-consensus will continue to build on.

• The latest gossip on BFT consensus
• Master's Thesis on Tendermint
• Original Whitepaper: "Tendermint: Consensus Without Mining"

Join us

por-consensus is currently maintained by Interchain Inc..

Funding for por-consensus development comes primarily from the Interchain Foundation, a Swiss non-profit.

Documentation

Index

• func InitializeAPI()

Functions

func InitializeAPI

func InitializeAPI()

InitializeAPI is a placeholder function to ensure all API packages are properly included and initialized