celestia-node

module

v0.7.0-rc1-dirty Latest Latest Go to latest Published: Jan 25, 2023 License: Apache-2.0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/celestiaorg/celestia-node

Links

README ¶

Celestia Node

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.

Minimum requirements

Requirement	Notes
Go version	1.19 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

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

Package-specific documentation

Code of Conduct

See our Code of Conduct here.

Directories ¶

Path	Synopsis
api
docgen Package docgen generates an OpenRPC spec for the Celestia Node.	Package docgen generates an OpenRPC spec for the Celestia Node.
gateway
rpc
rpc/client
rpc/perms
cmd
cel-key command
cel-shed command
celestia command
docgen command
core
das Package das contains the most important functionality provided by celestia-node.	Package das contains the most important functionality provided by celestia-node.
fraud
pb
header Package header contains all services related to generating, requesting, syncing and storing ExtendedHeaders.	Package header contains all services related to generating, requesting, syncing and storing ExtendedHeaders.
pb
headertest
libs
fslock
fxutil
header Package header contains all services related to generating, requesting, syncing and storing Headers.	Package header contains all services related to generating, requesting, syncing and storing Headers.
header/local
header/mocks
header/p2p
header/p2p/pb
header/store
header/sync
header/test
keystore
utils
logs
nodebuilder
core
das
das/mocks Package mocks is a generated GoMock package.	Package mocks is a generated GoMock package.
fraud
fraud/mocks Package mocks is a generated GoMock package.	Package mocks is a generated GoMock package.
gateway
header
header/mocks Package mocks is a generated GoMock package.	Package mocks is a generated GoMock package.
node
node/mocks Package mocks is a generated GoMock package.	Package mocks is a generated GoMock package.
p2p
p2p/mocks Package mocks is a generated GoMock package.	Package mocks is a generated GoMock package.
rpc
share
share/mocks Package mocks is a generated GoMock package.	Package mocks is a generated GoMock package.
state
state/mocks Package mocks is a generated GoMock package.	Package mocks is a generated GoMock package.
tests/swamp
share 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.
availability/cache
availability/discovery
availability/full
availability/light TODO(@Wondertan): Instead of doing sampling over the coordinates do a random walk over NMT trees.	TODO(@Wondertan): Instead of doing sampling over the coordinates do a random walk over NMT trees.
availability/mocks Package mocks is a generated GoMock package.	Package mocks is a generated GoMock package.
availability/test
eds
eds/byzantine
eds/byzantine/pb
getters
ipld
mocks Package mocks is a generated GoMock package.	Package mocks is a generated GoMock package.
p2p
p2p/shrexeds
p2p/shrexeds/pb
p2p/shrexnd
p2p/shrexnd/pb
p2p/shrexsub
state 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.

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