ethportal-api 0.12.0

use alloy::primitives::B256;
use discv5::enr::NodeId;
use jsonrpsee::{core::RpcResult, proc_macros::rpc};
use serde_json::Value;

use crate::{
    consensus::header::BeaconBlockHeader,
    light_client::store::LightClientStore,
    types::{
        consensus::light_client::{
            finality_update::LightClientFinalityUpdate,
            optimistic_update::LightClientOptimisticUpdate,
        },
        content_key::beacon::BeaconContentKey,
        enr::Enr,
        ping_extensions::extension_types::PingExtensionType,
        portal::{
            AcceptInfo, DataRadius, FindContentInfo, FindNodesInfo, GetContentInfo,
            PaginateLocalContentInfo, PongInfo, PutContentInfo, TraceContentInfo,
        },
        portal_wire::OfferTrace,
    },
    RawContentValue, RoutingTableInfo,
};

/// 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>;

    /// Returns the local store of the light client.
    #[method(name = "beaconLightClientStore")]
    async fn light_client_store(&self) -> RpcResult<LightClientStore>;

    /// 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,
        payload_type: Option<PingExtensionType>,
        payload: Option<Value>,
    ) -> RpcResult<PongInfo>;

    /// Get the finalized state root of the finalized beacon header.
    #[method(name = "beaconFinalizedStateRoot")]
    async fn finalized_state_root(&self) -> RpcResult<B256>;

    /// Get the finalized beacon header
    #[method(name = "beaconFinalizedHeader")]
    async fn finalized_header(&self) -> RpcResult<BeaconBlockHeader>;

    /// Get the latest finality update
    #[method(name = "beaconFinalityUpdate")]
    async fn finality_update(&self) -> RpcResult<LightClientFinalityUpdate>;

    /// Get the latest optimistic update
    #[method(name = "beaconOptimisticUpdate")]
    async fn optimistic_update(&self) -> RpcResult<LightClientOptimisticUpdate>;

    /// 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>>;

    /// Get the optimistic root of the optimistic header.
    #[method(name = "beaconOptimisticStateRoot")]
    async fn optimistic_state_root(&self) -> RpcResult<B256>;

    /// 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<FindContentInfo>;

    /// First checks local storage if content is not found lookup a target content key in the
    /// network
    #[method(name = "beaconGetContent")]
    async fn get_content(&self, content_key: BeaconContentKey) -> RpcResult<GetContentInfo>;

    /// First checks local storage if content is not found lookup a target content key in the
    /// network. Return tracing info.
    #[method(name = "beaconTraceGetContent")]
    async fn trace_get_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<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 = "beaconPutContent")]
    async fn put_content(
        &self,
        content_key: BeaconContentKey,
        content_value: RawContentValue,
    ) -> RpcResult<PutContentInfo>;

    /// Send an OFFER request with given ContentItems, to the designated peer and wait for a
    /// response. Does not store the content locally.
    /// Returns the content keys bitlist upon successful content transmission or empty bitlist
    /// receive.
    #[method(name = "beaconOffer")]
    async fn offer(
        &self,
        enr: Enr,
        content_items: Vec<(BeaconContentKey, RawContentValue)>,
    ) -> RpcResult<AcceptInfo>;

    /// Send an OFFER request with given ContentItems, to the designated peer.
    /// Does not store the content locally.
    /// Returns trace info for the offer.
    #[method(name = "beaconTraceOffer")]
    async fn trace_offer(
        &self,
        enr: Enr,
        content_key: BeaconContentKey,
        content_value: RawContentValue,
    ) -> RpcResult<OfferTrace>;

    /// Store content key with a content data to the local database.
    #[method(name = "beaconStore")]
    async fn store(
        &self,
        content_key: BeaconContentKey,
        content_value: RawContentValue,
    ) -> RpcResult<bool>;

    /// Get a content from the local database
    #[method(name = "beaconLocalContent")]
    async fn local_content(&self, content_key: BeaconContentKey) -> RpcResult<RawContentValue>;
}