base on Celestia consensus node # celestia-app [](https://pkg.go.dev/github.com/celestiaorg/celestia-app) [](https://celestiaorg.github.io/celestia-app/) [](https://github.com/celestiaorg/celestia-app/releases/latest) [](https://goreportcard.com/report/github.com/celestiaorg/celestia-app) [](https://www.gitpoap.io/gh/celestiaorg/celestia-app) celestia-app is the software used by [validators](https://docs.celestia.org/nodes/validator-node) and [consensus nodes](https://docs.celestia.org/nodes/consensus-node) on the Celestia consensus network. celestia-app is a blockchain application built using parts of the Cosmos stack: - [celestiaorg/cosmos-sdk](https://github.com/celestiaorg/cosmos-sdk) a fork of [cosmos/cosmos-sdk](https://github.com/cosmos/cosmos-sdk) - [celestiaorg/celestia-core](https://github.com/celestiaorg/celestia-core) a fork of [cometbft/cometbft](https://github.com/cometbft/cometbft) ## 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 ### From source 1. [Install Go](https://go.dev/doc/install) 1.23.1 1. Clone this repo 1. Install the celestia-appd binary ```shell make install ``` ### Prebuilt binary If you'd rather not install from source, you can download a prebuilt binary from the [releases](https://github.com/celestiaorg/celestia-app/releases) page. 1. Navigate to the latest release on <https://github.com/celestiaorg/celestia-app/releases>. 1. 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`). 1. Extract the archive ```shell tar -xvf celestia-app_Linux_x86_64.tar.gz ``` 1. Verify the extracted binary works ```shell ./celestia-appd --help ``` 1. [Optional] verify the prebuilt binary checksum. Download `checksums.txt` and then verify the checksum: ```shell sha256sum --ignore-missing --check checksums.txt ``` You should see output like this: ```shell celestia-app_Linux_x86_64.tar.gz: OK ``` See <https://docs.celestia.org/nodes/celestia-app> for more information. ## Usage > [!WARNING] > The celestia-appd binary doesn't support signing with Ledger hardware wallets on Windows and OpenBSD. ### Prerequisites Enable the [BBR](https://www.ietf.org/archive/id/draft-cardwell-iccrg-bbr-congestion-control-01.html) ("Bottleneck Bandwidth and Round-trip propagation time") congestion control algorithm. ```shell # Check if BBR is enabled. make bbr-check # If BBR is not enabled then enable it. make bbr-enable ``` ### Environment variables | Variable | Explanation | Default value | Required | |-----------------|-------------------------------------------------------------------|----------------------------------------------------------|----------| | `CELESTIA_HOME` | Where the application directory (`.celestia-app`) should be saved | [User home directory](https://pkg.go.dev/os#UserHomeDir) | Optional | ### Using celestia-appd ```sh # Print help. celestia-appd --help # Create config files for a new chain named "test". celestia-appd init test # Start the consensus node. celestia-appd start ``` ### Create a single node local testnet ```sh # Start a single node local testnet. ./scripts/single-node.sh # Publish blob data to the local testnet. celestia-appd tx blob pay-for-blob 0x00010203040506070809 0x48656c6c6f2c20576f726c6421 \ --chain-id private \ --from validator \ --keyring-backend test \ --fees 21000utia \ --yes ``` ### Usage as a library If you import celestia-app as a Go module, you may need to add some Go module `replace` directives to avoid type incompatibilities. Please see the `replace` directive in [go.mod](./go.mod) for inspiration. ### Usage in tests If you are running celestia-app in tests, you may want to override the `timeout_commit` to produce blocks faster. By default, a celestia-app chain with app version >= 3 will produce blocks every ~6 seconds. To produce blocks faster, you can override the `timeout_commit` with the `--timeout-commit` flag. ```shell # Start celestia-appd with a one second timeout commit. celestia-appd start --timeout-commit 1s ``` ## Contributing This repo attempts to conform to [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) 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`. ### Tools 1. Install [golangci-lint](https://golangci-lint.run/welcome/install) 1.61.0 1. Install [markdownlint](https://github.com/DavidAnson/markdownlint) 0.39.0 1. Install [hadolint](https://github.com/hadolint/hadolint) 1. Install [yamllint](https://yamllint.readthedocs.io/en/stable/quickstart.html) 1. Install [markdown-link-check](https://github.com/tcort/markdown-link-check) 1. Install [goreleaser](https://goreleaser.com/install/) ### Helpful Commands ```sh # 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 lint-fix # 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](https://celestiaorg.github.io/celestia-app/) aim to explain the protocol as a whole for developers building on top of Celestia. ## Audits | Date | Auditor | Version | Report | |------------|-----------------------------------------------|--------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------| | 2023/9/15 | [Informal Systems](https://informal.systems/) | [v1.0.0-rc6](https://github.com/celestiaorg/celestia-app/releases/tag/v1.0.0-rc6) | [informal-systems.pdf](docs/audit/informal-systems.pdf) | | 2023/10/17 | [Binary Builders](https://binary.builders/) | [v1.0.0-rc10](https://github.com/celestiaorg/celestia-app/releases/tag/v1.0.0-rc10) | [binary-builders.pdf](docs/audit/binary-builders.pdf) | | 2024/7/1 | [Informal Systems](https://informal.systems/) | [v2.0.0-rc1](https://github.com/celestiaorg/celestia-app/releases/tag/v2.0.0-rc1) | [informal-systems-v2.pdf](docs/audit/informal-systems-v2.pdf) | | 2024/9/20 | [Informal Systems](https://informal.systems/) | [306c587](https://github.com/celestiaorg/celestia-app/commit/306c58745d135d31c3777a1af2f58d50adbd32c8) | [informal-systems-authored-blobs.pdf](docs/audit/informal-systems-authored-blobs.pdf) | ", Assign "at most 3 tags" to the expected json: {"id":"6101","tags":[]} "only from the tags list I provide: [{"id":77,"name":"3d"},{"id":89,"name":"agent"},{"id":17,"name":"ai"},{"id":54,"name":"algorithm"},{"id":24,"name":"api"},{"id":44,"name":"authentication"},{"id":3,"name":"aws"},{"id":27,"name":"backend"},{"id":60,"name":"benchmark"},{"id":72,"name":"best-practices"},{"id":39,"name":"bitcoin"},{"id":37,"name":"blockchain"},{"id":1,"name":"blog"},{"id":45,"name":"bundler"},{"id":58,"name":"cache"},{"id":21,"name":"chat"},{"id":49,"name":"cicd"},{"id":4,"name":"cli"},{"id":64,"name":"cloud-native"},{"id":48,"name":"cms"},{"id":61,"name":"compiler"},{"id":68,"name":"containerization"},{"id":92,"name":"crm"},{"id":34,"name":"data"},{"id":47,"name":"database"},{"id":8,"name":"declarative-gui "},{"id":9,"name":"deploy-tool"},{"id":53,"name":"desktop-app"},{"id":6,"name":"dev-exp-lib"},{"id":59,"name":"dev-tool"},{"id":13,"name":"ecommerce"},{"id":26,"name":"editor"},{"id":66,"name":"emulator"},{"id":62,"name":"filesystem"},{"id":80,"name":"finance"},{"id":15,"name":"firmware"},{"id":73,"name":"for-fun"},{"id":2,"name":"framework"},{"id":11,"name":"frontend"},{"id":22,"name":"game"},{"id":81,"name":"game-engine "},{"id":23,"name":"graphql"},{"id":84,"name":"gui"},{"id":91,"name":"http"},{"id":5,"name":"http-client"},{"id":51,"name":"iac"},{"id":30,"name":"ide"},{"id":78,"name":"iot"},{"id":40,"name":"json"},{"id":83,"name":"julian"},{"id":38,"name":"k8s"},{"id":31,"name":"language"},{"id":10,"name":"learning-resource"},{"id":33,"name":"lib"},{"id":41,"name":"linter"},{"id":28,"name":"lms"},{"id":16,"name":"logging"},{"id":76,"name":"low-code"},{"id":90,"name":"message-queue"},{"id":42,"name":"mobile-app"},{"id":18,"name":"monitoring"},{"id":36,"name":"networking"},{"id":7,"name":"node-version"},{"id":55,"name":"nosql"},{"id":57,"name":"observability"},{"id":46,"name":"orm"},{"id":52,"name":"os"},{"id":14,"name":"parser"},{"id":74,"name":"react"},{"id":82,"name":"real-time"},{"id":56,"name":"robot"},{"id":65,"name":"runtime"},{"id":32,"name":"sdk"},{"id":71,"name":"search"},{"id":63,"name":"secrets"},{"id":25,"name":"security"},{"id":85,"name":"server"},{"id":86,"name":"serverless"},{"id":70,"name":"storage"},{"id":75,"name":"system-design"},{"id":79,"name":"terminal"},{"id":29,"name":"testing"},{"id":12,"name":"ui"},{"id":50,"name":"ux"},{"id":88,"name":"video"},{"id":20,"name":"web-app"},{"id":35,"name":"web-server"},{"id":43,"name":"webassembly"},{"id":69,"name":"workflow"},{"id":87,"name":"yaml"}]" returns me the "expected json"