Implement Beacon network RPC endpoints (#732)

Author: ogenev

Cargo.lock

@@ -0,0 +1,111 @@
+use crate::types::portal::FindNodesInfo;
+use crate::types::portal::{
+    AcceptInfo, ContentInfo, DataRadius, PaginateLocalContentInfo, PongInfo, TraceContentInfo,
+};
+use crate::{NodeId, RoutingTableInfo};
+use jsonrpsee::{core::RpcResult, proc_macros::rpc};
+use trin_types::content_key::BeaconContentKey;
+use trin_types::content_value::{BeaconContentValue, PossibleBeaconContentValue};
+use trin_types::enr::Enr;
+
+/// Portal Beacon JSON-RPC endpoints
+#[rpc(client, server, namespace = "portal")]
+pub trait BeaconNetworkApi {
+    /// Returns meta information about overlay routing table.
+    #[method(name = "beaconRoutingTableInfo")]
+    async fn routing_table_info(&self) -> RpcResult<RoutingTableInfo>;
+
+    /// Returns the node data radios
+    #[method(name = "beaconRadius")]
+    async fn radius(&self) -> RpcResult<DataRadius>;
+
+    /// Write an Ethereum Node Record to the overlay routing table.
+    #[method(name = "beaconAddEnr")]
+    async fn add_enr(&self, enr: Enr) -> RpcResult<bool>;
+
+    /// Fetch the latest ENR associated with the given node ID.
+    #[method(name = "beaconGetEnr")]
+    async fn get_enr(&self, node_id: NodeId) -> RpcResult<Enr>;
+
+    /// Delete Node ID from the overlay routing table.
+    #[method(name = "beaconDeleteEnr")]
+    async fn delete_enr(&self, node_id: NodeId) -> RpcResult<bool>;
+
+    /// Fetch the ENR representation associated with the given Node ID.
+    #[method(name = "beaconLookupEnr")]
+    async fn lookup_enr(&self, node_id: NodeId) -> RpcResult<Enr>;
+
+    /// Send a PING message to the designated node and wait for a PONG response
+    #[method(name = "beaconPing")]
+    async fn ping(&self, enr: Enr) -> RpcResult<PongInfo>;
+
+    /// Send a FINDNODES request for nodes that fall within the given set of distances, to the designated
+    /// peer and wait for a response
+    #[method(name = "beaconFindNodes")]
+    async fn find_nodes(&self, enr: Enr, distances: Vec<u16>) -> RpcResult<FindNodesInfo>;
+
+    /// Lookup a target node within in the network
+    #[method(name = "beaconRecursiveFindNodes")]
+    async fn recursive_find_nodes(&self, node_id: NodeId) -> RpcResult<Vec<Enr>>;
+
+    /// Send FINDCONTENT message to get the content with a content key.
+    #[method(name = "beaconFindContent")]
+    async fn find_content(&self, enr: Enr, content_key: BeaconContentKey)
+        -> RpcResult<ContentInfo>;
+
+    /// Lookup a target content key in the network
+    #[method(name = "beaconRecursiveFindContent")]
+    async fn recursive_find_content(
+        &self,
+        content_key: BeaconContentKey,
+    ) -> RpcResult<PossibleBeaconContentValue>;
+
+    /// Lookup a target content key in the network. Return tracing info.
+    #[method(name = "beaconTraceRecursiveFindContent")]
+    async fn trace_recursive_find_content(
+        &self,
+        content_key: BeaconContentKey,
+    ) -> RpcResult<TraceContentInfo>;
+
+    /// Pagination of local content keys
+    #[method(name = "beaconPaginateLocalContentKeys")]
+    async fn paginate_local_content_keys(
+        &self,
+        offset: u64,
+        limit: u64,
+    ) -> RpcResult<PaginateLocalContentInfo>;
+
+    /// Send the provided content value to interested peers. Clients may choose to send to some or all peers.
+    /// Return the number of peers that the content was gossiped to.
+    #[method(name = "beaconGossip")]
+    async fn gossip(
+        &self,
+        content_key: BeaconContentKey,
+        content_value: BeaconContentValue,
+    ) -> RpcResult<u32>;
+
+    /// Send an OFFER request with given ContentKey, to the designated peer and wait for a response.
+    /// Returns the content keys bitlist upon successful content transmission or empty bitlist receive.
+    #[method(name = "beaconOffer")]
+    async fn offer(
+        &self,
+        enr: Enr,
+        content_key: BeaconContentKey,
+        content_value: Option<BeaconContentValue>,
+    ) -> RpcResult<AcceptInfo>;
+
+    /// Store content key with a content data to the local database.
+    #[method(name = "beaconStore")]
+    async fn store(
+        &self,
+        content_key: BeaconContentKey,
+        content_value: BeaconContentValue,
+    ) -> RpcResult<bool>;
+
+    /// Get a content from the local database
+    #[method(name = "beaconLocalContent")]
+    async fn local_content(
+        &self,
+        content_key: BeaconContentKey,
+    ) -> RpcResult<PossibleBeaconContentValue>;
+}

ethportal-api/src/beacon.rs

@@ -15,7 +15,7 @@ pub trait HistoryNetworkApi {
     #[method(name = "historyRoutingTableInfo")]
     async fn routing_table_info(&self) -> RpcResult<RoutingTableInfo>;
 
-    /// Returns meta information about overlay routing table.
+    /// Returns the node data radios
     #[method(name = "historyRadius")]
     async fn radius(&self) -> RpcResult<DataRadius>;
 
@@ -71,7 +71,7 @@ pub trait HistoryNetworkApi {
     ) -> RpcResult<TraceContentInfo>;
 
     /// Pagination of local content keys
-    #[method(name = "paginateLocalContentKeys")]
+    #[method(name = "historyPaginateLocalContentKeys")]
     async fn paginate_local_content_keys(
         &self,
         offset: u64,

ethportal-api/src/history.rs

@@ -3,22 +3,26 @@
 //! `ethportal_api` is a collection of Portal Network APIs and types.
 #![warn(clippy::unwrap_used)]
 
+mod beacon;
 pub mod discv5;
 mod history;
 pub mod types;
 mod web3;
 
 pub use crate::discv5::{Discv5ApiClient, Discv5ApiServer};
+pub use beacon::{BeaconNetworkApiClient, BeaconNetworkApiServer};
 pub use history::{HistoryNetworkApiClient, HistoryNetworkApiServer};
 pub use web3::{Web3ApiClient, Web3ApiServer};
 
 // Re-exports trin-types
 pub use trin_types::content_key::{
-    BlockBodyKey, BlockHeaderKey, BlockReceiptsKey, EpochAccumulatorKey, HistoryContentKey,
-    OverlayContentKey, StateContentKey,
+    BeaconContentKey, BlockBodyKey, BlockHeaderKey, BlockReceiptsKey, EpochAccumulatorKey,
+    HistoryContentKey, LightClientBootstrapKey, LightClientUpdatesKey, OverlayContentKey,
+    StateContentKey,
 };
 pub use trin_types::content_value::{
-    ContentValue, ContentValueError, HistoryContentValue, PossibleHistoryContentValue,
+    BeaconContentValue, ContentValue, ContentValueError, HistoryContentValue,
+    PossibleBeaconContentValue, PossibleHistoryContentValue,
 };
 pub use trin_types::execution::block_body::*;
 pub use trin_types::execution::header::*;

ethportal-api/src/lib.rs

@@ -0,0 +1 @@
+Implement Beacon portal network json-rpc API