Merge pull request #37 from propeller-heads/zz/update-protobuf

Update protobuf and Balancer Substreams

substreams/crates/tycho-substreams/Changelog.md

@@ -0,0 +1,12 @@
+# Changelog
+
+## 0.2.0
+
+### Updated
+
+- Protobuf struct updated to align with recent changes in the indexer.
+
+### Changed
+
+- Removed the distinction between VM and native implementations. Now, there is a single implementation type that can extract both contracts and protocol state.
+- Enabled the attachment of dynamic attributes to protocol components.

substreams/crates/tycho-substreams/src/contract.rs

@@ -83,9 +83,8 @@ impl From<InterimContractChange> for tycho::ContractChange {
 ///   model.
 /// * `inclusion_predicate` - A closure that determines if a contract's address is of interest for
 ///   the collection of changes. Only contracts satisfying this predicate are included.
-/// * `transaction_contract_changes` - A mutable reference to a map where extracted contract changes
-///   are stored. Keyed by transaction index, it aggregates changes into
-///   `tycho::TransactionContractChanges`.
+/// * `transaction_changes` - A mutable reference to a map where extracted contract changes are
+///   stored. Keyed by transaction index, it aggregates changes into `tycho::TransactionChanges`.
 ///
 /// ## Panics
 /// Panics if the provided block is not an extended block model, as indicated by its detail level.
@@ -94,7 +93,7 @@ impl From<InterimContractChange> for tycho::ContractChange {
 /// The function iterates over transactions and their calls within the block, collecting contract
 /// changes (storage, balance, code) that pass the inclusion predicate. Changes are then sorted by
 /// their ordinals to maintain the correct sequence of events. Aggregated changes for each contract
-/// are stored in `transaction_contract_changes`, categorized by transaction index.
+/// are stored in `transaction_changes`, categorized by transaction index.
 ///
 /// Contracts created within the block are tracked to differentiate between new and existing
 /// contracts. The aggregation process respects transaction boundaries, ensuring that changes are
@@ -102,7 +101,7 @@ impl From<InterimContractChange> for tycho::ContractChange {
 pub fn extract_contract_changes<F: Fn(&[u8]) -> bool>(
     block: &eth::v2::Block,
     inclusion_predicate: F,
-    transaction_contract_changes: &mut HashMap<u64, tycho::TransactionContractChanges>,
+    transaction_changes: &mut HashMap<u64, tycho::TransactionChanges>,
 ) {
     if block.detail_level != Into::<i32>::into(DetailLevel::DetaillevelExtended) {
         panic!("Only extended blocks are supported");
@@ -215,9 +214,9 @@ pub fn extract_contract_changes<F: Fn(&[u8]) -> bool>(
                 !balance_changes.is_empty() ||
                 !code_changes.is_empty()
             {
-                transaction_contract_changes
+                transaction_changes
                     .entry(block_tx.index.into())
-                    .or_insert_with(|| tycho::TransactionContractChanges::new(&(block_tx.into())))
+                    .or_insert_with(|| tycho::TransactionChanges::new(&(block_tx.into())))
                     .contract_changes
                     .extend(
                         changed_contracts

substreams/crates/tycho-substreams/src/models.rs

@@ -6,12 +6,14 @@ pub use crate::pb::tycho::evm::v1::*;
 impl TransactionContractChanges {
     /// Creates a new empty `TransactionContractChanges` instance.
     pub fn new(tx: &Transaction) -> Self {
-        Self {
-            tx: Some(tx.clone()),
-            contract_changes: vec![],
-            component_changes: vec![],
-            balance_changes: vec![],
-        }
+        Self { tx: Some(tx.clone()), ..Default::default() }
+    }
+}
+
+impl TransactionChanges {
+    /// Creates a new empty `TransactionChanges` instance.
+    pub fn new(tx: &Transaction) -> Self {
+        Self { tx: Some(tx.clone()), ..Default::default() }
     }
 }
 

substreams/crates/tycho-substreams/src/pb/tycho.evm.v1.rs

@@ -115,6 +115,87 @@ pub struct BalanceChange {
     #[prost(bytes="vec", tag="3")]
     pub component_id: ::prost::alloc::vec::Vec<u8>,
 }
+// Native entities
+
+/// A component is a set of attributes that are associated with a custom entity.
+#[allow(clippy::derive_partial_eq_without_eq)]
+#[derive(Clone, PartialEq, ::prost::Message)]
+pub struct EntityChanges {
+    /// A unique identifier of the entity within the protocol.
+    #[prost(string, tag="1")]
+    pub component_id: ::prost::alloc::string::String,
+    /// The set of attributes that are associated with the entity.
+    #[prost(message, repeated, tag="2")]
+    pub attributes: ::prost::alloc::vec::Vec<Attribute>,
+}
+// VM entities
+
+/// A key value entry into contract storage.
+#[allow(clippy::derive_partial_eq_without_eq)]
+#[derive(Clone, PartialEq, ::prost::Message)]
+pub struct ContractSlot {
+    /// A contract's storage slot.
+    #[prost(bytes="vec", tag="2")]
+    pub slot: ::prost::alloc::vec::Vec<u8>,
+    /// The new value for this storage slot.
+    #[prost(bytes="vec", tag="3")]
+    pub value: ::prost::alloc::vec::Vec<u8>,
+}
+/// Changes made to a single contract's state.
+#[allow(clippy::derive_partial_eq_without_eq)]
+#[derive(Clone, PartialEq, ::prost::Message)]
+pub struct ContractChange {
+    /// The contract's address
+    #[prost(bytes="vec", tag="1")]
+    pub address: ::prost::alloc::vec::Vec<u8>,
+    /// The new balance of the contract, empty bytes indicates no change.
+    #[prost(bytes="vec", tag="2")]
+    pub balance: ::prost::alloc::vec::Vec<u8>,
+    /// The new code of the contract, empty bytes indicates no change.
+    #[prost(bytes="vec", tag="3")]
+    pub code: ::prost::alloc::vec::Vec<u8>,
+    /// The changes to this contract's slots, empty sequence indicates no change.
+    #[prost(message, repeated, tag="4")]
+    pub slots: ::prost::alloc::vec::Vec<ContractSlot>,
+    /// Whether this is an update, a creation or a deletion.
+    #[prost(enumeration="ChangeType", tag="5")]
+    pub change: i32,
+}
+// Aggregate entities
+
+/// A set of changes aggregated by transaction.
+#[allow(clippy::derive_partial_eq_without_eq)]
+#[derive(Clone, PartialEq, ::prost::Message)]
+pub struct TransactionChanges {
+    /// The transaction instance that results in the changes.
+    #[prost(message, optional, tag="1")]
+    pub tx: ::core::option::Option<Transaction>,
+    /// Contains the changes induced by the above transaction, aggregated on a per-contract basis.
+    /// Contains the contract changes induced by the above transaction, usually for tracking VM components.
+    #[prost(message, repeated, tag="2")]
+    pub contract_changes: ::prost::alloc::vec::Vec<ContractChange>,
+    /// Contains the entity changes induced by the above transaction.
+    /// Usually for tracking native components or used for VM extensions (plugins).
+    #[prost(message, repeated, tag="3")]
+    pub entity_changes: ::prost::alloc::vec::Vec<EntityChanges>,
+    /// An array of newly added components.
+    #[prost(message, repeated, tag="4")]
+    pub component_changes: ::prost::alloc::vec::Vec<ProtocolComponent>,
+    /// An array of balance changes to components.
+    #[prost(message, repeated, tag="5")]
+    pub balance_changes: ::prost::alloc::vec::Vec<BalanceChange>,
+}
+/// A set of transaction changes within a single block.
+#[allow(clippy::derive_partial_eq_without_eq)]
+#[derive(Clone, PartialEq, ::prost::Message)]
+pub struct BlockChanges {
+    /// The block for which these changes are collectively computed.
+    #[prost(message, optional, tag="1")]
+    pub block: ::core::option::Option<Block>,
+    /// The set of transaction changes observed in the specified block.
+    #[prost(message, repeated, tag="2")]
+    pub changes: ::prost::alloc::vec::Vec<TransactionChanges>,
+}
 /// Enum to specify the type of a change.
 #[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)]
 #[repr(i32)]
@@ -206,19 +287,9 @@ impl ImplementationType {
         }
     }
 }
+// WARNING: DEPRECATED. Please use common.proto's TransactionChanges and BlockChanges instead.
 // This file contains the definition for the native integration of Substreams.
 
-/// A component is a set of attributes that are associated with a custom entity.
-#[allow(clippy::derive_partial_eq_without_eq)]
-#[derive(Clone, PartialEq, ::prost::Message)]
-pub struct EntityChanges {
-    /// A unique identifier of the entity within the protocol.
-    #[prost(string, tag="1")]
-    pub component_id: ::prost::alloc::string::String,
-    /// The set of attributes that are associated with the entity.
-    #[prost(message, repeated, tag="2")]
-    pub attributes: ::prost::alloc::vec::Vec<Attribute>,
-}
 #[allow(clippy::derive_partial_eq_without_eq)]
 #[derive(Clone, PartialEq, ::prost::Message)]
 pub struct TransactionEntityChanges {
@@ -293,39 +364,9 @@ pub struct BlockTransactionProtocolComponents {
     #[prost(message, repeated, tag="1")]
     pub tx_components: ::prost::alloc::vec::Vec<TransactionProtocolComponents>,
 }
+// WARNING: DEPRECATED. Please use common.proto's TransactionChanges and BlockChanges instead.
 // This file contains proto definitions specific to the VM integration.
 
-/// A key value entry into contract storage.
-#[allow(clippy::derive_partial_eq_without_eq)]
-#[derive(Clone, PartialEq, ::prost::Message)]
-pub struct ContractSlot {
-    /// A contract's storage slot.
-    #[prost(bytes="vec", tag="2")]
-    pub slot: ::prost::alloc::vec::Vec<u8>,
-    /// The new value for this storage slot.
-    #[prost(bytes="vec", tag="3")]
-    pub value: ::prost::alloc::vec::Vec<u8>,
-}
-/// Changes made to a single contract's state.
-#[allow(clippy::derive_partial_eq_without_eq)]
-#[derive(Clone, PartialEq, ::prost::Message)]
-pub struct ContractChange {
-    /// The contract's address
-    #[prost(bytes="vec", tag="1")]
-    pub address: ::prost::alloc::vec::Vec<u8>,
-    /// The new native balance of the contract, empty bytes indicates no change.
-    #[prost(bytes="vec", tag="2")]
-    pub balance: ::prost::alloc::vec::Vec<u8>,
-    /// The new code of the contract, empty bytes indicates no change.
-    #[prost(bytes="vec", tag="3")]
-    pub code: ::prost::alloc::vec::Vec<u8>,
-    /// The changes to this contract's slots, empty sequence indicates no change.
-    #[prost(message, repeated, tag="4")]
-    pub slots: ::prost::alloc::vec::Vec<ContractSlot>,
-    /// Whether this is an update, a creation or a deletion.
-    #[prost(enumeration="ChangeType", tag="5")]
-    pub change: i32,
-}
 /// A set of changes aggregated by transaction.
 #[allow(clippy::derive_partial_eq_without_eq)]
 #[derive(Clone, PartialEq, ::prost::Message)]
@@ -334,10 +375,9 @@ pub struct TransactionContractChanges {
     #[prost(message, optional, tag="1")]
     pub tx: ::core::option::Option<Transaction>,
     /// Contains the changes induced by the above transaction, aggregated on a per-contract basis.
-    /// Must include changes to every contract that is tracked by all ProtocolComponents.
     #[prost(message, repeated, tag="2")]
     pub contract_changes: ::prost::alloc::vec::Vec<ContractChange>,
-    /// An array of any component changes.
+    /// An array of newly added components.
     #[prost(message, repeated, tag="3")]
     pub component_changes: ::prost::alloc::vec::Vec<ProtocolComponent>,
     /// An array of balance changes to components.