From e105b4f6c5880d9e81cb3b10857d3f90530b37b0 Mon Sep 17 00:00:00 2001 From: Jane Lusby Date: Wed, 22 Jul 2020 11:38:00 -0700 Subject: [PATCH] properly document guarantee provided by zebra-network (#713) Co-authored-by: Deirdre Connolly --- zebra-network/src/lib.rs | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/zebra-network/src/lib.rs b/zebra-network/src/lib.rs index da06626dd..500e759b3 100644 --- a/zebra-network/src/lib.rs +++ b/zebra-network/src/lib.rs @@ -12,6 +12,10 @@ //! [`tower::Service`] representing "the network" which load-balances //! outbound [`Request`]s over available peers. //! +//! Unlike the underlying legacy network protocol the provided +//! [`tower::Service`] guarantees that each `Request` future will resolve to +//! the correct `Response`, not a potentially random unrelated `Response`. +//! //! Each peer connection is a distinct task, which interprets incoming //! Bitcoin/Zcash messages either as [`Response`]s to pending //! [`Request`]s, or as an inbound [`Request`]s to an internal