From 66fc573ea4c2d230b48430a26bda5d1a0d31aa6c Mon Sep 17 00:00:00 2001 From: James Date: Wed, 8 Oct 2025 11:56:55 -0400 Subject: [PATCH] chore: update README --- README.md | 26 ++++++++------------------ 1 file changed, 8 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index f6474831..0f6401bc 100644 --- a/README.md +++ b/README.md @@ -25,14 +25,22 @@ See the [Signet docs] for more info. ### What's in the SDK? +- **signet-constants** - Constants for Signet, including chain IDs, contract + addresses, and other on-chain configuration. - **signet-zenith** - [Zenith] contract bindings and related types. - **signet-types** - Common types and utilities for Signet. - **signet-extract** - Extracts Signet blocks from an Ethereum block. Also includes test utilities for specifying host and rollup blocks. - **signet-evm** - A wrapper around [trevm] that implements a Signet-specific revm inspector for detecting orders, and Signet's block-execution logic. +- **signet-journal** - A serializablable, unwindable journal of EVM state + changes. - **signet-bundle** - Types and utilities for simulating bundles of Signet transactions, and determining what fills would be required to include them. +- **signet-sim** - Block construction library for Signet. Produces blocks from + a transaction cache by scoring them according to the increase in the + builder's balance. +- **signet-tx-cache** - A client for Signets tx-cache webservice. - **signet-test-utils** - Utilities for testing Signet libraries and applications. @@ -40,24 +48,6 @@ See the [Signet docs] for more info. Please see [CONTRIBUTING.md](CONTRIBUTING.md). -### Note on Stability - -For most users, we recommend depending on `main` for the most up-to-date -version of the SDK. You can do this by adding lines like the following to your -`Cargo.toml`: - -```toml -signet-types = { git = "https://github.com/init4tech/signet-sdk/" branch = "main"} -``` - -We intend to publish these crates, however, due to dependencies on unpublished -reth crates, we are currently unable to do so. We will be tagging release -versions and adhering to semver as well as possible. However, our dependence on -unstable reth APIs may result in regular breaking changes that do not adhere to -semver. We will do our best to minimize these changes. Reth also suffers -semi-frequent dependency rot, and as a result we cannot guarantee that -any given tagged versions of this crate will build without modification. - [Signet]: https://signet.sh [trevm]: https://docs.rs/trevm/latest/trevm/ [Signet docs]: https://docs.signet.sh