smoldot 1.0.0

Primitives to build a client for Substrate-based blockchains
Documentation 
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
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95

// Smoldot
// Copyright (C) 2019-2022  Parity Technologies (UK) Ltd.
// SPDX-License-Identifier: GPL-3.0-or-later WITH Classpath-exception-2.0

// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.

// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.

// You should have received a copy of the GNU General Public License
// along with this program.  If not, see <http://www.gnu.org/licenses/>.

use crate::{libp2p::peer_id, util::protobuf};

use alloc::vec::Vec;

// See https://github.com/libp2p/specs/tree/master/kad-dht#rpc-messages for the protobuf format.

/// Builds a wire message to send on the Kademlia request-response protocol to ask the target to
/// return the nodes closest to the parameter.
// TODO: parameter type?
pub fn build_find_node_request(peer_id: &[u8]) -> Vec<u8> {
    // The capacity is arbitrary but large enough to avoid Vec reallocations.
    let mut out = Vec::with_capacity(64 + peer_id.len());
    for slice in protobuf::enum_tag_encode(1, 4) {
        out.extend_from_slice(slice.as_ref());
    }
    for slice in protobuf::bytes_tag_encode(2, peer_id) {
        out.extend_from_slice(slice.as_ref());
    }
    out
}

/// Decodes a response to a request built using [`build_find_node_request`].
// TODO: return a borrow of the response bytes ; we're limited by protobuf library
pub fn decode_find_node_response(
    response_bytes: &[u8],
) -> Result<Vec<(peer_id::PeerId, Vec<Vec<u8>>)>, DecodeFindNodeResponseError> {
    let mut parser = nom::combinator::all_consuming::<_, nom::error::Error<&[u8]>, _>(
        nom::combinator::complete(protobuf::message_decode! {
            #[optional] response_ty = 1 => protobuf::enum_tag_decode,
            #[repeated(max = 1024)] peers = 8 => protobuf::message_tag_decode(protobuf::message_decode!{
                #[required] peer_id = 1 => protobuf::bytes_tag_decode,
                #[repeated(max = 1024)] addrs = 2 => protobuf::bytes_tag_decode,
            }),
        }),
    );

    let closer_peers = match nom::Finish::finish(nom::Parser::parse(&mut parser, response_bytes)) {
        Ok((_, out)) if out.response_ty.unwrap_or(0) == 4 => out.peers,
        Ok((_, _)) => return Err(DecodeFindNodeResponseError::BadResponseTy),
        Err(_) => {
            return Err(DecodeFindNodeResponseError::ProtobufDecode(
                ProtobufDecodeError,
            ));
        }
    };

    let mut result = Vec::with_capacity(closer_peers.len());
    for peer in closer_peers {
        let peer_id = peer_id::PeerId::from_bytes(peer.peer_id.to_vec())
            .map_err(|(err, _)| DecodeFindNodeResponseError::BadPeerId(err))?;

        let mut multiaddrs = Vec::with_capacity(peer.addrs.len());
        for addr in peer.addrs {
            multiaddrs.push(addr.to_vec());
        }

        result.push((peer_id, multiaddrs));
    }

    Ok(result)
}

/// Error potentially returned by [`decode_find_node_response`].
#[derive(Debug, derive_more::Display, derive_more::Error)]
pub enum DecodeFindNodeResponseError {
    /// Error while decoding the Protobuf encoding.
    #[display("Error decoding the response: {_0}")]
    ProtobufDecode(ProtobufDecodeError),
    /// Response isn't a response to a find node request.
    BadResponseTy,
    /// Error while parsing a [`peer_id::PeerId`] in the response.
    #[display("Invalid PeerId: {_0}")]
    BadPeerId(peer_id::FromBytesError),
}

/// Error while decoding the Protobuf encoding.
#[derive(Debug, derive_more::Display, derive_more::Error)]
pub struct ProtobufDecodeError;