Skip to main content

WithLaunchContext

Struct WithLaunchContext 

Source
pub struct WithLaunchContext<Builder> { /* private fields */ }
Expand description

A NodeBuilder with its launch context already configured.

This exposes the same methods as NodeBuilder but with the launch context already configured, See WithLaunchContext::launch

Implementations§

Source§

impl<Builder> WithLaunchContext<Builder>

Source

pub const fn task_executor(&self) -> &Runtime

Returns a reference to the task executor.

Source§

impl<DB, ChainSpec> WithLaunchContext<NodeBuilder<DB, ChainSpec>>

Source

pub const fn config(&self) -> &NodeConfig<ChainSpec>

Returns a reference to the node builder’s config.

Source

pub const fn config_mut(&mut self) -> &mut NodeConfig<ChainSpec>

Returns a mutable reference to the node builder’s config.

Source§

impl<DB, ChainSpec> WithLaunchContext<NodeBuilder<DB, ChainSpec>>
where DB: Database + DatabaseMetrics + Clone + Unpin + 'static, ChainSpec: EthChainSpec + EthereumHardforks,

Source

pub fn with_rocksdb_provider( self, rocksdb_provider: RocksDBProvider, ) -> WithLaunchContext<NodeBuilder<DB, ChainSpec>>

Sets the RocksDBProvider to use instead of creating one during launch.

Source

pub fn with_types<T>( self, ) -> WithLaunchContext<NodeBuilderWithTypes<FullNodeTypesAdapter<T, DB, BlockchainProvider<NodeTypesWithDBAdapter<T, DB>>>>>
where T: NodeTypesForProvider<ChainSpec = ChainSpec>,

Configures the types of the node.

Source

pub fn with_types_and_provider<T, P>( self, ) -> WithLaunchContext<NodeBuilderWithTypes<FullNodeTypesAdapter<T, DB, P>>>
where T: NodeTypesForProvider<ChainSpec = ChainSpec>, P: FullProvider<NodeTypesWithDBAdapter<T, DB>>,

Configures the types of the node and the provider type that will be used by the node.

Source

pub fn node<N>( self, node: N, ) -> WithLaunchContext<NodeBuilderWithComponents<FullNodeTypesAdapter<N, DB, BlockchainProvider<NodeTypesWithDBAdapter<N, DB>>>, <N as Node<FullNodeTypesAdapter<N, DB, BlockchainProvider<NodeTypesWithDBAdapter<N, DB>>>>>::ComponentsBuilder, <N as Node<FullNodeTypesAdapter<N, DB, BlockchainProvider<NodeTypesWithDBAdapter<N, DB>>>>>::AddOns>>
where N: Node<FullNodeTypesAdapter<N, DB, BlockchainProvider<NodeTypesWithDBAdapter<N, DB>>>, ChainSpec = ChainSpec> + NodeTypesForProvider,

Preconfigures the node with a specific node implementation.

This is a convenience method that sets the node’s types and components in one call.

Source

pub async fn launch_node<N>( self, node: N, ) -> Result<<EngineNodeLauncher as LaunchNode<NodeBuilderWithComponents<FullNodeTypesAdapter<N, DB, BlockchainProvider<NodeTypesWithDBAdapter<N, DB>>>, <N as Node<FullNodeTypesAdapter<N, DB, BlockchainProvider<NodeTypesWithDBAdapter<N, DB>>>>>::ComponentsBuilder, <N as Node<FullNodeTypesAdapter<N, DB, BlockchainProvider<NodeTypesWithDBAdapter<N, DB>>>>>::AddOns>>>::Node, Report>

Launches a preconfigured Node

This bootstraps the node internals, creates all the components with the given Node

Returns a NodeHandle that can be used to interact with the node.

Source§

impl<T> WithLaunchContext<NodeBuilderWithTypes<T>>
where T: FullNodeTypes,

Source

pub fn with_components<CB>( self, components_builder: CB, ) -> WithLaunchContext<NodeBuilderWithComponents<T, CB, ()>>
where CB: NodeComponentsBuilder<T>,

Advances the state of the node builder to the next state where all components are configured

Source§

impl<T, CB> WithLaunchContext<NodeBuilderWithComponents<T, CB, ()>>

Source

pub fn with_add_ons<AO>( self, add_ons: AO, ) -> WithLaunchContext<NodeBuilderWithComponents<T, CB, AO>>

Advances the state of the node builder to the next state where all customizable NodeAddOns types are configured.

Source§

impl<T, CB, AO> WithLaunchContext<NodeBuilderWithComponents<T, CB, AO>>

Source

pub const fn config( &self, ) -> &NodeConfig<<<T as FullNodeTypes>::Types as NodeTypes>::ChainSpec>

Returns a reference to the node builder’s config.

Source

pub const fn config_mut( &mut self, ) -> &mut NodeConfig<<<T as FullNodeTypes>::Types as NodeTypes>::ChainSpec>

Returns a mutable reference to the node builder’s config.

Source

pub const fn db(&self) -> &<T as FullNodeTypes>::DB

Returns a reference to node’s database.

Source

pub const fn db_mut(&mut self) -> &mut <T as FullNodeTypes>::DB

Returns a mutable reference to node’s database.

Source

pub fn try_apply<F, R>( self, f: F, ) -> Result<WithLaunchContext<NodeBuilderWithComponents<T, CB, AO>>, R>

Applies a fallible function to the builder.

Source

pub fn try_apply_if<F, R>( self, cond: bool, f: F, ) -> Result<WithLaunchContext<NodeBuilderWithComponents<T, CB, AO>>, R>

Applies a fallible function to the builder, if the condition is true.

Source

pub fn apply<F>( self, f: F, ) -> WithLaunchContext<NodeBuilderWithComponents<T, CB, AO>>

Apply a function to the builder

Source

pub fn apply_if<F>( self, cond: bool, f: F, ) -> WithLaunchContext<NodeBuilderWithComponents<T, CB, AO>>

Apply a function to the builder, if the condition is true.

Source

pub fn on_component_initialized<F>( self, hook: F, ) -> WithLaunchContext<NodeBuilderWithComponents<T, CB, AO>>
where F: FnOnce(NodeAdapter<T, <CB as NodeComponentsBuilder<T>>::Components>) -> Result<(), Report> + Send + 'static,

Sets the hook that is run once the node’s components are initialized.

Source

pub fn on_node_started<F>( self, hook: F, ) -> WithLaunchContext<NodeBuilderWithComponents<T, CB, AO>>
where F: FnOnce(FullNode<NodeAdapter<T, <CB as NodeComponentsBuilder<T>>::Components>, AO>) -> Result<(), Report> + Send + 'static,

Sets the hook that is run once the node has started.

Source

pub fn map_add_ons<F>( self, f: F, ) -> WithLaunchContext<NodeBuilderWithComponents<T, CB, AO>>
where F: FnOnce(AO) -> AO,

Modifies the addons with the given closure.

This method provides access to methods on the addons type that don’t have direct builder methods. It’s useful for advanced configuration scenarios where you need to call addon-specific methods.

§Examples
ⓘ
use tower::layer::util::Identity;

let builder = NodeBuilder::new(config)
    .with_types::<EthereumNode>()
    .with_components(EthereumNode::components())
    .with_add_ons(EthereumAddOns::default())
    .map_add_ons(|addons| addons.with_rpc_middleware(Identity::default()));
§See also
Source

pub fn on_rpc_started<F>( self, hook: F, ) -> WithLaunchContext<NodeBuilderWithComponents<T, CB, AO>>

Sets the hook that is run once the rpc server is started.

Source

pub fn extend_rpc_modules<F>( self, hook: F, ) -> WithLaunchContext<NodeBuilderWithComponents<T, CB, AO>>

Sets the hook that is run to configure the rpc modules.

This hook can obtain the node’s components (txpool, provider, etc.) and can modify the modules that the RPC server installs.

§Examples
ⓘ
use jsonrpsee::{core::RpcResult, proc_macros::rpc};

#[derive(Clone)]
struct CustomApi<Pool> { pool: Pool }

#[rpc(server, namespace = "custom")]
impl CustomApi {
    #[method(name = "hello")]
    async fn hello(&self) -> RpcResult<String> {
        Ok("World".to_string())
    }
}

let node = NodeBuilder::new(config)
    .node(EthereumNode::default())
    .extend_rpc_modules(|ctx| {
        // Access node components, so they can used by the CustomApi
        let pool = ctx.pool().clone();

        // Add custom RPC namespace
        ctx.modules.merge_configured(CustomApi { pool }.into_rpc())?;

        Ok(())
    })
    .build()?;
Source

pub fn install_exex<F, R, E>( self, exex_id: impl Into<String>, exex: F, ) -> WithLaunchContext<NodeBuilderWithComponents<T, CB, AO>>
where F: FnOnce(ExExContext<NodeAdapter<T, <CB as NodeComponentsBuilder<T>>::Components>>) -> R + Send + 'static, R: Future<Output = Result<E, Report>> + Send, E: Future<Output = Result<(), Report>> + Send,

Installs an ExEx (Execution Extension) in the node.

§Note

The ExEx ID must be unique.

Source

pub fn install_exex_if<F, R, E>( self, cond: bool, exex_id: impl Into<String>, exex: F, ) -> WithLaunchContext<NodeBuilderWithComponents<T, CB, AO>>
where F: FnOnce(ExExContext<NodeAdapter<T, <CB as NodeComponentsBuilder<T>>::Components>>) -> R + Send + 'static, R: Future<Output = Result<E, Report>> + Send, E: Future<Output = Result<(), Report>> + Send,

Installs an ExEx (Execution Extension) in the node if the condition is true.

§Note

The ExEx ID must be unique.

Source

pub async fn launch_with<L>( self, launcher: L, ) -> Result<<L as LaunchNode<NodeBuilderWithComponents<T, CB, AO>>>::Node, Report>

Launches the node with the given launcher.

Source

pub fn launch_with_fn<L, R>(self, launcher: L) -> R

Launches the node with the given closure.

Source

pub const fn check_launch( self, ) -> WithLaunchContext<NodeBuilderWithComponents<T, CB, AO>>

Check that the builder can be launched

This is useful when writing tests to ensure that the builder is configured correctly.

Source

pub async fn launch( self, ) -> Result<<EngineNodeLauncher as LaunchNode<NodeBuilderWithComponents<T, CB, AO>>>::Node, Report>

Launches the node with the EngineNodeLauncher that sets up engine API consensus and rpc

Source

pub fn launch_with_debug_capabilities( self, ) -> <DebugNodeLauncher as LaunchNode<NodeBuilderWithComponents<T, CB, AO>>>::Future

Launches the node with the DebugNodeLauncher.

This is equivalent to WithLaunchContext::launch, but will enable the debugging features, if they are configured.

Source

pub fn launch_with_debug_capabilities_and_backfill<B>( self, backfill: B, ) -> <DebugNodeLauncher<EngineNodeLauncher<B>> as LaunchNode<NodeBuilderWithComponents<T, CB, AO>>>::Future

Launches the node with the DebugNodeLauncher, with the engine’s backfill built by backfill instead of the staged pipeline.

Source

pub fn engine_api_launcher(&self) -> EngineNodeLauncher

Returns an EngineNodeLauncher that can be used to launch the node with engine API support.

Auto Trait Implementations§

§

impl<Builder> !RefUnwindSafe for WithLaunchContext<Builder>

§

impl<Builder> !UnwindSafe for WithLaunchContext<Builder>

§

impl<Builder> Freeze for WithLaunchContext<Builder>
where Builder: Freeze,

§

impl<Builder> Send for WithLaunchContext<Builder>
where Builder: Send,

§

impl<Builder> Sync for WithLaunchContext<Builder>
where Builder: Sync,

§

impl<Builder> Unpin for WithLaunchContext<Builder>
where Builder: Unpin,

§

impl<Builder> UnsafeUnpin for WithLaunchContext<Builder>
where Builder: UnsafeUnpin,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<T> Conv for T

§

fn conv<T>(self) -> T
where Self: Into<T>,

Converts self into T using Into<T>. Read more
§

impl<T> FmtForward for T

§

fn fmt_binary(self) -> FmtBinary<Self>
where Self: Binary,

Causes self to use its Binary implementation when Debug-formatted.
§

fn fmt_display(self) -> FmtDisplay<Self>
where Self: Display,

Causes self to use its Display implementation when Debug-formatted.
§

fn fmt_lower_exp(self) -> FmtLowerExp<Self>
where Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted.
§

fn fmt_lower_hex(self) -> FmtLowerHex<Self>
where Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted.
§

fn fmt_octal(self) -> FmtOctal<Self>
where Self: Octal,

Causes self to use its Octal implementation when Debug-formatted.
§

fn fmt_pointer(self) -> FmtPointer<Self>
where Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted.
§

fn fmt_upper_exp(self) -> FmtUpperExp<Self>
where Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted.
§

fn fmt_upper_hex(self) -> FmtUpperHex<Self>
where Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted.
§

fn fmt_list(self) -> FmtList<Self>
where &'a Self: for<'a> IntoIterator,

Formats each item in a sequence. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> FutureExt for T

§

fn with_context(self, otel_cx: Context) -> WithContext<Self> ⓘ

Attaches the provided Context to this type, returning a WithContext wrapper. Read more
§

fn with_current_context(self) -> WithContext<Self> ⓘ

Attaches the current Context to this type, returning a WithContext wrapper. Read more
§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> IntoRequest<T> for T

§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
§

impl<L> LayerExt<L> for L

§

fn named_layer<S>(&self, service: S) -> Layered<<L as Layer<S>>::Service, S>
where L: Layer<S>,

Applies the layer to a service and wraps it in [Layered].
§

impl<T> NonStaticAny for T
where T: ?Sized,

§

fn type_id(&self) -> TypeId

Returns the lifetime-erased type ID of self.
§

impl<T> Pipe for T
where T: ?Sized,

§

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
where Self: Sized,

Pipes by value. This is generally the method you want to use. Read more
§

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R
where R: 'a,

Borrows self and passes that borrow into the pipe function. Read more
§

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R
where R: 'a,

Mutably borrows self and passes that borrow into the pipe function. Read more
§

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
where Self: Borrow<B>, B: 'a + ?Sized, R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more
§

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
where Self: BorrowMut<B>, B: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more
§

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
where Self: AsRef<U>, U: 'a + ?Sized, R: 'a,

Borrows self, then passes self.as_ref() into the pipe function.
§

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
where Self: AsMut<U>, U: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.as_mut() into the pipe function.
§

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows self, then passes self.deref() into the pipe function.
§

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R, ) -> R
where Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function.
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
§

impl<T> PolicyExt for T
where T: ?Sized,

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] only if self and other return Action::Follow. Read more
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] if either self or other returns Action::Follow. Read more
§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
§

impl<T> Tap for T

§

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more
§

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more
§

fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Immutable access to the Borrow<B> of a value. Read more
§

fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Mutable access to the BorrowMut<B> of a value. Read more
§

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more
§

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more
§

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Immutable access to the Deref::Target of a value. Read more
§

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the Deref::Target of a value. Read more
§

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.
§

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds.
§

fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds.
§

fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds.
§

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Calls .tap_ref() only in debug builds, and is erased in release builds.
§

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds.
§

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds.
§

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.
§

impl<T> TryConv for T

§

fn try_conv<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

Layout§

Note: Unable to compute type layout, possibly due to this type having generic parameters. Layout can only be computed for concrete, fully-instantiated types.