chore: clean up ambient (propeller-heads#136)

louise-poole · web-flow · commit ad0a391f729f · 2025-01-27T10:36:13.000+02:00
* fix: remove unnecessary tx field in ProtocolComponent

* chore: move ambient protobuf files to ambient module

* chore: remove dependency on common message types

This allows us to isolate the ambient specific messages within the ambient module

* feat: update ambient substream with new message structs

* chore: update substream configs

And remove use of deprecated BlockContractChanges.

* feat: implement From for AmbientProtocolComponent to ProtocolComponent
diff --git a/buf.yaml b/buf.yaml
@@ -3,7 +3,6 @@ modules:
   - path: proto
     excludes:
       - proto/sf
-  - path: substreams/ethereum-ambient/proto
 lint:
   use:
     - BASIC
diff --git a/proto/tycho/evm/v1/common.proto b/proto/tycho/evm/v1/common.proto
@@ -90,8 +90,6 @@ message ProtocolComponent {
   ChangeType change = 5;
   /// Represents the functionality of the component.
   ProtocolType protocol_type = 6;
-  // Transaction where this component was created
-  Transaction tx = 7;
 }
 
 // A struct for following the changes of Total Value Locked (TVL) of a protocol component.
diff --git a/substreams/Cargo.lock b/substreams/Cargo.lock
diff --git a/substreams/crates/tycho-substreams/src/models.rs b/substreams/crates/tycho-substreams/src/models.rs
@@ -2,7 +2,7 @@ use std::collections::{HashMap, HashSet};
 use substreams_ethereum::pb::eth::v2::{self as sf, StorageChange};
 
 // re-export the protobuf types here.
-pub use crate::pb::tycho::{ambient::v1::*, evm::v1::*};
+pub use crate::pb::tycho::evm::v1::*;
 
 impl TransactionContractChanges {
     /// Creates a new empty `TransactionContractChanges` instance.
@@ -213,15 +213,14 @@ impl ProtocolComponent {
     /// ## Parameters
     /// - `id`: Identifier for the component.
     /// - `tx`: Reference to the associated transaction.
-    pub fn new(id: &str, tx: &Transaction) -> Self {
+    pub fn new(id: &str) -> Self {
         Self {
             id: id.to_string(),
             tokens: Vec::new(),
             contracts: Vec::new(),
             static_att: Vec::new(),
             change: ChangeType::Creation.into(),
             protocol_type: None,
-            tx: Some(tx.clone()),
         }
     }
 
@@ -233,15 +232,14 @@ impl ProtocolComponent {
     /// ## Parameters
     /// - `id`: Contract address to be encoded and set as the component's ID.
     /// - `tx`: Reference to the associated transaction.
-    pub fn at_contract(id: &[u8], tx: &Transaction) -> Self {
+    pub fn at_contract(id: &[u8]) -> Self {
         Self {
             id: format!("0x{}", hex::encode(id)),
             tokens: Vec::new(),
             contracts: vec![id.to_vec()],
             static_att: Vec::new(),
             change: ChangeType::Creation.into(),
             protocol_type: None,
-            tx: Some(tx.clone()),
         }
     }
 
diff --git a/substreams/crates/tycho-substreams/src/pb/mod.rs b/substreams/crates/tycho-substreams/src/pb/mod.rs
@@ -1,12 +1,5 @@
 // @generated
 pub mod tycho {
-    pub mod ambient {
-        // @@protoc_insertion_point(attribute:tycho.ambient.v1)
-        pub mod v1 {
-            include!("tycho.ambient.v1.rs");
-            // @@protoc_insertion_point(tycho.ambient.v1)
-        }
-    }
     pub mod evm {
         // @@protoc_insertion_point(attribute:tycho.evm.v1)
         pub mod v1 {
diff --git a/substreams/crates/tycho-substreams/src/pb/tycho.evm.v1.rs b/substreams/crates/tycho-substreams/src/pb/tycho.evm.v1.rs
@@ -95,9 +95,6 @@ pub struct ProtocolComponent {
     /// / Represents the functionality of the component.
     #[prost(message, optional, tag="6")]
     pub protocol_type: ::core::option::Option<ProtocolType>,
-    /// Transaction where this component was created
-    #[prost(message, optional, tag = "7")]
-    pub tx: ::core::option::Option<Transaction>,
 }
 /// A struct for following the changes of Total Value Locked (TVL) of a protocol component.
 /// Note that if a ProtocolComponent contains multiple contracts, the TVL is tracked for the component as a whole.
diff --git a/substreams/ethereum-ambient/Cargo.toml b/substreams/ethereum-ambient/Cargo.toml
@@ -8,7 +8,7 @@ name = "substreams_ethereum_ambient"
 crate-type = ["cdylib"]
 
 [dependencies]
-tycho-substreams = { git = "https://github.com/propeller-heads/tycho-protocol-sdk.git", rev = "b8aeaa3" }
+tycho-substreams = { git = "https://github.com/propeller-heads/tycho-protocol-sdk.git", rev = "f90c33b" }
 substreams = "0.5.22"
 substreams-ethereum = "0.9.9"
 prost = "0.11"
diff --git a/substreams/ethereum-ambient/Readme.md b/substreams/ethereum-ambient/Readme.md
@@ -9,7 +9,7 @@ Modules Description
 *   **Type**: Map
 *   **Purpose**: This module detects new pools within the Ethereum blockchain and balance changes.
 *   **Inputs**: Ethereum block data (`sf.ethereum.type.v2.Block`).
-*   **Output**: Emits data of type `proto:tycho.evm.state.v1.BlockPoolChanges`.
+*   **Output**: Emits data of type `proto:tycho.ambient.v1.BlockPoolChanges`.
 
 ### `store_pools_balances`
 
@@ -26,10 +26,10 @@ Modules Description
 ### `map_changes`
 
 *   **Type**: Map
-*   **Purpose**: This module integrates all the processed information to generate comprehensive `BlockContractChanges`. It considers new pools, balance changes and contract changes.
+*   **Purpose**: This module integrates all the processed information to generate comprehensive `BlockChanges`. It considers new pools, balance changes and contract changes.
 *   **Inputs**:
     *   Ethereum block data (`sf.ethereum.type.v2.Block`).
     *   Data from `map_pool_changes`.
     *   Data from `store_pools_balances`.
     *   Data from `store_pools`.
-*   **Output**: Emits `proto:tycho.evm.state.v1.BlockContractChanges`.
+*   **Output**: Emits `proto:tycho.evm.state.v1.BlockChanges`.
diff --git a/substreams/ethereum-ambient/proto/ambient.proto b/substreams/ethereum-ambient/proto/ambient.proto
@@ -2,8 +2,6 @@ syntax = "proto3";
 
 package tycho.ambient.v1;
 
-import "tycho/evm/v1/common.proto";
-
 // A change to a pool's balance. Ambient specific.
 message AmbientBalanceDelta {
   // The address of the ERC20 token whose balance changed.
@@ -14,14 +12,25 @@ message AmbientBalanceDelta {
   bytes token_delta = 3;
   // Used to determine the order of the balance changes. Necessary for the balance store.
   uint64 ordinal = 4;
-  // Transaction where the balance changed.
-  tycho.evm.v1.Transaction tx = 5;
+  // Transaction index of the balance change
+  uint64 tx_index = 5;
+}
+
+message AmbientProtocolComponent {
+  // A unique identifier for the component within the protocol.
+  string id = 1;
+  // Addresses of the ERC20 tokens used by the component.
+  repeated bytes tokens = 2;
+  // Ambient pool index [static attribute for ambient pools]
+  bytes pool_index = 3;
+  // Transaction index for the component creation
+  uint64 tx_index = 4;
 }
 
 // Ambient pool changes within a single block
 message BlockPoolChanges {
   // New protocol components added in this block
-  repeated tycho.evm.v1.ProtocolComponent protocol_components = 1;
-  // Balance changes to pools in this block
+  repeated AmbientProtocolComponent new_components = 1;
+    // Balance changes on this block
   repeated AmbientBalanceDelta balance_deltas = 2;
 }
diff --git a/substreams/ethereum-ambient/src/contracts/main.rs b/substreams/ethereum-ambient/src/contracts/main.rs
@@ -1,13 +1,16 @@
 use anyhow::{anyhow, bail};
+use ethabi::{decode, ParamType};
+use hex_literal::hex;
+use substreams_ethereum::pb::eth::v2::Call;
+
 use tycho_substreams::models::{
     Attribute, ChangeType, FinancialType, ImplementationType, ProtocolComponent, ProtocolType,
-    Transaction,
 };
 
-use crate::utils::{decode_flows_from_output, encode_pool_hash};
-use ethabi::{decode, ParamType};
-use hex_literal::hex;
-use substreams_ethereum::pb::eth::v2::Call;
+use crate::{
+    pb::tycho::ambient::v1::AmbientProtocolComponent,
+    utils::{decode_flows_from_output, encode_pool_hash},
+};
 
 pub const AMBIENT_CONTRACT: [u8; 20] = hex!("aaaaaaaaa24eeeb8d57d431224f73832bc34f688");
 pub const USER_CMD_FN_SIG: [u8; 4] = hex!("a15112f9");
@@ -91,10 +94,11 @@ pub fn decode_direct_swap_call(
         bail!("Failed to decode swap call inputs.".to_string());
     }
 }
+
 pub fn decode_pool_init(
     call: &Call,
-    tx: Transaction,
-) -> Result<Option<ProtocolComponent>, anyhow::Error> {
+    tx_index: u64,
+) -> Result<Option<AmbientProtocolComponent>, anyhow::Error> {
     // Decode external call to UserCmd
     if let Ok(external_params) = decode(USER_CMD_EXTERNAL_ABI, &call.input[4..]) {
         let cmd_bytes = external_params[1]
@@ -134,28 +138,14 @@ pub fn decode_pool_init(
                 let pool_index = pool_index_buf.to_vec();
                 let pool_hash = encode_pool_hash(base.clone(), quote.clone(), pool_index.clone());
 
-                let static_attribute = Attribute {
-                    name: String::from("pool_index"),
-                    value: pool_index,
-                    change: ChangeType::Creation.into(),
-                };
-
                 let mut tokens: Vec<Vec<u8>> = vec![base.clone(), quote.clone()];
                 tokens.sort();
 
-                let new_component = ProtocolComponent {
+                let new_component = AmbientProtocolComponent {
                     id: hex::encode(pool_hash),
                     tokens,
-                    contracts: vec![AMBIENT_CONTRACT.to_vec()],
-                    static_att: vec![static_attribute],
-                    change: ChangeType::Creation.into(),
-                    protocol_type: Some(ProtocolType {
-                        name: "ambient_pool".to_string(),
-                        attribute_schema: vec![],
-                        financial_type: FinancialType::Swap.into(),
-                        implementation_type: ImplementationType::Vm.into(),
-                    }),
-                    tx: Some(tx.clone()),
+                    pool_index,
+                    tx_index,
                 };
                 Ok(Some(new_component))
             } else {
@@ -168,3 +158,25 @@ pub fn decode_pool_init(
         bail!("Failed to decode ABI external call.".to_string());
     }
 }
+
+impl From<AmbientProtocolComponent> for ProtocolComponent {
+    fn from(component: AmbientProtocolComponent) -> Self {
+        ProtocolComponent {
+            id: component.id,
+            tokens: component.tokens,
+            contracts: vec![AMBIENT_CONTRACT.to_vec()],
+            static_att: vec![Attribute {
+                name: "pool_index".to_string(),
+                value: component.pool_index,
+                change: ChangeType::Creation.into(),
+            }],
+            change: ChangeType::Creation.into(),
+            protocol_type: Some(ProtocolType {
+                name: "ambient_pool".to_string(),
+                attribute_schema: vec![],
+                financial_type: FinancialType::Swap.into(),
+                implementation_type: ImplementationType::Vm.into(),
+            }),
+        }
+    }
+}
diff --git a/substreams/ethereum-ambient/src/lib.rs b/substreams/ethereum-ambient/src/lib.rs
@@ -1,4 +1,5 @@
 mod contracts;
+mod pb;
 
 pub use modules::*;
 mod modules;
diff --git a/substreams/ethereum-ambient/src/modules/1_map_pool_changes.rs b/substreams/ethereum-ambient/src/modules/1_map_pool_changes.rs
@@ -20,24 +20,17 @@ use crate::{
             decode_warm_path_user_cmd_call, AMBIENT_WARMPATH_CONTRACT, USER_CMD_WARMPATH_FN_SIG,
         },
     },
+    pb::tycho::ambient::v1::{AmbientBalanceDelta, BlockPoolChanges},
     utils::from_u256_to_vec,
 };
-use tycho_substreams::{
-    models::{AmbientBalanceDelta, BlockPoolChanges},
-    prelude::Transaction,
-};
 
 #[substreams::handlers::map]
 fn map_pool_changes(block: eth::v2::Block) -> Result<BlockPoolChanges, substreams::errors::Error> {
-    let mut protocol_components = Vec::new();
     let mut balance_deltas = Vec::new();
+    let mut protocol_components = Vec::new();
+
     for block_tx in block.transactions() {
-        let tx = Transaction {
-            hash: block_tx.hash.clone(),
-            from: block_tx.from.clone(),
-            to: block_tx.to.clone(),
-            index: block_tx.index as u64,
-        };
+        let tx_index = block_tx.index as u64;
         // extract storage changes
         let mut storage_changes = block_tx
             .calls
@@ -66,7 +59,7 @@ fn map_pool_changes(block: eth::v2::Block) -> Result<BlockPoolChanges, substream
 
             if call.address == AMBIENT_CONTRACT && selector == USER_CMD_FN_SIG {
                 // Extract pool creations
-                if let Some(protocol_component) = decode_pool_init(call, tx.clone())? {
+                if let Some(protocol_component) = decode_pool_init(call, tx_index)? {
                     protocol_components.push(protocol_component);
                 }
             }
@@ -109,19 +102,18 @@ fn map_pool_changes(block: eth::v2::Block) -> Result<BlockPoolChanges, substream
                 token_type: "base".to_string(),
                 token_delta: from_u256_to_vec(base_flow),
                 ordinal: call.index as u64,
-                tx: Some(tx.clone()),
+                tx_index,
             };
             let quote_balance_delta = AmbientBalanceDelta {
                 pool_hash: Vec::from(pool_hash),
                 token_type: "quote".to_string(),
                 token_delta: from_u256_to_vec(quote_flow),
                 ordinal: call.index as u64,
-                tx: Some(tx.clone()),
+                tx_index,
             };
             balance_deltas.extend([base_balance_delta.clone(), quote_balance_delta.clone()]);
         }
     }
     balance_deltas.sort_by_key(|delta| (delta.ordinal, delta.token_type.clone()));
-    let pool_changes = BlockPoolChanges { protocol_components, balance_deltas };
-    Ok(pool_changes)
+    Ok(BlockPoolChanges { balance_deltas, new_components: protocol_components })
 }
diff --git a/substreams/ethereum-ambient/src/modules/2_store_pool_balances.rs b/substreams/ethereum-ambient/src/modules/2_store_pool_balances.rs
@@ -2,12 +2,12 @@ use substreams::{
     scalar::BigInt,
     store::{StoreAdd, StoreAddBigInt, StoreNew},
 };
-use tycho_substreams::models::BlockPoolChanges;
+
+use crate::pb::tycho::ambient::v1::BlockPoolChanges;
 
 #[substreams::handlers::store]
 pub fn store_pool_balances(changes: BlockPoolChanges, balance_store: StoreAddBigInt) {
-    let deltas = changes.balance_deltas.clone();
-    for balance_delta in deltas {
+    for balance_delta in changes.balance_deltas {
         let pool_hash_hex = hex::encode(&balance_delta.pool_hash);
         balance_store.add(
             balance_delta.ordinal,
diff --git a/substreams/ethereum-ambient/src/modules/2_store_pools.rs b/substreams/ethereum-ambient/src/modules/2_store_pools.rs
@@ -1,9 +1,12 @@
 use substreams::store::{StoreNew, StoreSet, StoreSetProto};
-use tycho_substreams::models::{BlockPoolChanges, ProtocolComponent};
+use tycho_substreams::models::ProtocolComponent;
+
+use crate::pb::tycho::ambient::v1::BlockPoolChanges;
 
 #[substreams::handlers::store]
 pub fn store_pools(changes: BlockPoolChanges, component_store: StoreSetProto<ProtocolComponent>) {
-    for component in changes.protocol_components {
-        component_store.set(0, component.id.clone(), &component);
+    for component in changes.new_components {
+        let protocol_component: ProtocolComponent = component.into();
+        component_store.set(0, protocol_component.id.clone(), &protocol_component);
     }
 }
diff --git a/substreams/ethereum-ambient/src/modules/3_map_changes.rs b/substreams/ethereum-ambient/src/modules/3_map_changes.rs
diff --git a/substreams/ethereum-ambient/src/pb/mod.rs b/substreams/ethereum-ambient/src/pb/mod.rs
diff --git a/substreams/ethereum-ambient/src/pb/tycho.ambient.v1.rs b/substreams/ethereum-ambient/src/pb/tycho.ambient.v1.rs
diff --git a/substreams/ethereum-ambient/substreams.yaml b/substreams/ethereum-ambient/substreams.yaml

Original file line number	Diff line number	Diff line change
`@@ -90,8 +90,6 @@ message ProtocolComponent {`
`90`	`90`	`ChangeType change = 5;`
`91`	`91`	`/// Represents the functionality of the component.`
`92`	`92`	`ProtocolType protocol_type = 6;`
`93`		`- // Transaction where this component was created`
`94`		`- Transaction tx = 7;`
`95`	`93`	`}`
`96`	`94`
`97`	`95`	`// A struct for following the changes of Total Value Locked (TVL) of a protocol component.`