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.

Sign up for GitHub

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

Already on GitHub? Sign in to your account

feat!: streaming decoder #1564

Merged
merged 9 commits into from
Jan 17, 2025
+221 −353
Merged

feat!: streaming decoder #1564

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
d5d5003
Make ABIDecoder accept std::io::Read
Dentosal Jan 6, 2025
3582bd1
Cleanup generics
Dentosal Jan 6, 2025
867cc21
Use impl Read instead of a generic
Dentosal Jan 6, 2025
2231990
Merge branch 'master' into dento/streaming-decoder
hal3e Jan 7, 2025
c2b23c2
Merge branch 'master' into dento/streaming-decoder
segfault-magnet Jan 10, 2025
9814483
fix clippy
segfault-magnet Jan 10, 2025
6d753ba
fix doctests
segfault-magnet Jan 13, 2025
b80cdd3
Merge branch 'master' into dento/streaming-decoder
segfault-magnet Jan 14, 2025
ce5a713
Merge branch 'master' into dento/streaming-decoder
JoshuaBatty Jan 17, 2025
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
16 changes: 8 additions & 8 deletions e2e/tests/debug_utils.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ async fn can_debug_single_call_tx() -> Result<()> {
assert_eq!(
decoder.decode_fn_args(
&call_description.decode_fn_selector().unwrap(),
&call_description.encoded_args
call_description.encoded_args.as_slice()
)?,
vec!["AllStruct { some_struct: SomeStruct { field: 2, field_2: true } }"]
);
Expand Down Expand Up @@ -115,7 +115,7 @@ async fn can_debug_single_call_tx() -> Result<()> {
assert_eq!(
decoder.decode_fn_args(
&call_description.decode_fn_selector().unwrap(),
&call_description.encoded_args
call_description.encoded_args.as_slice()
)?,
vec!["AllStruct { some_struct: SomeStruct { field: 2, field_2: true } }"]
);
Expand Down Expand Up @@ -214,7 +214,7 @@ async fn can_debug_multi_call_tx() -> Result<()> {
assert_eq!(
decoder.decode_fn_args(
&call_description.decode_fn_selector().unwrap(),
&call_description.encoded_args
call_description.encoded_args.as_slice()
)?,
vec!["AllStruct { some_struct: SomeStruct { field: 2, field_2: true } }"]
);
Expand All @@ -229,7 +229,7 @@ async fn can_debug_multi_call_tx() -> Result<()> {
assert!(call_description.gas_forwarded.is_none());

assert_eq!(
decoder.decode_fn_args(&fn_selector, &call_description.encoded_args)?,
decoder.decode_fn_args(&fn_selector, call_description.encoded_args.as_slice())?,
vec!["AllStruct { some_struct: SomeStruct { field: 2, field_2: true } }", "MemoryAddress { contract_id: std::contract_id::ContractId { bits: Bits256([77, 127, 224, 17, 182, 42, 211, 241, 46, 156, 74, 204, 31, 156, 188, 77, 183, 63, 55, 80, 119, 142, 192, 75, 130, 205, 208, 253, 25, 104, 22, 171]) }, function_selector: 123, function_data: 456 }"]
);
}
Expand Down Expand Up @@ -286,7 +286,7 @@ async fn can_debug_multi_call_tx() -> Result<()> {
assert_eq!(
decoder.decode_fn_args(
&call_description.decode_fn_selector().unwrap(),
&call_description.encoded_args
call_description.encoded_args.as_slice()
)?,
vec!["AllStruct { some_struct: SomeStruct { field: 2, field_2: true } }"]
);
Expand All @@ -303,7 +303,7 @@ async fn can_debug_multi_call_tx() -> Result<()> {
assert_eq!(call_description.gas_forwarded, Some(25));

assert_eq!(
decoder.decode_fn_args(&call_description.decode_fn_selector().unwrap(), &call_description.encoded_args)?,
decoder.decode_fn_args(&call_description.decode_fn_selector().unwrap(), call_description.encoded_args.as_slice())?,
vec!["AllStruct { some_struct: SomeStruct { field: 2, field_2: true } }", "MemoryAddress { contract_id: std::contract_id::ContractId { bits: Bits256([77, 127, 224, 17, 182, 42, 211, 241, 46, 156, 74, 204, 31, 156, 188, 77, 183, 63, 55, 80, 119, 142, 192, 75, 130, 205, 208, 253, 25, 104, 22, 171]) }, function_selector: 123, function_data: 456 }"]
);
}
Expand Down Expand Up @@ -345,7 +345,7 @@ async fn can_debug_sway_script() -> Result<()> {
};

assert_eq!(
decoder.decode_fn_args("main", &desc.data)?,
decoder.decode_fn_args("main", desc.data.as_slice())?,
vec!["MyStruct { number: 10, boolean: false }"]
);

Expand Down Expand Up @@ -455,7 +455,7 @@ async fn can_detect_a_loader_script_w_data_section() -> Result<()> {
)?)?;

assert_eq!(
decoder.decode_fn_args("main", &script.data)?,
decoder.decode_fn_args("main", script.data.as_slice())?,
vec!["MyStruct { number: 10, boolean: false }"]
);

Expand Down
3 changes: 2 additions & 1 deletion examples/contracts/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1198,7 +1198,8 @@ mod tests {

let call = &calls[0];
let fn_selector = call.decode_fn_selector()?;
let decoded_args = abi_formatter.decode_fn_args(&fn_selector, &call.encoded_args)?;
let decoded_args =
abi_formatter.decode_fn_args(&fn_selector, call.encoded_args.as_slice())?;

eprintln!(
"The script called: {fn_selector}({})",
Expand Down
8 changes: 4 additions & 4 deletions examples/debugging/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ mod tests {

assert_eq!(
format!("{expected_struct:?}"),
decoder.decode_as_debug_str(&param_type, &[0, 0, 0, 0, 0, 0, 0, 123])?
decoder.decode_as_debug_str(&param_type, [0, 0, 0, 0, 0, 0, 0, 123].as_slice())?
);
}
{
Expand All @@ -83,7 +83,7 @@ mod tests {

assert_eq!(
format!("{expected_struct:?}"),
decoder.decode_as_debug_str(&param_type, &[97, 98, 99])?
decoder.decode_as_debug_str(&param_type, [97, 98, 99].as_slice())?
);
}
{
Expand All @@ -97,7 +97,7 @@ mod tests {
format!("{expected_enum:?}"),
decoder.decode_as_debug_str(
&param_type,
&[0, 0, 0, 0, 0, 0, 0, 1, 0, 0, 0, 0, 0, 0, 0, 10]
[0, 0, 0, 0, 0, 0, 0, 1, 0, 0, 0, 0, 0, 0, 0, 10].as_slice()
)?
);
}
Expand All @@ -117,7 +117,7 @@ mod tests {

assert_eq!(
format!("{expected_u8}"),
decoder.decode_as_debug_str(&param_type, &[1])?
decoder.decode_as_debug_str(&param_type, [1].as_slice())?
);
}

Expand Down
18 changes: 12 additions & 6 deletions packages/fuels-core/src/codec.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ mod function_selector;
mod logs;
mod utils;

use std::io::Read;

pub use abi_decoder::*;
pub use abi_encoder::*;
pub use abi_formatter::*;
Expand All @@ -17,7 +19,7 @@ use crate::{
};

/// Decodes `bytes` into type `T` following the schema defined by T's `Parameterize` impl
pub fn try_from_bytes<T>(bytes: &[u8], decoder_config: DecoderConfig) -> Result<T>
pub fn try_from_bytes<T>(bytes: impl Read, decoder_config: DecoderConfig) -> Result<T>
where
T: Parameterize + Tokenizable,
{
Expand All @@ -41,13 +43,16 @@ mod tests {
macro_rules! test_decode {
($($for_type: ident),*) => {
$(assert_eq!(
try_from_bytes::<$for_type>(&bytes, DecoderConfig::default())?,
try_from_bytes::<$for_type>(bytes.as_slice(), DecoderConfig::default())?,
$for_type::MAX
);)*
};
}

assert!(try_from_bytes::<bool>(&bytes, DecoderConfig::default())?);
assert!(try_from_bytes::<bool>(
bytes.as_slice(),
DecoderConfig::default()
)?);

test_decode!(u8, u16, u32, u64);

Expand All @@ -58,7 +63,8 @@ mod tests {
fn convert_bytes_into_tuple() -> Result<()> {
let tuple_in_bytes = [0, 0, 0, 0, 0, 0, 0, 1, 0, 0, 0, 2];

let the_tuple: (u64, u32) = try_from_bytes(&tuple_in_bytes, DecoderConfig::default())?;
let the_tuple: (u64, u32) =
try_from_bytes(tuple_in_bytes.as_slice(), DecoderConfig::default())?;

assert_eq!(the_tuple, (1, 2));

Expand All @@ -72,7 +78,7 @@ mod tests {
macro_rules! test_decode {
($($for_type: ident),*) => {
$(assert_eq!(
try_from_bytes::<$for_type>(&bytes, DecoderConfig::default())?,
try_from_bytes::<$for_type>(bytes.as_slice(), DecoderConfig::default())?,
$for_type::new(bytes.as_slice().try_into()?)
);)*
};
Expand Down Expand Up @@ -109,7 +115,7 @@ mod tests {
.unwrap();

// when
let decoded = try_from_bytes::<Test>(&encoded, DecoderConfig::default()).unwrap();
let decoded = try_from_bytes::<Test>(encoded.as_slice(), DecoderConfig::default()).unwrap();

// then
assert_eq!(decoded, input);
Expand Down
Loading
Loading