snarkos_node_router_messages/
challenge_request.rs

1// Copyright (c) 2019-2025 Provable Inc.
2// This file is part of the snarkOS library.
3
4// Licensed under the Apache License, Version 2.0 (the "License");
5// you may not use this file except in compliance with the License.
6// You may obtain a copy of the License at:
7
8// http://www.apache.org/licenses/LICENSE-2.0
9
10// Unless required by applicable law or agreed to in writing, software
11// distributed under the License is distributed on an "AS IS" BASIS,
12// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13// See the License for the specific language governing permissions and
14// limitations under the License.
15
16use super::*;
17
18use snarkvm::prelude::{FromBytes, ToBytes};
19
20use std::borrow::Cow;
21
22#[derive(Clone, Debug, PartialEq, Eq)]
23pub struct ChallengeRequest<N: Network> {
24    pub version: u32,
25    pub listener_port: u16,
26    pub node_type: NodeType,
27    pub address: Address<N>,
28    pub nonce: u64,
29}
30
31impl<N: Network> MessageTrait for ChallengeRequest<N> {
32    /// Returns the message name.
33    #[inline]
34    fn name(&self) -> Cow<'static, str> {
35        "ChallengeRequest".into()
36    }
37}
38
39impl<N: Network> ToBytes for ChallengeRequest<N> {
40    fn write_le<W: io::Write>(&self, mut writer: W) -> io::Result<()> {
41        self.version.write_le(&mut writer)?;
42        self.listener_port.write_le(&mut writer)?;
43        self.node_type.write_le(&mut writer)?;
44        self.address.write_le(&mut writer)?;
45        self.nonce.write_le(&mut writer)?;
46        Ok(())
47    }
48}
49
50impl<N: Network> FromBytes for ChallengeRequest<N> {
51    fn read_le<R: io::Read>(mut reader: R) -> io::Result<Self> {
52        let version = u32::read_le(&mut reader)?;
53        let listener_port = u16::read_le(&mut reader)?;
54        let node_type = NodeType::read_le(&mut reader)?;
55        let address = Address::<N>::read_le(&mut reader)?;
56        let nonce = u64::read_le(&mut reader)?;
57
58        Ok(Self { version, listener_port, node_type, address, nonce })
59    }
60}
61
62impl<N: Network> ChallengeRequest<N> {
63    pub fn new(listener_port: u16, node_type: NodeType, address: Address<N>, nonce: u64) -> Self {
64        Self { version: Message::<N>::latest_message_version(), listener_port, node_type, address, nonce }
65    }
66}
67
68#[cfg(test)]
69pub mod prop_tests {
70    use crate::{ChallengeRequest, NodeType};
71    use snarkvm::{
72        console::prelude::{FromBytes, ToBytes},
73        prelude::{Address, TestRng, Uniform},
74    };
75
76    use bytes::{Buf, BufMut, BytesMut};
77    use proptest::prelude::{BoxedStrategy, Strategy, any};
78    use test_strategy::proptest;
79
80    type CurrentNetwork = snarkvm::prelude::MainnetV0;
81
82    pub fn any_valid_address() -> BoxedStrategy<Address<CurrentNetwork>> {
83        any::<u64>().prop_map(|seed| Address::rand(&mut TestRng::fixed(seed))).boxed()
84    }
85
86    pub fn any_node_type() -> BoxedStrategy<NodeType> {
87        (0..=2)
88            .prop_map(|id| match id {
89                0 => NodeType::Client,
90                1 => NodeType::Prover,
91                2 => NodeType::Validator,
92                _ => unreachable!(),
93            })
94            .boxed()
95    }
96
97    pub fn any_challenge_request() -> BoxedStrategy<ChallengeRequest<CurrentNetwork>> {
98        (any_valid_address(), any::<u64>(), any::<u32>(), any::<u16>(), any_node_type())
99            .prop_map(|(address, nonce, version, listener_port, node_type)| ChallengeRequest {
100                address,
101                nonce,
102                version,
103                listener_port,
104                node_type,
105            })
106            .boxed()
107    }
108
109    #[proptest]
110    fn challenge_request_roundtrip(#[strategy(any_challenge_request())] original: ChallengeRequest<CurrentNetwork>) {
111        let mut buf = BytesMut::default().writer();
112        ChallengeRequest::write_le(&original, &mut buf).unwrap();
113
114        let deserialized: ChallengeRequest<CurrentNetwork> =
115            ChallengeRequest::read_le(buf.into_inner().reader()).unwrap();
116        assert_eq!(original, deserialized);
117    }
118}
snarkos_node_router_messages/challenge_request.rs

snarkos_node_router_messages/
challenge_request.rs
