Skip to content

Latest commit

 

History

History
247 lines (182 loc) · 12.7 KB

README.md

File metadata and controls

247 lines (182 loc) · 12.7 KB
Raw

dYdX Fork of CometBFT

This is a lightweight fork of CometBFT. The current version of the forked code resides on the default branch.

Making Changes to the Fork

  1. Open a PR against the current default branch (i.e. dydx-fork-v0.38.2).
  2. Get approval, and merge.
  3. After merging, update the v4 repository's go.mod, and go.sum files with your merged $COMMIT_HASH.
  4. (In dydxprotocol/v4) go mod edit -replace github.com/cometbft/cometbft=github.com/dydxprotocol/cometbft@$COMMIT_HASH
  5. (In dydxprotocol/v4) go mod tidy
  6. (In dydxprotocol/v4) update package references in mocks/Makefile. See here for an example.
  7. Open a PR in dydxprotocol/v4 to bump the version of the fork.

Fork maintenance

We'd like to keep the main branch up to date with cometbft/cometbft. You can utilize GitHub's sync fork button to accomplish this. ⚠️ Please only use this on the main branch, not on the fork branches as it will discard our commits.⚠️

Note that this doesn't pull in upstream tags, so in order to do this follow these steps:

  1. git fetch upstream
  2. git push --tags

dYdX Proto maintenance

In order to support some of our custom functionality, we require some dydx protobuf files to be copied into this repository. Currently, the source of truth for protos is in dydxprotocol/v4, and any changes that require updates to any of the protos in this repository should be sync'd over as well. Here are steps for updating and compiling the protos here.

  1. Modify the protos in proto/dydxcometbft.
  2. make proto-gen

Note that the protos cannot be copied over directly. golang protobufs share a global namespace, and we have changed the package name slightly to avoid a name clash.

We've also included a new dependency in the buf.yaml file for "cosmos_proto/cosmos.proto". If this needs to be updated, run buf build. For more information, read here.

In the future, we will aim to have a single source of truth for protos.

Updating CometBFT to new versions

When a new version of CometBFT is published, we may want to adopt the changes in our fork. This process can be somewhat tedious, but below are the recommended steps to accomplish this.

  1. Ensure the main branch and all tags are up to date by following the steps above in "Fork maintenance".
  2. Create a new branch off the desired CometBFT commit using tags. git checkout -b dydx-fork-$VERSION <CometBFT repo's tag name>. The new branch should be named something like dydx-fork-$VERSION where $VERSION is the version of CometBFT being forked (should match the CometBFT repo's tag name). i.e. dydx-fork-v0.38.2.
  3. Push the new branch.
  4. Open a PR which cherry-picks each commit in the current default branch, in order, on to the new dydx-fork-$VERSION branch (note: you may want to consider creating multiple PRs for this process if there are difficulties or merge conflicts). For example, git cherry-pick <commit hash>.
  5. Get approval, and merge.
  6. Update dydxprotocol/v4 by following the steps in "Making Changes to the fork" above.
  7. Set dydx-fork-$VERSION as the default branch in this repository.

CometBFT

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

Version API Reference Go version Discord chat License Sourcegraph

Branch Tests Linting
main Tests Lint
v0.38.x Tests Lint
v0.37.x Tests Lint
v0.34.x Tests Lint

CometBFT 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.

It is a fork of Tendermint Core and implements the Tendermint consensus algorithm.

For protocol details, refer to the CometBFT Specification.

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

Documentation

Complete documentation can be found on the website.

Releases

Please do not depend on main as your production branch. Use releases instead.

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

More on how releases are conducted can be found here.

Security

To report a security vulnerability, see our bug bounty program. For examples of the kinds of bugs we're looking for, see our security policy.

Minimum requirements

CometBFT version Requirement Notes
main Go version Go 1.20 or higher
v0.38.x Go version Go 1.20 or higher
v0.37.x Go version Go 1.20 or higher
v0.34.x Go version Go 1.19 or higher

Install

See the install guide.

Quick Start

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

Semantic Versioning

CometBFT uses Semantic Versioning to determine when and how the version changes. According to SemVer, anything in the public API can change at any time before version 1.0.0

To provide some stability to users of 0.X.X versions of CometBFT, the MINOR version is used to signal breaking changes across CometBFT's API. This API includes all publicly exposed types, functions, and methods in non-internal Go packages as well as the types and methods accessible via the CometBFT RPC interface.

Breaking changes to these public APIs will be documented in the CHANGELOG.

Upgrades

In an effort to avoid accumulating technical debt prior to 1.0.0, we do not guarantee that breaking changes (i.e. bumps in the MINOR version) will work with existing CometBFT blockchains. In these cases you will have to start a new blockchain, or write something custom to get the old data into the new chain. However, any bump in the PATCH version should be compatible with existing blockchain histories.

For more information on upgrading, 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 CometBFT up-to-date. Upgrading instructions can be found in UPGRADING.md.

Currently supported versions include:

  • v0.38.x: CometBFT v0.38 introduces ABCI 2.0, which implements the entirety of ABCI++
  • v0.37.x: CometBFT v0.37 introduces ABCI 1.0, which is the first major step towards the full ABCI++ implementation in ABCI 2.0
  • v0.34.x: The CometBFT v0.34 series is compatible with the Tendermint Core v0.34 series

Resources

Libraries

Applications

Research

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

Join us

CometBFT is currently maintained by Informal Systems. If you'd like to work full-time on CometBFT, we're hiring!

Funding for CometBFT development comes primarily from the Interchain Foundation, a Swiss non-profit. Informal Systems also maintains cometbft.com.