Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/celestiaorg/celestia-core
A fork of CometBFT
https://github.com/celestiaorg/celestia-core
celestia data-availability data-availability-sampling lazyledger tendermint
Last synced: 7 days ago
JSON representation
A fork of CometBFT
- Host: GitHub
- URL: https://github.com/celestiaorg/celestia-core
- Owner: celestiaorg
- License: apache-2.0
- Created: 2019-11-15T13:37:18.000Z (about 5 years ago)
- Default Branch: v0.34.x-celestia
- Last Pushed: 2024-10-29T08:54:22.000Z (3 months ago)
- Last Synced: 2024-10-29T10:03:09.038Z (3 months ago)
- Topics: celestia, data-availability, data-availability-sampling, lazyledger, tendermint
- Language: Go
- Homepage:
- Size: 244 MB
- Stars: 487
- Watchers: 32
- Forks: 263
- Open Issues: 157
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
- awesome-ccamel - celestiaorg/celestia-core - A fork of CometBFT (Go)
- best-of-crypto - GitHub - 22% open · ⏱️ 05.06.2024): (Others)
README
# celestia-core
[](https://pkg.go.dev/github.com/celestiaorg/celestia-core)
[](https://github.com/celestiaorg/celestia-core/releases/latest)
[](https://goreportcard.com/report/github.com/celestiaorg/celestia-core)
[](https://github.com/celestiaorg/celestia-core/actions/workflows/lint.yml)
[](https://github.com/celestiaorg/celestia-core/actions/workflows/tests.yml)
celestia-core is a fork of [cometbft/cometbft](https://github.com/cometbft/cometbft), an implementation of the Tendermint protocol, with the following changes:
1. Early adoption of the ABCI++ methods: `PrepareProposal` and `ProcessProposal` because they haven't yet landed in a CometBFT release.
1. Modifications to how `DataHash` in the block header is determined. In CometBFT, `DataHash` is based on the transactions included in a block. In Celestia, block data (including transactions) are erasure coded into a data square to enable data availability sampling. In order for the header to contain a commitment to this data square, `DataHash` was modified to be the Merkle root of the row and column roots of the erasure coded data square. See [ADR 008](https://github.com/celestiaorg/celestia-core/blob/v0.34.x-celestia/docs/celestia-architecture/adr-008-updating-to-tendermint-v0.35.x.md?plain=1#L20) for the motivation or [celestia-app/pkg/da/data_availability_header.go](https://github.com/celestiaorg/celestia-app/blob/2f89956b22c4c3cfdec19b3b8601095af6f69804/pkg/da/data_availability_header.go) for the implementation. Note on the implementation: celestia-app computes the hash in prepare_proposal and returns it to CometBFT via [`blockData.Hash`](https://github.com/celestiaorg/celestia-app/blob/5bbdac2d3f46662a34b2111602b8f964d6e6fba5/app/prepare_proposal.go#L78) so a modification to celestia-core isn't strictly necessary but [comments](https://github.com/celestiaorg/celestia-core/blob/2ec23f804691afc196d0104616e6c880d4c1ca41/types/block.go#L1041-L1042) were added.
See [./docs/celestia-architecture](./docs/celestia-architecture/) for architecture decision records (ADRs) on Celestia modifications.
## Diagram
```ascii
^ +-------------------------------+ ^
| | | |
| | State-machine = Application | |
| | | | celestia-app (built with Cosmos SDK)
| | ^ + | |
| +----------- | ABCI | ----------+ v
Celestia | | + v | ^
validator or | | | |
full consensus | | Consensus | |
node | | | |
| +-------------------------------+ | celestia-core (fork of CometBFT)
| | | |
| | Networking | |
| | | |
v +-------------------------------+ v
```
## Install
See
## Usage
See
## Contributing
This repo intends on preserving the minimal possible diff with [cometbft/cometbft](https://github.com/cometbft/cometbft) to make fetching upstream changes easy. If the proposed contribution is
- **specific to Celestia**: consider if [celestia-app](https://github.com/celestiaorg/celestia-app) is a better target
- **not specific to Celestia**: consider making the contribution upstream in CometBFT
1. [Install Go](https://go.dev/doc/install) 1.23.1+
2. Fork this repo
3. Clone your fork
4. Find an issue to work on (see [good first issues](https://github.com/celestiaorg/celestia-core/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22))
5. Work on a change in a branch on your fork
6. When your change is ready, push your branch and create a PR that targets this repo
### Helpful Commands
```sh
# Build a new CometBFT binary and output to build/comet
make build
# Install CometBFT binary
make install
# Run tests
make test
# If you modified any protobuf definitions in a `*.proto` file then
# you may need to lint, format, and generate updated `*.pb.go` files
make proto-lint
make proto-format
make proto-gen
```
## Branches
The canonical branches in this repo are based on CometBFT releases. For example: [`v0.34.x-celestia`](https://github.com/celestiaorg/celestia-core/tree/v0.34.x-celestia) is based on the CometBFT `v0.34.x` release branch and contains Celestia-specific changes.
## Versioning
Releases are formatted: `v-tm-v`
For example: [`v1.4.0-tm-v0.34.20`](https://github.com/celestiaorg/celestia-core/releases/tag/v1.4.0-tm-v0.34.20) is celestia-core version `1.4.0` based on CometBFT `0.34.20`.
`CELESTIA_CORE_VERSION` strives to adhere to [Semantic Versioning](http://semver.org/).