Skip to content

Commit 32ca8ec

Browse files
TheBlueMattTheBlueMatt
committed
Make Readable::read a templated on the stream, not Readable itself
This makes Readable symmetric with Writeable and makes sense - something which is Readable should be Readable for any stream which implements std::io::Read, not only for a stream type it decides on. This solves some lifetime-compatibility issues in trying to read() from a LengthLimitingReader in arbitrary Readable impls.
1 parent 39b6233 commit 32ca8ec

File tree

14 files changed

+179
-185
lines changed

14 files changed

+179
-185
lines changed

‎fuzz/src/msg_targets/utils.rs

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ macro_rules! test_msg {
2828
{
2929
use lightning::util::ser::{Writeable, Readable};
3030
let mut r = ::std::io::Cursor::new($data);
31-
if let Ok(msg) = <$MsgType as Readable<::std::io::Cursor<&[u8]>>>::read(&mut r) {
31+
if let Ok(msg) = <$MsgType as Readable>::read(&mut r) {
3232
let p = r.position() as usize;
3333
let mut w = VecWriter(Vec::new());
3434
msg.write(&mut w).unwrap();
@@ -48,11 +48,11 @@ macro_rules! test_msg_simple {
4848
{
4949
use lightning::util::ser::{Writeable, Readable};
5050
let mut r = ::std::io::Cursor::new($data);
51-
if let Ok(msg) = <$MsgType as Readable<::std::io::Cursor<&[u8]>>>::read(&mut r) {
51+
if let Ok(msg) = <$MsgType as Readable>::read(&mut r) {
5252
let mut w = VecWriter(Vec::new());
5353
msg.write(&mut w).unwrap();
5454

55-
let msg = <$MsgType as Readable<::std::io::Cursor<&[u8]>>>::read(&mut ::std::io::Cursor::new(&w.0)).unwrap();
55+
let msg = <$MsgType as Readable>::read(&mut ::std::io::Cursor::new(&w.0)).unwrap();
5656
let mut w_two = VecWriter(Vec::new());
5757
msg.write(&mut w_two).unwrap();
5858
assert_eq!(&w.0[..], &w_two.0[..]);
@@ -69,7 +69,7 @@ macro_rules! test_msg_exact {
6969
{
7070
use lightning::util::ser::{Writeable, Readable};
7171
let mut r = ::std::io::Cursor::new($data);
72-
if let Ok(msg) = <$MsgType as Readable<::std::io::Cursor<&[u8]>>>::read(&mut r) {
72+
if let Ok(msg) = <$MsgType as Readable>::read(&mut r) {
7373
let mut w = VecWriter(Vec::new());
7474
msg.write(&mut w).unwrap();
7575
assert_eq!(&r.into_inner()[..], &w.0[..]);
@@ -86,7 +86,7 @@ macro_rules! test_msg_hole {
8686
{
8787
use lightning::util::ser::{Writeable, Readable};
8888
let mut r = ::std::io::Cursor::new($data);
89-
if let Ok(msg) = <$MsgType as Readable<::std::io::Cursor<&[u8]>>>::read(&mut r) {
89+
if let Ok(msg) = <$MsgType as Readable>::read(&mut r) {
9090
let mut w = VecWriter(Vec::new());
9191
msg.write(&mut w).unwrap();
9292
let p = w.0.len() as usize;

‎lightning/src/chain/keysinterface.rs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -115,8 +115,8 @@ impl Writeable for SpendableOutputDescriptor {
115115
}
116116
}
117117

118-
impl<R: ::std::io::Read> Readable<R> for SpendableOutputDescriptor {
119-
fn read(reader: &mut R) -> Result<Self, DecodeError> {
118+
impl Readable for SpendableOutputDescriptor {
119+
fn read<R: ::std::io::Read>(reader: &mut R) -> Result<Self, DecodeError> {
120120
match Readable::read(reader)? {
121121
0u8 => Ok(SpendableOutputDescriptor::StaticOutput {
122122
outpoint: Readable::read(reader)?,
@@ -381,8 +381,8 @@ impl Writeable for InMemoryChannelKeys {
381381
}
382382
}
383383

384-
impl<R: ::std::io::Read> Readable<R> for InMemoryChannelKeys {
385-
fn read(reader: &mut R) -> Result<Self, DecodeError> {
384+
impl Readable for InMemoryChannelKeys {
385+
fn read<R: ::std::io::Read>(reader: &mut R) -> Result<Self, DecodeError> {
386386
let funding_key = Readable::read(reader)?;
387387
let revocation_base_key = Readable::read(reader)?;
388388
let payment_base_key = Readable::read(reader)?;

‎lightning/src/ln/chan_utils.rs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -156,8 +156,8 @@ impl Writeable for CounterpartyCommitmentSecrets {
156156
Ok(())
157157
}
158158
}
159-
impl<R: ::std::io::Read> Readable<R> for CounterpartyCommitmentSecrets {
160-
fn read(reader: &mut R) -> Result<Self, DecodeError> {
159+
impl Readable for CounterpartyCommitmentSecrets {
160+
fn read<R: ::std::io::Read>(reader: &mut R) -> Result<Self, DecodeError> {
161161
let mut old_secrets = [([0; 32], 1 << 48); 49];
162162
for &mut (ref mut secret, ref mut idx) in old_secrets.iter_mut() {
163163
*secret = Readable::read(reader)?;
@@ -607,8 +607,8 @@ impl Writeable for LocalCommitmentTransaction {
607607
Ok(())
608608
}
609609
}
610-
impl<R: ::std::io::Read> Readable<R> for LocalCommitmentTransaction {
611-
fn read(reader: &mut R) -> Result<Self, DecodeError> {
610+
impl Readable for LocalCommitmentTransaction {
611+
fn read<R: ::std::io::Read>(reader: &mut R) -> Result<Self, DecodeError> {
612612
let tx = match Transaction::consensus_decode(reader.by_ref()) {
613613
Ok(tx) => tx,
614614
Err(e) => match e {

‎lightning/src/ln/channel.rs

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -3811,9 +3811,9 @@ impl Writeable for InboundHTLCRemovalReason {
38113811
}
38123812
}
38133813

3814-
impl<R: ::std::io::Read> Readable<R> for InboundHTLCRemovalReason {
3815-
fn read(reader: &mut R) -> Result<Self, DecodeError> {
3816-
Ok(match <u8 as Readable<R>>::read(reader)? {
3814+
impl Readable for InboundHTLCRemovalReason {
3815+
fn read<R: ::std::io::Read>(reader: &mut R) -> Result<Self, DecodeError> {
3816+
Ok(match <u8 as Readable>::read(reader)? {
38173817
0 => InboundHTLCRemovalReason::FailRelay(Readable::read(reader)?),
38183818
1 => InboundHTLCRemovalReason::FailMalformed((Readable::read(reader)?, Readable::read(reader)?)),
38193819
2 => InboundHTLCRemovalReason::Fulfill(Readable::read(reader)?),
@@ -4022,8 +4022,8 @@ impl<ChanSigner: ChannelKeys + Writeable> Writeable for Channel<ChanSigner> {
40224022
}
40234023
}
40244024

4025-
impl<R : ::std::io::Read, ChanSigner: ChannelKeys + Readable<R>> ReadableArgs<R, Arc<Logger>> for Channel<ChanSigner> {
4026-
fn read(reader: &mut R, logger: Arc<Logger>) -> Result<Self, DecodeError> {
4025+
impl<ChanSigner: ChannelKeys + Readable> ReadableArgs<Arc<Logger>> for Channel<ChanSigner> {
4026+
fn read<R : ::std::io::Read>(reader: &mut R, logger: Arc<Logger>) -> Result<Self, DecodeError> {
40274027
let _ver: u8 = Readable::read(reader)?;
40284028
let min_ver: u8 = Readable::read(reader)?;
40294029
if min_ver > SERIALIZATION_VERSION {
@@ -4056,7 +4056,7 @@ impl<R : ::std::io::Read, ChanSigner: ChannelKeys + Readable<R>> ReadableArgs<R,
40564056
amount_msat: Readable::read(reader)?,
40574057
cltv_expiry: Readable::read(reader)?,
40584058
payment_hash: Readable::read(reader)?,
4059-
state: match <u8 as Readable<R>>::read(reader)? {
4059+
state: match <u8 as Readable>::read(reader)? {
40604060
1 => InboundHTLCState::AwaitingRemoteRevokeToAnnounce(Readable::read(reader)?),
40614061
2 => InboundHTLCState::AwaitingAnnouncedRemoteRevoke(Readable::read(reader)?),
40624062
3 => InboundHTLCState::Committed,
@@ -4075,7 +4075,7 @@ impl<R : ::std::io::Read, ChanSigner: ChannelKeys + Readable<R>> ReadableArgs<R,
40754075
cltv_expiry: Readable::read(reader)?,
40764076
payment_hash: Readable::read(reader)?,
40774077
source: Readable::read(reader)?,
4078-
state: match <u8 as Readable<R>>::read(reader)? {
4078+
state: match <u8 as Readable>::read(reader)? {
40794079
0 => OutboundHTLCState::LocalAnnounced(Box::new(Readable::read(reader)?)),
40804080
1 => OutboundHTLCState::Committed,
40814081
2 => OutboundHTLCState::RemoteRemoved(Readable::read(reader)?),
@@ -4089,7 +4089,7 @@ impl<R : ::std::io::Read, ChanSigner: ChannelKeys + Readable<R>> ReadableArgs<R,
40894089
let holding_cell_htlc_update_count: u64 = Readable::read(reader)?;
40904090
let mut holding_cell_htlc_updates = Vec::with_capacity(cmp::min(holding_cell_htlc_update_count as usize, OUR_MAX_HTLCS as usize*2));
40914091
for _ in 0..holding_cell_htlc_update_count {
4092-
holding_cell_htlc_updates.push(match <u8 as Readable<R>>::read(reader)? {
4092+
holding_cell_htlc_updates.push(match <u8 as Readable>::read(reader)? {
40934093
0 => HTLCUpdateAwaitingACK::AddHTLC {
40944094
amount_msat: Readable::read(reader)?,
40954095
cltv_expiry: Readable::read(reader)?,
@@ -4109,7 +4109,7 @@ impl<R : ::std::io::Read, ChanSigner: ChannelKeys + Readable<R>> ReadableArgs<R,
41094109
});
41104110
}
41114111

4112-
let resend_order = match <u8 as Readable<R>>::read(reader)? {
4112+
let resend_order = match <u8 as Readable>::read(reader)? {
41134113
0 => RAACommitmentOrder::CommitmentFirst,
41144114
1 => RAACommitmentOrder::RevokeAndACKFirst,
41154115
_ => return Err(DecodeError::InvalidValue),
@@ -4139,7 +4139,7 @@ impl<R : ::std::io::Read, ChanSigner: ChannelKeys + Readable<R>> ReadableArgs<R,
41394139
let channel_update_count = Readable::read(reader)?;
41404140
let feerate_per_kw = Readable::read(reader)?;
41414141

4142-
let last_sent_closing_fee = match <u8 as Readable<R>>::read(reader)? {
4142+
let last_sent_closing_fee = match <u8 as Readable>::read(reader)? {
41434143
0 => None,
41444144
1 => Some((Readable::read(reader)?, Readable::read(reader)?, Readable::read(reader)?)),
41454145
_ => return Err(DecodeError::InvalidValue),

‎lightning/src/ln/channelmanager.rs

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -3062,8 +3062,8 @@ impl Writeable for PendingHTLCInfo {
30623062
}
30633063
}
30643064

3065-
impl<R: ::std::io::Read> Readable<R> for PendingHTLCInfo {
3066-
fn read(reader: &mut R) -> Result<PendingHTLCInfo, DecodeError> {
3065+
impl Readable for PendingHTLCInfo {
3066+
fn read<R: ::std::io::Read>(reader: &mut R) -> Result<PendingHTLCInfo, DecodeError> {
30673067
Ok(PendingHTLCInfo {
30683068
onion_packet: Readable::read(reader)?,
30693069
incoming_shared_secret: Readable::read(reader)?,
@@ -3091,9 +3091,9 @@ impl Writeable for HTLCFailureMsg {
30913091
}
30923092
}
30933093

3094-
impl<R: ::std::io::Read> Readable<R> for HTLCFailureMsg {
3095-
fn read(reader: &mut R) -> Result<HTLCFailureMsg, DecodeError> {
3096-
match <u8 as Readable<R>>::read(reader)? {
3094+
impl Readable for HTLCFailureMsg {
3095+
fn read<R: ::std::io::Read>(reader: &mut R) -> Result<HTLCFailureMsg, DecodeError> {
3096+
match <u8 as Readable>::read(reader)? {
30973097
0 => Ok(HTLCFailureMsg::Relay(Readable::read(reader)?)),
30983098
1 => Ok(HTLCFailureMsg::Malformed(Readable::read(reader)?)),
30993099
_ => Err(DecodeError::InvalidValue),
@@ -3117,9 +3117,9 @@ impl Writeable for PendingHTLCStatus {
31173117
}
31183118
}
31193119

3120-
impl<R: ::std::io::Read> Readable<R> for PendingHTLCStatus {
3121-
fn read(reader: &mut R) -> Result<PendingHTLCStatus, DecodeError> {
3122-
match <u8 as Readable<R>>::read(reader)? {
3120+
impl Readable for PendingHTLCStatus {
3121+
fn read<R: ::std::io::Read>(reader: &mut R) -> Result<PendingHTLCStatus, DecodeError> {
3122+
match <u8 as Readable>::read(reader)? {
31233123
0 => Ok(PendingHTLCStatus::Forward(Readable::read(reader)?)),
31243124
1 => Ok(PendingHTLCStatus::Fail(Readable::read(reader)?)),
31253125
_ => Err(DecodeError::InvalidValue),
@@ -3151,9 +3151,9 @@ impl Writeable for HTLCSource {
31513151
}
31523152
}
31533153

3154-
impl<R: ::std::io::Read> Readable<R> for HTLCSource {
3155-
fn read(reader: &mut R) -> Result<HTLCSource, DecodeError> {
3156-
match <u8 as Readable<R>>::read(reader)? {
3154+
impl Readable for HTLCSource {
3155+
fn read<R: ::std::io::Read>(reader: &mut R) -> Result<HTLCSource, DecodeError> {
3156+
match <u8 as Readable>::read(reader)? {
31573157
0 => Ok(HTLCSource::PreviousHopData(Readable::read(reader)?)),
31583158
1 => Ok(HTLCSource::OutboundRoute {
31593159
route: Readable::read(reader)?,
@@ -3182,9 +3182,9 @@ impl Writeable for HTLCFailReason {
31823182
}
31833183
}
31843184

3185-
impl<R: ::std::io::Read> Readable<R> for HTLCFailReason {
3186-
fn read(reader: &mut R) -> Result<HTLCFailReason, DecodeError> {
3187-
match <u8 as Readable<R>>::read(reader)? {
3185+
impl Readable for HTLCFailReason {
3186+
fn read<R: ::std::io::Read>(reader: &mut R) -> Result<HTLCFailReason, DecodeError> {
3187+
match <u8 as Readable>::read(reader)? {
31883188
0 => Ok(HTLCFailReason::LightningError { err: Readable::read(reader)? }),
31893189
1 => Ok(HTLCFailReason::Reason {
31903190
failure_code: Readable::read(reader)?,
@@ -3214,9 +3214,9 @@ impl Writeable for HTLCForwardInfo {
32143214
}
32153215
}
32163216

3217-
impl<R: ::std::io::Read> Readable<R> for HTLCForwardInfo {
3218-
fn read(reader: &mut R) -> Result<HTLCForwardInfo, DecodeError> {
3219-
match <u8 as Readable<R>>::read(reader)? {
3217+
impl Readable for HTLCForwardInfo {
3218+
fn read<R: ::std::io::Read>(reader: &mut R) -> Result<HTLCForwardInfo, DecodeError> {
3219+
match <u8 as Readable>::read(reader)? {
32203220
0 => Ok(HTLCForwardInfo::AddHTLC {
32213221
prev_short_channel_id: Readable::read(reader)?,
32223222
prev_htlc_id: Readable::read(reader)?,
@@ -3355,27 +3355,27 @@ pub struct ChannelManagerReadArgs<'a, ChanSigner: 'a + ChannelKeys, M: Deref, T:
33553355

33563356
// Implement ReadableArgs for an Arc'd ChannelManager to make it a bit easier to work with the
33573357
// SipmleArcChannelManager type:
3358-
impl<'a, R : ::std::io::Read, ChanSigner: ChannelKeys + Readable<R>, M: Deref, T: Deref, K: Deref, F: Deref>
3359-
ReadableArgs<R, ChannelManagerReadArgs<'a, ChanSigner, M, T, K, F>> for (Sha256dHash, Arc<ChannelManager<ChanSigner, M, T, K, F>>)
3358+
impl<'a, ChanSigner: ChannelKeys + Readable, M: Deref, T: Deref, K: Deref, F: Deref>
3359+
ReadableArgs<ChannelManagerReadArgs<'a, ChanSigner, M, T, K, F>> for (Sha256dHash, Arc<ChannelManager<ChanSigner, M, T, K, F>>)
33603360
where M::Target: ManyChannelMonitor<ChanSigner>,
33613361
T::Target: BroadcasterInterface,
33623362
K::Target: KeysInterface<ChanKeySigner = ChanSigner>,
33633363
F::Target: FeeEstimator,
33643364
{
3365-
fn read(reader: &mut R, args: ChannelManagerReadArgs<'a, ChanSigner, M, T, K, F>) -> Result<Self, DecodeError> {
3365+
fn read<R: ::std::io::Read>(reader: &mut R, args: ChannelManagerReadArgs<'a, ChanSigner, M, T, K, F>) -> Result<Self, DecodeError> {
33663366
let (blockhash, chan_manager) = <(Sha256dHash, ChannelManager<ChanSigner, M, T, K, F>)>::read(reader, args)?;
33673367
Ok((blockhash, Arc::new(chan_manager)))
33683368
}
33693369
}
33703370

3371-
impl<'a, R : ::std::io::Read, ChanSigner: ChannelKeys + Readable<R>, M: Deref, T: Deref, K: Deref, F: Deref>
3372-
ReadableArgs<R, ChannelManagerReadArgs<'a, ChanSigner, M, T, K, F>> for (Sha256dHash, ChannelManager<ChanSigner, M, T, K, F>)
3371+
impl<'a, ChanSigner: ChannelKeys + Readable, M: Deref, T: Deref, K: Deref, F: Deref>
3372+
ReadableArgs<ChannelManagerReadArgs<'a, ChanSigner, M, T, K, F>> for (Sha256dHash, ChannelManager<ChanSigner, M, T, K, F>)
33733373
where M::Target: ManyChannelMonitor<ChanSigner>,
33743374
T::Target: BroadcasterInterface,
33753375
K::Target: KeysInterface<ChanKeySigner = ChanSigner>,
33763376
F::Target: FeeEstimator,
33773377
{
3378-
fn read(reader: &mut R, args: ChannelManagerReadArgs<'a, ChanSigner, M, T, K, F>) -> Result<Self, DecodeError> {
3378+
fn read<R: ::std::io::Read>(reader: &mut R, args: ChannelManagerReadArgs<'a, ChanSigner, M, T, K, F>) -> Result<Self, DecodeError> {
33793379
let _ver: u8 = Readable::read(reader)?;
33803380
let min_ver: u8 = Readable::read(reader)?;
33813381
if min_ver > SERIALIZATION_VERSION {

0 commit comments

Comments
 (0)