Skip to content

Commit

Permalink
fix: update n2n version table (#530)
Browse files Browse the repository at this point in the history
  • Loading branch information
@scarmuega
scarmuega authored Oct 23, 2024
1 parent c1cf128 commit eac906f
Showing 1 changed file with 147 additions and 31 deletions.
178 changes: 147 additions & 31 deletions pallas-miniprotocols/src/handshake/n2n.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,51 +4,137 @@ use pallas_codec::minicbor::{decode, encode, Decode, Decoder, Encode, Encoder};

pub type VersionTable = super::protocol::VersionTable<VersionData>;

const PROTOCOL_V4: u64 = 4;
const PROTOCOL_V5: u64 = 5;
const PROTOCOL_V6: u64 = 6;
const PROTOCOL_V7: u64 = 7;
const PROTOCOL_V8: u64 = 8;
const PROTOCOL_V9: u64 = 9;
const PROTOCOL_V10: u64 = 10;
const PROTOCOL_V11: u64 = 11;
const PROTOCOL_V12: u64 = 12;
const PROTOCOL_V13: u64 = 13;

const PEER_SHARING_DISABLED: u8 = 0;

impl VersionTable {
#[deprecated(note = "no longer supported by spec")]
pub fn v4_and_above(network_magic: u64) -> VersionTable {
// Older versions are not supported anymore (removed from network-spec.pdf).
// Try not to break compatibility with older pallas users.
Self::v7_and_above(network_magic)
}

#[deprecated(note = "no longer supported by spec")]
pub fn v6_and_above(network_magic: u64) -> VersionTable {
// Older versions are not supported anymore (removed from network-spec.pdf).
// Try not to break compatibility with older pallas users.
Self::v7_and_above(network_magic)
}

pub fn v7_to_v10(network_magic: u64) -> VersionTable {
let values = vec![
(PROTOCOL_V4, VersionData::new(network_magic, false)),
(PROTOCOL_V5, VersionData::new(network_magic, false)),
(PROTOCOL_V6, VersionData::new(network_magic, false)),
(PROTOCOL_V7, VersionData::new(network_magic, false)),
(PROTOCOL_V8, VersionData::new(network_magic, false)),
(PROTOCOL_V9, VersionData::new(network_magic, false)),
(PROTOCOL_V10, VersionData::new(network_magic, false)),
(
PROTOCOL_V7,
VersionData::new(network_magic, true, None, None),
),
(
PROTOCOL_V8,
VersionData::new(network_magic, true, None, None),
),
(
PROTOCOL_V9,
VersionData::new(network_magic, true, None, None),
),
(
PROTOCOL_V10,
VersionData::new(network_magic, true, None, None),
),
]
.into_iter()
.collect::<HashMap<u64, VersionData>>();

VersionTable { values }
}

pub fn v6_and_above(network_magic: u64) -> VersionTable {
pub fn v7_and_above(network_magic: u64) -> VersionTable {
let values = vec![
(PROTOCOL_V6, VersionData::new(network_magic, false)),
(PROTOCOL_V7, VersionData::new(network_magic, false)),
(PROTOCOL_V8, VersionData::new(network_magic, false)),
(PROTOCOL_V9, VersionData::new(network_magic, false)),
(PROTOCOL_V10, VersionData::new(network_magic, false)),
(
PROTOCOL_V7,
VersionData::new(network_magic, true, None, None),
),
(
PROTOCOL_V8,
VersionData::new(network_magic, true, None, None),
),
(
PROTOCOL_V9,
VersionData::new(network_magic, true, None, None),
),
(
PROTOCOL_V10,
VersionData::new(network_magic, true, None, None),
),
(
PROTOCOL_V11,
VersionData::new(
network_magic,
true,
Some(PEER_SHARING_DISABLED),
Some(false),
),
),
(
PROTOCOL_V12,
VersionData::new(
network_magic,
true,
Some(PEER_SHARING_DISABLED),
Some(false),
),
),
(
PROTOCOL_V13,
VersionData::new(
network_magic,
true,
Some(PEER_SHARING_DISABLED),
Some(false),
),
),
]
.into_iter()
.collect::<HashMap<u64, VersionData>>();

VersionTable { values }
}

pub fn v7_and_above(network_magic: u64) -> VersionTable {
pub fn v11_and_above(network_magic: u64) -> VersionTable {
let values = vec![
(PROTOCOL_V7, VersionData::new(network_magic, false)),
(PROTOCOL_V8, VersionData::new(network_magic, false)),
(PROTOCOL_V9, VersionData::new(network_magic, false)),
(PROTOCOL_V10, VersionData::new(network_magic, false)),
(
PROTOCOL_V11,
VersionData::new(
network_magic,
true,
Some(PEER_SHARING_DISABLED),
Some(false),
),
),
(
PROTOCOL_V12,
VersionData::new(
network_magic,
true,
Some(PEER_SHARING_DISABLED),
Some(false),
),
),
(
PROTOCOL_V13,
VersionData::new(
network_magic,
true,
Some(PEER_SHARING_DISABLED),
Some(false),
),
),
]
.into_iter()
.collect::<HashMap<u64, VersionData>>();
Expand All @@ -57,17 +143,26 @@ impl VersionTable {
}
}

#[derive(Debug, Clone)]
#[derive(Debug, Clone, PartialEq)]
pub struct VersionData {
network_magic: u64,
initiator_and_responder_diffusion_mode: bool,
initiator_only_diffusion_mode: bool,
peer_sharing: Option<u8>,
query: Option<bool>,
}

impl VersionData {
pub fn new(network_magic: u64, initiator_and_responder_diffusion_mode: bool) -> Self {
pub fn new(
network_magic: u64,
initiator_only_diffusion_mode: bool,
peer_sharing: Option<u8>,
query: Option<bool>,
) -> Self {
VersionData {
network_magic,
initiator_and_responder_diffusion_mode,
initiator_only_diffusion_mode,
peer_sharing,
query,
}
}
}
Expand All @@ -78,23 +173,44 @@ impl Encode<()> for VersionData {
e: &mut Encoder<W>,
_ctx: &mut (),
) -> Result<(), encode::Error<W::Error>> {
e.array(2)?
.u64(self.network_magic)?
.bool(self.initiator_and_responder_diffusion_mode)?;
match (self.peer_sharing, self.query) {
(Some(peer_sharing), Some(query)) => {
e.array(4)?
.u64(self.network_magic)?
.bool(self.initiator_only_diffusion_mode)?
.u8(peer_sharing)?
.bool(query)?;
}
_ => {
e.array(2)?
.u64(self.network_magic)?
.bool(self.initiator_only_diffusion_mode)?;
}
};

Ok(())
}
}

impl<'b> Decode<'b, ()> for VersionData {
fn decode(d: &mut Decoder<'b>, _ctx: &mut ()) -> Result<Self, decode::Error> {
d.array()?;
let len = d.array()?;
let network_magic = d.u64()?;
let initiator_and_responder_diffusion_mode = d.bool()?;
let initiator_only_diffusion_mode = d.bool()?;
let peer_sharing = match len {
Some(4) => Some(d.u8()?),
_ => None,
};
let query = match len {
Some(4) => Some(d.bool()?),
_ => None,
};

Ok(Self {
network_magic,
initiator_and_responder_diffusion_mode,
initiator_only_diffusion_mode,
peer_sharing,
query,
})
}
}

0 comments on commit eac906f

Please sign in to comment.