Struct Node

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

Celestia node.

Implementations

impl Node<InMemoryBlockstore, InMemoryStore>

pub fn builder() -> NodeBuilder<InMemoryBlockstore, InMemoryStore>

Creates a new NodeBuilder that is using in-memory stores.

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

Example

let node = Node::builder()
    .network(Network::Mainnet)
    .start()
    .await
    .unwrap();

impl<B, S> Node<B, S>

where B: Blockstore, S: Store,

pub async fn stop(self)

Stop the node.

pub fn event_subscriber(&self) -> EventSubscriber

Returns a new EventSubscriber.

pub fn local_peer_id(&self) -> &PeerId

Get node’s local peer ID.

pub fn peer_tracker_info(&self) -> PeerTrackerInfo

Get current PeerTrackerInfo.

pub fn peer_tracker_info_watcher(&self) -> Receiver<PeerTrackerInfo>

Get PeerTrackerInfo watcher.

pub async fn wait_connected(&self) -> Result<()>

Wait until the node is connected to at least 1 peer.

pub async fn wait_connected_trusted(&self) -> Result<()>

Wait until the node is connected to at least 1 trusted peer.

pub async fn network_info(&self) -> Result<NetworkInfo>

Get current network info.

pub async fn listeners(&self) -> Result<Vec<Multiaddr>>

Get all the multiaddresses on which the node listens.

pub async fn connected_peers(&self) -> Result<Vec<PeerId>>

Get all the peers that node is connected to.

pub async fn set_peer_trust( &self, peer_id: PeerId, is_trusted: bool, ) -> Result<()>

Trust or untrust the peer with a given ID.

pub async fn request_head_header(&self) -> Result<ExtendedHeader>

Request the head header from the network.

pub async fn request_header_by_hash( &self, hash: &Hash, ) -> Result<ExtendedHeader>

Request a header for the block with a given hash from the network.

pub async fn request_header_by_height( &self, hash: u64, ) -> Result<ExtendedHeader>

Request a header for the block with a given height from the network.

pub async fn request_verified_headers( &self, from: &ExtendedHeader, amount: u64, ) -> Result<Vec<ExtendedHeader>>

Request headers in range (from, from + amount] from the network.

The headers will be verified with the from header.

pub async fn request_row( &self, row_index: u16, block_height: u64, timeout: Option<Duration>, ) -> Result<Row>

Request a verified Row from the network.

Errors

On failure to receive a verified Row within a certain time, the NodeError::P2p(P2pError::BitswapQueryTimeout) error will be returned.

pub async fn request_sample( &self, row_index: u16, column_index: u16, block_height: u64, timeout: Option<Duration>, ) -> Result<Sample>

Request a verified Sample from the network.

Errors

On failure to receive a verified Sample within a certain time, the NodeError::P2p(P2pError::BitswapQueryTimeout) error will be returned.

pub async fn request_row_namespace_data( &self, namespace: Namespace, row_index: u16, block_height: u64, timeout: Option<Duration>, ) -> Result<RowNamespaceData>

Request a verified RowNamespaceData from the network.

Errors

On failure to receive a verified RowNamespaceData within a certain time, the NodeError::P2p(P2pError::BitswapQueryTimeout) error will be returned.

pub async fn request_all_blobs( &self, namespace: Namespace, block_height: u64, timeout: Option<Duration>, ) -> Result<Vec<Blob>>

Request all blobs with provided namespace in the block corresponding to this header using bitswap protocol.

pub async fn syncer_info(&self) -> Result<SyncingInfo>

Get current header syncing info.

pub async fn get_network_head_header(&self) -> Result<Option<ExtendedHeader>>

Get the latest header announced in the network.

pub async fn get_local_head_header(&self) -> Result<ExtendedHeader>

Get the latest locally synced header.

pub async fn get_header_by_hash(&self, hash: &Hash) -> Result<ExtendedHeader>

Get a synced header for the block with a given hash.

pub async fn get_header_by_height(&self, height: u64) -> Result<ExtendedHeader>

Get a synced header for the block with a given height.

pub async fn get_headers<R>(&self, range: R) -> Result<Vec<ExtendedHeader>>

where R: RangeBounds<u64> + Send,

Get synced headers from the given heights range.

If start of the range is unbounded, the first returned header will be of height 1. If end of the range is unbounded, the last returned header will be the last header in the store.

Errors

If range contains a height of a header that is not found in the store or RangeBounds cannot be converted to a valid range.

pub async fn get_sampling_metadata( &self, height: u64, ) -> Result<Option<SamplingMetadata>>

Get data sampling metadata of an already sampled height.

Returns Ok(None) if metadata for the given height does not exists.

Trait Implementations

impl<B, S> Drop for Node<B, S>

where B: Blockstore, S: Store,

fn drop(&mut self)

Executes the destructor for this type.