celestia-node

module
v0.18.0-rc45-debug-qui... Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 30, 2024 License: Apache-2.0

README

Celestia Node

Go Reference GitHub release (latest by date including pre-releases) Go CI Go Report Card codecov

Golang implementation of Celestia's data availability node types (light | full | bridge).

The celestia-node types described above comprise the celestia data availability (DA) network.

The DA network wraps the celestia-core consensus network by listening for blocks from the consensus network and making them digestible for data availability sampling (DAS).

Continue reading here if you want to learn more about DAS and how it enables secure and scalable access to Celestia chain data.

Table of Contents

Minimum requirements

Requirement Notes
Go version 1.23 or higher

System Requirements

See the official docs page for system requirements per node type:

Installation

git clone https://github.com/celestiaorg/celestia-node.git
cd celestia-node
make build
sudo make install

For more information on setting up a node and the hardware requirements needed, go visit our docs at https://docs.celestia.org.

API docs

The celestia-node public API is documented here.

Node types

  • Bridge nodes - relay blocks from the celestia consensus network to the celestia data availability (DA) network
  • Full nodes - fully reconstruct and store blocks by sampling the DA network for shares
  • Light nodes - verify the availability of block data by sampling the DA network for shares

More information can be found here.

Run a node

<node_type> can be: bridge, full or light.

celestia <node_type> init
celestia <node_type> start

Please refer to this guide for more information on running a node.

Environment variables

Variable Explanation Default value Required
CELESTIA_BOOTSTRAPPER Start the node in bootstrapper mode false Optional

Package-specific documentation

Code of Conduct

See our Code of Conduct here.

Directories

Path Synopsis
api
cmd
Package das contains the most important functionality provided by celestia-node.
Package das contains the most important functionality provided by celestia-node.
Package header contains all services related to generating, requesting, syncing and storing ExtendedHeaders.
libs
Package share contains logic related to the retrieval and random sampling of shares of block data.
Package share contains logic related to the retrieval and random sampling of shares of block data.
Package state provides a structure for celestia-node's ability to access state-relevant information from as well as submit transactions/messages to the celestia network.
Package state provides a structure for celestia-node's ability to access state-relevant information from as well as submit transactions/messages to the celestia network.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL