11# Signet Node Components
22
3+ [ ![ CI] ( https://github.com/init4tech/node-components/actions/workflows/rust.yml/badge.svg )] ( https://github.com/init4tech/node-components/actions/workflows/rust.yml )
4+ [ ![ License: MIT] ( https://img.shields.io/badge/License-MIT-blue.svg )] ( LICENSE )
5+
36> ** Note:** The ` main ` branch is in maintenance and bug-fix mode. The
47> ` develop ` branch contains current work.
58
69A collection of components for building the Signet node. These components
7- implement core node functionality, but are potentially indepedently useful.
8-
9- ## What's in the Components?
10-
11- - ** signet-node-types** - Shim types wrapping reth's internal node types
12- system to make it more usable in Signet.
13- - ** signet-blobber** - Blob retrieval and parsing, using blob explorers,
14- Signet's Pylon, and the local node transaction API.
15- - ** signet-rpc** - An Ethereum JSON-RPC Server for Signet nodes. Makes heavy
16- use of reth internals.
17- - ** signet-db** - An extension of reth's database, providing a Signet-specific
18- database schema and utilities for working with Signet blocks and transactions.
19-
20- ### Contributing to the Node Components
21-
22- Please see [ CONTRIBUTING.md] ( CONTRIBUTING.md ) .
23-
24- [ Signet docs ] : https://signet.sh/docs
25-
26- ## Note on Semver
27-
28- This repo is UNPUBLISHED and may NOT respect semantic versioning between tagged
29- versions. In general, it is versioned to match the signet-sdk version with
30- which it is compatible. I.e. ` node-components@0.8.x ` is expected to be
31- compatible with any signet-sdk ` 0.8.x ` version. However, a release of
32- ` node-components@0.8.1 ` may have breaking changes from ` node-components@0.8.0 ` .
10+ implement core node functionality, but are potentially independently useful.
3311
3412## What's new in Signet?
3513
@@ -50,3 +28,28 @@ knowledge. Signet does not have a native token.
5028Signet is just a rollup.
5129
5230See the [ Signet docs] for more info.
31+
32+ ## What's in the Components?
33+
34+ - ** signet-node-types** — Shim types wrapping reth's internal node types
35+ system to make it more usable in Signet.
36+ - ** signet-blobber** — Blob retrieval and parsing, using blob explorers,
37+ Signet's Pylon, and the local node transaction API.
38+ - ** signet-rpc** — An Ethereum JSON-RPC Server for Signet nodes. Makes heavy
39+ use of reth internals.
40+ - ** signet-db** — An extension of reth's database, providing a Signet-specific
41+ database schema and utilities for working with Signet blocks and transactions.
42+
43+ ## Contributing
44+
45+ Please see [ CONTRIBUTING.md] ( CONTRIBUTING.md ) .
46+
47+ ## Note on Semver
48+
49+ This repo is UNPUBLISHED and may NOT respect semantic versioning between tagged
50+ versions. In general, it is versioned to match the signet-sdk version with
51+ which it is compatible. I.e. ` node-components@0.8.x ` is expected to be
52+ compatible with any signet-sdk ` 0.8.x ` version. However, a release of
53+ ` node-components@0.8.1 ` may have breaking changes from ` node-components@0.8.0 ` .
54+
55+ [ Signet docs ] : https://signet.sh/docs
0 commit comments