celestiaorg / docs

Celestia Documentation Site

Celestia Documentation Site

Welcome to the official documentation repository for Celestia.

Here you'll find comprehensive guides, tutorials, and reference materials to help you make the most out of Celestia.

Building the site

To get started, clone the repository and run the following:

yarn && yarn dev

This documentation site is built with VitePress

Contribution Guidelines

We love contributions from the community! Whether you're fixing typos, improving content clarity, or adding new topics, every contribution helps.

• Fork & Clone: Fork this repository and clone it to your local machine.
• Branch: Always create a new branch for your changes. Naming it relevantly.
• Commit Changes: Make your changes and commit them with a clear and concise commit message.
• Push & Create PR: Push your changes to your fork and create a pull request to the main branch of this repository.

Please ensure to review the detailed Contribution Guidelines above before making a pull request.

Directory Structure

• /learn: A category for learning about Celestia.
• /developers: A category with tutorials and guides for deploying rollups and interacting with Celestia nodes.
• /nodes: Technical reference materials for all node types.

• /community: A category for the Celestia community.
• /public: Images, diagrams, and other media files used in the documentation.

Feedback & Suggestions

We value feedback from the community. If you have suggestions for improvements or find any discrepancies in the documentation, please raise an issue in this repository.

docs's Issues

Create A Wallet As A Separate Documentation Page

Integrate Search Functionality in the Docs

Integration search functionality in the docs will make finding things much easier as we grow our docs.

Create Docs on CosmWasm with Optimint

Integrate Existing Diagrams as Draw.io Code In the Docs

After merging this: #73

We can move the code for the diagrams as draw.io code to be rendered in the docs page.

Sentence-case all titles for consistency

https://github.com/celestiaorg/docs/blob/main/docs/developers/celestia-app-commands.md does this. https://github.com/celestiaorg/docs/blob/main/docs/developers/node-tutorial.md does not.

Integrate Draw.io Plugin in the Docs

Allowing for Draw.io plugins allows for rendering different charts and graphs via code and keeping them well updated

Deploy Smart Contract on Ethermint-Optimint Docs

Deploying A Smart Contract

• Which Version is the EVMOS compiler on?

Add a Tools Section for the Docs

List available tools that Celestia community can use like explorers, wallets, etc.

Document Celestia's Reserved Namespaces

It's important for developers to know what Celestia's Reserved Namespaces are

Update diagram of celestia stack in our docs

At present we dont have an updated diagram which we show here: https://docs.celestia.org/nodes/bridge-node, as the celestia full storage node was introduced after that diagram was made.

Given the new node type that diagram should be updated and perhaps any changes to the docs due to it (like the general overview of each celestia node sub node type and what it does etc)

Clicking "Edit this page" in the document returns an error

In the documentation page, when you click "Edit this page", it will jump to the error page

Translate Docs to Russian

Do a documentation translation to Russian

Command to check balance assumes celestia-appd is running

I funded a wallet following the steps in https://docs.celestia.org/developers/wallet#fund-a-wallet

However I can't query celestia-appd because I don't have it running. This section assumes I have celestia-appd running but I haven't gotten to that step yet.

root@rootulp-consensus-full-node:~/celestia-app# celestia-appd q bank balances celestia1w9axzgxkqkznpgwhlp80f4uq9nzm59ry809l7a
Error: Post "http://localhost:26657": dial tcp [::1]:26657: connect: connection refused

Clarify bandwidth requirements

There's no internet service in the world measured as "GB of input-output."

1. Specify bandwidth in Mbps or Gbps
2. Specify up and down separately

Add Tracking to the Docs

Add tracking to the docs page

Create A Full Node Tutorial Guide

Create A Separate Tutorial for Full Node

Add Docs For Interacting With Celestia Node API

When API for Nodes is Ready, Document It

Troubleshooting note for account not found when calling submit_pfd

[ec2-user@ip-172-31-15-92 celestia-node]$ curl -X POST -d '{"namespace_id": "c14da9d459dc57f5", "data": "4f7a3f1aadd83255b8410fef4860c0cd2eba82e24a", "gas_limit": 60000}'  localhost:26658/submit_pfd
"rpc error: code = NotFound desc = account celestia1krkle0n547u0znz3unnln8paft2dq4z3rznv86 not found"

This error is observed if an account hasn't been funded with testnet tokens prior to calling submit_pfd. It may help to include a small troubleshooting note under https://docs.celestia.org/developers/node-tutorial#submit-a-pfd-transaction

PFD curl commands cause errors in bash shell

https://docs.celestia.org/developers/node-tutorial#node-api-calls

Working through the above steps:

• curl -X GET http://127.0.0.1:26658/balance/ returns a 404, the working endpoint for me is curl -X GET http://127.0.0.1:26658/balance

• The example PFD curl command gives me the below error. This is fixed by removing the slashes within the curl command.

  • invalid character '\\\\' looking for beginning of object key string

Wondering if others are hitting these issues, or if the second issue is just something weird with my shell.

Broken link

• On the light node page, the link to the install celestia node page doesn't lead anywhere
• Also in the "start the light node" section, the link to the RPC endpoints is also broken - its meant to lead to this url: https://docs.celestia.org/nodes/mamaki-testnet/#rpc-endpoints
• same with the link in the "Optional: Start Light Node with SystemD" section. Required url: https://docs.celestia.org/nodes/systemd/#celestia-light-node
• same with "setup the dependencies" section.

Translate Docs to Mandarin

Do a documentation translation to Mandarin

Add More Buttons to Landing Page of Docs

Change Body Font to Use Inter

Documentation body font should use Inter instead of Ruberoid.

Configure branches to be automatically deleted on merge

Explain Why Validators Need to Run A Bridge Node

Explain the need for validators to also need a bridge node.

Update Node API endpoints in the Docs

Update Node API Endpoints in the Docs after this PR is merged: celestiaorg/celestia-node#693

Add CI job to check output

This isn't easily maintainable. A CI job should be added that runs the above steps, then runs celestia version and compares the output to these lines.

Originally posted by @adlerjohn in #109 (comment)

Documentation Request: Explain Entire Protocol

Documentation Pages Explained in Depth

• Data Availability Layer
• Describe Fraud Proofs and its Lifecycle
• Describe Settlement Layer
• Describe QGB
• Describe Consensus
• Describe Slashing
• Describe Different Rollups like Optimistic and ZK Rollups
• Describe Sovereign Rollups

Add `/head` to API docs

Update Run A Node Section

Update Run A Node Section based on feedback from @0xmako

Have Automated Swagger API Docs for Newly Updated Binaries

Having a service discovery system when new binary releases are added will allow for automatic updating of the API endpoints that Celestia's codebase offers

Add `/data-available` Endpoint to Node API Docs

Based on this PR celestiaorg/celestia-node#802

Create Docs on Creating A Sovereign Chain with Cosmos-SDK

Smart Contract Deployment on Rollup on Ethermint Docs

Define What PayForData Means

It's important to define what PayForData means in the context of Celestia.

Long outputs

Some of the JSON output examples in the docs are really long and take up too much space on the page. We should try to modify the template so that long outputs have a scrollbar.

Remove backlinks in Mamaki testnet guide

I'm setting up a consensus full node by following https://docs.celestia.org/nodes/consensus-full-node

which links to https://docs.celestia.org/nodes/mamaki-testnet#setup-p2p-network

the bottom of this section says:

You can return back to where you left off in the Bridge Node guide here

However this section is applicable to consensus full nodes and not just bridge nodes so this backlink is confusing.

This occurs again in the following section https://docs.celestia.org/nodes/mamaki-testnet#quick-sync-with-snapshot

You can return back to where you left off in the Bridge Node guide here

Confusing naming in the docs

Hey guys, so while checking the docs page for the validator, we have a nice diagram that shows how the celestia stack works in general.

The diagram shows that a Bridge Node is made out of celestia app and celestia node. All good here.

The docs also start ok here: https://docs.celestia.org/nodes/bridge-validator-node#deploy-the-celestia-node

But then at some point that changes (https://docs.celestia.org/nodes/bridge-validator-node#initialize-the-bridge-node), and the name Bridge Node is introduced, as a substack of the "main" Bridge Node. See the confusion?
Now granted the issue is that the Celestia Node actually starts with the command: celestia bridge. Alas when discussing the stack, people mentioning the bridge node can now mean two things, either the full stack (celestia app and celestia node) or as just the bridge node (celestia node).

One idea i had that doesnt change things too much could also be to leave the naming of the stack as the Bridge Node, and name the sub component of it, to be strictly Celestia Node Bridge. Downside of that is people might still get confused while discussing, since the word bridge is still mentioned in both parts.

The easiest solution is still to just rename the stack (celestia app and celestia node (bridge)) to something else.

cc @YazzyYaz

Docs on denominations

https://docs.celestia.org/nodes/mamaki-testnet includes commands that reference the denomination utia however this denomination doesn't appear to be documented.

Perhaps it would be helpful to include a section or page that describes token denominations for Celestia:

1. Are there other denominations?
2. What does utia stand for?
3. If no denomination is specified, is utia the default?
4. What is the relationship between TIA and utia?

Document that PFD endpoint accepts up to 2 MB under default settings

The Node submit_pfd API endpoint must indicate it can accept up-to 1 MB size for a data submission

Consistent casing for light node, bridge node, full node

I don't think these should be capitalized when used in paragraphs. Ex:

1. https://github.com/celestiaorg/docs/blob/main/docs/nodes/systemd.md?plain=1#L205=

Provide Metamask Docs for Rollup on Ethermint Docs

Metamask as an example

Tutorial on Running an Ethermint-Tendermint Node

Running an Astria Node

• Wait on this PR
  Script
• Set the version of Ethermint via a flag
• export ETHERMINT_IMAGE_TAG=sha-02075c6
• https://github.com/celestiaorg/ethermint/pkgs/container/ethermint
• https://github.com/celestiaorg/ephemeral-cluster#ephemeral-cluster

Celestia node flags are outdates across the doc

In multiple places there is use of --core.grpc host:port flag that doesn't exist anymore. It needs to be updated to combination of flags: --core.ip , --core.grpc.port

Translate Docs to French

Do a Documentation Translation to French

Add instructions for submitting and getting data from Celestia for testnet

Create Tutorial on common validator commands with Celestia App

Create Tutorial on QGB Deployment and Settlement on an EVM Network

Explain Slashing in the Docs

Feedback from one of the validators is to explain the slashing mechanics in consensus using the docs.

Add Docker Compose Docs For Ephemeral Testnet

https://github.com/celestiaorg/ephemeral-cluster