forest/libp2p/hello/
message.rs

1// Copyright 2019-2025 ChainSafe Systems
2// SPDX-License-Identifier: Apache-2.0, MIT
3
4use crate::shim::bigint::BigInt;
5use crate::shim::clock::ChainEpoch;
6use cid::Cid;
7use nunny::Vec as NonEmpty;
8use serde_tuple::{self, Deserialize_tuple, Serialize_tuple};
9
10/// Hello message <https://filecoin-project.github.io/specs/#hello-spec>
11#[derive(Clone, Debug, PartialEq, Eq, Serialize_tuple, Deserialize_tuple)]
12pub struct HelloRequest {
13    pub heaviest_tip_set: NonEmpty<Cid>,
14    pub heaviest_tipset_height: ChainEpoch,
15    pub heaviest_tipset_weight: BigInt,
16    pub genesis_cid: Cid,
17}
18
19/// Response to a Hello message. This just handles latency of the peer.
20#[derive(Clone, Debug, PartialEq, Eq, Serialize_tuple, Deserialize_tuple)]
21pub struct HelloResponse {
22    /// Time of arrival to peer in UNIX nanoseconds.
23    pub arrival: u64,
24    /// Time sent from peer in UNIX nanoseconds.
25    pub sent: u64,
26}
27
28#[cfg(test)]
29mod tests {
30    use super::*;
31    use crate::utils::encoding::from_slice_with_fallback;
32    use crate::utils::multihash::prelude::*;
33    use fvm_ipld_encoding::{DAG_CBOR, to_vec};
34
35    #[test]
36    fn hello_default_ser() {
37        let orig_msg = HelloRequest {
38            genesis_cid: Cid::new_v1(DAG_CBOR, MultihashCode::Identity.digest(&[])),
39            heaviest_tipset_weight: Default::default(),
40            heaviest_tipset_height: Default::default(),
41            heaviest_tip_set: NonEmpty::of(Default::default()),
42        };
43        let bz = to_vec(&orig_msg).unwrap();
44        let msg: HelloRequest = from_slice_with_fallback(&bz).unwrap();
45        assert_eq!(msg, orig_msg);
46    }
47}