jleony/nanoreth
1
0
Fork 0
mirror of https://github.com/hl-archive-node/nanoreth.git synced 2025-12-06 10:59:55 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: add docs about bincode compat (#14045)

Browse Source
This commit is contained in:
Matthias Seitz
2025-01-28 17:49:27 +01:00
committed by GitHub
parent ba6a1122d8
commit 4653d3dd3a
2 changed files with 15 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
crates/primitives-traits/src/lib.rs
View File

@ -17,6 +17,7 @@
//! - `secp256k1`: Adds secp256k1 support for transaction signing/recovery. (By default the no-std //! - `secp256k1`: Adds secp256k1 support for transaction signing/recovery. (By default the no-std
//! friendly `k256` is used) //! friendly `k256` is used)
//! - `rayon`: Uses `rayon` for parallel transaction sender recovery in [`BlockBody`] by default. //! - `rayon`: Uses `rayon` for parallel transaction sender recovery in [`BlockBody`] by default.
//! - `serde-bincode-compat` provides helpers for dealing with the `bincode` crate.
//! //!
//! ## Overview //! ## Overview
//! //!
@ -51,6 +52,15 @@
//! Hence this function is necessary when dealing with pre EIP-2 transactions on the ethereum //! Hence this function is necessary when dealing with pre EIP-2 transactions on the ethereum
//! mainnet. Newer transactions must always be recovered with the regular `recover` functions, see //! mainnet. Newer transactions must always be recovered with the regular `recover` functions, see
//! also [`recover_signer`](crypto::secp256k1::recover_signer). //! also [`recover_signer`](crypto::secp256k1::recover_signer).
//!
//! ## Bincode serde compatibility
//!
//! The [bincode-crate](https://github.com/bincode-org/bincode) is often used by additional tools when sending data over the network.
//! `bincode` crate doesn't work well with optionally serializable serde fields, but some of the consensus types require optional serialization for RPC compatibility. Read more: <https://github.com/bincode-org/bincode/issues/326>
//!
//! As a workaround this crate introduces the
//! [`SerdeBincodeCompat`](serde_bincode_compat::SerdeBincodeCompat) trait used to a bincode
//! compatible serde representation.
#![doc( #![doc(
html_logo_url = "https://raw.githubusercontent.com/paradigmxyz/reth/main/assets/reth-docs.png", html_logo_url = "https://raw.githubusercontent.com/paradigmxyz/reth/main/assets/reth-docs.png",

5
crates/primitives-traits/src/serde_bincode_compat.rs
View File

@ -8,8 +8,13 @@ pub use super::{
pub use block_bincode::{Block, BlockBody}; pub use block_bincode::{Block, BlockBody};
/// Trait for types that can be serialized and deserialized using bincode. /// Trait for types that can be serialized and deserialized using bincode.
///
/// The recommended way to add bincode compatible serialization is via the
/// [`serde_with`] crate and the `serde_as` macro that. See for reference [`header`].
pub trait SerdeBincodeCompat: Sized + 'static { pub trait SerdeBincodeCompat: Sized + 'static {
/// Serde representation of the type for bincode serialization. /// Serde representation of the type for bincode serialization.
///
/// This type defines the bincode compatible serde format for the type.
type BincodeRepr<'a>: Debug + Serialize + DeserializeOwned + From<&'a Self> + Into<Self>; type BincodeRepr<'a>: Debug + Serialize + DeserializeOwned + From<&'a Self> + Into<Self>;
} }