README
¶
Elysium Node
Golang implementation of Elysium's data availability node types (light | full | bridge).
The elysium-node types described above comprise the elysium data availability (DA) network.
The DA network wraps the elysium-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 Elysium chain data.
Table of Contents
Minimum requirements
| Requirement | Notes |
|---|---|
| Go version | 1.20 or higher |
System Requirements
See the official docs page for system requirements per node type:
Installation
git clone https://github.com/furyaxyz/elysium-node.git
cd elysium-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.elysium.org.
API docs
Elysium-node public API is documented here.
Node types
- Bridge nodes - relay blocks from the elysium consensus network to the elysium 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.
elysium <node_type> init
elysium <node_type> start
Environment variables
| Variable | Explanation | Default value | Required |
|---|---|---|---|
ELESYIUM_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
|
|
|
docgen
Package docgen generates an OpenRPC spec for the Elysium Node.
|
Package docgen generates an OpenRPC spec for the Elysium Node. |
|
docgen
command
|
|
|
ely-key
command
|
|
|
ely-shed
command
|
|
|
elysium
command
|
|
|
Package das contains the most important functionality provided by elysium-node.
|
Package das contains the most important functionality provided by elysium-node. |
|
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. |
|
libs
|
|
|
das/mocks
Package mocks is a generated GoMock package.
|
Package mocks is a generated GoMock package. |
|
fraud/mocks
Package mocks is a generated GoMock package.
|
Package mocks is a generated GoMock package. |
|
header/mocks
Package mocks is a generated GoMock package.
|
Package mocks is a generated GoMock package. |
|
node/mocks
Package mocks is a generated GoMock package.
|
Package mocks is a generated GoMock package. |
|
p2p/mocks
Package mocks is a generated GoMock package.
|
Package mocks is a generated GoMock package. |
|
share/mocks
Package mocks is a generated GoMock package.
|
Package mocks is a generated GoMock package. |
|
state/mocks
Package mocks is a generated GoMock package.
|
Package mocks is a generated GoMock package. |
|
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/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. |
|
mocks
Package mocks is a generated GoMock package.
|
Package mocks is a generated GoMock package. |
|
Package state provides a structure for elysium-node's ability to access state-relevant information from as well as submit transactions/messages to the elysium network.
|
Package state provides a structure for elysium-node's ability to access state-relevant information from as well as submit transactions/messages to the elysium network. |