mirrors/rust-lightning
1
0
Fork 0
mirror of https://github.com/lightningdevkit/rust-lightning.git synced 2025-02-25 07:17:40 +01:00
Code Issues Projects Releases Packages Wiki Activity

Add skipping variants to impl_writeable_tlv_based_enum_upgradable

Browse source 
In some cases, we have variants of an enum serialized using
`impl_writeable_tlv_based_enum_upgradable` which we don't want to
write/read. Here we add support for such variants by writing them
using the (odd) type 255 without any contents and using
`MaybeReadable` to decline to read them.
This commit is contained in:
Matt Corallo 2024-06-18 17:24:21 +00:00
parent 88e1b56d66
commit 1c6ce8e789
1 changed files with 9 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
lightning/src/util/ser_macros.rs
View file

@ -1001,7 +1001,7 @@ macro_rules! _impl_writeable_tlv_based_enum_common {
impl $crate::util::ser::Writeable for $st { impl $crate::util::ser::Writeable for $st {
fn write<W: $crate::util::ser::Writer>(&self, writer: &mut W) -> Result<(), $crate::io::Error> { fn write<W: $crate::util::ser::Writer>(&self, writer: &mut W) -> Result<(), $crate::io::Error> {
match self { match self {
$($st::$variant_name { $(ref $field),* } => { $($st::$variant_name { $(ref $field, )* .. } => {
let id: u8 = $variant_id; let id: u8 = $variant_id;
id.write(writer)?; id.write(writer)?;
$crate::write_tlv_fields!(writer, { $crate::write_tlv_fields!(writer, {
@ -1099,10 +1099,12 @@ macro_rules! impl_writeable_tlv_based_enum_upgradable {
{$(($type: expr, $field: ident, $fieldty: tt)),* $(,)*} {$(($type: expr, $field: ident, $fieldty: tt)),* $(,)*}
),* $(,)* ),* $(,)*
$(; $(;
$(($tuple_variant_id: expr, $tuple_variant_name: ident)),* $(,)*)*) => { $(($tuple_variant_id: expr, $tuple_variant_name: ident)),* $(,)*)?
$(unread_variants: $($unread_variant: ident),*)?) => {
$crate::_impl_writeable_tlv_based_enum_common!($st, $crate::_impl_writeable_tlv_based_enum_common!($st,
$(($variant_id, $variant_name) => {$(($type, $field, $fieldty)),*}),*; $(($variant_id, $variant_name) => {$(($type, $field, $fieldty)),*}),*
$($(($tuple_variant_id, $tuple_variant_name)),*)*); $(, $((255, $unread_variant) => {}),*)?
; $($(($tuple_variant_id, $tuple_variant_name)),*)?);
impl $crate::util::ser::MaybeReadable for $st { impl $crate::util::ser::MaybeReadable for $st {
fn read<R: $crate::io::Read>(reader: &mut R) -> Result<Option<Self>, $crate::ln::msgs::DecodeError> { fn read<R: $crate::io::Read>(reader: &mut R) -> Result<Option<Self>, $crate::ln::msgs::DecodeError> {
@ -1126,7 +1128,9 @@ macro_rules! impl_writeable_tlv_based_enum_upgradable {
$($($tuple_variant_id => { $($($tuple_variant_id => {
Ok(Some($st::$tuple_variant_name(Readable::read(reader)?))) Ok(Some($st::$tuple_variant_name(Readable::read(reader)?)))
}),*)* }),*)*
_ if id % 2 == 1 => { // Note that we explicitly match 255 here to reserve it for use in
// `unread_variants`.
255|_ if id % 2 == 1 => {
// Assume that a $variant_id was written, not a $tuple_variant_id, and read // Assume that a $variant_id was written, not a $tuple_variant_id, and read
// the length prefix and discard the correct number of bytes. // the length prefix and discard the correct number of bytes.
let tlv_len: $crate::util::ser::BigSize = $crate::util::ser::Readable::read(reader)?; let tlv_len: $crate::util::ser::BigSize = $crate::util::ser::Readable::read(reader)?;