Signet SDK

Overview of Signet's SDK libraries and tools for developers building with Orders. Covers core components and integration points for working with the order system.

What's in the SDK?

• 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-bundle - Types and utilities for simulating bundles of Signet transactions, and determining what fills would be required to include them.

• signet-rpc - An Ethereum JSON-RPC Server for Signet nodes. Makes heavy use of reth internals.

For more information, visit the Signet SDK repository.

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 yourCargo.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.