Skip to content

Fix TLV serialization to work with large types #964

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 24, 2021
Merged

Fix TLV serialization to work with large types #964

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
96 changes: 46 additions & 50 deletions lightning/src/chain/channelmonitor.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ impl Writeable for ChannelMonitorUpdate {
for update_step in self.updates.iter() {
update_step.write(w)?;
}
write_tlv_fields!(w, {}, {});
write_tlv_fields!(w, {});
Ok(())
}
}
Expand All @@ -108,7 +108,7 @@ impl Readable for ChannelMonitorUpdate {
for _ in 0..len {
updates.push(Readable::read(r)?);
}
read_tlv_fields!(r, {}, {});
read_tlv_fields!(r, {});
Ok(Self { update_id, updates })
}
}
Expand Down Expand Up @@ -202,11 +202,10 @@ pub struct HTLCUpdate {
pub(crate) source: HTLCSource
}
impl_writeable_tlv_based!(HTLCUpdate, {
(0, payment_hash),
(2, source),
}, {
(4, payment_preimage)
}, {});
(0, payment_hash, required),
(2, source, required),
(4, payment_preimage, option),
});

/// If an HTLC expires within this many blocks, don't try to claim it in a shared transaction,
/// instead claiming it in its own individual transaction.
Expand Down Expand Up @@ -273,15 +272,14 @@ struct HolderSignedTx {
htlc_outputs: Vec<(HTLCOutputInCommitment, Option<Signature>, Option<HTLCSource>)>,
}
impl_writeable_tlv_based!(HolderSignedTx, {
(0, txid),
(2, revocation_key),
(4, a_htlc_key),
(6, b_htlc_key),
(8, delayed_payment_key),
(10, per_commitment_point),
(12, feerate_per_kw),
}, {}, {
(14, htlc_outputs)
(0, txid, required),
(2, revocation_key, required),
(4, a_htlc_key, required),
(6, b_htlc_key, required),
(8, delayed_payment_key, required),
(10, per_commitment_point, required),
(12, feerate_per_kw, required),
(14, htlc_outputs, vec_type)
});

/// We use this to track counterparty commitment transactions and htlcs outputs and
Expand All @@ -305,10 +303,10 @@ impl Writeable for CounterpartyCommitmentTransaction {
}
}
write_tlv_fields!(w, {
(0, self.counterparty_delayed_payment_base_key),
(2, self.counterparty_htlc_base_key),
(4, self.on_counterparty_tx_csv),
}, {});
(0, self.counterparty_delayed_payment_base_key, required),
(2, self.counterparty_htlc_base_key, required),
(4, self.on_counterparty_tx_csv, required),
});
Ok(())
}
}
Expand All @@ -333,10 +331,10 @@ impl Readable for CounterpartyCommitmentTransaction {
let mut counterparty_htlc_base_key = OptionDeserWrapper(None);
let mut on_counterparty_tx_csv: u16 = 0;
read_tlv_fields!(r, {
(0, counterparty_delayed_payment_base_key),
(2, counterparty_htlc_base_key),
(4, on_counterparty_tx_csv),
}, {});
(0, counterparty_delayed_payment_base_key, required),
(2, counterparty_htlc_base_key, required),
(4, on_counterparty_tx_csv, required),
});
CounterpartyCommitmentTransaction {
counterparty_delayed_payment_base_key: counterparty_delayed_payment_base_key.0.unwrap(),
counterparty_htlc_base_key: counterparty_htlc_base_key.0.unwrap(),
Expand Down Expand Up @@ -394,19 +392,19 @@ enum OnchainEvent {
}

impl_writeable_tlv_based!(OnchainEventEntry, {
(0, txid),
(2, height),
(4, event),
}, {}, {});
(0, txid, required),
(2, height, required),
(4, event, required),
});

impl_writeable_tlv_based_enum!(OnchainEvent,
(0, HTLCUpdate) => {
(0, source),
(2, payment_hash),
}, {}, {},
(0, source, required),
(2, payment_hash, required),
},
(1, MaturingOutput) => {
(0, descriptor),
}, {}, {},
(0, descriptor, required),
},
;);

#[cfg_attr(any(test, feature = "fuzztarget", feature = "_test_utils"), derive(PartialEq))]
Expand Down Expand Up @@ -440,27 +438,25 @@ pub(crate) enum ChannelMonitorUpdateStep {

impl_writeable_tlv_based_enum!(ChannelMonitorUpdateStep,
(0, LatestHolderCommitmentTXInfo) => {
(0, commitment_tx),
}, {}, {
(2, htlc_outputs),
(0, commitment_tx, required),
(2, htlc_outputs, vec_type),
},
(1, LatestCounterpartyCommitmentTXInfo) => {
(0, commitment_txid),
(2, commitment_number),
(4, their_revocation_point),
}, {}, {
(6, htlc_outputs),
(0, commitment_txid, required),
(2, commitment_number, required),
(4, their_revocation_point, required),
(6, htlc_outputs, vec_type),
},
(2, PaymentPreimage) => {
(0, payment_preimage),
}, {}, {},
(0, payment_preimage, required),
},
(3, CommitmentSecret) => {
(0, idx),
(2, secret),
}, {}, {},
(0, idx, required),
(2, secret, required),
},
(4, ChannelForceClosed) => {
(0, should_broadcast),
}, {}, {},
(0, should_broadcast, required),
},
;);

/// A ChannelMonitor handles chain events (blocks connected and disconnected) and generates
Expand Down Expand Up @@ -792,7 +788,7 @@ impl<Signer: Sign> Writeable for ChannelMonitorImpl<Signer> {
self.lockdown_from_offchain.write(writer)?;
self.holder_tx_signed.write(writer)?;

write_tlv_fields!(writer, {}, {});
write_tlv_fields!(writer, {});

Ok(())
}
Expand Down Expand Up @@ -2740,7 +2736,7 @@ impl<'a, Signer: Sign, K: KeysInterface<Signer = Signer>> ReadableArgs<&'a K>
let lockdown_from_offchain = Readable::read(reader)?;
let holder_tx_signed = Readable::read(reader)?;

read_tlv_fields!(reader, {}, {});
read_tlv_fields!(reader, {});

let mut secp_ctx = Secp256k1::new();
secp_ctx.seeded_randomize(&keys_manager.get_secure_random_bytes());
Expand Down
36 changes: 18 additions & 18 deletions lightning/src/chain/keysinterface.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,14 +73,14 @@ impl DelayedPaymentOutputDescriptor {
}

impl_writeable_tlv_based!(DelayedPaymentOutputDescriptor, {
(0, outpoint),
(2, per_commitment_point),
(4, to_self_delay),
(6, output),
(8, revocation_pubkey),
(10, channel_keys_id),
(12, channel_value_satoshis),
}, {}, {});
(0, outpoint, required),
(2, per_commitment_point, required),
(4, to_self_delay, required),
(6, output, required),
(8, revocation_pubkey, required),
(10, channel_keys_id, required),
(12, channel_value_satoshis, required),
});

/// Information about a spendable output to our "payment key". See
/// SpendableOutputDescriptor::StaticPaymentOutput for more details on how to spend this.
Expand All @@ -104,11 +104,11 @@ impl StaticPaymentOutputDescriptor {
pub const MAX_WITNESS_LENGTH: usize = 1 + 73 + 34;
}
impl_writeable_tlv_based!(StaticPaymentOutputDescriptor, {
(0, outpoint),
(2, output),
(4, channel_keys_id),
(6, channel_value_satoshis),
}, {}, {});
(0, outpoint, required),
(2, output, required),
(4, channel_keys_id, required),
(6, channel_value_satoshis, required),
});

/// When on-chain outputs are created by rust-lightning (which our counterparty is not able to
/// claim at any point in the future) an event is generated which you must track and be able to
Expand Down Expand Up @@ -169,9 +169,9 @@ pub enum SpendableOutputDescriptor {

impl_writeable_tlv_based_enum!(SpendableOutputDescriptor,
(0, StaticOutput) => {
(0, outpoint),
(2, output),
}, {}, {},
(0, outpoint, required),
(2, output, required),
},
;
(1, DelayedPaymentOutput),
(2, StaticPaymentOutput),
Expand Down Expand Up @@ -692,7 +692,7 @@ impl Writeable for InMemorySigner {
self.channel_value_satoshis.write(writer)?;
self.channel_keys_id.write(writer)?;

write_tlv_fields!(writer, {}, {});
write_tlv_fields!(writer, {});

Ok(())
}
Expand All @@ -717,7 +717,7 @@ impl Readable for InMemorySigner {
&htlc_base_key);
let keys_id = Readable::read(reader)?;

read_tlv_fields!(reader, {}, {});
read_tlv_fields!(reader, {});

Ok(InMemorySigner {
funding_key,
Expand Down
20 changes: 10 additions & 10 deletions lightning/src/chain/onchaintx.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,18 +79,18 @@ enum OnchainEvent {
}

impl_writeable_tlv_based!(OnchainEventEntry, {
(0, txid),
(2, height),
(4, event),
}, {}, {});
(0, txid, required),
(2, height, required),
(4, event, required),
});

impl_writeable_tlv_based_enum!(OnchainEvent,
(0, Claim) => {
(0, claim_request),
}, {}, {},
(0, claim_request, required),
},
(1, ContentiousOutpoint) => {
(0, package),
}, {}, {},
(0, package, required),
},
;);

impl Readable for Option<Vec<Option<(usize, Signature)>>> {
Expand Down Expand Up @@ -236,7 +236,7 @@ impl<ChannelSigner: Sign> OnchainTxHandler<ChannelSigner> {
entry.write(writer)?;
}

write_tlv_fields!(writer, {}, {});
write_tlv_fields!(writer, {});
Ok(())
}
}
Expand Down Expand Up @@ -298,7 +298,7 @@ impl<'a, K: KeysInterface> ReadableArgs<&'a K> for OnchainTxHandler<K::Signer> {
onchain_events_awaiting_threshold_conf.push(Readable::read(reader)?);
}

read_tlv_fields!(reader, {}, {});
read_tlv_fields!(reader, {});

let mut secp_ctx = Secp256k1::new();
secp_ctx.seeded_randomize(&keys_manager.get_secure_random_bytes());
Expand Down
Loading