Skip to content

docs: polish README for mainnet readiness (develop) #116

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
prestwich merged 2 commits into from
Mar 23, 2026
Merged

docs: polish README for mainnet readiness (develop) #116

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4837a04
docs: polish README for mainnet readiness
init4samwise Mar 21, 2026
9417bfc
docs: update component list for develop branch
init4samwise Mar 23, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
57 changes: 31 additions & 26 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,35 +1,13 @@
# Signet Node Components

[![CI](https://github.com/init4tech/node-components/actions/workflows/rust.yml/badge.svg)](https://github.com/init4tech/node-components/actions/workflows/rust.yml)
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)

> **Note:** The `main` branch is in maintenance and bug-fix mode. The
> `develop` branch contains current work.

A collection of components for building the Signet node. These components
implement core node functionality, but are potentially indepedently useful.

## What's in the Components?

- **signet-node-types** - Shim types wrapping reth's internal node types
system to make it more usable in Signet.
- **signet-blobber** - Blob retrieval and parsing, using blob explorers,
Signet's Pylon, and the local node transaction API.
- **signet-rpc** - An Ethereum JSON-RPC Server for Signet nodes. Makes heavy
use of reth internals.
- **signet-db** - An extension of reth's database, providing a Signet-specific
database schema and utilities for working with Signet blocks and transactions.

### Contributing to the Node Components

Please see [CONTRIBUTING.md](CONTRIBUTING.md).

[Signet docs]: https://signet.sh/docs

## Note on Semver

This repo is UNPUBLISHED and may NOT respect semantic versioning between tagged
versions. In general, it is versioned to match the signet-sdk version with
which it is compatible. I.e. `node-components@0.8.x` is expected to be
compatible with any signet-sdk `0.8.x` version. However, a release of
`node-components@0.8.1` may have breaking changes from `node-components@0.8.0`.
implement core node functionality, but are potentially independently useful.

## What's new in Signet?

Expand All @@ -50,3 +28,30 @@ knowledge. Signet does not have a native token.
Signet is just a rollup.

See the [Signet docs] for more info.

## What's in the Components?

- **signet-node-types** — Shim types wrapping reth's internal node types
system to make it more usable in Signet.
- **signet-blobber** — Blob retrieval and parsing, using blob explorers,
Signet's Pylon, and the local node transaction API.
- **signet-rpc** — An Ethereum JSON-RPC Server for Signet nodes. Makes heavy
use of reth internals.
- **signet-host-reth** — Reth ExEx implementation of the `HostNotifier` trait
for signet-node.
- **signet-host-rpc** — RPC-based implementation of the `HostNotifier` trait
for signet-node.

## Contributing

Please see [CONTRIBUTING.md](CONTRIBUTING.md).

## Note on Semver

This repo is UNPUBLISHED and may NOT respect semantic versioning between tagged
versions. In general, it is versioned to match the signet-sdk version with
which it is compatible. I.e. `node-components@0.8.x` is expected to be
compatible with any signet-sdk `0.8.x` version. However, a release of
`node-components@0.8.1` may have breaking changes from `node-components@0.8.0`.

[Signet docs]: https://signet.sh/docs