chains, graph: NoopRuntimeAdapter to reduce code duplication (#4424)

neysofu · web-flow · commit e1f04cf0584a · 2023-03-06T15:29:39.000+01:00
diff --git a/chain/arweave/src/chain.rs b/chain/arweave/src/chain.rs
@@ -1,6 +1,7 @@
 use graph::blockchain::client::ChainClient;
 use graph::blockchain::{
     BasicBlockchainBuilder, Block, BlockchainBuilder, BlockchainKind, EmptyNodeCapabilities,
+    NoopRuntimeAdapter,
 };
 use graph::cheap_clone::CheapClone;
 use graph::data::subgraph::UnifiedMappingApiVersion;
@@ -24,7 +25,6 @@ use std::sync::Arc;
 
 use crate::adapter::TriggerFilter;
 use crate::data_source::{DataSourceTemplate, UnresolvedDataSourceTemplate};
-use crate::runtime::RuntimeAdapter;
 use crate::trigger::{self, ArweaveTrigger};
 use crate::{
     codec,
@@ -170,7 +170,7 @@ impl Blockchain for Chain {
     }
 
     fn runtime_adapter(&self) -> Arc<dyn RuntimeAdapterTrait<Self>> {
-        Arc::new(RuntimeAdapter {})
+        Arc::new(NoopRuntimeAdapter::default())
     }
 
     fn chain_client(&self) -> Arc<ChainClient<Self>> {
diff --git a/chain/arweave/src/runtime/mod.rs b/chain/arweave/src/runtime/mod.rs
@@ -1,6 +1,3 @@
-pub use runtime_adapter::RuntimeAdapter;
-
 pub mod abi;
-pub mod runtime_adapter;
 
 mod generated;
diff --git a/chain/arweave/src/runtime/runtime_adapter.rs b/chain/arweave/src/runtime/runtime_adapter.rs
diff --git a/chain/cosmos/src/chain.rs b/chain/cosmos/src/chain.rs
@@ -2,7 +2,7 @@ use std::sync::Arc;
 
 use graph::blockchain::block_stream::FirehoseCursor;
 use graph::blockchain::client::ChainClient;
-use graph::blockchain::{BasicBlockchainBuilder, BlockchainBuilder};
+use graph::blockchain::{BasicBlockchainBuilder, BlockchainBuilder, NoopRuntimeAdapter};
 use graph::cheap_clone::CheapClone;
 use graph::data::subgraph::UnifiedMappingApiVersion;
 use graph::prelude::MetricsRegistry;
@@ -26,7 +26,6 @@ use crate::data_source::{
     DataSource, DataSourceTemplate, EventOrigin, UnresolvedDataSource, UnresolvedDataSourceTemplate,
 };
 use crate::trigger::CosmosTrigger;
-use crate::RuntimeAdapter;
 use crate::{codec, TriggerFilter};
 
 pub struct Chain {
@@ -168,7 +167,7 @@ impl Blockchain for Chain {
     }
 
     fn runtime_adapter(&self) -> Arc<dyn RuntimeAdapterTrait<Self>> {
-        Arc::new(RuntimeAdapter {})
+        Arc::new(NoopRuntimeAdapter::default())
     }
 
     fn chain_client(&self) -> Arc<ChainClient<Self>> {
diff --git a/chain/cosmos/src/lib.rs b/chain/cosmos/src/lib.rs
@@ -6,8 +6,6 @@ mod protobuf;
 pub mod runtime;
 mod trigger;
 
-pub use self::runtime::RuntimeAdapter;
-
 // ETHDEP: These concrete types should probably not be exposed.
 pub use data_source::{DataSource, DataSourceTemplate};
 
diff --git a/chain/cosmos/src/runtime/mod.rs b/chain/cosmos/src/runtime/mod.rs
@@ -1,7 +1,4 @@
-pub use runtime_adapter::RuntimeAdapter;
-
 pub mod abi;
-pub mod runtime_adapter;
 
 #[cfg(test)]
 mod test {
diff --git a/chain/cosmos/src/runtime/runtime_adapter.rs b/chain/cosmos/src/runtime/runtime_adapter.rs
diff --git a/chain/near/src/chain.rs b/chain/near/src/chain.rs
@@ -1,5 +1,7 @@
 use graph::blockchain::client::ChainClient;
-use graph::blockchain::{BasicBlockchainBuilder, BlockchainBuilder, BlockchainKind};
+use graph::blockchain::{
+    BasicBlockchainBuilder, BlockchainBuilder, BlockchainKind, NoopRuntimeAdapter,
+};
 use graph::cheap_clone::CheapClone;
 use graph::data::subgraph::UnifiedMappingApiVersion;
 use graph::firehose::FirehoseEndpoint;
@@ -24,7 +26,6 @@ use std::sync::Arc;
 
 use crate::adapter::TriggerFilter;
 use crate::data_source::{DataSourceTemplate, UnresolvedDataSourceTemplate};
-use crate::runtime::RuntimeAdapter;
 use crate::trigger::{self, NearTrigger};
 use crate::{
     codec,
@@ -214,7 +215,7 @@ impl Blockchain for Chain {
     }
 
     fn runtime_adapter(&self) -> Arc<dyn RuntimeAdapterTrait<Self>> {
-        Arc::new(RuntimeAdapter {})
+        Arc::new(NoopRuntimeAdapter::default())
     }
 
     fn chain_client(&self) -> Arc<ChainClient<Self>> {
diff --git a/chain/near/src/runtime/mod.rs b/chain/near/src/runtime/mod.rs
@@ -1,6 +1,3 @@
-pub use runtime_adapter::RuntimeAdapter;
-
 pub mod abi;
-pub mod runtime_adapter;
 
 mod generated;
diff --git a/chain/near/src/runtime/runtime_adapter.rs b/chain/near/src/runtime/runtime_adapter.rs
diff --git a/chain/substreams/src/chain.rs b/chain/substreams/src/chain.rs
@@ -1,7 +1,7 @@
 use crate::{data_source::*, EntityChanges, TriggerData, TriggerFilter, TriggersAdapter};
 use anyhow::Error;
 use graph::blockchain::client::ChainClient;
-use graph::blockchain::EmptyNodeCapabilities;
+use graph::blockchain::{EmptyNodeCapabilities, NoopRuntimeAdapter};
 use graph::firehose::FirehoseEndpoints;
 use graph::prelude::{BlockHash, LoggerFactory, MetricsRegistry};
 use graph::{
@@ -166,20 +166,10 @@ impl Blockchain for Chain {
         })
     }
     fn runtime_adapter(&self) -> Arc<dyn RuntimeAdapterTrait<Self>> {
-        Arc::new(RuntimeAdapter {})
+        Arc::new(NoopRuntimeAdapter::default())
     }
 
     fn chain_client(&self) -> Arc<ChainClient<Self>> {
         self.client.clone()
     }
 }
-
-pub struct RuntimeAdapter {}
-impl RuntimeAdapterTrait<crate::Chain> for RuntimeAdapter {
-    fn host_fns(
-        &self,
-        _ds: &<crate::Chain as Blockchain>::DataSource,
-    ) -> Result<Vec<blockchain::HostFn>, Error> {
-        todo!()
-    }
-}
diff --git a/graph/src/blockchain/empty_runtime_adapter.rs b/graph/src/blockchain/empty_runtime_adapter.rs
@@ -0,0 +1,22 @@
+use std::marker::PhantomData;
+
+use super::{Blockchain, HostFn, RuntimeAdapter};
+
+/// A [`RuntimeAdapter`] that does not expose any host functions.
+#[derive(Debug, Clone)]
+pub struct NoopRuntimeAdapter<C>(PhantomData<C>);
+
+impl<C> Default for NoopRuntimeAdapter<C> {
+    fn default() -> Self {
+        Self(PhantomData)
+    }
+}
+
+impl<C> RuntimeAdapter<C> for NoopRuntimeAdapter<C>
+where
+    C: Blockchain,
+{
+    fn host_fns(&self, _ds: &C::DataSource) -> anyhow::Result<Vec<HostFn>> {
+        Ok(vec![])
+    }
+}
diff --git a/graph/src/blockchain/mock.rs b/graph/src/blockchain/mock.rs
@@ -4,20 +4,19 @@ use crate::{
 };
 use anyhow::Error;
 use async_trait::async_trait;
-use core::fmt;
 use serde::Deserialize;
 use std::{convert::TryFrom, sync::Arc};
 
 use super::{
     block_stream::{self, FirehoseCursor},
     client::ChainClient,
-    HostFn, IngestorError, TriggerWithHandler,
+    EmptyNodeCapabilities, HostFn, IngestorError, TriggerWithHandler,
 };
 
 use super::{
     block_stream::BlockWithTriggers, Block, BlockPtr, Blockchain, BlockchainKind, DataSource,
-    DataSourceTemplate, NodeCapabilities, RuntimeAdapter, TriggerData, TriggerFilter,
-    TriggersAdapter, UnresolvedDataSource, UnresolvedDataSourceTemplate,
+    DataSourceTemplate, RuntimeAdapter, TriggerData, TriggerFilter, TriggersAdapter,
+    UnresolvedDataSource, UnresolvedDataSourceTemplate,
 };
 
 #[derive(Debug)]
@@ -245,21 +244,6 @@ impl<C: Blockchain> TriggerFilter<C> for MockTriggerFilter {
     }
 }
 
-#[derive(Debug)]
-pub struct MockNodeCapabilities;
-
-impl fmt::Display for MockNodeCapabilities {
-    fn fmt(&self, _f: &mut fmt::Formatter<'_>) -> fmt::Result {
-        todo!()
-    }
-}
-
-impl<C: Blockchain> NodeCapabilities<C> for MockNodeCapabilities {
-    fn from_data_sources(_data_sources: &[C::DataSource]) -> Self {
-        todo!()
-    }
-}
-
 pub struct MockRuntimeAdapter;
 
 impl<C: Blockchain> RuntimeAdapter<C> for MockRuntimeAdapter {
@@ -289,7 +273,7 @@ impl Blockchain for MockBlockchain {
 
     type TriggerFilter = MockTriggerFilter;
 
-    type NodeCapabilities = MockNodeCapabilities;
+    type NodeCapabilities = EmptyNodeCapabilities<Self>;
 
     fn triggers_adapter(
         &self,
diff --git a/graph/src/blockchain/mod.rs b/graph/src/blockchain/mod.rs
@@ -6,6 +6,7 @@ pub mod block_stream;
 mod builder;
 pub mod client;
 mod empty_node_capabilities;
+mod empty_runtime_adapter;
 pub mod firehose_block_ingestor;
 pub mod firehose_block_stream;
 pub mod mock;
@@ -46,6 +47,7 @@ use web3::types::H256;
 pub use block_stream::{ChainHeadUpdateListener, ChainHeadUpdateStream, TriggersAdapter};
 pub use builder::{BasicBlockchainBuilder, BlockchainBuilder};
 pub use empty_node_capabilities::EmptyNodeCapabilities;
+pub use empty_runtime_adapter::NoopRuntimeAdapter;
 pub use types::{BlockHash, BlockPtr, ChainIdentifier};
 
 use self::{
