mod bounded_encoder;
mod configurables_bounded_encoder;
use std::default::Default;
use crate::{
codec::abi_encoder::{
bounded_encoder::BoundedEncoder, configurables_bounded_encoder::ConfigurablesBoundedEncoder,
},
types::{errors::Result, unresolved_bytes::UnresolvedBytes, Token},
};
#[derive(Debug, Clone, Copy)]
pub struct EncoderConfig {
pub max_depth: usize,
pub max_tokens: usize,
pub max_total_enum_width: usize,
}
impl Default for EncoderConfig {
fn default() -> Self {
Self {
max_depth: 45,
max_tokens: 10_000,
max_total_enum_width: 10_000,
}
}
}
#[derive(Default, Clone, Debug)]
pub struct ABIEncoder {
pub config: EncoderConfig,
}
impl ABIEncoder {
pub fn new(config: EncoderConfig) -> Self {
Self { config }
}
pub fn encode(&self, args: &[Token]) -> Result<UnresolvedBytes> {
BoundedEncoder::new(self.config, false).encode(args)
}
}
#[derive(Default, Clone, Debug)]
pub struct ConfigurablesEncoder {
pub config: EncoderConfig,
}
impl ConfigurablesEncoder {
pub fn new(config: EncoderConfig) -> Self {
Self { config }
}
pub fn encode(&self, args: &[Token]) -> Result<UnresolvedBytes> {
ConfigurablesBoundedEncoder::new(self.config, true).encode(args)
}
}
#[cfg(test)]
mod tests {
use std::slice;
use itertools::chain;
use super::*;
use crate::{
constants::WORD_SIZE,
to_named,
types::{
errors::Error,
param_types::{EnumVariants, ParamType},
StaticStringToken, U256,
},
};
#[test]
fn encode_multiple_uint() -> Result<()> {
let tokens = [
Token::U8(u8::MAX),
Token::U16(u16::MAX),
Token::U32(u32::MAX),
Token::U64(u64::MAX),
Token::U128(u128::MAX),
Token::U256(U256::MAX),
];
let result = ABIEncoder::default().encode(&tokens)?.resolve(0);
let expected = [
255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255,
255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255,
255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, ];
assert_eq!(result, expected);
Ok(())
}
#[test]
fn encode_bool() -> Result<()> {
let token = Token::Bool(true);
let result = ABIEncoder::default().encode(&[token])?.resolve(0);
let expected = [1];
assert_eq!(result, expected);
Ok(())
}
#[test]
fn encode_b256() -> Result<()> {
let data = [
213, 87, 156, 70, 223, 204, 127, 24, 32, 112, 19, 230, 91, 68, 228, 203, 78, 44, 34,
152, 244, 172, 69, 123, 168, 248, 39, 67, 243, 30, 147, 11,
];
let token = Token::B256(data);
let result = ABIEncoder::default().encode(&[token])?.resolve(0);
assert_eq!(result, data);
Ok(())
}
#[test]
fn encode_bytes() -> Result<()> {
let token = Token::Bytes([255, 0, 1, 2, 3, 4, 5].to_vec());
let result = ABIEncoder::default().encode(&[token])?.resolve(0);
let expected = [
0, 0, 0, 0, 0, 0, 0, 7, 255, 0, 1, 2, 3, 4, 5, ];
assert_eq!(result, expected);
Ok(())
}
#[test]
fn encode_string() -> Result<()> {
let token = Token::String("This is a full sentence".to_string());
let result = ABIEncoder::default().encode(&[token])?.resolve(0);
let expected = [
0, 0, 0, 0, 0, 0, 0, 23, 84, 104, 105, 115, 32, 105, 115, 32, 97, 32, 102, 117, 108, 108, 32, 115, 101, 110,
116, 101, 110, 99, 101, ];
assert_eq!(result, expected);
Ok(())
}
#[test]
fn encode_raw_slice() -> Result<()> {
let token = Token::RawSlice([255, 0, 1, 2, 3, 4, 5].to_vec());
let result = ABIEncoder::default().encode(&[token])?.resolve(0);
let expected = [
0, 0, 0, 0, 0, 0, 0, 7, 255, 0, 1, 2, 3, 4, 5, ];
assert_eq!(result, expected);
Ok(())
}
#[test]
fn encode_string_array() -> Result<()> {
let token = Token::StringArray(StaticStringToken::new(
"This is a full sentence".into(),
Some(23),
));
let result = ABIEncoder::default().encode(&[token])?.resolve(0);
let expected = [
84, 104, 105, 115, 32, 105, 115, 32, 97, 32, 102, 117, 108, 108, 32, 115, 101, 110,
116, 101, 110, 99, 101, ];
assert_eq!(result, expected);
Ok(())
}
#[test]
fn encode_string_slice() -> Result<()> {
let token = Token::StringSlice(StaticStringToken::new(
"This is a full sentence".into(),
None,
));
let result = ABIEncoder::default().encode(&[token])?.resolve(0);
let expected = [
0, 0, 0, 0, 0, 0, 0, 23, 84, 104, 105, 115, 32, 105, 115, 32, 97, 32, 102, 117, 108, 108, 32, 115, 101, 110,
116, 101, 110, 99, 101, ];
assert_eq!(result, expected);
Ok(())
}
#[test]
fn encode_tuple() -> Result<()> {
let token = Token::Tuple(vec![Token::U32(255), Token::Bool(true)]);
let result = ABIEncoder::default().encode(&[token])?.resolve(0);
let expected = [
0, 0, 0, 255, 1, ];
assert_eq!(result, expected);
Ok(())
}
#[test]
fn encode_array() -> Result<()> {
let token = Token::Tuple(vec![Token::U32(255), Token::U32(128)]);
let result = ABIEncoder::default().encode(&[token])?.resolve(0);
let expected = [
0, 0, 0, 255, 0, 0, 0, 128, ];
assert_eq!(result, expected);
Ok(())
}
#[test]
fn enums_are_sized_to_fit_the_biggest_variant() -> Result<()> {
let types = to_named(&[ParamType::B256, ParamType::U64]);
let enum_variants = EnumVariants::new(types)?;
let enum_selector = Box::new((1, Token::U64(42), enum_variants));
let encoded = ConfigurablesEncoder::default()
.encode(slice::from_ref(&Token::Enum(enum_selector)))?
.resolve(0);
let enum_discriminant_enc = vec![0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x1];
let u64_enc = vec![0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x2a];
let enum_padding = vec![0x0; 24];
let expected: Vec<u8> = [enum_discriminant_enc, enum_padding, u64_enc]
.into_iter()
.flatten()
.collect();
assert_eq!(hex::encode(expected), hex::encode(encoded));
Ok(())
}
#[test]
fn encode_enum_with_deeply_nested_types() -> Result<()> {
let types = to_named(&[ParamType::Bool, ParamType::StringArray(10)]);
let deeper_enum_variants = EnumVariants::new(types)?;
let deeper_enum_token =
Token::StringArray(StaticStringToken::new("0123456789".into(), Some(10)));
let fields = to_named(&[
ParamType::Enum {
name: "".to_string(),
enum_variants: deeper_enum_variants.clone(),
generics: vec![],
},
ParamType::Bool,
]);
let struct_a_type = ParamType::Struct {
name: "".to_string(),
fields,
generics: vec![],
};
let struct_a_token = Token::Struct(vec![
Token::Enum(Box::new((1, deeper_enum_token, deeper_enum_variants))),
Token::U32(11332),
]);
let types = to_named(&[struct_a_type, ParamType::Bool, ParamType::U64]);
let top_level_enum_variants = EnumVariants::new(types)?;
let top_level_enum_token =
Token::Enum(Box::new((0, struct_a_token, top_level_enum_variants)));
let result = ABIEncoder::default()
.encode(slice::from_ref(&top_level_enum_token))?
.resolve(0);
let expected = [
0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 0, 0, 44, 68, ];
assert_eq!(result, expected);
Ok(())
}
#[test]
fn encode_nested_structs() -> Result<()> {
let token = Token::Struct(vec![
Token::U16(10),
Token::Struct(vec![
Token::Bool(true),
Token::Array(vec![Token::U8(1), Token::U8(2)]),
]),
]);
let result = ABIEncoder::default().encode(&[token])?.resolve(0);
let expected = [
0, 10, 1, 1, 2, ];
assert_eq!(result, expected);
Ok(())
}
#[test]
fn encode_comprehensive() -> Result<()> {
let foo = Token::Struct(vec![
Token::U16(10),
Token::Struct(vec![
Token::Bool(true),
Token::Array(vec![Token::U8(1), Token::U8(2)]),
]),
]);
let arr_u8 = Token::Array(vec![Token::U8(1), Token::U8(2)]);
let b256 = Token::B256([255; 32]);
let str_arr = Token::StringArray(StaticStringToken::new(
"This is a full sentence".into(),
Some(23),
));
let tokens = vec![foo, arr_u8, b256, str_arr];
let result = ABIEncoder::default().encode(&tokens)?.resolve(0);
let expected = [
0, 10, 1, 1, 2, 1, 2, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 84, 104, 105, 115, 32, 105, 115, 32, 97, 32, 102, 117, 108, 108, 32, 115, 101, 110,
116, 101, 110, 99, 101, ];
assert_eq!(result, expected);
Ok(())
}
#[test]
fn enums_with_only_unit_variants_are_encoded_in_one_word() -> Result<()> {
let expected = [0, 0, 0, 0, 0, 0, 0, 1];
let types = to_named(&[ParamType::Unit, ParamType::Unit]);
let enum_selector = Box::new((1, Token::Unit, EnumVariants::new(types)?));
let actual = ABIEncoder::default()
.encode(&[Token::Enum(enum_selector)])?
.resolve(0);
assert_eq!(actual, expected);
Ok(())
}
#[test]
fn units_in_composite_types_are_encoded_in_one_word() -> Result<()> {
let expected = [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 5];
let actual = ConfigurablesEncoder::default()
.encode(&[Token::Struct(vec![Token::Unit, Token::U32(5)])])?
.resolve(0);
assert_eq!(actual, expected);
Ok(())
}
#[test]
fn enums_with_units_are_correctly_padded() -> Result<()> {
let discriminant = vec![0, 0, 0, 0, 0, 0, 0, 1];
let padding = vec![0; 32];
let expected: Vec<u8> = [discriminant, padding].into_iter().flatten().collect();
let types = to_named(&[ParamType::B256, ParamType::Unit]);
let enum_selector = Box::new((1, Token::Unit, EnumVariants::new(types)?));
let actual = ConfigurablesEncoder::default()
.encode(&[Token::Enum(enum_selector)])?
.resolve(0);
assert_eq!(actual, expected);
Ok(())
}
#[test]
fn vector_has_ptr_cap_len_and_then_data() -> Result<()> {
let offset: u8 = 150;
let token = Token::Vector(vec![Token::U64(5)]);
let result = ConfigurablesEncoder::default()
.encode(&[token])?
.resolve(offset as u64);
let ptr = [0, 0, 0, 0, 0, 0, 0, 3 * WORD_SIZE as u8 + offset];
let cap = [0, 0, 0, 0, 0, 0, 0, 1];
let len = [0, 0, 0, 0, 0, 0, 0, 1];
let data = [0, 0, 0, 0, 0, 0, 0, 5];
let expected = chain!(ptr, cap, len, data).collect::<Vec<_>>();
assert_eq!(result, expected);
Ok(())
}
#[test]
fn data_from_two_vectors_aggregated_at_the_end() -> Result<()> {
let offset: u8 = 40;
let vec_1 = Token::Vector(vec![Token::U64(5)]);
let vec_2 = Token::Vector(vec![Token::U64(6)]);
let result = ConfigurablesEncoder::default()
.encode(&[vec_1, vec_2])?
.resolve(offset as u64);
let vec1_data_offset = 6 * WORD_SIZE as u8 + offset;
let vec1_ptr = [0, 0, 0, 0, 0, 0, 0, vec1_data_offset];
let vec1_cap = [0, 0, 0, 0, 0, 0, 0, 1];
let vec1_len = [0, 0, 0, 0, 0, 0, 0, 1];
let vec1_data = [0, 0, 0, 0, 0, 0, 0, 5];
let vec2_data_offset = vec1_data_offset + vec1_data.len() as u8;
let vec2_ptr = [0, 0, 0, 0, 0, 0, 0, vec2_data_offset];
let vec2_cap = [0, 0, 0, 0, 0, 0, 0, 1];
let vec2_len = [0, 0, 0, 0, 0, 0, 0, 1];
let vec2_data = [0, 0, 0, 0, 0, 0, 0, 6];
let expected = chain!(
vec1_ptr, vec1_cap, vec1_len, vec2_ptr, vec2_cap, vec2_len, vec1_data, vec2_data,
)
.collect::<Vec<_>>();
assert_eq!(result, expected);
Ok(())
}
#[test]
fn vec_in_enum() -> Result<()> {
let offset = 40;
let types = to_named(&[ParamType::B256, ParamType::Vector(Box::new(ParamType::U64))]);
let variants = EnumVariants::new(types)?;
let selector = (1, Token::Vector(vec![Token::U64(5)]), variants);
let token = Token::Enum(Box::new(selector));
let result = ABIEncoder::default()
.encode(&[token])?
.resolve(offset as u64);
let expected = [
0, 0, 0, 0, 0, 0, 0, 1, 0, 0, 0, 0, 0, 0, 0, 1, 0, 0, 0, 0, 0, 0, 0, 5, ];
assert_eq!(result, expected);
Ok(())
}
#[test]
fn enum_in_vec() -> Result<()> {
let offset = 40;
let types = to_named(&[ParamType::B256, ParamType::U8]);
let variants = EnumVariants::new(types)?;
let selector = (1, Token::U8(8), variants);
let enum_token = Token::Enum(Box::new(selector));
let vec_token = Token::Vector(vec![enum_token]);
let result = ABIEncoder::default()
.encode(&[vec_token])?
.resolve(offset as u64);
let expected = [
0, 0, 0, 0, 0, 0, 0, 1, 0, 0, 0, 0, 0, 0, 0, 1, 8, ];
assert_eq!(result, expected);
Ok(())
}
#[test]
fn vec_in_struct() -> Result<()> {
let offset = 40;
let token = Token::Struct(vec![Token::Vector(vec![Token::U64(5)]), Token::U8(9)]);
let result = ABIEncoder::default()
.encode(&[token])?
.resolve(offset as u64);
let expected = [
0, 0, 0, 0, 0, 0, 0, 1, 0, 0, 0, 0, 0, 0, 0, 5, 9, ];
assert_eq!(result, expected);
Ok(())
}
#[test]
fn vec_in_vec() -> Result<()> {
let offset = 40;
let token = Token::Vector(vec![Token::Vector(vec![Token::U8(5), Token::U8(6)])]);
let result = ABIEncoder::default()
.encode(&[token])?
.resolve(offset as u64);
let expected = [
0, 0, 0, 0, 0, 0, 0, 1, 0, 0, 0, 0, 0, 0, 0, 2, 5, 6, ];
assert_eq!(result, expected);
Ok(())
}
#[test]
fn capacity_overflow_is_caught() -> Result<()> {
let token = Token::Enum(Box::new((
1,
Token::String("".to_string()),
EnumVariants::new(to_named(&[
ParamType::StringArray(18446742977385549567),
ParamType::U8,
]))?,
)));
let capacity_overflow_error = ConfigurablesEncoder::default()
.encode(&[token])
.unwrap_err();
assert!(capacity_overflow_error
.to_string()
.contains("Try increasing maximum total enum width"));
Ok(())
}
#[test]
fn max_depth_surpassed() {
const MAX_DEPTH: usize = 2;
let config = EncoderConfig {
max_depth: MAX_DEPTH,
..Default::default()
};
let msg = "depth limit `2` reached while encoding. Try increasing it".to_string();
[nested_struct, nested_enum, nested_tuple, nested_array]
.iter()
.map(|fun| fun(MAX_DEPTH + 1))
.for_each(|token| {
assert_encoding_failed(config, token, &msg);
});
}
#[test]
fn encoder_for_configurables_optimizes_top_level_u8() {
let encoder = ConfigurablesEncoder::default();
let encoded = encoder.encode(&[Token::U8(255)]).unwrap().resolve(0);
assert_eq!(encoded, vec![255]);
}
#[test]
fn encoder_for_configurables_optimizes_top_level_bool() {
let encoder = ConfigurablesEncoder::default();
let encoded = encoder.encode(&[Token::Bool(true)]).unwrap().resolve(0);
assert_eq!(encoded, vec![1]);
}
fn assert_encoding_failed(config: EncoderConfig, token: Token, msg: &str) {
let encoder = ABIEncoder::new(config);
let err = encoder.encode(&[token]);
let Err(Error::Codec(actual_msg)) = err else {
panic!("expected a Codec error. Got: `{err:?}`");
};
assert_eq!(actual_msg, msg);
}
fn nested_struct(depth: usize) -> Token {
let fields = if depth == 1 {
vec![Token::U8(255), Token::String("bloopblip".to_string())]
} else {
vec![nested_struct(depth - 1)]
};
Token::Struct(fields)
}
fn nested_enum(depth: usize) -> Token {
if depth == 0 {
return Token::U8(255);
}
let inner_enum = nested_enum(depth - 1);
let selector = (
0u64,
inner_enum,
EnumVariants::new(to_named(&[ParamType::U64])).unwrap(),
);
Token::Enum(Box::new(selector))
}
fn nested_array(depth: usize) -> Token {
if depth == 1 {
Token::Array(vec![Token::U8(255)])
} else {
Token::Array(vec![nested_array(depth - 1)])
}
}
fn nested_tuple(depth: usize) -> Token {
let fields = if depth == 1 {
vec![Token::U8(255), Token::String("bloopblip".to_string())]
} else {
vec![nested_tuple(depth - 1)]
};
Token::Tuple(fields)
}
}