jleony/nanoreth
1
0
Fork 0
mirror of https://github.com/hl-archive-node/nanoreth.git synced 2025-12-06 19:09:54 +00:00
Code Issues Packages Projects Releases Wiki Activity

feat(eth-wire): return Hello on handshake (#161)

Browse Source 
* feat(eth-wire): return Hello on handshake

* update P2PStream docs based on new auth design

* cargo fmt

* make clippy happy
This commit is contained in:
Dan Cline
2022-11-04 03:14:41 -04:00
committed by GitHub
parent ccdf2ffa92
commit 43a0a2b160
2 changed files with 20 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

29
crates/net/eth-wire/src/p2pstream.rs
View File

@ -51,8 +51,8 @@ const GRACE_PERIOD: Duration = Duration::from_secs(2);
/// from a peer.
const MAX_FAILED_PINGS: u8 = 3;
/// An un-authenticated `P2PStream`. This is consumed and returns a [`P2PStream`] after the `Hello`
/// handshake is completed.
/// An un-authenticated [`P2PStream`]. This is consumed and returns a [`P2PStream`] after the
/// `Hello` handshake is completed.
#[pin_project]
pub struct UnauthedP2PStream<S> {
#[pin]
@ -71,8 +71,11 @@ where
S: Stream<Item = Result<BytesMut, io::Error>> + Sink<Bytes, Error = io::Error> + Unpin,
{
/// Consumes the `UnauthedP2PStream` and returns a `P2PStream` after the `Hello` handshake is
/// completed.
pub async fn handshake(mut self, hello: HelloMessage) -> Result<P2PStream<S>, P2PStreamError> {
/// completed successfully. This also returns the `Hello` message sent by the remote peer.
pub async fn handshake(
mut self,
hello: HelloMessage,
) -> Result<(P2PStream<S>, HelloMessage), P2PStreamError> {
tracing::trace!("sending p2p hello ...");
// send our hello message with the Sink
@ -97,7 +100,7 @@ where
}
// get the message id
let id = *hello_bytes.first().ok_or_else(|| P2PStreamError::EmptyProtocolMessage)?;
let id = *hello_bytes.first().ok_or(P2PStreamError::EmptyProtocolMessage)?;
// the first message sent MUST be the hello message
if id != P2PMessageID::Hello as u8 {
@ -124,11 +127,12 @@ where
}
// determine shared capabilities (currently returns only one capability)
let capability = set_capability_offsets(hello.capabilities, their_hello.capabilities)?;
let capability =
set_capability_offsets(hello.capabilities, their_hello.capabilities.clone())?;
let stream = P2PStream::new(self.inner, capability);
Ok(stream)
Ok((stream, their_hello))
}
}
@ -153,8 +157,9 @@ pub struct P2PStream<S> {
}
impl<S> P2PStream<S> {
/// Create a new unauthed [`P2PStream`] from the provided stream. You will need to manually
/// handshake with a peer.
/// Create a new [`P2PStream`] from the provided stream.
/// New [`P2PStream`]s are assumed to have completed the `p2p` handshake successfully and are
/// ready to send and receive subprotocol messages.
pub fn new(inner: S, capability: SharedCapability) -> Self {
Self {
inner,
@ -388,7 +393,7 @@ pub fn set_capability_offsets(
// capability with the lowest offset.
Ok(shared_with_offsets
.first()
.ok_or_else(|| P2PStreamError::HandshakeError(P2PHandshakeError::NoSharedCapabilities))?
.ok_or(P2PStreamError::HandshakeError(P2PHandshakeError::NoSharedCapabilities))?
.clone())
}
@ -736,7 +741,7 @@ mod tests {
};
let unauthed_stream = UnauthedP2PStream::new(stream);
let p2p_stream = unauthed_stream.handshake(server_hello).await.unwrap();
let (p2p_stream, _) = unauthed_stream.handshake(server_hello).await.unwrap();
// ensure that the two share a single capability, eth67
assert_eq!(
@ -762,7 +767,7 @@ mod tests {
};
let unauthed_stream = UnauthedP2PStream::new(sink);
let p2p_stream = unauthed_stream.handshake(client_hello).await.unwrap();
let (p2p_stream, _) = unauthed_stream.handshake(client_hello).await.unwrap();
// ensure that the two share a single capability, eth67
assert_eq!(