Skip to content
New issue

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

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

Already on GitHub? Sign in to your account

Fix: avoid infinite recursion with Message::max_encoded_len() #1982

Merged
merged 1 commit into from
Aug 23, 2024
Merged
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
30 changes: 17 additions & 13 deletions pallets/liquidity-pools/src/message.rs
Original file line number Diff line number Diff line change
Expand Up @@ -98,9 +98,11 @@ impl TryFrom<Message> for NonBatchMessage {

impl MaxEncodedLen for NonBatchMessage {
fn max_encoded_len() -> usize {
// This message uses a non-batch message version to obtain the encoded
// len to avoid an infinite recursion: message -> batch -> message -> batch ...
Message::<()>::max_encoded_len()
// This message uses a non-recursive message version to obtain the encoded
// len to avoid an infinite recursion of messages
//
// Note: A Batch can NOT contain Forwarded messages
Message::<(), ()>::max_encoded_len()
}
}

Expand Down Expand Up @@ -206,7 +208,7 @@ impl TryFrom<Message> for NonForwardMessage {
fn try_from(message: Message) -> Result<Self, DispatchError> {
match message {
Message::Forwarded { .. } => Err(DispatchError::Other(
"A submessage can not be a forwarded one",
"The inner forwarded message can not be a forwarded one",
)),
_ => Ok(Self(message.into())),
}
Expand All @@ -221,10 +223,11 @@ impl From<NonForwardMessage> for Message {

impl MaxEncodedLen for NonForwardMessage {
fn max_encoded_len() -> usize {
// This message uses a non-forwarded message version to obtain the encoded
// len to avoid an infinite recursion: message -> forward -> message -> forward
// ...
Message::<()>::max_encoded_len()
// This message uses a non-recursive message version to obtain the encoded
// len to avoid an infinite recursion of messages
//
// Note: A Batch CAN be inside of a Forwarded message
Message::<BatchMessages, ()>::max_encoded_len()
}
}

Expand Down Expand Up @@ -667,11 +670,7 @@ impl LpMessageForwarded for Message {
Ok(Self::Forwarded {
source_domain: source_domain.into(),
forwarding_contract,
message: message.try_into().map_err(|_| {
DispatchError::Other(
"Failed to convert LpMessage {message:?} into NonForwardMessage",
)
})?,
message: message.try_into()?,
})
}
}
Expand Down Expand Up @@ -731,6 +730,11 @@ mod tests {
const POOL_ID: PoolId = 12378532;
const TOKEN_ID: u128 = 246803579;

#[test]
fn ensure_non_recursive_max_encoded_len_computation() {
Message::<BatchMessages, NonForwardMessage>::max_encoded_len();
}

#[test]
fn invalid() {
let msg: Message<BatchMessages> = Message::Invalid;
Expand Down
Loading