@@ -25,39 +25,29 @@ See the [Signet docs] for more info.
2525
2626### What's in the SDK?
2727
28+ - ** signet-constants** - Constants for Signet, including chain IDs, contract
29+ addresses, and other on-chain configuration.
2830- ** signet-zenith** - [ Zenith] contract bindings and related types.
2931- ** signet-types** - Common types and utilities for Signet.
3032- ** signet-extract** - Extracts Signet blocks from an Ethereum block. Also
3133 includes test utilities for specifying host and rollup blocks.
3234- ** signet-evm** - A wrapper around [ trevm] that implements a Signet-specific
3335 revm inspector for detecting orders, and Signet's block-execution logic.
36+ - ** signet-journal** - A serializablable, unwindable journal of EVM state
37+ changes.
3438- ** signet-bundle** - Types and utilities for simulating bundles of Signet
3539 transactions, and determining what fills would be required to include them.
40+ - ** signet-sim** - Block construction library for Signet. Produces blocks from
41+ a transaction cache by scoring them according to the increase in the
42+ builder's balance.
43+ - ** signet-tx-cache** - A client for Signets tx-cache webservice.
3644- ** signet-test-utils** - Utilities for testing Signet libraries and
3745 applications.
3846
3947### Contributing to the SDK
4048
4149Please see [ CONTRIBUTING.md] ( CONTRIBUTING.md ) .
4250
43- ### Note on Stability
44-
45- For most users, we recommend depending on ` main ` for the most up-to-date
46- version of the SDK. You can do this by adding lines like the following to your
47- ` Cargo.toml ` :
48-
49- ``` toml
50- signet-types = { git = " https://github.com/init4tech/signet-sdk/" branch = " main" }
51- ```
52-
53- We intend to publish these crates, however, due to dependencies on unpublished
54- reth crates, we are currently unable to do so. We will be tagging release
55- versions and adhering to semver as well as possible. However, our dependence on
56- unstable reth APIs may result in regular breaking changes that do not adhere to
57- semver. We will do our best to minimize these changes. Reth also suffers
58- semi-frequent dependency rot, and as a result we cannot guarantee that
59- any given tagged versions of this crate will build without modification.
60-
6151[ Signet ] : https://signet.sh
6252[ trevm ] : https://docs.rs/trevm/latest/trevm/
6353[ Signet docs ] : https://docs.signet.sh
0 commit comments