Add Event::encode_data_to

davidsemakula · davidsemakula · commit 081e7990956e · 2025-10-11T00:45:15.000+03:00
diff --git a/crates/env/src/engine/on_chain/pallet_revive.rs b/crates/env/src/engine/on_chain/pallet_revive.rs
@@ -992,14 +992,7 @@ impl TypedEnvBackend for EnvInstance {
             .chunks_exact(32)
             .map(|c| c.try_into().unwrap())
             .collect::<ink_prelude::vec::Vec<[u8; 32]>>();
-        let enc_data = scope.take_encoded_with(|buffer| {
-            let encoded = event.encode_data();
-            let len = encoded.len();
-            // NOTE: panics if buffer isn't large enough.
-            // This behavior is similar to `ScopedBuffer::take_encoded`.
-            buffer[..len].copy_from_slice(&encoded);
-            len
-        });
+        let enc_data = scope.take_encoded_with(|buffer| event.encode_data_to(buffer));
 
         ext::deposit_event(&enc_topics[..], enc_data);
     }
diff --git a/crates/env/src/event.rs b/crates/env/src/event.rs
@@ -252,6 +252,10 @@ pub trait Event<Abi = crate::DefaultAbi>: AbiEncodeWith<Abi> {
 
     /// ABI encode the dynamic data of this event.
     fn encode_data(&self) -> ink_prelude::vec::Vec<u8>;
+
+    /// ABI encode the dynamic data of this event into the given buffer, and returns the
+    /// number of bytes written.
+    fn encode_data_to(&self, buffer: &mut [u8]) -> usize;
 }
 
 mod private {
diff --git a/crates/ink/macro/src/event/mod.rs b/crates/ink/macro/src/event/mod.rs
@@ -204,10 +204,15 @@ fn event_derive_struct(s: synstructure::Structure) -> syn::Result<TokenStream2>
             }
         );
 
-        let encode_data = match abi {
-            Abi::Ink => quote! {
-                ::ink::abi::AbiEncodeWith::<::ink::abi::Ink>::encode_with(self)
-            },
+        let (encode_data, encode_data_to) = match abi {
+            Abi::Ink => (
+                quote! {
+                    ::ink::abi::AbiEncodeWith::<::ink::abi::Ink>::encode_with(self)
+                },
+                quote! {
+                    ::ink::abi::AbiEncodeWith::<::ink::abi::Ink>::encode_to_slice(self, buffer)
+                }
+            ),
             Abi::Sol => {
                 // For Solidity ABI encoding, only un-indexed fields are encoded as data.
                 let data_field_tys = data_fields.iter().map(|field| {
@@ -217,15 +222,24 @@ fn event_derive_struct(s: synstructure::Structure) -> syn::Result<TokenStream2>
                 let data_field_values = data_fields.iter().map(|field| {
                     &field.binding
                 });
-                quote! {
-                    match self {
-                        #pat => {
-                            ::ink::sol::encode_sequence::<( #( #data_field_tys, )* )>(
-                                &( #( #data_field_values, )* ),
-                            )
+                let ty = quote! { ( #( #data_field_tys, )* ) };
+                let val = quote! { ( #( #data_field_values, )* ) };
+                (
+                    quote! {
+                        match self {
+                            #pat => {
+                                ::ink::sol::encode_sequence::<#ty>(&#val)
+                            }
+                        }
+                    },
+                    quote! {
+                        match self {
+                            #pat => {
+                                ::ink::sol::encode_sequence_to::<#ty>(&#val, buffer)
+                            }
                         }
                     }
-                }
+                )
             },
         };
 
@@ -248,6 +262,10 @@ fn event_derive_struct(s: synstructure::Structure) -> syn::Result<TokenStream2>
             fn encode_data(&self) -> ::ink::prelude::vec::Vec<::core::primitive::u8> {
                 #encode_data
             }
+
+            fn encode_data_to(&self, buffer: &mut [::core::primitive::u8]) -> ::core::primitive::usize {
+                #encode_data_to
+            }
         })
     }))
 }
diff --git a/crates/ink/macro/src/tests/event.rs b/crates/ink/macro/src/tests/event.rs
@@ -57,6 +57,10 @@ fn unit_struct_works() {
                     fn encode_data(&self) -> ::ink::prelude::vec::Vec<::core::primitive::u8> {
                         ::ink::abi::AbiEncodeWith::<::ink::abi::Ink>::encode_with(self)
                     }
+
+                    fn encode_data_to(&self, buffer: &mut [::core::primitive::u8]) -> ::core::primitive::usize {
+                        ::ink::abi::AbiEncodeWith::<::ink::abi::Ink>::encode_to_slice(self, buffer)
+                    }
                 }
             };
         }
@@ -98,6 +102,10 @@ fn unit_struct_anonymous_has_no_topics() {
                     fn encode_data(&self) -> ::ink::prelude::vec::Vec<::core::primitive::u8> {
                         ::ink::abi::AbiEncodeWith::<::ink::abi::Ink>::encode_with(self)
                     }
+
+                    fn encode_data_to(&self, buffer: &mut [::core::primitive::u8]) -> ::core::primitive::usize {
+                        ::ink::abi::AbiEncodeWith::<::ink::abi::Ink>::encode_to_slice(self, buffer)
+                    }
                 }
             };
         } no_build
@@ -143,6 +151,10 @@ fn struct_with_fields_no_topics() {
                     fn encode_data(&self) -> ::ink::prelude::vec::Vec<::core::primitive::u8> {
                         ::ink::abi::AbiEncodeWith::<::ink::abi::Ink>::encode_with(self)
                     }
+
+                    fn encode_data_to(&self, buffer: &mut [::core::primitive::u8]) -> ::core::primitive::usize {
+                        ::ink::abi::AbiEncodeWith::<::ink::abi::Ink>::encode_to_slice(self, buffer)
+                    }
                 }
             };
         }
@@ -192,6 +204,10 @@ fn struct_with_fields_and_some_topics() {
                     fn encode_data(&self) -> ::ink::prelude::vec::Vec<::core::primitive::u8> {
                         ::ink::abi::AbiEncodeWith::<::ink::abi::Ink>::encode_with(self)
                     }
+
+                    fn encode_data_to(&self, buffer: &mut [::core::primitive::u8]) -> ::core::primitive::usize {
+                        ::ink::abi::AbiEncodeWith::<::ink::abi::Ink>::encode_to_slice(self, buffer)
+                    }
                 }
             };
         } no_build
@@ -234,6 +250,10 @@ fn custom_signature_topic() {
                     fn encode_data(&self) -> ::ink::prelude::vec::Vec<::core::primitive::u8> {
                         ::ink::abi::AbiEncodeWith::<::ink::abi::Ink>::encode_with(self)
                     }
+
+                    fn encode_data_to(&self, buffer: &mut [::core::primitive::u8]) -> ::core::primitive::usize {
+                        ::ink::abi::AbiEncodeWith::<::ink::abi::Ink>::encode_to_slice(self, buffer)
+                    }
                 }
             };
         } no_build
@@ -276,6 +296,10 @@ fn name_override_works() {
                     fn encode_data(&self) -> ::ink::prelude::vec::Vec<::core::primitive::u8> {
                         ::ink::abi::AbiEncodeWith::<::ink::abi::Ink>::encode_with(self)
                     }
+
+                    fn encode_data_to(&self, buffer: &mut [::core::primitive::u8]) -> ::core::primitive::usize {
+                        ::ink::abi::AbiEncodeWith::<::ink::abi::Ink>::encode_to_slice(self, buffer)
+                    }
                 }
             };
         } no_build
@@ -319,6 +343,10 @@ fn custom_signature_topic_precedence() {
                     fn encode_data(&self) -> ::ink::prelude::vec::Vec<::core::primitive::u8> {
                         ::ink::abi::AbiEncodeWith::<::ink::abi::Ink>::encode_with(self)
                     }
+
+                    fn encode_data_to(&self, buffer: &mut [::core::primitive::u8]) -> ::core::primitive::usize {
+                        ::ink::abi::AbiEncodeWith::<::ink::abi::Ink>::encode_to_slice(self, buffer)
+                    }
                 }
             };
         } no_build

Original file line number	Diff line number	Diff line change
`@@ -252,6 +252,10 @@ pub trait Event<Abi = crate::DefaultAbi>: AbiEncodeWith<Abi> {`
`252`	`252`
`253`	`253`	`/// ABI encode the dynamic data of this event.`
`254`	`254`	`fn encode_data(&self) -> ink_prelude::vec::Vec<u8>;`
	`255`	`+`
	`256`	`+ /// ABI encode the dynamic data of this event into the given buffer, and returns the`
	`257`	`+ /// number of bytes written.`
	`258`	`+ fn encode_data_to(&self, buffer: &mut [u8]) -> usize;`
`255`	`259`	`}`
`256`	`260`
`257`	`261`	`mod private {`
Original file line number	Diff line number	Diff line change
`@@ -57,6 +57,10 @@ fn unit_struct_works() {`
`57`	`57`	`fn encode_data(&self) -> ::ink::prelude::vec::Vec<::core::primitive::u8> {`
`58`	`58`	`::ink::abi::AbiEncodeWith::<::ink::abi::Ink>::encode_with(self)`
`59`	`59`	`}`
	`60`	`+`
	`61`	`+ fn encode_data_to(&self, buffer: &mut [::core::primitive::u8]) -> ::core::primitive::usize {`
	`62`	`+ ::ink::abi::AbiEncodeWith::<::ink::abi::Ink>::encode_to_slice(self, buffer)`
	`63`	`+ }`
`60`	`64`	`}`
`61`	`65`	`};`
`62`	`66`	`}`
`@@ -98,6 +102,10 @@ fn unit_struct_anonymous_has_no_topics() {`
`98`	`102`	`fn encode_data(&self) -> ::ink::prelude::vec::Vec<::core::primitive::u8> {`
`99`	`103`	`::ink::abi::AbiEncodeWith::<::ink::abi::Ink>::encode_with(self)`
`100`	`104`	`}`
	`105`	`+`
	`106`	`+ fn encode_data_to(&self, buffer: &mut [::core::primitive::u8]) -> ::core::primitive::usize {`
	`107`	`+ ::ink::abi::AbiEncodeWith::<::ink::abi::Ink>::encode_to_slice(self, buffer)`
	`108`	`+ }`
`101`	`109`	`}`
`102`	`110`	`};`
`103`	`111`	`} no_build`
`@@ -143,6 +151,10 @@ fn struct_with_fields_no_topics() {`
`143`	`151`	`fn encode_data(&self) -> ::ink::prelude::vec::Vec<::core::primitive::u8> {`
`144`	`152`	`::ink::abi::AbiEncodeWith::<::ink::abi::Ink>::encode_with(self)`
`145`	`153`	`}`
	`154`	`+`
	`155`	`+ fn encode_data_to(&self, buffer: &mut [::core::primitive::u8]) -> ::core::primitive::usize {`
	`156`	`+ ::ink::abi::AbiEncodeWith::<::ink::abi::Ink>::encode_to_slice(self, buffer)`
	`157`	`+ }`
`146`	`158`	`}`
`147`	`159`	`};`
`148`	`160`	`}`
`@@ -192,6 +204,10 @@ fn struct_with_fields_and_some_topics() {`
`192`	`204`	`fn encode_data(&self) -> ::ink::prelude::vec::Vec<::core::primitive::u8> {`
`193`	`205`	`::ink::abi::AbiEncodeWith::<::ink::abi::Ink>::encode_with(self)`
`194`	`206`	`}`
	`207`	`+`
	`208`	`+ fn encode_data_to(&self, buffer: &mut [::core::primitive::u8]) -> ::core::primitive::usize {`
	`209`	`+ ::ink::abi::AbiEncodeWith::<::ink::abi::Ink>::encode_to_slice(self, buffer)`
	`210`	`+ }`
`195`	`211`	`}`
`196`	`212`	`};`
`197`	`213`	`} no_build`
`@@ -234,6 +250,10 @@ fn custom_signature_topic() {`
`234`	`250`	`fn encode_data(&self) -> ::ink::prelude::vec::Vec<::core::primitive::u8> {`
`235`	`251`	`::ink::abi::AbiEncodeWith::<::ink::abi::Ink>::encode_with(self)`
`236`	`252`	`}`
	`253`	`+`
	`254`	`+ fn encode_data_to(&self, buffer: &mut [::core::primitive::u8]) -> ::core::primitive::usize {`
	`255`	`+ ::ink::abi::AbiEncodeWith::<::ink::abi::Ink>::encode_to_slice(self, buffer)`
	`256`	`+ }`
`237`	`257`	`}`
`238`	`258`	`};`
`239`	`259`	`} no_build`
`@@ -276,6 +296,10 @@ fn name_override_works() {`
`276`	`296`	`fn encode_data(&self) -> ::ink::prelude::vec::Vec<::core::primitive::u8> {`
`277`	`297`	`::ink::abi::AbiEncodeWith::<::ink::abi::Ink>::encode_with(self)`
`278`	`298`	`}`
	`299`	`+`
	`300`	`+ fn encode_data_to(&self, buffer: &mut [::core::primitive::u8]) -> ::core::primitive::usize {`
	`301`	`+ ::ink::abi::AbiEncodeWith::<::ink::abi::Ink>::encode_to_slice(self, buffer)`
	`302`	`+ }`
`279`	`303`	`}`
`280`	`304`	`};`
`281`	`305`	`} no_build`
`@@ -319,6 +343,10 @@ fn custom_signature_topic_precedence() {`
`319`	`343`	`fn encode_data(&self) -> ::ink::prelude::vec::Vec<::core::primitive::u8> {`
`320`	`344`	`::ink::abi::AbiEncodeWith::<::ink::abi::Ink>::encode_with(self)`
`321`	`345`	`}`
	`346`	`+`
	`347`	`+ fn encode_data_to(&self, buffer: &mut [::core::primitive::u8]) -> ::core::primitive::usize {`
	`348`	`+ ::ink::abi::AbiEncodeWith::<::ink::abi::Ink>::encode_to_slice(self, buffer)`
	`349`	`+ }`
`322`	`350`	`}`
`323`	`351`	`};`
`324`	`352`	`} no_build`