Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
6 changes: 3 additions & 3 deletions lightning/src/ln/msgs.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -1958,7 +1958,7 @@ impl Writeable for TrampolineOnionPacket {
}

impl LengthReadable for TrampolineOnionPacket {
fn read<R: LengthRead>(r: &mut R) -> Result<Self, DecodeError> {
fn read_from_fixed_length_buffer<R: LengthRead>(r: &mut R) -> Result<Self, DecodeError> {
let version = Readable::read(r)?;
let public_key = Readable::read(r)?;

Expand DownExpand Up@@ -2684,7 +2684,7 @@ impl Readable for OnionMessage {
let len: u16 = Readable::read(r)?;
let mut packet_reader = FixedLengthReader::new(r, len as u64);
let onion_routing_packet: onion_message::packet::Packet =
<onion_message::packet::Packet as LengthReadable>::read(&mut packet_reader)?;
<onion_message::packet::Packet as LengthReadable>::read_from_fixed_length_buffer(&mut packet_reader)?;
Ok(Self {
blinding_point,
onion_routing_packet,
Expand DownExpand Up@@ -4708,7 +4708,7 @@ mod tests {
{ // verify that a codec round trip works
let mut reader = Cursor::new(&encoded_trampoline_packet);
let mut trampoline_packet_reader = FixedLengthReader::new(&mut reader, encoded_trampoline_packet.len() as u64);
let decoded_trampoline_packet: TrampolineOnionPacket = <TrampolineOnionPacket as LengthReadable>::read(&mut trampoline_packet_reader).unwrap();
let decoded_trampoline_packet: TrampolineOnionPacket = <TrampolineOnionPacket as LengthReadable>::read_from_fixed_length_buffer(&mut trampoline_packet_reader).unwrap();
assert_eq!(decoded_trampoline_packet.encode(), encoded_trampoline_packet);
}

Expand Down
2 changes: 1 addition & 1 deletion lightning/src/onion_message/functional_tests.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -901,7 +901,7 @@ fn spec_test_vector() {
let mut reader = io::Cursor::new(sender_to_alice_packet_bytes);
let mut packet_reader = FixedLengthReader::new(&mut reader, sender_to_alice_packet_bytes_len);
let sender_to_alice_packet: Packet =
<Packet as LengthReadable>::read(&mut packet_reader).unwrap();
<Packet as LengthReadable>::read_from_fixed_length_buffer(&mut packet_reader).unwrap();
let secp_ctx = Secp256k1::new();
let sender_to_alice_om = msgs::OnionMessage {
blinding_point: PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&<Vec<u8>>::from_hex("6363636363636363636363636363636363636363636363636363636363636363").unwrap()).unwrap()),
Expand Down
2 changes: 1 addition & 1 deletion lightning/src/onion_message/packet.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -82,7 +82,7 @@ impl Writeable for Packet {
}

impl LengthReadable for Packet {
fn read<R: LengthRead>(r: &mut R) -> Result<Self, DecodeError> {
fn read_from_fixed_length_buffer<R: LengthRead>(r: &mut R) -> Result<Self, DecodeError> {
const READ_BUFFER_SIZE: usize = 4096;

let version = Readable::read(r)?;
Expand Down
22 changes: 16 additions & 6 deletions lightning/src/util/ser.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -344,8 +344,8 @@ where
fn read<R: Read>(reader: &mut R, params: P) -> Result<Self, DecodeError>;
}

/// A [`std::io::Read`] that also provides the total bytes available to be read.
pub(crate) trait LengthRead: Read {
/// A [`io::Read`] that also provides the total bytes available to be read.
pub trait LengthRead: Read {
/// The total number of bytes available to be read.
fn total_bytes(&self) -> u64;
}
Expand All@@ -361,14 +361,24 @@ where
fn read<R: LengthRead>(reader: &mut R, params: P) -> Result<Self, DecodeError>;
}

/// A trait that various higher-level LDK types implement allowing them to be read in
/// from a [`Read`], requiring the implementer to provide the total length of the read.
pub(crate) trait LengthReadable

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Probably could update the docs since its now pub

/// A trait that allows the implementer to be read in from a [`LengthRead`], requiring
/// the reader to provide the total length of the read.
///
/// Any type that implements [`Readable`] also automatically has a [`LengthReadable`]
/// implementation, but some types, most notably onion packets, only implement [`LengthReadable`].
pub trait LengthReadable
where
Self: Sized,
{
/// Reads a `Self` in from the given [`LengthRead`].
fn read<R: LengthRead>(reader: &mut R) -> Result<Self, DecodeError>;
fn read_from_fixed_length_buffer<R: LengthRead>(reader: &mut R) -> Result<Self, DecodeError>;
}

impl<T: Readable> LengthReadable for T {
Comment thread
arik-so marked this conversation as resolved.
#[inline]
fn read_from_fixed_length_buffer<R: LengthRead>(reader: &mut R) -> Result<T, DecodeError> {
Readable::read(reader)

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this fail if the expected length wasn't read?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

given that without resorting to assert_eq, it would produce pretty ubiquitous overhead, we agreed not to

}
}

/// A trait that various LDK types implement allowing them to (maybe) be read in from a [`Read`].
Expand Down
6 changes: 3 additions & 3 deletions lightning/src/util/ser_macros.rs

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hello!
I was reviewing this and noticed that the rule at line 454 doesn’t use LengthReadable. I was curious—why is that the case?

($outer_reader: expr, $reader: expr, $field: ident,(option,encoding:($fieldty: ty, $encoding: ident))) => {{
$field = {let field: $encoding<$fieldty> = ser::Readable::read(&mut $reader)?;Some(field.0)};}};

Would love to understand it. Thanks!

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, I think this is the last missing one

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

CI is currently running with it added

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

squashed

Original file line numberDiff line numberDiff line change
Expand Up@@ -385,7 +385,7 @@ macro_rules! _decode_tlv {
($outer_reader: expr, $reader: expr, $field: ident, (static_value, $value: expr)) => {{
}};
($outer_reader: expr, $reader: expr, $field: ident, required) => {{
$field = $crate::util::ser::Readable::read(&mut $reader)?;
$field = $crate::util::ser::LengthReadable::read_from_fixed_length_buffer(&mut $reader)?;
}};
($outer_reader: expr, $reader: expr, $field: ident, (required: $trait: ident $(, $read_arg: expr)?)) => {{
$field = $trait::read(&mut $reader $(, $read_arg)*)?;
Expand All@@ -395,7 +395,7 @@ macro_rules! _decode_tlv {
$field = f.0;
}};
($outer_reader: expr, $reader: expr, $field: ident, option) => {{
$field = Some($crate::util::ser::Readable::read(&mut $reader)?);
$field = Some($crate::util::ser::LengthReadable::read_from_fixed_length_buffer(&mut $reader)?);
}};
($outer_reader: expr, $reader: expr, $field: ident, (option, explicit_type: $fieldty: ty)) => {{
let _field: &Option<$fieldty> = &$field;
Expand DownExpand Up@@ -453,7 +453,7 @@ macro_rules! _decode_tlv {
}};
($outer_reader: expr, $reader: expr, $field: ident, (option, encoding: ($fieldty: ty, $encoding: ident))) => {{
$field = {
let field: $encoding<$fieldty> = ser::Readable::read(&mut $reader)?;
let field: $encoding<$fieldty> = ser::LengthReadable::read_from_fixed_length_buffer(&mut $reader)?;
Some(field.0)
};
}};
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Implement Readable for LengthReadable by arik-so · Pull Request #3579 · lightningdevkit/rust-lightning · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
6 changes: 3 additions & 3 deletions lightning/src/ln/msgs.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -1958,7 +1958,7 @@ impl Writeable for TrampolineOnionPacket {
}

impl LengthReadable for TrampolineOnionPacket {
fn read<R: LengthRead>(r: &mut R) -> Result<Self, DecodeError> {
fn read_from_fixed_length_buffer<R: LengthRead>(r: &mut R) -> Result<Self, DecodeError> {
let version = Readable::read(r)?;
let public_key = Readable::read(r)?;

Expand DownExpand Up@@ -2684,7 +2684,7 @@ impl Readable for OnionMessage {
let len: u16 = Readable::read(r)?;
let mut packet_reader = FixedLengthReader::new(r, len as u64);
let onion_routing_packet: onion_message::packet::Packet =
<onion_message::packet::Packet as LengthReadable>::read(&mut packet_reader)?;
<onion_message::packet::Packet as LengthReadable>::read_from_fixed_length_buffer(&mut packet_reader)?;
Ok(Self {
blinding_point,
onion_routing_packet,
Expand DownExpand Up@@ -4708,7 +4708,7 @@ mod tests {
{ // verify that a codec round trip works
let mut reader = Cursor::new(&encoded_trampoline_packet);
let mut trampoline_packet_reader = FixedLengthReader::new(&mut reader, encoded_trampoline_packet.len() as u64);
let decoded_trampoline_packet: TrampolineOnionPacket = <TrampolineOnionPacket as LengthReadable>::read(&mut trampoline_packet_reader).unwrap();
let decoded_trampoline_packet: TrampolineOnionPacket = <TrampolineOnionPacket as LengthReadable>::read_from_fixed_length_buffer(&mut trampoline_packet_reader).unwrap();
assert_eq!(decoded_trampoline_packet.encode(), encoded_trampoline_packet);
}

Expand Down
2 changes: 1 addition & 1 deletion lightning/src/onion_message/functional_tests.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -901,7 +901,7 @@ fn spec_test_vector() {
let mut reader = io::Cursor::new(sender_to_alice_packet_bytes);
let mut packet_reader = FixedLengthReader::new(&mut reader, sender_to_alice_packet_bytes_len);
let sender_to_alice_packet: Packet =
<Packet as LengthReadable>::read(&mut packet_reader).unwrap();
<Packet as LengthReadable>::read_from_fixed_length_buffer(&mut packet_reader).unwrap();
let secp_ctx = Secp256k1::new();
let sender_to_alice_om = msgs::OnionMessage {
blinding_point: PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&<Vec<u8>>::from_hex("6363636363636363636363636363636363636363636363636363636363636363").unwrap()).unwrap()),
Expand Down
2 changes: 1 addition & 1 deletion lightning/src/onion_message/packet.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -82,7 +82,7 @@ impl Writeable for Packet {
}

impl LengthReadable for Packet {
fn read<R: LengthRead>(r: &mut R) -> Result<Self, DecodeError> {
fn read_from_fixed_length_buffer<R: LengthRead>(r: &mut R) -> Result<Self, DecodeError> {
const READ_BUFFER_SIZE: usize = 4096;

let version = Readable::read(r)?;
Expand Down
22 changes: 16 additions & 6 deletions lightning/src/util/ser.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -344,8 +344,8 @@ where
fn read<R: Read>(reader: &mut R, params: P) -> Result<Self, DecodeError>;
}

/// A [`std::io::Read`] that also provides the total bytes available to be read.
pub(crate) trait LengthRead: Read {
/// A [`io::Read`] that also provides the total bytes available to be read.
pub trait LengthRead: Read {
/// The total number of bytes available to be read.
fn total_bytes(&self) -> u64;
}
Expand All@@ -361,14 +361,24 @@ where
fn read<R: LengthRead>(reader: &mut R, params: P) -> Result<Self, DecodeError>;
}

/// A trait that various higher-level LDK types implement allowing them to be read in
/// from a [`Read`], requiring the implementer to provide the total length of the read.
pub(crate) trait LengthReadable

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Probably could update the docs since its now pub

/// A trait that allows the implementer to be read in from a [`LengthRead`], requiring
/// the reader to provide the total length of the read.
///
/// Any type that implements [`Readable`] also automatically has a [`LengthReadable`]
/// implementation, but some types, most notably onion packets, only implement [`LengthReadable`].
pub trait LengthReadable
where
Self: Sized,
{
/// Reads a `Self` in from the given [`LengthRead`].
fn read<R: LengthRead>(reader: &mut R) -> Result<Self, DecodeError>;
fn read_from_fixed_length_buffer<R: LengthRead>(reader: &mut R) -> Result<Self, DecodeError>;
}

impl<T: Readable> LengthReadable for T {
Comment thread
arik-so marked this conversation as resolved.
#[inline]
fn read_from_fixed_length_buffer<R: LengthRead>(reader: &mut R) -> Result<T, DecodeError> {
Readable::read(reader)

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this fail if the expected length wasn't read?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

given that without resorting to assert_eq, it would produce pretty ubiquitous overhead, we agreed not to

}
}

/// A trait that various LDK types implement allowing them to (maybe) be read in from a [`Read`].
Expand Down
6 changes: 3 additions & 3 deletions lightning/src/util/ser_macros.rs

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hello!
I was reviewing this and noticed that the rule at line 454 doesn’t use LengthReadable. I was curious—why is that the case?

($outer_reader: expr, $reader: expr, $field: ident,(option,encoding:($fieldty: ty, $encoding: ident))) => {{
$field = {let field: $encoding<$fieldty> = ser::Readable::read(&mut $reader)?;Some(field.0)};}};

Would love to understand it. Thanks!

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, I think this is the last missing one

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

CI is currently running with it added

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

squashed

Original file line numberDiff line numberDiff line change
Expand Up@@ -385,7 +385,7 @@ macro_rules! _decode_tlv {
($outer_reader: expr, $reader: expr, $field: ident, (static_value, $value: expr)) => {{
}};
($outer_reader: expr, $reader: expr, $field: ident, required) => {{
$field = $crate::util::ser::Readable::read(&mut $reader)?;
$field = $crate::util::ser::LengthReadable::read_from_fixed_length_buffer(&mut $reader)?;
}};
($outer_reader: expr, $reader: expr, $field: ident, (required: $trait: ident $(, $read_arg: expr)?)) => {{
$field = $trait::read(&mut $reader $(, $read_arg)*)?;
Expand All@@ -395,7 +395,7 @@ macro_rules! _decode_tlv {
$field = f.0;
}};
($outer_reader: expr, $reader: expr, $field: ident, option) => {{
$field = Some($crate::util::ser::Readable::read(&mut $reader)?);
$field = Some($crate::util::ser::LengthReadable::read_from_fixed_length_buffer(&mut $reader)?);
}};
($outer_reader: expr, $reader: expr, $field: ident, (option, explicit_type: $fieldty: ty)) => {{
let _field: &Option<$fieldty> = &$field;
Expand DownExpand Up@@ -453,7 +453,7 @@ macro_rules! _decode_tlv {
}};
($outer_reader: expr, $reader: expr, $field: ident, (option, encoding: ($fieldty: ty, $encoding: ident))) => {{
$field = {
let field: $encoding<$fieldty> = ser::Readable::read(&mut $reader)?;
let field: $encoding<$fieldty> = ser::LengthReadable::read_from_fixed_length_buffer(&mut $reader)?;
Some(field.0)
};
}};
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { // Force GitHub README to respect dark mode (function() { var style = document.createElement('style'); style.textContent = ' .markdown-body { color-scheme: dark light; } .markdown-body pre { background: #161b22 !important; } .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; } .markdown-body table th, .markdown-body table td { border-color: #30363d !important; } .markdown-body img { background: #0d1117; } .markdown-body blockquote { border-left-color: #8b949e; } .markdown-body hr { border-color: #30363d; } '; document.head.appendChild(style); })(); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' Implement Readable for LengthReadable by arik-so · Pull Request #3579 · lightningdevkit/rust-lightning · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
6 changes: 3 additions & 3 deletions lightning/src/ln/msgs.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -1958,7 +1958,7 @@ impl Writeable for TrampolineOnionPacket {
}

impl LengthReadable for TrampolineOnionPacket {
fn read<R: LengthRead>(r: &mut R) -> Result<Self, DecodeError> {
fn read_from_fixed_length_buffer<R: LengthRead>(r: &mut R) -> Result<Self, DecodeError> {
let version = Readable::read(r)?;
let public_key = Readable::read(r)?;

Expand DownExpand Up@@ -2684,7 +2684,7 @@ impl Readable for OnionMessage {
let len: u16 = Readable::read(r)?;
let mut packet_reader = FixedLengthReader::new(r, len as u64);
let onion_routing_packet: onion_message::packet::Packet =
<onion_message::packet::Packet as LengthReadable>::read(&mut packet_reader)?;
<onion_message::packet::Packet as LengthReadable>::read_from_fixed_length_buffer(&mut packet_reader)?;
Ok(Self {
blinding_point,
onion_routing_packet,
Expand DownExpand Up@@ -4708,7 +4708,7 @@ mod tests {
{ // verify that a codec round trip works
let mut reader = Cursor::new(&encoded_trampoline_packet);
let mut trampoline_packet_reader = FixedLengthReader::new(&mut reader, encoded_trampoline_packet.len() as u64);
let decoded_trampoline_packet: TrampolineOnionPacket = <TrampolineOnionPacket as LengthReadable>::read(&mut trampoline_packet_reader).unwrap();
let decoded_trampoline_packet: TrampolineOnionPacket = <TrampolineOnionPacket as LengthReadable>::read_from_fixed_length_buffer(&mut trampoline_packet_reader).unwrap();
assert_eq!(decoded_trampoline_packet.encode(), encoded_trampoline_packet);
}

Expand Down
2 changes: 1 addition & 1 deletion lightning/src/onion_message/functional_tests.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -901,7 +901,7 @@ fn spec_test_vector() {
let mut reader = io::Cursor::new(sender_to_alice_packet_bytes);
let mut packet_reader = FixedLengthReader::new(&mut reader, sender_to_alice_packet_bytes_len);
let sender_to_alice_packet: Packet =
<Packet as LengthReadable>::read(&mut packet_reader).unwrap();
<Packet as LengthReadable>::read_from_fixed_length_buffer(&mut packet_reader).unwrap();
let secp_ctx = Secp256k1::new();
let sender_to_alice_om = msgs::OnionMessage {
blinding_point: PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&<Vec<u8>>::from_hex("6363636363636363636363636363636363636363636363636363636363636363").unwrap()).unwrap()),
Expand Down
2 changes: 1 addition & 1 deletion lightning/src/onion_message/packet.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -82,7 +82,7 @@ impl Writeable for Packet {
}

impl LengthReadable for Packet {
fn read<R: LengthRead>(r: &mut R) -> Result<Self, DecodeError> {
fn read_from_fixed_length_buffer<R: LengthRead>(r: &mut R) -> Result<Self, DecodeError> {
const READ_BUFFER_SIZE: usize = 4096;

let version = Readable::read(r)?;
Expand Down
22 changes: 16 additions & 6 deletions lightning/src/util/ser.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -344,8 +344,8 @@ where
fn read<R: Read>(reader: &mut R, params: P) -> Result<Self, DecodeError>;
}

/// A [`std::io::Read`] that also provides the total bytes available to be read.
pub(crate) trait LengthRead: Read {
/// A [`io::Read`] that also provides the total bytes available to be read.
pub trait LengthRead: Read {
/// The total number of bytes available to be read.
fn total_bytes(&self) -> u64;
}
Expand All@@ -361,14 +361,24 @@ where
fn read<R: LengthRead>(reader: &mut R, params: P) -> Result<Self, DecodeError>;
}

/// A trait that various higher-level LDK types implement allowing them to be read in
/// from a [`Read`], requiring the implementer to provide the total length of the read.
pub(crate) trait LengthReadable

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Probably could update the docs since its now pub

/// A trait that allows the implementer to be read in from a [`LengthRead`], requiring
/// the reader to provide the total length of the read.
///
/// Any type that implements [`Readable`] also automatically has a [`LengthReadable`]
/// implementation, but some types, most notably onion packets, only implement [`LengthReadable`].
pub trait LengthReadable
where
Self: Sized,
{
/// Reads a `Self` in from the given [`LengthRead`].
fn read<R: LengthRead>(reader: &mut R) -> Result<Self, DecodeError>;
fn read_from_fixed_length_buffer<R: LengthRead>(reader: &mut R) -> Result<Self, DecodeError>;
}

impl<T: Readable> LengthReadable for T {
Comment thread
arik-so marked this conversation as resolved.
#[inline]
fn read_from_fixed_length_buffer<R: LengthRead>(reader: &mut R) -> Result<T, DecodeError> {
Readable::read(reader)

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this fail if the expected length wasn't read?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

given that without resorting to assert_eq, it would produce pretty ubiquitous overhead, we agreed not to

}
}

/// A trait that various LDK types implement allowing them to (maybe) be read in from a [`Read`].
Expand Down
6 changes: 3 additions & 3 deletions lightning/src/util/ser_macros.rs

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hello!
I was reviewing this and noticed that the rule at line 454 doesn’t use LengthReadable. I was curious—why is that the case?

($outer_reader: expr, $reader: expr, $field: ident,(option,encoding:($fieldty: ty, $encoding: ident))) => {{
$field = {let field: $encoding<$fieldty> = ser::Readable::read(&mut $reader)?;Some(field.0)};}};

Would love to understand it. Thanks!

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, I think this is the last missing one

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

CI is currently running with it added

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

squashed

Original file line numberDiff line numberDiff line change
Expand Up@@ -385,7 +385,7 @@ macro_rules! _decode_tlv {
($outer_reader: expr, $reader: expr, $field: ident, (static_value, $value: expr)) => {{
}};
($outer_reader: expr, $reader: expr, $field: ident, required) => {{
$field = $crate::util::ser::Readable::read(&mut $reader)?;
$field = $crate::util::ser::LengthReadable::read_from_fixed_length_buffer(&mut $reader)?;
}};
($outer_reader: expr, $reader: expr, $field: ident, (required: $trait: ident $(, $read_arg: expr)?)) => {{
$field = $trait::read(&mut $reader $(, $read_arg)*)?;
Expand All@@ -395,7 +395,7 @@ macro_rules! _decode_tlv {
$field = f.0;
}};
($outer_reader: expr, $reader: expr, $field: ident, option) => {{
$field = Some($crate::util::ser::Readable::read(&mut $reader)?);
$field = Some($crate::util::ser::LengthReadable::read_from_fixed_length_buffer(&mut $reader)?);
}};
($outer_reader: expr, $reader: expr, $field: ident, (option, explicit_type: $fieldty: ty)) => {{
let _field: &Option<$fieldty> = &$field;
Expand DownExpand Up@@ -453,7 +453,7 @@ macro_rules! _decode_tlv {
}};
($outer_reader: expr, $reader: expr, $field: ident, (option, encoding: ($fieldty: ty, $encoding: ident))) => {{
$field = {
let field: $encoding<$fieldty> = ser::Readable::read(&mut $reader)?;
let field: $encoding<$fieldty> = ser::LengthReadable::read_from_fixed_length_buffer(&mut $reader)?;
Some(field.0)
};
}};
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { // Highlight search terms from Google/DuckDuckGo/Bing referrer (function() { var ref = document.referrer; var terms = []; if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) { var url = new URL(ref); var q = url.searchParams.get('q') || url.searchParams.get('p'); if (q) { terms = q.split(/\s+/).filter(function(t) { return t.length > 2; }); } } if (terms.length === 0) return; var style = document.createElement('style'); style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }'; document.head.appendChild(style); function highlight(node) { if (node.nodeType === 3) { // text node var text = node.textContent; var found = false; terms.forEach(function(term) { var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi'); if (regex.test(text)) { found = true; var frag = document.createDocumentFragment(); var parts = text.split(regex); parts.forEach(function(part, i) { if (i % 2 === 0) { frag.appendChild(document.createTextNode(part)); } else { var span = document.createElement('span'); span.className = 'userscript-highlight'; span.textContent = part; frag.appendChild(span); } }); node.parentNode.replaceChild(frag, node); } }); } else if (node.nodeType === 1 && node.childNodes) { // element var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT']; if (!skipTags.includes(node.tagName)) { Array.from(node.childNodes).forEach(highlight); } } } highlight(document.body); // Re-highlight on dynamic content var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1 || node.nodeType === 3) highlight(node); }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' Implement Readable for LengthReadable by arik-so · Pull Request #3579 · lightningdevkit/rust-lightning · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
6 changes: 3 additions & 3 deletions lightning/src/ln/msgs.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -1958,7 +1958,7 @@ impl Writeable for TrampolineOnionPacket {
}

impl LengthReadable for TrampolineOnionPacket {
fn read<R: LengthRead>(r: &mut R) -> Result<Self, DecodeError> {
fn read_from_fixed_length_buffer<R: LengthRead>(r: &mut R) -> Result<Self, DecodeError> {
let version = Readable::read(r)?;
let public_key = Readable::read(r)?;

Expand DownExpand Up@@ -2684,7 +2684,7 @@ impl Readable for OnionMessage {
let len: u16 = Readable::read(r)?;
let mut packet_reader = FixedLengthReader::new(r, len as u64);
let onion_routing_packet: onion_message::packet::Packet =
<onion_message::packet::Packet as LengthReadable>::read(&mut packet_reader)?;
<onion_message::packet::Packet as LengthReadable>::read_from_fixed_length_buffer(&mut packet_reader)?;
Ok(Self {
blinding_point,
onion_routing_packet,
Expand DownExpand Up@@ -4708,7 +4708,7 @@ mod tests {
{ // verify that a codec round trip works
let mut reader = Cursor::new(&encoded_trampoline_packet);
let mut trampoline_packet_reader = FixedLengthReader::new(&mut reader, encoded_trampoline_packet.len() as u64);
let decoded_trampoline_packet: TrampolineOnionPacket = <TrampolineOnionPacket as LengthReadable>::read(&mut trampoline_packet_reader).unwrap();
let decoded_trampoline_packet: TrampolineOnionPacket = <TrampolineOnionPacket as LengthReadable>::read_from_fixed_length_buffer(&mut trampoline_packet_reader).unwrap();
assert_eq!(decoded_trampoline_packet.encode(), encoded_trampoline_packet);
}

Expand Down
2 changes: 1 addition & 1 deletion lightning/src/onion_message/functional_tests.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -901,7 +901,7 @@ fn spec_test_vector() {
let mut reader = io::Cursor::new(sender_to_alice_packet_bytes);
let mut packet_reader = FixedLengthReader::new(&mut reader, sender_to_alice_packet_bytes_len);
let sender_to_alice_packet: Packet =
<Packet as LengthReadable>::read(&mut packet_reader).unwrap();
<Packet as LengthReadable>::read_from_fixed_length_buffer(&mut packet_reader).unwrap();
let secp_ctx = Secp256k1::new();
let sender_to_alice_om = msgs::OnionMessage {
blinding_point: PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&<Vec<u8>>::from_hex("6363636363636363636363636363636363636363636363636363636363636363").unwrap()).unwrap()),
Expand Down
2 changes: 1 addition & 1 deletion lightning/src/onion_message/packet.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -82,7 +82,7 @@ impl Writeable for Packet {
}

impl LengthReadable for Packet {
fn read<R: LengthRead>(r: &mut R) -> Result<Self, DecodeError> {
fn read_from_fixed_length_buffer<R: LengthRead>(r: &mut R) -> Result<Self, DecodeError> {
const READ_BUFFER_SIZE: usize = 4096;

let version = Readable::read(r)?;
Expand Down
22 changes: 16 additions & 6 deletions lightning/src/util/ser.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -344,8 +344,8 @@ where
fn read<R: Read>(reader: &mut R, params: P) -> Result<Self, DecodeError>;
}

/// A [`std::io::Read`] that also provides the total bytes available to be read.
pub(crate) trait LengthRead: Read {
/// A [`io::Read`] that also provides the total bytes available to be read.
pub trait LengthRead: Read {
/// The total number of bytes available to be read.
fn total_bytes(&self) -> u64;
}
Expand All@@ -361,14 +361,24 @@ where
fn read<R: LengthRead>(reader: &mut R, params: P) -> Result<Self, DecodeError>;
}

/// A trait that various higher-level LDK types implement allowing them to be read in
/// from a [`Read`], requiring the implementer to provide the total length of the read.
pub(crate) trait LengthReadable

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Probably could update the docs since its now pub

/// A trait that allows the implementer to be read in from a [`LengthRead`], requiring
/// the reader to provide the total length of the read.
///
/// Any type that implements [`Readable`] also automatically has a [`LengthReadable`]
/// implementation, but some types, most notably onion packets, only implement [`LengthReadable`].
pub trait LengthReadable
where
Self: Sized,
{
/// Reads a `Self` in from the given [`LengthRead`].
fn read<R: LengthRead>(reader: &mut R) -> Result<Self, DecodeError>;
fn read_from_fixed_length_buffer<R: LengthRead>(reader: &mut R) -> Result<Self, DecodeError>;
}

impl<T: Readable> LengthReadable for T {
Comment thread
arik-so marked this conversation as resolved.
#[inline]
fn read_from_fixed_length_buffer<R: LengthRead>(reader: &mut R) -> Result<T, DecodeError> {
Readable::read(reader)

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this fail if the expected length wasn't read?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

given that without resorting to assert_eq, it would produce pretty ubiquitous overhead, we agreed not to

}
}

/// A trait that various LDK types implement allowing them to (maybe) be read in from a [`Read`].
Expand Down
6 changes: 3 additions & 3 deletions lightning/src/util/ser_macros.rs

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hello!
I was reviewing this and noticed that the rule at line 454 doesn’t use LengthReadable. I was curious—why is that the case?

($outer_reader: expr, $reader: expr, $field: ident,(option,encoding:($fieldty: ty, $encoding: ident))) => {{
$field = {let field: $encoding<$fieldty> = ser::Readable::read(&mut $reader)?;Some(field.0)};}};

Would love to understand it. Thanks!

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, I think this is the last missing one

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

CI is currently running with it added

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

squashed

Original file line numberDiff line numberDiff line change
Expand Up@@ -385,7 +385,7 @@ macro_rules! _decode_tlv {
($outer_reader: expr, $reader: expr, $field: ident, (static_value, $value: expr)) => {{
}};
($outer_reader: expr, $reader: expr, $field: ident, required) => {{
$field = $crate::util::ser::Readable::read(&mut $reader)?;
$field = $crate::util::ser::LengthReadable::read_from_fixed_length_buffer(&mut $reader)?;
}};
($outer_reader: expr, $reader: expr, $field: ident, (required: $trait: ident $(, $read_arg: expr)?)) => {{
$field = $trait::read(&mut $reader $(, $read_arg)*)?;
Expand All@@ -395,7 +395,7 @@ macro_rules! _decode_tlv {
$field = f.0;
}};
($outer_reader: expr, $reader: expr, $field: ident, option) => {{
$field = Some($crate::util::ser::Readable::read(&mut $reader)?);
$field = Some($crate::util::ser::LengthReadable::read_from_fixed_length_buffer(&mut $reader)?);
}};
($outer_reader: expr, $reader: expr, $field: ident, (option, explicit_type: $fieldty: ty)) => {{
let _field: &Option<$fieldty> = &$field;
Expand DownExpand Up@@ -453,7 +453,7 @@ macro_rules! _decode_tlv {
}};
($outer_reader: expr, $reader: expr, $field: ident, (option, encoding: ($fieldty: ty, $encoding: ident))) => {{
$field = {
let field: $encoding<$fieldty> = ser::Readable::read(&mut $reader)?;
let field: $encoding<$fieldty> = ser::LengthReadable::read_from_fixed_length_buffer(&mut $reader)?;
Some(field.0)
};
}};
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { // Strip utm_, fbclid, gclid, etc. from all links on page (function() { var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content', 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid', 'ref', 'ref_src', 'source', 'medium', 'campaign']; function cleanUrl(url) { try { var u = new URL(url, window.location.origin); var changed = false; trackingParams.forEach(function(p) { if (u.searchParams.has(p)) { u.searchParams.delete(p); changed = true; } }); return changed ? u.toString() : url; } catch (e) { return url; } } function cleanLinks() { document.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } cleanLinks(); var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1) { if (node.tagName === 'A') cleanLinks(); node.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + ' Implement Readable for LengthReadable by arik-so · Pull Request #3579 · lightningdevkit/rust-lightning · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
6 changes: 3 additions & 3 deletions lightning/src/ln/msgs.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -1958,7 +1958,7 @@ impl Writeable for TrampolineOnionPacket {
}

impl LengthReadable for TrampolineOnionPacket {
fn read<R: LengthRead>(r: &mut R) -> Result<Self, DecodeError> {
fn read_from_fixed_length_buffer<R: LengthRead>(r: &mut R) -> Result<Self, DecodeError> {
let version = Readable::read(r)?;
let public_key = Readable::read(r)?;

Expand DownExpand Up@@ -2684,7 +2684,7 @@ impl Readable for OnionMessage {
let len: u16 = Readable::read(r)?;
let mut packet_reader = FixedLengthReader::new(r, len as u64);
let onion_routing_packet: onion_message::packet::Packet =
<onion_message::packet::Packet as LengthReadable>::read(&mut packet_reader)?;
<onion_message::packet::Packet as LengthReadable>::read_from_fixed_length_buffer(&mut packet_reader)?;
Ok(Self {
blinding_point,
onion_routing_packet,
Expand DownExpand Up@@ -4708,7 +4708,7 @@ mod tests {
{ // verify that a codec round trip works
let mut reader = Cursor::new(&encoded_trampoline_packet);
let mut trampoline_packet_reader = FixedLengthReader::new(&mut reader, encoded_trampoline_packet.len() as u64);
let decoded_trampoline_packet: TrampolineOnionPacket = <TrampolineOnionPacket as LengthReadable>::read(&mut trampoline_packet_reader).unwrap();
let decoded_trampoline_packet: TrampolineOnionPacket = <TrampolineOnionPacket as LengthReadable>::read_from_fixed_length_buffer(&mut trampoline_packet_reader).unwrap();
assert_eq!(decoded_trampoline_packet.encode(), encoded_trampoline_packet);
}

Expand Down
2 changes: 1 addition & 1 deletion lightning/src/onion_message/functional_tests.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -901,7 +901,7 @@ fn spec_test_vector() {
let mut reader = io::Cursor::new(sender_to_alice_packet_bytes);
let mut packet_reader = FixedLengthReader::new(&mut reader, sender_to_alice_packet_bytes_len);
let sender_to_alice_packet: Packet =
<Packet as LengthReadable>::read(&mut packet_reader).unwrap();
<Packet as LengthReadable>::read_from_fixed_length_buffer(&mut packet_reader).unwrap();
let secp_ctx = Secp256k1::new();
let sender_to_alice_om = msgs::OnionMessage {
blinding_point: PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&<Vec<u8>>::from_hex("6363636363636363636363636363636363636363636363636363636363636363").unwrap()).unwrap()),
Expand Down
2 changes: 1 addition & 1 deletion lightning/src/onion_message/packet.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -82,7 +82,7 @@ impl Writeable for Packet {
}

impl LengthReadable for Packet {
fn read<R: LengthRead>(r: &mut R) -> Result<Self, DecodeError> {
fn read_from_fixed_length_buffer<R: LengthRead>(r: &mut R) -> Result<Self, DecodeError> {
const READ_BUFFER_SIZE: usize = 4096;

let version = Readable::read(r)?;
Expand Down
22 changes: 16 additions & 6 deletions lightning/src/util/ser.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -344,8 +344,8 @@ where
fn read<R: Read>(reader: &mut R, params: P) -> Result<Self, DecodeError>;
}

/// A [`std::io::Read`] that also provides the total bytes available to be read.
pub(crate) trait LengthRead: Read {
/// A [`io::Read`] that also provides the total bytes available to be read.
pub trait LengthRead: Read {
/// The total number of bytes available to be read.
fn total_bytes(&self) -> u64;
}
Expand All@@ -361,14 +361,24 @@ where
fn read<R: LengthRead>(reader: &mut R, params: P) -> Result<Self, DecodeError>;
}

/// A trait that various higher-level LDK types implement allowing them to be read in
/// from a [`Read`], requiring the implementer to provide the total length of the read.
pub(crate) trait LengthReadable

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Probably could update the docs since its now pub

/// A trait that allows the implementer to be read in from a [`LengthRead`], requiring
/// the reader to provide the total length of the read.
///
/// Any type that implements [`Readable`] also automatically has a [`LengthReadable`]
/// implementation, but some types, most notably onion packets, only implement [`LengthReadable`].
pub trait LengthReadable
where
Self: Sized,
{
/// Reads a `Self` in from the given [`LengthRead`].
fn read<R: LengthRead>(reader: &mut R) -> Result<Self, DecodeError>;
fn read_from_fixed_length_buffer<R: LengthRead>(reader: &mut R) -> Result<Self, DecodeError>;
}

impl<T: Readable> LengthReadable for T {
Comment thread
arik-so marked this conversation as resolved.
#[inline]
fn read_from_fixed_length_buffer<R: LengthRead>(reader: &mut R) -> Result<T, DecodeError> {
Readable::read(reader)

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this fail if the expected length wasn't read?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

given that without resorting to assert_eq, it would produce pretty ubiquitous overhead, we agreed not to

}
}

/// A trait that various LDK types implement allowing them to (maybe) be read in from a [`Read`].
Expand Down
6 changes: 3 additions & 3 deletions lightning/src/util/ser_macros.rs

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hello!
I was reviewing this and noticed that the rule at line 454 doesn’t use LengthReadable. I was curious—why is that the case?

($outer_reader: expr, $reader: expr, $field: ident,(option,encoding:($fieldty: ty, $encoding: ident))) => {{
$field = {let field: $encoding<$fieldty> = ser::Readable::read(&mut $reader)?;Some(field.0)};}};

Would love to understand it. Thanks!

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, I think this is the last missing one

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

CI is currently running with it added

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

squashed

Original file line numberDiff line numberDiff line change
Expand Up@@ -385,7 +385,7 @@ macro_rules! _decode_tlv {
($outer_reader: expr, $reader: expr, $field: ident, (static_value, $value: expr)) => {{
}};
($outer_reader: expr, $reader: expr, $field: ident, required) => {{
$field = $crate::util::ser::Readable::read(&mut $reader)?;
$field = $crate::util::ser::LengthReadable::read_from_fixed_length_buffer(&mut $reader)?;
}};
($outer_reader: expr, $reader: expr, $field: ident, (required: $trait: ident $(, $read_arg: expr)?)) => {{
$field = $trait::read(&mut $reader $(, $read_arg)*)?;
Expand All@@ -395,7 +395,7 @@ macro_rules! _decode_tlv {
$field = f.0;
}};
($outer_reader: expr, $reader: expr, $field: ident, option) => {{
$field = Some($crate::util::ser::Readable::read(&mut $reader)?);
$field = Some($crate::util::ser::LengthReadable::read_from_fixed_length_buffer(&mut $reader)?);
}};
($outer_reader: expr, $reader: expr, $field: ident, (option, explicit_type: $fieldty: ty)) => {{
let _field: &Option<$fieldty> = &$field;
Expand DownExpand Up@@ -453,7 +453,7 @@ macro_rules! _decode_tlv {
}};
($outer_reader: expr, $reader: expr, $field: ident, (option, encoding: ($fieldty: ty, $encoding: ident))) => {{
$field = {
let field: $encoding<$fieldty> = ser::Readable::read(&mut $reader)?;
let field: $encoding<$fieldty> = ser::LengthReadable::read_from_fixed_length_buffer(&mut $reader)?;
Some(field.0)
};
}};
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { // Auto-enable theater mode on YouTube (function() { function tryTheater() { var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]'); if (btn && !btn.classList.contains('activated')) { btn.click(); } } // Try immediately tryTheater(); // Try after navigation (SPA) var lastUrl = location.href; setInterval(function() { if (location.href !== lastUrl) { lastUrl = location.href; setTimeout(tryTheater, 500); } }, 1000); // Also try on player load var observer = new MutationObserver(tryTheater); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' Implement Readable for LengthReadable by arik-so · Pull Request #3579 · lightningdevkit/rust-lightning · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
6 changes: 3 additions & 3 deletions lightning/src/ln/msgs.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -1958,7 +1958,7 @@ impl Writeable for TrampolineOnionPacket {
}

impl LengthReadable for TrampolineOnionPacket {
fn read<R: LengthRead>(r: &mut R) -> Result<Self, DecodeError> {
fn read_from_fixed_length_buffer<R: LengthRead>(r: &mut R) -> Result<Self, DecodeError> {
let version = Readable::read(r)?;
let public_key = Readable::read(r)?;

Expand DownExpand Up@@ -2684,7 +2684,7 @@ impl Readable for OnionMessage {
let len: u16 = Readable::read(r)?;
let mut packet_reader = FixedLengthReader::new(r, len as u64);
let onion_routing_packet: onion_message::packet::Packet =
<onion_message::packet::Packet as LengthReadable>::read(&mut packet_reader)?;
<onion_message::packet::Packet as LengthReadable>::read_from_fixed_length_buffer(&mut packet_reader)?;
Ok(Self {
blinding_point,
onion_routing_packet,
Expand DownExpand Up@@ -4708,7 +4708,7 @@ mod tests {
{ // verify that a codec round trip works
let mut reader = Cursor::new(&encoded_trampoline_packet);
let mut trampoline_packet_reader = FixedLengthReader::new(&mut reader, encoded_trampoline_packet.len() as u64);
let decoded_trampoline_packet: TrampolineOnionPacket = <TrampolineOnionPacket as LengthReadable>::read(&mut trampoline_packet_reader).unwrap();
let decoded_trampoline_packet: TrampolineOnionPacket = <TrampolineOnionPacket as LengthReadable>::read_from_fixed_length_buffer(&mut trampoline_packet_reader).unwrap();
assert_eq!(decoded_trampoline_packet.encode(), encoded_trampoline_packet);
}

Expand Down
2 changes: 1 addition & 1 deletion lightning/src/onion_message/functional_tests.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -901,7 +901,7 @@ fn spec_test_vector() {
let mut reader = io::Cursor::new(sender_to_alice_packet_bytes);
let mut packet_reader = FixedLengthReader::new(&mut reader, sender_to_alice_packet_bytes_len);
let sender_to_alice_packet: Packet =
<Packet as LengthReadable>::read(&mut packet_reader).unwrap();
<Packet as LengthReadable>::read_from_fixed_length_buffer(&mut packet_reader).unwrap();
let secp_ctx = Secp256k1::new();
let sender_to_alice_om = msgs::OnionMessage {
blinding_point: PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&<Vec<u8>>::from_hex("6363636363636363636363636363636363636363636363636363636363636363").unwrap()).unwrap()),
Expand Down
2 changes: 1 addition & 1 deletion lightning/src/onion_message/packet.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -82,7 +82,7 @@ impl Writeable for Packet {
}

impl LengthReadable for Packet {
fn read<R: LengthRead>(r: &mut R) -> Result<Self, DecodeError> {
fn read_from_fixed_length_buffer<R: LengthRead>(r: &mut R) -> Result<Self, DecodeError> {
const READ_BUFFER_SIZE: usize = 4096;

let version = Readable::read(r)?;
Expand Down
22 changes: 16 additions & 6 deletions lightning/src/util/ser.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -344,8 +344,8 @@ where
fn read<R: Read>(reader: &mut R, params: P) -> Result<Self, DecodeError>;
}

/// A [`std::io::Read`] that also provides the total bytes available to be read.
pub(crate) trait LengthRead: Read {
/// A [`io::Read`] that also provides the total bytes available to be read.
pub trait LengthRead: Read {
/// The total number of bytes available to be read.
fn total_bytes(&self) -> u64;
}
Expand All@@ -361,14 +361,24 @@ where
fn read<R: LengthRead>(reader: &mut R, params: P) -> Result<Self, DecodeError>;
}

/// A trait that various higher-level LDK types implement allowing them to be read in
/// from a [`Read`], requiring the implementer to provide the total length of the read.
pub(crate) trait LengthReadable

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Probably could update the docs since its now pub

/// A trait that allows the implementer to be read in from a [`LengthRead`], requiring
/// the reader to provide the total length of the read.
///
/// Any type that implements [`Readable`] also automatically has a [`LengthReadable`]
/// implementation, but some types, most notably onion packets, only implement [`LengthReadable`].
pub trait LengthReadable
where
Self: Sized,
{
/// Reads a `Self` in from the given [`LengthRead`].
fn read<R: LengthRead>(reader: &mut R) -> Result<Self, DecodeError>;
fn read_from_fixed_length_buffer<R: LengthRead>(reader: &mut R) -> Result<Self, DecodeError>;
}

impl<T: Readable> LengthReadable for T {
Comment thread
arik-so marked this conversation as resolved.
#[inline]
fn read_from_fixed_length_buffer<R: LengthRead>(reader: &mut R) -> Result<T, DecodeError> {
Readable::read(reader)

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this fail if the expected length wasn't read?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

given that without resorting to assert_eq, it would produce pretty ubiquitous overhead, we agreed not to

}
}

/// A trait that various LDK types implement allowing them to (maybe) be read in from a [`Read`].
Expand Down
6 changes: 3 additions & 3 deletions lightning/src/util/ser_macros.rs

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hello!
I was reviewing this and noticed that the rule at line 454 doesn’t use LengthReadable. I was curious—why is that the case?

($outer_reader: expr, $reader: expr, $field: ident,(option,encoding:($fieldty: ty, $encoding: ident))) => {{
$field = {let field: $encoding<$fieldty> = ser::Readable::read(&mut $reader)?;Some(field.0)};}};

Would love to understand it. Thanks!

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, I think this is the last missing one

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

CI is currently running with it added

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

squashed

Original file line numberDiff line numberDiff line change
Expand Up@@ -385,7 +385,7 @@ macro_rules! _decode_tlv {
($outer_reader: expr, $reader: expr, $field: ident, (static_value, $value: expr)) => {{
}};
($outer_reader: expr, $reader: expr, $field: ident, required) => {{
$field = $crate::util::ser::Readable::read(&mut $reader)?;
$field = $crate::util::ser::LengthReadable::read_from_fixed_length_buffer(&mut $reader)?;
}};
($outer_reader: expr, $reader: expr, $field: ident, (required: $trait: ident $(, $read_arg: expr)?)) => {{
$field = $trait::read(&mut $reader $(, $read_arg)*)?;
Expand All@@ -395,7 +395,7 @@ macro_rules! _decode_tlv {
$field = f.0;
}};
($outer_reader: expr, $reader: expr, $field: ident, option) => {{
$field = Some($crate::util::ser::Readable::read(&mut $reader)?);
$field = Some($crate::util::ser::LengthReadable::read_from_fixed_length_buffer(&mut $reader)?);
}};
($outer_reader: expr, $reader: expr, $field: ident, (option, explicit_type: $fieldty: ty)) => {{
let _field: &Option<$fieldty> = &$field;
Expand DownExpand Up@@ -453,7 +453,7 @@ macro_rules! _decode_tlv {
}};
($outer_reader: expr, $reader: expr, $field: ident, (option, encoding: ($fieldty: ty, $encoding: ident))) => {{
$field = {
let field: $encoding<$fieldty> = ser::Readable::read(&mut $reader)?;
let field: $encoding<$fieldty> = ser::LengthReadable::read_from_fixed_length_buffer(&mut $reader)?;
Some(field.0)
};
}};
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { // Remove or un-stick sticky/fixed headers that block content (function() { function unstick() { document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) { if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') { el.style.position = 'static'; el.style.top = 'auto'; el.style.zIndex = 'auto'; } }); } unstick(); var observer = new MutationObserver(unstick); observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] }); })(); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' Implement Readable for LengthReadable by arik-so · Pull Request #3579 · lightningdevkit/rust-lightning · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
6 changes: 3 additions & 3 deletions lightning/src/ln/msgs.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -1958,7 +1958,7 @@ impl Writeable for TrampolineOnionPacket {
}

impl LengthReadable for TrampolineOnionPacket {
fn read<R: LengthRead>(r: &mut R) -> Result<Self, DecodeError> {
fn read_from_fixed_length_buffer<R: LengthRead>(r: &mut R) -> Result<Self, DecodeError> {
let version = Readable::read(r)?;
let public_key = Readable::read(r)?;

Expand DownExpand Up@@ -2684,7 +2684,7 @@ impl Readable for OnionMessage {
let len: u16 = Readable::read(r)?;
let mut packet_reader = FixedLengthReader::new(r, len as u64);
let onion_routing_packet: onion_message::packet::Packet =
<onion_message::packet::Packet as LengthReadable>::read(&mut packet_reader)?;
<onion_message::packet::Packet as LengthReadable>::read_from_fixed_length_buffer(&mut packet_reader)?;
Ok(Self {
blinding_point,
onion_routing_packet,
Expand DownExpand Up@@ -4708,7 +4708,7 @@ mod tests {
{ // verify that a codec round trip works
let mut reader = Cursor::new(&encoded_trampoline_packet);
let mut trampoline_packet_reader = FixedLengthReader::new(&mut reader, encoded_trampoline_packet.len() as u64);
let decoded_trampoline_packet: TrampolineOnionPacket = <TrampolineOnionPacket as LengthReadable>::read(&mut trampoline_packet_reader).unwrap();
let decoded_trampoline_packet: TrampolineOnionPacket = <TrampolineOnionPacket as LengthReadable>::read_from_fixed_length_buffer(&mut trampoline_packet_reader).unwrap();
assert_eq!(decoded_trampoline_packet.encode(), encoded_trampoline_packet);
}

Expand Down
2 changes: 1 addition & 1 deletion lightning/src/onion_message/functional_tests.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -901,7 +901,7 @@ fn spec_test_vector() {
let mut reader = io::Cursor::new(sender_to_alice_packet_bytes);
let mut packet_reader = FixedLengthReader::new(&mut reader, sender_to_alice_packet_bytes_len);
let sender_to_alice_packet: Packet =
<Packet as LengthReadable>::read(&mut packet_reader).unwrap();
<Packet as LengthReadable>::read_from_fixed_length_buffer(&mut packet_reader).unwrap();
let secp_ctx = Secp256k1::new();
let sender_to_alice_om = msgs::OnionMessage {
blinding_point: PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&<Vec<u8>>::from_hex("6363636363636363636363636363636363636363636363636363636363636363").unwrap()).unwrap()),
Expand Down
2 changes: 1 addition & 1 deletion lightning/src/onion_message/packet.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -82,7 +82,7 @@ impl Writeable for Packet {
}

impl LengthReadable for Packet {
fn read<R: LengthRead>(r: &mut R) -> Result<Self, DecodeError> {
fn read_from_fixed_length_buffer<R: LengthRead>(r: &mut R) -> Result<Self, DecodeError> {
const READ_BUFFER_SIZE: usize = 4096;

let version = Readable::read(r)?;
Expand Down
22 changes: 16 additions & 6 deletions lightning/src/util/ser.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -344,8 +344,8 @@ where
fn read<R: Read>(reader: &mut R, params: P) -> Result<Self, DecodeError>;
}

/// A [`std::io::Read`] that also provides the total bytes available to be read.
pub(crate) trait LengthRead: Read {
/// A [`io::Read`] that also provides the total bytes available to be read.
pub trait LengthRead: Read {
/// The total number of bytes available to be read.
fn total_bytes(&self) -> u64;
}
Expand All@@ -361,14 +361,24 @@ where
fn read<R: LengthRead>(reader: &mut R, params: P) -> Result<Self, DecodeError>;
}

/// A trait that various higher-level LDK types implement allowing them to be read in
/// from a [`Read`], requiring the implementer to provide the total length of the read.
pub(crate) trait LengthReadable

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Probably could update the docs since its now pub

/// A trait that allows the implementer to be read in from a [`LengthRead`], requiring
/// the reader to provide the total length of the read.
///
/// Any type that implements [`Readable`] also automatically has a [`LengthReadable`]
/// implementation, but some types, most notably onion packets, only implement [`LengthReadable`].
pub trait LengthReadable
where
Self: Sized,
{
/// Reads a `Self` in from the given [`LengthRead`].
fn read<R: LengthRead>(reader: &mut R) -> Result<Self, DecodeError>;
fn read_from_fixed_length_buffer<R: LengthRead>(reader: &mut R) -> Result<Self, DecodeError>;
}

impl<T: Readable> LengthReadable for T {
Comment thread
arik-so marked this conversation as resolved.
#[inline]
fn read_from_fixed_length_buffer<R: LengthRead>(reader: &mut R) -> Result<T, DecodeError> {
Readable::read(reader)

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this fail if the expected length wasn't read?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

given that without resorting to assert_eq, it would produce pretty ubiquitous overhead, we agreed not to

}
}

/// A trait that various LDK types implement allowing them to (maybe) be read in from a [`Read`].
Expand Down
6 changes: 3 additions & 3 deletions lightning/src/util/ser_macros.rs

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hello!
I was reviewing this and noticed that the rule at line 454 doesn’t use LengthReadable. I was curious—why is that the case?

($outer_reader: expr, $reader: expr, $field: ident,(option,encoding:($fieldty: ty, $encoding: ident))) => {{
$field = {let field: $encoding<$fieldty> = ser::Readable::read(&mut $reader)?;Some(field.0)};}};

Would love to understand it. Thanks!

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, I think this is the last missing one

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

CI is currently running with it added

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

squashed

Original file line numberDiff line numberDiff line change
Expand Up@@ -385,7 +385,7 @@ macro_rules! _decode_tlv {
($outer_reader: expr, $reader: expr, $field: ident, (static_value, $value: expr)) => {{
}};
($outer_reader: expr, $reader: expr, $field: ident, required) => {{
$field = $crate::util::ser::Readable::read(&mut $reader)?;
$field = $crate::util::ser::LengthReadable::read_from_fixed_length_buffer(&mut $reader)?;
}};
($outer_reader: expr, $reader: expr, $field: ident, (required: $trait: ident $(, $read_arg: expr)?)) => {{
$field = $trait::read(&mut $reader $(, $read_arg)*)?;
Expand All@@ -395,7 +395,7 @@ macro_rules! _decode_tlv {
$field = f.0;
}};
($outer_reader: expr, $reader: expr, $field: ident, option) => {{
$field = Some($crate::util::ser::Readable::read(&mut $reader)?);
$field = Some($crate::util::ser::LengthReadable::read_from_fixed_length_buffer(&mut $reader)?);
}};
($outer_reader: expr, $reader: expr, $field: ident, (option, explicit_type: $fieldty: ty)) => {{
let _field: &Option<$fieldty> = &$field;
Expand DownExpand Up@@ -453,7 +453,7 @@ macro_rules! _decode_tlv {
}};
($outer_reader: expr, $reader: expr, $field: ident, (option, encoding: ($fieldty: ty, $encoding: ident))) => {{
$field = {
let field: $encoding<$fieldty> = ser::Readable::read(&mut $reader)?;
let field: $encoding<$fieldty> = ser::LengthReadable::read_from_fixed_length_buffer(&mut $reader)?;
Some(field.0)
};
}};
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { // Universal Dark Mode - works on any site (function() { var enabled = true; function applyDarkMode() { if (!enabled) return; // Create style element if it doesn't exist var style = document.getElementById('universal-dark-mode-style'); if (!style) { style = document.createElement('style'); style.id = 'universal-dark-mode-style'; document.head.appendChild(style); } // Dark mode CSS - inverts colors but preserves images/video style.textContent = ' /* Invert everything except media */ html { filter: invert(1) hue-rotate(180deg) !important; background: #1a1a2e !important; } /* Restore images, videos, iframes, canvas */ img, video, iframe, canvas, svg, picture, [style*="background-image"] { filter: invert(1) hue-rotate(180deg) !important; } /* Preserve specific elements that should not be inverted */ .no-dark-mode, .no-dark-mode *, [data-theme="light"], [data-theme="light"], .ace_editor, .ace_editor *, .CodeMirror, .CodeMirror *, .monaco-editor, .monaco-editor *, .markdown-body pre, .markdown-body pre *, .highlight, .highlight *, pre code, pre code * { filter: none !important; } /* Fix common UI elements */ .modal, .popup, .dropdown-menu, .tooltip, .popover { filter: invert(1) hue-rotate(180deg) !important; background: #2d2d44 !important; border-color: #444 !important; } /* Scrollbars */ ::-webkit-scrollbar { background: #1a1a2e !important; } ::-webkit-scrollbar-thumb { background: #444 !important; } ::-webkit-scrollbar-thumb:hover { background: #555 !important; } /* Selection */ ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; } ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; } '; } function removeDarkMode() { var style = document.getElementById('universal-dark-mode-style'); if (style) style.remove(); } // Toggle with Alt+Shift+D document.addEventListener('keydown', function(e) { if (e.altKey && e.shiftKey && e.key === 'D') { e.preventDefault(); enabled = !enabled; if (enabled) { applyDarkMode(); console.log('[Universal Dark Mode] Enabled'); } else { removeDarkMode(); console.log('[Universal Dark Mode] Disabled'); } } }); // Apply on load applyDarkMode(); // Re-apply on dynamic content var observer = new MutationObserver(function(mutations) { if (enabled && !document.getElementById('universal-dark-mode-style')) { applyDarkMode(); } }); observer.observe(document.head, { childList: true }); console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle'); })(); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })(); Implement Readable for LengthReadable by arik-so · Pull Request #3579 · lightningdevkit/rust-lightning · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
6 changes: 3 additions & 3 deletions lightning/src/ln/msgs.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -1958,7 +1958,7 @@ impl Writeable for TrampolineOnionPacket {
}

impl LengthReadable for TrampolineOnionPacket {
fn read<R: LengthRead>(r: &mut R) -> Result<Self, DecodeError> {
fn read_from_fixed_length_buffer<R: LengthRead>(r: &mut R) -> Result<Self, DecodeError> {
let version = Readable::read(r)?;
let public_key = Readable::read(r)?;

Expand DownExpand Up@@ -2684,7 +2684,7 @@ impl Readable for OnionMessage {
let len: u16 = Readable::read(r)?;
let mut packet_reader = FixedLengthReader::new(r, len as u64);
let onion_routing_packet: onion_message::packet::Packet =
<onion_message::packet::Packet as LengthReadable>::read(&mut packet_reader)?;
<onion_message::packet::Packet as LengthReadable>::read_from_fixed_length_buffer(&mut packet_reader)?;
Ok(Self {
blinding_point,
onion_routing_packet,
Expand DownExpand Up@@ -4708,7 +4708,7 @@ mod tests {
{ // verify that a codec round trip works
let mut reader = Cursor::new(&encoded_trampoline_packet);
let mut trampoline_packet_reader = FixedLengthReader::new(&mut reader, encoded_trampoline_packet.len() as u64);
let decoded_trampoline_packet: TrampolineOnionPacket = <TrampolineOnionPacket as LengthReadable>::read(&mut trampoline_packet_reader).unwrap();
let decoded_trampoline_packet: TrampolineOnionPacket = <TrampolineOnionPacket as LengthReadable>::read_from_fixed_length_buffer(&mut trampoline_packet_reader).unwrap();
assert_eq!(decoded_trampoline_packet.encode(), encoded_trampoline_packet);
}

Expand Down
2 changes: 1 addition & 1 deletion lightning/src/onion_message/functional_tests.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -901,7 +901,7 @@ fn spec_test_vector() {
let mut reader = io::Cursor::new(sender_to_alice_packet_bytes);
let mut packet_reader = FixedLengthReader::new(&mut reader, sender_to_alice_packet_bytes_len);
let sender_to_alice_packet: Packet =
<Packet as LengthReadable>::read(&mut packet_reader).unwrap();
<Packet as LengthReadable>::read_from_fixed_length_buffer(&mut packet_reader).unwrap();
let secp_ctx = Secp256k1::new();
let sender_to_alice_om = msgs::OnionMessage {
blinding_point: PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&<Vec<u8>>::from_hex("6363636363636363636363636363636363636363636363636363636363636363").unwrap()).unwrap()),
Expand Down
2 changes: 1 addition & 1 deletion lightning/src/onion_message/packet.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -82,7 +82,7 @@ impl Writeable for Packet {
}

impl LengthReadable for Packet {
fn read<R: LengthRead>(r: &mut R) -> Result<Self, DecodeError> {
fn read_from_fixed_length_buffer<R: LengthRead>(r: &mut R) -> Result<Self, DecodeError> {
const READ_BUFFER_SIZE: usize = 4096;

let version = Readable::read(r)?;
Expand Down
22 changes: 16 additions & 6 deletions lightning/src/util/ser.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -344,8 +344,8 @@ where
fn read<R: Read>(reader: &mut R, params: P) -> Result<Self, DecodeError>;
}

/// A [`std::io::Read`] that also provides the total bytes available to be read.
pub(crate) trait LengthRead: Read {
/// A [`io::Read`] that also provides the total bytes available to be read.
pub trait LengthRead: Read {
/// The total number of bytes available to be read.
fn total_bytes(&self) -> u64;
}
Expand All@@ -361,14 +361,24 @@ where
fn read<R: LengthRead>(reader: &mut R, params: P) -> Result<Self, DecodeError>;
}

/// A trait that various higher-level LDK types implement allowing them to be read in
/// from a [`Read`], requiring the implementer to provide the total length of the read.
pub(crate) trait LengthReadable

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Probably could update the docs since its now pub

/// A trait that allows the implementer to be read in from a [`LengthRead`], requiring
/// the reader to provide the total length of the read.
///
/// Any type that implements [`Readable`] also automatically has a [`LengthReadable`]
/// implementation, but some types, most notably onion packets, only implement [`LengthReadable`].
pub trait LengthReadable
where
Self: Sized,
{
/// Reads a `Self` in from the given [`LengthRead`].
fn read<R: LengthRead>(reader: &mut R) -> Result<Self, DecodeError>;
fn read_from_fixed_length_buffer<R: LengthRead>(reader: &mut R) -> Result<Self, DecodeError>;
}

impl<T: Readable> LengthReadable for T {
Comment thread
arik-so marked this conversation as resolved.
#[inline]
fn read_from_fixed_length_buffer<R: LengthRead>(reader: &mut R) -> Result<T, DecodeError> {
Readable::read(reader)

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this fail if the expected length wasn't read?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

given that without resorting to assert_eq, it would produce pretty ubiquitous overhead, we agreed not to

}
}

/// A trait that various LDK types implement allowing them to (maybe) be read in from a [`Read`].
Expand Down
6 changes: 3 additions & 3 deletions lightning/src/util/ser_macros.rs

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hello!
I was reviewing this and noticed that the rule at line 454 doesn’t use LengthReadable. I was curious—why is that the case?

($outer_reader: expr, $reader: expr, $field: ident,(option,encoding:($fieldty: ty, $encoding: ident))) => {{
$field = {let field: $encoding<$fieldty> = ser::Readable::read(&mut $reader)?;Some(field.0)};}};

Would love to understand it. Thanks!

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, I think this is the last missing one

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

CI is currently running with it added

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

squashed

Original file line numberDiff line numberDiff line change
Expand Up@@ -385,7 +385,7 @@ macro_rules! _decode_tlv {
($outer_reader: expr, $reader: expr, $field: ident, (static_value, $value: expr)) => {{
}};
($outer_reader: expr, $reader: expr, $field: ident, required) => {{
$field = $crate::util::ser::Readable::read(&mut $reader)?;
$field = $crate::util::ser::LengthReadable::read_from_fixed_length_buffer(&mut $reader)?;
}};
($outer_reader: expr, $reader: expr, $field: ident, (required: $trait: ident $(, $read_arg: expr)?)) => {{
$field = $trait::read(&mut $reader $(, $read_arg)*)?;
Expand All@@ -395,7 +395,7 @@ macro_rules! _decode_tlv {
$field = f.0;
}};
($outer_reader: expr, $reader: expr, $field: ident, option) => {{
$field = Some($crate::util::ser::Readable::read(&mut $reader)?);
$field = Some($crate::util::ser::LengthReadable::read_from_fixed_length_buffer(&mut $reader)?);
}};
($outer_reader: expr, $reader: expr, $field: ident, (option, explicit_type: $fieldty: ty)) => {{
let _field: &Option<$fieldty> = &$field;
Expand DownExpand Up@@ -453,7 +453,7 @@ macro_rules! _decode_tlv {
}};
($outer_reader: expr, $reader: expr, $field: ident, (option, encoding: ($fieldty: ty, $encoding: ident))) => {{
$field = {
let field: $encoding<$fieldty> = ser::Readable::read(&mut $reader)?;
let field: $encoding<$fieldty> = ser::LengthReadable::read_from_fixed_length_buffer(&mut $reader)?;
Some(field.0)
};
}};
Expand Down