bee_block/payload/milestone/option/
parameters.rs

1// Copyright 2022 IOTA Stiftung
2// SPDX-License-Identifier: Apache-2.0
3
4//! Module describing the parameters milestone option.
5
6use alloc::vec::Vec;
7use core::ops::RangeInclusive;
8
9use packable::{bounded::BoundedU16, prefix::BoxedSlicePrefix, Packable};
10
11use crate::{payload::milestone::MilestoneIndex, Error};
12
13pub(crate) type BinaryParametersLength = BoundedU16<
14    { *ParametersMilestoneOption::BINARY_PARAMETERS_LENGTH_RANGE.start() },
15    { *ParametersMilestoneOption::BINARY_PARAMETERS_LENGTH_RANGE.end() },
16>;
17
18///
19#[derive(Clone, Debug, Eq, PartialEq, Packable)]
20#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
21#[packable(unpack_error = Error)]
22pub struct ParametersMilestoneOption {
23    // The milestone index at which these protocol parameters become active.
24    target_milestone_index: MilestoneIndex,
25    // The protocol version.
26    protocol_version: u8,
27    // The protocol parameters in binary form.
28    #[packable(unpack_error_with = |err| Error::InvalidBinaryParametersLength(err.into_prefix_err().into()))]
29    binary_parameters: BoxedSlicePrefix<u8, BinaryParametersLength>,
30}
31
32impl ParametersMilestoneOption {
33    /// The milestone option kind of a [`ParametersMilestoneOption`].
34    pub const KIND: u8 = 1;
35    /// Valid lengths for binary parameters.
36    pub const BINARY_PARAMETERS_LENGTH_RANGE: RangeInclusive<u16> = 0..=8192;
37
38    /// Creates a new [`ParametersMilestoneOption`].
39    pub fn new(
40        target_milestone_index: MilestoneIndex,
41        protocol_version: u8,
42        binary_parameters: Vec<u8>,
43    ) -> Result<Self, Error> {
44        Ok(Self {
45            target_milestone_index,
46            protocol_version,
47            binary_parameters: binary_parameters
48                .into_boxed_slice()
49                .try_into()
50                .map_err(Error::InvalidBinaryParametersLength)?,
51        })
52    }
53
54    /// Returns the target milestone index of a [`ParametersMilestoneOption`].
55    pub fn target_milestone_index(&self) -> MilestoneIndex {
56        self.target_milestone_index
57    }
58
59    /// Returns the protocol version of a [`ParametersMilestoneOption`].
60    pub fn protocol_version(&self) -> u8 {
61        self.protocol_version
62    }
63
64    /// Returns the binary parameters of a [`ParametersMilestoneOption`].
65    pub fn binary_parameters(&self) -> &[u8] {
66        &self.binary_parameters
67    }
68}
69
70#[cfg(feature = "dto")]
71#[allow(missing_docs)]
72pub mod dto {
73    use serde::{Deserialize, Serialize};
74
75    use super::*;
76    use crate::error::dto::DtoError;
77
78    ///
79    #[derive(Clone, Debug, Eq, PartialEq, Serialize, Deserialize)]
80    pub struct ParametersMilestoneOptionDto {
81        #[serde(rename = "type")]
82        pub kind: u8,
83        #[serde(rename = "targetMilestoneIndex")]
84        pub target_milestone_index: u32,
85        #[serde(rename = "protocolVersion")]
86        pub protocol_version: u8,
87        #[serde(rename = "params")]
88        pub binary_parameters: String,
89    }
90
91    impl From<&ParametersMilestoneOption> for ParametersMilestoneOptionDto {
92        fn from(value: &ParametersMilestoneOption) -> Self {
93            ParametersMilestoneOptionDto {
94                kind: ParametersMilestoneOption::KIND,
95                target_milestone_index: *value.target_milestone_index(),
96                protocol_version: value.protocol_version(),
97                binary_parameters: prefix_hex::encode(value.binary_parameters()),
98            }
99        }
100    }
101
102    impl TryFrom<&ParametersMilestoneOptionDto> for ParametersMilestoneOption {
103        type Error = DtoError;
104
105        fn try_from(value: &ParametersMilestoneOptionDto) -> Result<Self, Self::Error> {
106            Ok(ParametersMilestoneOption::new(
107                value.target_milestone_index.into(),
108                value.protocol_version,
109                prefix_hex::decode(&value.binary_parameters).map_err(|_| DtoError::InvalidField("params"))?,
110            )?)
111        }
112    }
113}
bee_block/payload/milestone/option/parameters.rs

bee_block/payload/milestone/option/
parameters.rs
