refactor: decode ContentValue only with known ContentKey (#1403)

ethereum · Aug 28, 2024 · 1aa4c2d · 1aa4c2d
1 parent 5ee5e92
commit 1aa4c2d
Show file tree

Hide file tree

Showing 49 changed files with 659 additions and 622 deletions.
diff --git a/ethportal-api/src/beacon.rs b/ethportal-api/src/beacon.rs
@@ -1,11 +1,13 @@
 use crate::{
     types::{
-        beacon::{ContentInfo, PaginateLocalContentInfo, TraceContentInfo},
         content_key::beacon::BeaconContentKey,
         enr::Enr,
-        portal::{AcceptInfo, DataRadius, FindNodesInfo, PongInfo, TraceGossipInfo},
+        portal::{
+            AcceptInfo, ContentInfo, DataRadius, FindNodesInfo, PaginateLocalContentInfo, PongInfo,
+            TraceContentInfo, TraceGossipInfo,
+        },
     },
-    BeaconContentValue, RoutingTableInfo,
+    RawContentValue, RoutingTableInfo,
 };
 use alloy_primitives::B256;
 use discv5::enr::NodeId;
@@ -82,15 +84,15 @@ pub trait BeaconNetworkApi {
         &self,
         offset: u64,
         limit: u64,
-    ) -> RpcResult<PaginateLocalContentInfo>;
+    ) -> RpcResult<PaginateLocalContentInfo<BeaconContentKey>>;
 
     /// 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,
+        content_value: RawContentValue,
     ) -> RpcResult<u32>;
 
     /// Send the provided content value to interested peers. Clients may choose to send to some or
@@ -99,7 +101,7 @@ pub trait BeaconNetworkApi {
     async fn trace_gossip(
         &self,
         content_key: BeaconContentKey,
-        content_value: BeaconContentValue,
+        content_value: RawContentValue,
     ) -> RpcResult<TraceGossipInfo>;
 
     /// Send an OFFER request with given ContentKey, to the designated peer and wait for a response.
@@ -111,7 +113,7 @@ pub trait BeaconNetworkApi {
         &self,
         enr: Enr,
         content_key: BeaconContentKey,
-        content_value: BeaconContentValue,
+        content_value: RawContentValue,
     ) -> RpcResult<AcceptInfo>;
 
     /// Send an OFFER request with given ContentKey, to the designated peer.
@@ -123,7 +125,7 @@ pub trait BeaconNetworkApi {
         &self,
         enr: Enr,
         content_key: BeaconContentKey,
-        content_value: BeaconContentValue,
+        content_value: RawContentValue,
     ) -> RpcResult<bool>;
 
     /// Send an OFFER request with given ContentKeys, to the designated peer and wait for a
@@ -142,10 +144,10 @@ pub trait BeaconNetworkApi {
     async fn store(
         &self,
         content_key: BeaconContentKey,
-        content_value: BeaconContentValue,
+        content_value: RawContentValue,
     ) -> RpcResult<bool>;
 
     /// Get a content from the local database
     #[method(name = "beaconLocalContent")]
-    async fn local_content(&self, content_key: BeaconContentKey) -> RpcResult<BeaconContentValue>;
+    async fn local_content(&self, content_key: BeaconContentKey) -> RpcResult<RawContentValue>;
 }
diff --git a/ethportal-api/src/history.rs b/ethportal-api/src/history.rs
@@ -2,10 +2,12 @@ use crate::{
     types::{
         content_key::history::HistoryContentKey,
         enr::Enr,
-        history::{ContentInfo, PaginateLocalContentInfo, TraceContentInfo},
-        portal::{AcceptInfo, DataRadius, FindNodesInfo, PongInfo, TraceGossipInfo},
+        portal::{
+            AcceptInfo, ContentInfo, DataRadius, FindNodesInfo, PaginateLocalContentInfo, PongInfo,
+            TraceContentInfo, TraceGossipInfo,
+        },
     },
-    HistoryContentValue, RoutingTableInfo,
+    RawContentValue, RoutingTableInfo,
 };
 use discv5::enr::NodeId;
 use jsonrpsee::{core::RpcResult, proc_macros::rpc};
@@ -78,15 +80,15 @@ pub trait HistoryNetworkApi {
         &self,
         offset: u64,
         limit: u64,
-    ) -> RpcResult<PaginateLocalContentInfo>;
+    ) -> RpcResult<PaginateLocalContentInfo<HistoryContentKey>>;
 
     /// 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 = "historyGossip")]
     async fn gossip(
         &self,
         content_key: HistoryContentKey,
-        content_value: HistoryContentValue,
+        content_value: RawContentValue,
     ) -> RpcResult<u32>;
 
     /// Send the provided content value to interested peers. Clients may choose to send to some or
@@ -95,7 +97,7 @@ pub trait HistoryNetworkApi {
     async fn trace_gossip(
         &self,
         content_key: HistoryContentKey,
-        content_value: HistoryContentValue,
+        content_value: RawContentValue,
     ) -> RpcResult<TraceGossipInfo>;
 
     /// Send an OFFER request with given ContentKey, to the designated peer and wait for a response.
@@ -107,7 +109,7 @@ pub trait HistoryNetworkApi {
         &self,
         enr: Enr,
         content_key: HistoryContentKey,
-        content_value: HistoryContentValue,
+        content_value: RawContentValue,
     ) -> RpcResult<AcceptInfo>;
 
     /// Send an OFFER request with given ContentKey, to the designated peer.
@@ -119,7 +121,7 @@ pub trait HistoryNetworkApi {
         &self,
         enr: Enr,
         content_key: HistoryContentKey,
-        content_value: HistoryContentValue,
+        content_value: RawContentValue,
     ) -> RpcResult<bool>;
 
     /// Send an OFFER request with given ContentKeys, to the designated peer and wait for a
@@ -138,11 +140,10 @@ pub trait HistoryNetworkApi {
     async fn store(
         &self,
         content_key: HistoryContentKey,
-        content_value: HistoryContentValue,
+        content_value: RawContentValue,
     ) -> RpcResult<bool>;
 
     /// Get a content value from the local database
     #[method(name = "historyLocalContent")]
-    async fn local_content(&self, content_key: HistoryContentKey)
-        -> RpcResult<HistoryContentValue>;
+    async fn local_content(&self, content_key: HistoryContentKey) -> RpcResult<RawContentValue>;
 }
diff --git a/ethportal-api/src/lib.rs b/ethportal-api/src/lib.rs
@@ -12,43 +12,42 @@ mod dashboard;
 pub mod discv5;
 mod eth;
 mod history;
-pub mod state;
+mod state;
 #[cfg(test)]
 mod test_utils;
 pub mod types;
 pub mod utils;
 mod web3;
 
-pub use crate::discv5::{Discv5ApiClient, Discv5ApiServer};
 pub use beacon::{BeaconNetworkApiClient, BeaconNetworkApiServer};
+pub use discv5::{Discv5ApiClient, Discv5ApiServer};
 pub use eth::{EthApiClient, EthApiServer};
 pub use history::{HistoryNetworkApiClient, HistoryNetworkApiServer};
 pub use state::{StateNetworkApiClient, StateNetworkApiServer};
 pub use web3::{Web3ApiClient, Web3ApiServer};
 
-pub use types::content_key::{
-    beacon::{BeaconContentKey, LightClientBootstrapKey, LightClientUpdatesByRangeKey},
-    error::ContentKeyError,
-    history::{
-        BlockBodyKey, BlockHeaderKey, BlockReceiptsKey, EpochAccumulatorKey, HistoryContentKey,
-        RawContentKey,
-    },
-    overlay::{IdentityContentKey, OverlayContentKey},
-    state::StateContentKey,
-};
-
 pub use types::{
     consensus,
     consensus::light_client,
+    content_key::{
+        beacon::{BeaconContentKey, LightClientBootstrapKey, LightClientUpdatesByRangeKey},
+        error::ContentKeyError,
+        history::{
+            BlockBodyKey, BlockHeaderKey, BlockReceiptsKey, EpochAccumulatorKey, HistoryContentKey,
+        },
+        overlay::{IdentityContentKey, OverlayContentKey},
+        state::StateContentKey,
+    },
     content_value::{
         beacon::BeaconContentValue, error::ContentValueError, history::HistoryContentValue,
-        state::StateContentValue,
+        state::StateContentValue, ContentValue,
     },
+    discv5::*,
+    enr::*,
     execution::{block_body::*, header::*, receipts::*},
+    node_id::*,
+    portal::{RawContentKey, RawContentValue},
 };
 
 // Re-exports jsonrpsee crate
 pub use jsonrpsee;
-pub use types::content_value::ContentValue;
-
-pub use types::{discv5::*, enr::*, node_id::*};
diff --git a/ethportal-api/src/state.rs b/ethportal-api/src/state.rs
@@ -2,10 +2,12 @@ use crate::{
     types::{
         content_key::state::StateContentKey,
         enr::Enr,
-        portal::{AcceptInfo, DataRadius, FindNodesInfo, PongInfo, TraceGossipInfo},
-        state::{ContentInfo, PaginateLocalContentInfo, TraceContentInfo},
+        portal::{
+            AcceptInfo, ContentInfo, DataRadius, FindNodesInfo, PaginateLocalContentInfo, PongInfo,
+            TraceContentInfo, TraceGossipInfo,
+        },
     },
-    RoutingTableInfo, StateContentValue,
+    RawContentValue, RoutingTableInfo,
 };
 use discv5::enr::NodeId;
 use jsonrpsee::{core::RpcResult, proc_macros::rpc};
@@ -71,15 +73,15 @@ pub trait StateNetworkApi {
         &self,
         offset: u64,
         limit: u64,
-    ) -> RpcResult<PaginateLocalContentInfo>;
+    ) -> RpcResult<PaginateLocalContentInfo<StateContentKey>>;
 
     /// 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 = "stateGossip")]
     async fn gossip(
         &self,
         content_key: StateContentKey,
-        content_value: StateContentValue,
+        content_value: RawContentValue,
     ) -> RpcResult<u32>;
 
     /// Send the provided content value to interested peers. Clients may choose to send to some or
@@ -88,7 +90,7 @@ pub trait StateNetworkApi {
     async fn trace_gossip(
         &self,
         content_key: StateContentKey,
-        content_value: StateContentValue,
+        content_value: RawContentValue,
     ) -> RpcResult<TraceGossipInfo>;
 
     /// Send an OFFER request with given ContentKey, to the designated peer and wait for a response.
@@ -100,7 +102,7 @@ pub trait StateNetworkApi {
         &self,
         enr: Enr,
         content_key: StateContentKey,
-        content_value: StateContentValue,
+        content_value: RawContentValue,
     ) -> RpcResult<AcceptInfo>;
 
     /// Send an OFFER request with given ContentKey, to the designated peer.
@@ -112,18 +114,18 @@ pub trait StateNetworkApi {
         &self,
         enr: Enr,
         content_key: StateContentKey,
-        content_value: StateContentValue,
+        content_value: RawContentValue,
     ) -> RpcResult<bool>;
 
     /// Store content key with a content data to the local database.
     #[method(name = "stateStore")]
     async fn store(
         &self,
         content_key: StateContentKey,
-        content_value: StateContentValue,
+        content_value: RawContentValue,
     ) -> RpcResult<bool>;
 
     /// Get a content from the local database
     #[method(name = "stateLocalContent")]
-    async fn local_content(&self, content_key: StateContentKey) -> RpcResult<StateContentValue>;
+    async fn local_content(&self, content_key: StateContentKey) -> RpcResult<RawContentValue>;
 }
diff --git a/ethportal-api/src/types/beacon.rs b/ethportal-api/src/types/beacon.rs
diff --git a/ethportal-api/src/types/content_key/history.rs b/ethportal-api/src/types/content_key/history.rs
@@ -18,9 +18,6 @@ pub const HISTORY_BLOCK_BODY_KEY_PREFIX: u8 = 0x01;
 pub const HISTORY_BLOCK_RECEIPTS_KEY_PREFIX: u8 = 0x02;
 pub const HISTORY_BLOCK_EPOCH_ACCUMULATOR_KEY_PREFIX: u8 = 0x03;
 
-/// SSZ encoded overlay content key as bytes
-pub type RawContentKey = Vec<u8>;
-
 /// A content key in the history overlay network.
 #[derive(Clone, Debug, Eq, PartialEq)]
 pub enum HistoryContentKey {