Add an example for a Node with custom Header and transaction type

[mattsse]

we now support configuring the the NodePrimitives, e.g.:

https://github.com/paradigmxyz/reth/blob/main/crates/primitives/src/lib.rs#L83-L89

we want to showcase and find blockers in the current design by adding a more elaborate SDK example that:

• uses a custom header type, (configured in the block type)

TODO

• add a new examples crate that introduces all custom types and components necessary for modifying something like this

this header type could be a simple wrapper struct CustomHeader {eth_header: Header, extra: ...}
this requires a bunch of custom components, those can be simple noops at first (e.g. consensus)

this likely highlights a few blockers and bad DX so this can be done incrementally and ideally flags issues and resolves them via separate PRs.

[PelleKrab]

I'd be happy to start working on this, but I am a little confused on the scope of custom components. Would this look some what like custom-dev-node?

[mattsse]

yeah, very similar

this task is a bit larger, so we can take this step by step,

the goal should be something similar to:

reth/crates/optimism/node/src/node.rs

Lines 115 to 138 in b97d9b4

	impl<N> Node<N> for OpNode
	where
	N: FullNodeTypes<
	Types: NodeTypesWithEngine<
	Engine = OpEngineTypes,
	ChainSpec = OpChainSpec,
	Primitives = OpPrimitives,
	Storage = OpStorage,
	>,
	>,
	{
	type ComponentsBuilder = ComponentsBuilder<
	N,
	OpPoolBuilder,
	OpPayloadBuilder,
	OpNetworkBuilder,
	OpExecutorBuilder,
	OpConsensusBuilder,
	>;
	type AddOns =
	OpAddOns<NodeAdapter<N, <Self::ComponentsBuilder as NodeComponentsBuilder<N>>::Components>>;
	fn components_builder(&self) -> Self::ComponentsBuilder {

but let's how far we come with custom header type draft first and then, a consensus impl, etc and keep stacking up custom components.

will provide more instructions once there's a draft pr (can be small in scope)

this issue is intended as an exercise and should give us some DX feedback and flag blockers

[Elite-tch]

Can I start working on this?

[PelleKrab]

I'm a little stuck. I am trying to implement the CustomHeader into the a custom NodePrimitives. Since the Block<> takes a TransactionSigned, do I need to make a custom signed tx for a basic custom header type draft? Or am I over complicating things and there is an easier way test CustomHeader implementation? @mattsse

[loocapro]

I'm a little stuck. I am trying to implement the CustomHeader into the a custom NodePrimitives. Since the Block<> takes a TransactionSigned, do I need to make a custom signed tx for a basic custom header type draft? Or am I over complicating things and there is an easier way test CustomHeader implementation? @mattsse

Hi @PelleKrab, pardon my intrusion! 🙂

I think you can simply make your CustomHeader a wrapper type around alloy_consensus::Block and implement the reth_primitives_traits::block::Block trait. For this exercise, we just want to demonstrate that all types and components can be seamlessly integrated.

Also, if you open a draft PR, it’ll be easier to follow your progress and in case help you out.