celestia-app
celestia-app is the software used by validators and full consensus nodes on the Celestia consensus network. celestia-app is a blockchain application built using parts of the Cosmos stack:
Diagram
^ +-------------------------------+ ^
| | | |
| | 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
Source
-
Install Go 1.22.3
-
Clone this repo
-
Install the celestia-app CLI
make install
Prebuilt binary
If you'd rather not install from source, you can download a prebuilt binary from the releases page.
-
Navigate to the latest release on https://github.com/celestiaorg/celestia-app/releases.
-
Download the binary for your platform (e.g. celestia-app_Linux_x86_64.tar.gz
) from the Assets section. Tip: if you're not sure what platform you're on, you can run uname -a
and look for the operating system (e.g. Linux
, Darwin
) and architecture (e.g. x86_64
, arm64
).
-
Extract the archive
tar -xvf celestia-app_Linux_x86_64.tar.gz
-
Verify the extracted binary works
./celestia-appd --help
-
[Optional] verify the prebuilt binary checksum. Download checksums.txt
and then verify the checksum:
sha256sum --ignore-missing --check checksums.txt
You should see output like this:
celestia-app_Linux_x86_64.tar.gz: OK
See https://docs.celestia.org/nodes/celestia-app for more information.
Usage
# Print help
celestia-appd --help
Environment variables
Variable |
Explanation |
Default value |
Required |
CELESTIA_HOME |
Home directory for the application |
User home dir. Ref. |
Optional |
Create your own single node devnet
# Start a single node devnet
./scripts/single-node.sh
# Publish blob data to the local devnet
celestia-appd tx blob pay-for-blob 0x00010203040506070809 0x48656c6c6f2c20576f726c6421 \
--chain-id private \
--from validator \
--keyring-backend test \
--fees 21000utia \
--yes
[!NOTE]
The celestia-appd binary doesn't support signing with Ledger hardware wallets on Windows and OpenBSD.
Contributing
This repo attempts to conform to conventional commits so PR titles should ideally start with fix:
, feat:
, build:
, chore:
, ci:
, docs:
, style:
, refactor:
, perf:
, or test:
because this helps with semantic versioning and changelog generation. It is especially important to include an !
(e.g. feat!:
) if the PR includes a breaking change.
This repo contains multiple go modules. When using it, rename go.work.example
to go.work
and run go work sync
.
- Install golangci-lint 1.57.0
- Install markdownlint 0.39.0
- Install hadolint
- Install yamllint
- Install markdown-link-check
- Install goreleaser
Helpful Commands
# Get more info on make commands.
make help
# Build the celestia-appd binary into the ./build directory.
make build
# Build and install the celestia-appd binary into the $GOPATH/bin directory.
make install
# Run tests
make test
# Format code with linters (this assumes golangci-lint and markdownlint are installed)
make fmt
# Regenerate Protobuf files (this assumes Docker is running)
make proto-gen
Docs
Package-specific READMEs aim to explain implementation details for developers that are contributing to these packages. The specs aim to explain the protocol as a whole for developers building on top of Celestia.
Audits