1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42

//! Helper for incoming segment header requests.
//!
//! Handle (i.e. answer) incoming segment headers requests from a remote peer received via
//! `RequestResponsesBehaviour` with generic [`GenericRequestHandler`].

use super::generic_request_handler::{GenericRequest, GenericRequestHandler};
use parity_scale_codec::{Decode, Encode};
use subspace_core_primitives::{SegmentHeader, SegmentIndex};

/// Segment header by segment indexes protocol request.
#[derive(Debug, Clone, Eq, PartialEq, Encode, Decode)]
pub enum SegmentHeaderRequest {
    /// Segment headers by segment indexes.
    SegmentIndexes {
        /// Segment indexes to get.
        segment_indexes: Vec<SegmentIndex>,
    },
    // TODO: Should this be changed to return segments in normal order once we can introduce
    //  breaking changes?
    /// Defines how many segment headers to return, segments will be in reverse order.
    LastSegmentHeaders {
        /// Number of segment headers to return.
        // TODO: Replace u64 with a smaller type when able to make breaking changes
        segment_header_number: u64,
    },
}

impl GenericRequest for SegmentHeaderRequest {
    const PROTOCOL_NAME: &'static str = "/subspace/segment-headers-by-indexes/0.1.0";
    const LOG_TARGET: &'static str = "segment-headers-by-indexes-request-response-handler";
    type Response = SegmentHeaderResponse;
}

/// Segment header by segment indexes protocol response.
#[derive(Debug, PartialEq, Eq, Clone, Encode, Decode)]
pub struct SegmentHeaderResponse {
    /// Returned data.
    pub segment_headers: Vec<SegmentHeader>,
}

/// Create a new segment-header-by-segment-indexes request handler.
pub type SegmentHeaderBySegmentIndexesRequestHandler = GenericRequestHandler<SegmentHeaderRequest>;