Struct NodeBuilder

pub struct NodeBuilder<B, S>
where
    B: Blockstore + 'static,
    S: Store + 'static,
{ /* private fields */ }

Node builder.

Implementations

impl NodeBuilder<InMemoryBlockstore, InMemoryStore>

pub fn new() -> Self

Creates a new NodeBuilder which uses in-memory stores.

After the creation you can call NodeBuilder::blockstore and NodeBuilder::store to use other stores.

Example

let node = NodeBuilder::new()
    .network(Network::Mainnet)
    .start()
    .await
    .unwrap();

impl<B, S> NodeBuilder<B, S>

where B: Blockstore + 'static, S: Store + 'static,

pub async fn start(self) -> Result<Node<B, S>>

Creates and starts a new Celestia Node.

pub async fn start_subscribed(self) -> Result<(Node<B, S>, EventSubscriber)>

Creates and starts a new Celestia Node.

Returns Node along with EventSubscriber. Use this to avoid missing any events that will be generated on the construction of the node.

pub fn blockstore<B2>(self, blockstore: B2) -> NodeBuilder<B2, S>

where B2: Blockstore + 'static,

Set the Blockstore for Bitswap.

Default: InMemoryBlockstore

pub fn store<S2>(self, store: S2) -> NodeBuilder<B, S2>

where S2: Store + 'static,

Set the Store for headers.

Default: InMemoryStore

pub fn network(self, network: Network) -> Self

The Network to connect to.

pub fn keypair(self, keypair: Keypair) -> Self

Set the keypair to be used as Nodes identity.

Default: Random generated with Keypair::generate_ed25519.

pub fn bootnodes<I>(self, addrs: I) -> Self

where I: IntoIterator<Item = Multiaddr>,

Set the bootstrap nodes to connect and trust.

Default: Network::canonical_bootnodes

pub fn listen<I>(self, addrs: I) -> Self

where I: IntoIterator<Item = Multiaddr>,

Set the addresses where Node will listen for incoming connections.

pub fn sync_batch_size(self, batch_size: u64) -> Self

Maximum number of headers in batch while syncing.

Default: 512

pub fn sampling_window(self, dur: Duration) -> Self

Set sampling window.

Sampling window defines maximum age of a block considered for syncing and sampling.

Default if InMemoryStore/InMemoryBlockstore are used: 60 seconds.
Default: 30 days.
Minimum: 60 seconds.

pub fn pruning_delay(self, dur: Duration) -> Self

Set pruning delay.

Pruning delay defines how much time the pruner should wait after sampling window in order to prune the block.

Default if InMemoryStore/InMemoryBlockstore are used: 60 seconds.
Default: 1 hour.
Minimum: 60 seconds.

Trait Implementations

impl Default for NodeBuilder<InMemoryBlockstore, InMemoryStore>

fn default() -> Self

Returns the “default value” for a type.