From 11de62ecbc5acfd19cbe208346c405318f2bf663 Mon Sep 17 00:00:00 2001 From: incrypto32 Date: Fri, 31 Jan 2025 17:12:22 +0400 Subject: [PATCH] Subgraph Composition: Support declared calls for subgraph datasources --- chain/ethereum/src/adapter.rs | 13 +- chain/ethereum/src/data_source.rs | 520 ++++---------- chain/ethereum/src/ethereum_adapter.rs | 3 +- chain/ethereum/src/lib.rs | 4 +- chain/ethereum/src/runtime/runtime_adapter.rs | 6 +- chain/ethereum/src/trigger.rs | 2 +- graph/src/data_source/common.rs | 673 +++++++++++++++++- graph/src/data_source/mod.rs | 4 +- graph/src/data_source/subgraph.rs | 76 +- runtime/wasm/src/module/mod.rs | 10 + .../tests/chain/ethereum/manifest.rs | 71 ++ 11 files changed, 953 insertions(+), 429 deletions(-) diff --git a/chain/ethereum/src/adapter.rs b/chain/ethereum/src/adapter.rs index f78ff1b0bec..469e8932b5e 100644 --- a/chain/ethereum/src/adapter.rs +++ b/chain/ethereum/src/adapter.rs @@ -1,8 +1,9 @@ use anyhow::Error; -use ethabi::{Error as ABIError, Function, ParamType, Token}; +use ethabi::{Error as ABIError, ParamType, Token}; use graph::blockchain::ChainIdentifier; use graph::components::subgraph::MappingError; use graph::data::store::ethereum::call; +use graph::data_source::common::ContractCall; use graph::firehose::CallToFilter; use graph::firehose::CombinedFilter; use graph::firehose::LogFilter; @@ -93,16 +94,6 @@ impl EventSignatureWithTopics { } } -#[derive(Clone, Debug)] -pub struct ContractCall { - pub contract_name: String, - pub address: Address, - pub block_ptr: BlockPtr, - pub function: Function, - pub args: Vec, - pub gas: Option, -} - #[derive(Error, Debug)] pub enum EthereumRpcError { #[error("call error: {0}")] diff --git a/chain/ethereum/src/data_source.rs b/chain/ethereum/src/data_source.rs index fa2cb745524..a2da3e6cb4e 100644 --- a/chain/ethereum/src/data_source.rs +++ b/chain/ethereum/src/data_source.rs @@ -5,21 +5,19 @@ use graph::components::metrics::subgraph::SubgraphInstanceMetrics; use graph::components::store::{EthereumCallCache, StoredDynamicDataSource}; use graph::components::subgraph::{HostMetrics, InstanceDSTemplateInfo, MappingError}; use graph::components::trigger_processor::RunnableTriggers; -use graph::data::value::Word; -use graph::data_source::common::{MappingABI, UnresolvedMappingABI}; -use graph::data_source::CausalityRegion; +use graph::data_source::common::{ + CallDecls, DeclaredCall, FindMappingABI, MappingABI, UnresolvedMappingABI, +}; +use graph::data_source::{CausalityRegion, MappingTrigger as MappingTriggerType}; use graph::env::ENV_VARS; use graph::futures03::future::try_join; use graph::futures03::stream::FuturesOrdered; use graph::futures03::TryStreamExt; use graph::prelude::ethabi::ethereum_types::H160; -use graph::prelude::ethabi::{StateMutability, Token}; -use graph::prelude::lazy_static; -use graph::prelude::regex::Regex; +use graph::prelude::ethabi::StateMutability; use graph::prelude::{Link, SubgraphManifestValidationError}; use graph::slog::{debug, error, o, trace}; use itertools::Itertools; -use serde::de; use serde::de::Error as ErrorD; use serde::{Deserialize, Deserializer}; use std::collections::HashSet; @@ -31,7 +29,6 @@ use tiny_keccak::{keccak256, Keccak}; use graph::{ blockchain::{self, Blockchain}, - derive::CheapClone, prelude::{ async_trait, ethabi::{Address, Event, Function, LogParam, ParamType, RawLog}, @@ -51,7 +48,7 @@ use crate::adapter::EthereumAdapter as _; use crate::chain::Chain; use crate::network::EthereumNetworkAdapters; use crate::trigger::{EthereumBlockTriggerType, EthereumTrigger, MappingTrigger}; -use crate::{ContractCall, NodeCapabilities}; +use crate::NodeCapabilities; // The recommended kind is `ethereum`, `ethereum/contract` is accepted for backwards compatibility. const ETHEREUM_KINDS: &[&str] = &["ethereum/contract", "ethereum"]; @@ -803,7 +800,12 @@ impl DataSource { "transaction" => format!("{}", &transaction.hash), }); let handler = event_handler.handler.clone(); - let calls = DeclaredCall::new(&self.mapping, &event_handler, &log, ¶ms)?; + let calls = DeclaredCall::from_log_trigger( + &self.mapping, + &event_handler.calls, + &log, + ¶ms, + )?; Ok(Some(TriggerWithHandler::::new_with_logging_extras( MappingTrigger::Log { block: block.cheap_clone(), @@ -934,73 +936,6 @@ impl DataSource { } } -#[derive(Clone, Debug, PartialEq)] -pub struct DeclaredCall { - /// The user-supplied label from the manifest - label: String, - contract_name: String, - address: Address, - function: Function, - args: Vec, -} - -impl DeclaredCall { - fn new( - mapping: &Mapping, - handler: &MappingEventHandler, - log: &Log, - params: &[LogParam], - ) -> Result, anyhow::Error> { - let mut calls = Vec::new(); - for decl in handler.calls.decls.iter() { - let contract_name = decl.expr.abi.to_string(); - let function_name = decl.expr.func.as_str(); - // Obtain the path to the contract ABI - let abi = mapping.find_abi(&contract_name)?; - // TODO: Handle overloaded functions - let function = { - // Behavior for apiVersion < 0.0.4: look up function by name; for overloaded - // functions this always picks the same overloaded variant, which is incorrect - // and may lead to encoding/decoding errors - abi.contract.function(function_name).with_context(|| { - format!( - "Unknown function \"{}::{}\" called from WASM runtime", - contract_name, function_name - ) - })? - }; - - let address = decl.address(log, params)?; - let args = decl.args(log, params)?; - - let call = DeclaredCall { - label: decl.label.clone(), - contract_name, - address, - function: function.clone(), - args, - }; - calls.push(call); - } - - Ok(calls) - } - - fn as_eth_call(self, block_ptr: BlockPtr, gas: Option) -> (ContractCall, String) { - ( - ContractCall { - contract_name: self.contract_name, - address: self.address, - block_ptr, - function: self.function, - args: self.args, - gas, - }, - self.label, - ) - } -} - pub struct DecoderHook { eth_adapters: Arc, call_cache: Arc, @@ -1099,6 +1034,115 @@ impl DecoderHook { .collect(); Ok(labels) } + + fn collect_declared_calls<'a>( + &self, + runnables: &Vec>, + ) -> Vec<(Arc, DeclaredCall)> { + // Extract all hosted triggers from runnables + let all_triggers = runnables + .iter() + .flat_map(|runnable| &runnable.hosted_triggers); + + // Collect calls from both onchain and subgraph triggers + let mut all_calls = Vec::new(); + + for trigger in all_triggers { + let host_metrics = trigger.host.host_metrics(); + + match &trigger.mapping_trigger.trigger { + MappingTriggerType::Onchain(t) => { + if let MappingTrigger::Log { calls, .. } = t { + for call in calls.clone() { + all_calls.push((host_metrics.cheap_clone(), call)); + } + } + } + MappingTriggerType::Subgraph(t) => { + for call in t.calls.clone() { + // Convert subgraph call to the expected DeclaredCall type if needed + // or handle differently based on the types + all_calls.push((host_metrics.cheap_clone(), call)); + } + } + MappingTriggerType::Offchain(_) => {} + } + } + + all_calls + } + + /// Deduplicate calls. Unfortunately, we can't get `DeclaredCall` to + /// implement `Hash` or `Ord` easily, so we can only deduplicate by + /// comparing the whole call not with a `HashSet` or `BTreeSet`. + /// Since that can be inefficient, we don't deduplicate if we have an + /// enormous amount of calls; in that case though, things will likely + /// blow up because of the amount of I/O that many calls cause. + /// Cutting off at 1000 is fairly arbitrary + fn deduplicate_calls( + &self, + calls: Vec<(Arc, DeclaredCall)>, + ) -> Vec<(Arc, DeclaredCall)> { + if calls.len() >= 1000 { + return calls; + } + + let mut uniq_calls = Vec::new(); + for (metrics, call) in calls { + if !uniq_calls.iter().any(|(_, c)| c == &call) { + uniq_calls.push((metrics, call)); + } + } + uniq_calls + } + + /// Log information about failed eth calls. 'Failure' here simply + /// means that the call was reverted; outright errors lead to a real + /// error. For reverted calls, `self.eth_calls` returns the label + /// from the manifest for that call. + /// + /// One reason why declared calls can fail is if they are attached + /// to the wrong handler, or if arguments are specified incorrectly. + /// Calls that revert every once in a while might be ok and what the + /// user intended, but we want to clearly log so that users can spot + /// mistakes in their manifest, which will lead to unnecessary eth + /// calls + fn log_declared_call_results( + logger: &Logger, + failures: &[String], + calls_count: usize, + trigger_count: usize, + elapsed: Duration, + ) { + let fail_count = failures.len(); + + if fail_count > 0 { + let mut counts: Vec<_> = failures.iter().counts().into_iter().collect(); + counts.sort_by_key(|(label, _)| *label); + + let failure_summary = counts + .into_iter() + .map(|(label, count)| { + let times = if count == 1 { "time" } else { "times" }; + format!("{label} ({count} {times})") + }) + .join(", "); + + error!(logger, "Declared calls failed"; + "triggers" => trigger_count, + "calls_count" => calls_count, + "fail_count" => fail_count, + "calls_ms" => elapsed.as_millis(), + "failures" => format!("[{}]", failure_summary) + ); + } else { + debug!(logger, "Declared calls"; + "triggers" => trigger_count, + "calls_count" => calls_count, + "calls_ms" => elapsed.as_millis() + ); + } + } } #[async_trait] @@ -1110,50 +1154,6 @@ impl blockchain::DecoderHook for DecoderHook { runnables: Vec>, metrics: &Arc, ) -> Result>, MappingError> { - /// Log information about failed eth calls. 'Failure' here simply - /// means that the call was reverted; outright errors lead to a real - /// error. For reverted calls, `self.eth_calls` returns the label - /// from the manifest for that call. - /// - /// One reason why declared calls can fail is if they are attached - /// to the wrong handler, or if arguments are specified incorrectly. - /// Calls that revert every once in a while might be ok and what the - /// user intended, but we want to clearly log so that users can spot - /// mistakes in their manifest, which will lead to unnecessary eth - /// calls - fn log_results( - logger: &Logger, - failures: &[String], - calls_count: usize, - trigger_count: usize, - elapsed: Duration, - ) { - let fail_count = failures.len(); - - if fail_count > 0 { - let mut counts: Vec<_> = failures.iter().counts().into_iter().collect(); - counts.sort_by_key(|(label, _)| *label); - let counts = counts - .into_iter() - .map(|(label, count)| { - let times = if count == 1 { "time" } else { "times" }; - format!("{label} ({count} {times})") - }) - .join(", "); - error!(logger, "Declared calls failed"; - "triggers" => trigger_count, - "calls_count" => calls_count, - "fail_count" => fail_count, - "calls_ms" => elapsed.as_millis(), - "failures" => format!("[{}]", counts)); - } else { - debug!(logger, "Declared calls"; - "triggers" => trigger_count, - "calls_count" => calls_count, - "calls_ms" => elapsed.as_millis()); - } - } - if ENV_VARS.mappings.disable_declared_calls { return Ok(runnables); } @@ -1161,51 +1161,17 @@ impl blockchain::DecoderHook for DecoderHook { let _section = metrics.stopwatch.start_section("declared_ethereum_call"); let start = Instant::now(); - let calls: Vec<_> = runnables - .iter() - .map(|r| &r.hosted_triggers) - .flatten() - .filter_map(|trigger| { - trigger - .mapping_trigger - .trigger - .as_onchain() - .map(|t| (trigger.host.host_metrics(), t)) - }) - .filter_map(|(metrics, trigger)| match trigger { - MappingTrigger::Log { calls, .. } => Some( - calls - .clone() - .into_iter() - .map(move |call| (metrics.cheap_clone(), call)), - ), - MappingTrigger::Block { .. } | MappingTrigger::Call { .. } => None, - }) - .flatten() - .collect(); + // Collect and process declared calls + let calls = self.collect_declared_calls(&runnables); + let deduplicated_calls = self.deduplicate_calls(calls); - // Deduplicate calls. Unfortunately, we can't get `DeclaredCall` to - // implement `Hash` or `Ord` easily, so we can only deduplicate by - // comparing the whole call not with a `HashSet` or `BTreeSet`. - // Since that can be inefficient, we don't deduplicate if we have an - // enormous amount of calls; in that case though, things will likely - // blow up because of the amount of I/O that many calls cause. - // Cutting off at 1000 is fairly arbitrary - let calls = if calls.len() < 1000 { - let mut uniq_calls = Vec::new(); - for (metrics, call) in calls { - if !uniq_calls.iter().any(|(_, c)| c == &call) { - uniq_calls.push((metrics, call)); - } - } - uniq_calls - } else { - calls - }; + // Execute calls and log results + let calls_count = deduplicated_calls.len(); + let results = self + .eth_calls(logger, block_ptr, deduplicated_calls) + .await?; - let calls_count = calls.len(); - let results = self.eth_calls(logger, block_ptr, calls).await?; - log_results( + Self::log_declared_call_results( logger, &results, calls_count, @@ -1373,8 +1339,10 @@ impl Mapping { .iter() .any(|handler| matches!(handler.filter, Some(BlockHandlerFilter::Call))) } +} - pub fn find_abi(&self, abi_name: &str) -> Result, Error> { +impl FindMappingABI for Mapping { + fn find_abi(&self, abi_name: &str) -> Result, Error> { Ok(self .abis .iter() @@ -1569,225 +1537,3 @@ fn string_to_h256(s: &str) -> H256 { pub struct TemplateSource { pub abi: String, } - -/// Internal representation of declared calls. In the manifest that's -/// written as part of an event handler as -/// ```yaml -/// calls: -/// - myCall1: Contract[address].function(arg1, arg2, ...) -/// - .. -/// ``` -/// -/// The `address` and `arg` fields can be either `event.address` or -/// `event.params.`. Each entry under `calls` gets turned into a -/// `CallDcl` -#[derive(Clone, CheapClone, Debug, Default, Hash, Eq, PartialEq)] -pub struct CallDecls { - pub decls: Arc>, - readonly: (), -} - -/// A single call declaration, like `myCall1: -/// Contract[address].function(arg1, arg2, ...)` -#[derive(Clone, Debug, Hash, Eq, PartialEq)] -pub struct CallDecl { - /// A user-defined label - pub label: String, - /// The call expression - pub expr: CallExpr, - readonly: (), -} -impl CallDecl { - fn address(&self, log: &Log, params: &[LogParam]) -> Result { - let address = match &self.expr.address { - CallArg::Address => log.address, - CallArg::HexAddress(address) => *address, - CallArg::Param(name) => { - let value = params - .iter() - .find(|param| ¶m.name == name.as_str()) - .ok_or_else(|| anyhow!("unknown param {name}"))? - .value - .clone(); - value - .into_address() - .ok_or_else(|| anyhow!("param {name} is not an address"))? - } - }; - Ok(address) - } - - fn args(&self, log: &Log, params: &[LogParam]) -> Result, Error> { - self.expr - .args - .iter() - .map(|arg| match arg { - CallArg::Address => Ok(Token::Address(log.address)), - CallArg::HexAddress(address) => Ok(Token::Address(*address)), - CallArg::Param(name) => { - let value = params - .iter() - .find(|param| ¶m.name == name.as_str()) - .ok_or_else(|| anyhow!("unknown param {name}"))? - .value - .clone(); - Ok(value) - } - }) - .collect() - } -} - -impl<'de> de::Deserialize<'de> for CallDecls { - fn deserialize(deserializer: D) -> Result - where - D: de::Deserializer<'de>, - { - let decls: std::collections::HashMap = - de::Deserialize::deserialize(deserializer)?; - let decls = decls - .into_iter() - .map(|(name, expr)| { - expr.parse::().map(|expr| CallDecl { - label: name, - expr, - readonly: (), - }) - }) - .collect::>() - .map(|decls| Arc::new(decls)) - .map_err(de::Error::custom)?; - Ok(CallDecls { - decls, - readonly: (), - }) - } -} - -#[derive(Clone, Debug, Hash, Eq, PartialEq)] -pub struct CallExpr { - pub abi: Word, - pub address: CallArg, - pub func: Word, - pub args: Vec, - readonly: (), -} - -/// Parse expressions of the form `Contract[address].function(arg1, arg2, -/// ...)` where the `address` and the args are either `event.address` or -/// `event.params.`. -/// -/// The parser is pretty awful as it generates error messages that aren't -/// very helpful. We should replace all this with a real parser, most likely -/// `combine` which is what `graphql_parser` uses -impl FromStr for CallExpr { - type Err = anyhow::Error; - - fn from_str(s: &str) -> Result { - lazy_static! { - static ref RE: Regex = Regex::new( - r"(?x) - (?P[a-zA-Z0-9_]+)\[ - (?P
[^]]+)\] - \. - (?P[a-zA-Z0-9_]+)\( - (?P[^)]*) - \)" - ) - .unwrap(); - } - let x = RE - .captures(s) - .ok_or_else(|| anyhow!("invalid call expression `{s}`"))?; - let abi = Word::from(x.name("abi").unwrap().as_str()); - let address = x.name("address").unwrap().as_str().parse()?; - let func = Word::from(x.name("func").unwrap().as_str()); - let args: Vec = x - .name("args") - .unwrap() - .as_str() - .split(',') - .filter(|s| !s.is_empty()) - .map(|s| s.trim().parse::()) - .collect::>()?; - Ok(CallExpr { - abi, - address, - func, - args, - readonly: (), - }) - } -} - -#[derive(Clone, Debug, Hash, Eq, PartialEq)] -pub enum CallArg { - HexAddress(Address), - Address, - Param(Word), -} - -lazy_static! { - // Matches a 40-character hexadecimal string prefixed with '0x', typical for Ethereum addresses - static ref ADDR_RE: Regex = Regex::new(r"^0x[0-9a-fA-F]{40}$").unwrap(); -} - -impl FromStr for CallArg { - type Err = anyhow::Error; - - fn from_str(s: &str) -> Result { - if ADDR_RE.is_match(s) { - if let Ok(parsed_address) = Address::from_str(s) { - return Ok(CallArg::HexAddress(parsed_address)); - } - } - - let mut parts = s.split('.'); - match (parts.next(), parts.next(), parts.next()) { - (Some("event"), Some("address"), None) => Ok(CallArg::Address), - (Some("event"), Some("params"), Some(param)) => Ok(CallArg::Param(Word::from(param))), - _ => Err(anyhow!("invalid call argument `{}`", s)), - } - } -} - -#[test] -fn test_call_expr() { - let expr: CallExpr = "ERC20[event.address].balanceOf(event.params.token)" - .parse() - .unwrap(); - assert_eq!(expr.abi, "ERC20"); - assert_eq!(expr.address, CallArg::Address); - assert_eq!(expr.func, "balanceOf"); - assert_eq!(expr.args, vec![CallArg::Param("token".into())]); - - let expr: CallExpr = "Pool[event.params.pool].fees(event.params.token0, event.params.token1)" - .parse() - .unwrap(); - assert_eq!(expr.abi, "Pool"); - assert_eq!(expr.address, CallArg::Param("pool".into())); - assert_eq!(expr.func, "fees"); - assert_eq!( - expr.args, - vec![ - CallArg::Param("token0".into()), - CallArg::Param("token1".into()) - ] - ); - - let expr: CallExpr = "Pool[event.address].growth()".parse().unwrap(); - assert_eq!(expr.abi, "Pool"); - assert_eq!(expr.address, CallArg::Address); - assert_eq!(expr.func, "growth"); - assert_eq!(expr.args, vec![]); - - let expr: CallExpr = "Pool[0xDeaDbeefdEAdbeefdEadbEEFdeadbeEFdEaDbeeF].growth(0xDeaDbeefdEAdbeefdEadbEEFdeadbeEFdEaDbeeF)" - .parse() - .unwrap(); - let call_arg = - CallArg::HexAddress(H160::from_str("0xDeaDbeefdEAdbeefdEadbEEFdeadbeEFdEaDbeeF").unwrap()); - assert_eq!(expr.abi, "Pool"); - assert_eq!(expr.address, call_arg); - assert_eq!(expr.func, "growth"); - assert_eq!(expr.args, vec![call_arg]); -} diff --git a/chain/ethereum/src/ethereum_adapter.rs b/chain/ethereum/src/ethereum_adapter.rs index 71af858fb9f..78d0d084a85 100644 --- a/chain/ethereum/src/ethereum_adapter.rs +++ b/chain/ethereum/src/ethereum_adapter.rs @@ -9,6 +9,7 @@ use graph::data::store::ethereum::call; use graph::data::store::scalar; use graph::data::subgraph::UnifiedMappingApiVersion; use graph::data::subgraph::API_VERSION_0_0_7; +use graph::data_source::common::ContractCall; use graph::futures01::stream; use graph::futures01::Future; use graph::futures01::Stream; @@ -63,7 +64,7 @@ use crate::NodeCapabilities; use crate::TriggerFilter; use crate::{ adapter::{ - ContractCall, ContractCallError, EthGetLogsFilter, EthereumAdapter as EthereumAdapterTrait, + ContractCallError, EthGetLogsFilter, EthereumAdapter as EthereumAdapterTrait, EthereumBlockFilter, EthereumCallFilter, EthereumLogFilter, ProviderEthRpcMetrics, SubgraphEthRpcMetrics, }, diff --git a/chain/ethereum/src/lib.rs b/chain/ethereum/src/lib.rs index 3853ac13d31..8cf4e4cc669 100644 --- a/chain/ethereum/src/lib.rs +++ b/chain/ethereum/src/lib.rs @@ -28,8 +28,8 @@ pub mod network; pub mod trigger; pub use crate::adapter::{ - ContractCall, ContractCallError, EthereumAdapter as EthereumAdapterTrait, - ProviderEthRpcMetrics, SubgraphEthRpcMetrics, TriggerFilter, + ContractCallError, EthereumAdapter as EthereumAdapterTrait, ProviderEthRpcMetrics, + SubgraphEthRpcMetrics, TriggerFilter, }; pub use crate::chain::Chain; pub use graph::blockchain::BlockIngestor; diff --git a/chain/ethereum/src/runtime/runtime_adapter.rs b/chain/ethereum/src/runtime/runtime_adapter.rs index 06e425fa73c..01f148bdd4c 100644 --- a/chain/ethereum/src/runtime/runtime_adapter.rs +++ b/chain/ethereum/src/runtime/runtime_adapter.rs @@ -2,8 +2,8 @@ use std::{sync::Arc, time::Instant}; use crate::adapter::EthereumRpcError; use crate::{ - capabilities::NodeCapabilities, network::EthereumNetworkAdapters, Chain, ContractCall, - ContractCallError, EthereumAdapter, EthereumAdapterTrait, ENV_VARS, + capabilities::NodeCapabilities, network::EthereumNetworkAdapters, Chain, ContractCallError, + EthereumAdapter, EthereumAdapterTrait, ENV_VARS, }; use anyhow::{anyhow, Context, Error}; use blockchain::HostFn; @@ -13,7 +13,7 @@ use graph::data::store::ethereum::call; use graph::data::store::scalar::BigInt; use graph::data::subgraph::API_VERSION_0_0_9; use graph::data_source; -use graph::data_source::common::MappingABI; +use graph::data_source::common::{ContractCall, MappingABI}; use graph::futures03::compat::Future01CompatExt; use graph::prelude::web3::types::H160; use graph::runtime::gas::Gas; diff --git a/chain/ethereum/src/trigger.rs b/chain/ethereum/src/trigger.rs index 128ed8d3e98..a5d83690b4b 100644 --- a/chain/ethereum/src/trigger.rs +++ b/chain/ethereum/src/trigger.rs @@ -3,6 +3,7 @@ use graph::blockchain::TriggerData; use graph::data::subgraph::API_VERSION_0_0_2; use graph::data::subgraph::API_VERSION_0_0_6; use graph::data::subgraph::API_VERSION_0_0_7; +use graph::data_source::common::DeclaredCall; use graph::prelude::ethabi::ethereum_types::H160; use graph::prelude::ethabi::ethereum_types::H256; use graph::prelude::ethabi::ethereum_types::U128; @@ -28,7 +29,6 @@ use graph_runtime_wasm::module::ToAscPtr; use std::ops::Deref; use std::{cmp::Ordering, sync::Arc}; -use crate::data_source::DeclaredCall; use crate::runtime::abi::AscEthereumBlock; use crate::runtime::abi::AscEthereumBlock_0_0_6; use crate::runtime::abi::AscEthereumCall; diff --git a/graph/src/data_source/common.rs b/graph/src/data_source/common.rs index 789f04bb09c..80612340526 100644 --- a/graph/src/data_source/common.rs +++ b/graph/src/data_source/common.rs @@ -1,9 +1,17 @@ -use crate::{components::link_resolver::LinkResolver, prelude::Link}; -use anyhow::{Context, Error}; -use ethabi::{Contract, Function}; +use crate::blockchain::block_stream::EntityWithType; +use crate::prelude::{BlockPtr, Value}; +use crate::{components::link_resolver::LinkResolver, data::value::Word, prelude::Link}; +use anyhow::{anyhow, Context, Error}; +use ethabi::{Address, Contract, Function, LogParam, ParamType, Token}; +use graph_derive::CheapClone; +use lazy_static::lazy_static; +use num_bigint::Sign; +use regex::Regex; +use serde::de; use serde::Deserialize; use slog::Logger; -use std::sync::Arc; +use std::{str::FromStr, sync::Arc}; +use web3::types::{Log, H160}; #[derive(Clone, Debug, PartialEq)] pub struct MappingABI { @@ -80,3 +88,660 @@ impl UnresolvedMappingABI { }) } } + +/// Internal representation of declared calls. In the manifest that's +/// written as part of an event handler as +/// ```yaml +/// calls: +/// - myCall1: Contract[address].function(arg1, arg2, ...) +/// - .. +/// ``` +/// +/// The `address` and `arg` fields can be either `event.address` or +/// `event.params.`. Each entry under `calls` gets turned into a +/// `CallDcl` +#[derive(Clone, CheapClone, Debug, Default, Hash, Eq, PartialEq)] +pub struct CallDecls { + pub decls: Arc>, + readonly: (), +} + +/// A single call declaration, like `myCall1: +/// Contract[address].function(arg1, arg2, ...)` +#[derive(Clone, Debug, Hash, Eq, PartialEq)] +pub struct CallDecl { + /// A user-defined label + pub label: String, + /// The call expression + pub expr: CallExpr, + readonly: (), +} + +impl CallDecl { + pub fn validate_args(&self) -> Result<(), Error> { + self.expr.validate_args() + } + + pub fn address_for_log(&self, log: &Log, params: &[LogParam]) -> Result { + let address = match &self.expr.address { + CallArg::HexAddress(address) => *address, + CallArg::Ethereum(arg) => match arg { + EthereumArg::Address => log.address, + EthereumArg::Param(name) => { + let value = params + .iter() + .find(|param| ¶m.name == name.as_str()) + .ok_or_else(|| anyhow!("unknown param {name}"))? + .value + .clone(); + value + .into_address() + .ok_or_else(|| anyhow!("param {name} is not an address"))? + } + }, + CallArg::Subgraph(_) => { + return Err(anyhow!( + "Subgraph params are not supported for when declaring calls for event handlers" + )) + } + }; + Ok(address) + } + + pub fn args_for_log(&self, log: &Log, params: &[LogParam]) -> Result, Error> { + self.expr + .args + .iter() + .map(|arg| match arg { + CallArg::HexAddress(address) => Ok(Token::Address(*address)), + CallArg::Ethereum(arg) => match arg { + EthereumArg::Address => Ok(Token::Address(log.address)), + EthereumArg::Param(name) => { + let value = params + .iter() + .find(|param| ¶m.name == name.as_str()) + .ok_or_else(|| anyhow!("unknown param {name}"))? + .value + .clone(); + Ok(value) + } + }, + CallArg::Subgraph(_) => Err(anyhow!( + "Subgraph params are not supported for when declaring calls for event handlers" + )), + }) + .collect() + } + + pub fn get_function(&self, mapping: &dyn FindMappingABI) -> Result { + let contract_name = self.expr.abi.to_string(); + let function_name = self.expr.func.as_str(); + let abi = mapping.find_abi(&contract_name)?; + + // TODO: Handle overloaded functions + // Behavior for apiVersion < 0.0.4: look up function by name; for overloaded + // functions this always picks the same overloaded variant, which is incorrect + // and may lead to encoding/decoding errors + abi.contract + .function(function_name) + .cloned() + .with_context(|| { + format!( + "Unknown function \"{}::{}\" called from WASM runtime", + contract_name, function_name + ) + }) + } + + pub fn address_for_entity_handler(&self, entity: &EntityWithType) -> Result { + match &self.expr.address { + // Static hex address - just return it directly + CallArg::HexAddress(address) => Ok(*address), + + // Ethereum params not allowed here + CallArg::Ethereum(_) => Err(anyhow!( + "Ethereum params are not supported for entity handler calls" + )), + + // Look up address from entity parameter + CallArg::Subgraph(SubgraphArg::EntityParam(name)) => { + // Get the value for this parameter + let value = entity + .entity + .get(name.as_str()) + .ok_or_else(|| anyhow!("entity missing required param '{name}'"))?; + + // Make sure it's a bytes value and convert to address + match value { + Value::Bytes(bytes) => { + let address = H160::from_slice(bytes.as_slice()); + Ok(address) + } + _ => Err(anyhow!("param '{name}' must be an address")), + } + } + } + } + + /// Processes arguments for an entity handler, converting them to the expected token types. + /// Returns an error if argument count mismatches or if conversion fails. + pub fn args_for_entity_handler( + &self, + entity: &EntityWithType, + param_types: Vec, + ) -> Result, Error> { + self.validate_entity_handler_args(¶m_types)?; + + self.expr + .args + .iter() + .zip(param_types.into_iter()) + .map(|(arg, expected_type)| { + self.process_entity_handler_arg(arg, &expected_type, entity) + }) + .collect() + } + + /// Validates that the number of provided arguments matches the expected parameter types. + fn validate_entity_handler_args(&self, param_types: &[ParamType]) -> Result<(), Error> { + if self.expr.args.len() != param_types.len() { + return Err(anyhow!( + "mismatched number of arguments: expected {}, got {}", + param_types.len(), + self.expr.args.len() + )); + } + Ok(()) + } + + /// Processes a single entity handler argument based on its type (HexAddress, Ethereum, or Subgraph). + /// Returns error for unsupported Ethereum params. + fn process_entity_handler_arg( + &self, + arg: &CallArg, + expected_type: &ParamType, + entity: &EntityWithType, + ) -> Result { + match arg { + CallArg::HexAddress(address) => self.process_hex_address(*address, expected_type), + CallArg::Ethereum(_) => Err(anyhow!( + "Ethereum params are not supported for entity handler calls" + )), + CallArg::Subgraph(SubgraphArg::EntityParam(name)) => { + self.process_entity_param(name, expected_type, entity) + } + } + } + + /// Converts a hex address to a token, ensuring it matches the expected parameter type. + fn process_hex_address( + &self, + address: H160, + expected_type: &ParamType, + ) -> Result { + match expected_type { + ParamType::Address => Ok(Token::Address(address)), + _ => Err(anyhow!( + "type mismatch: hex address provided for non-address parameter" + )), + } + } + + /// Retrieves and processes an entity parameter, converting it to the expected token type. + fn process_entity_param( + &self, + name: &str, + expected_type: &ParamType, + entity: &EntityWithType, + ) -> Result { + let value = entity + .entity + .get(name) + .ok_or_else(|| anyhow!("entity missing required param '{name}'"))?; + + self.convert_entity_value_to_token(value, expected_type, name) + } + + /// Converts a `Value` to the appropriate `Token` type based on the expected parameter type. + /// Handles various type conversions including primitives, bytes, and arrays. + fn convert_entity_value_to_token( + &self, + value: &Value, + expected_type: &ParamType, + param_name: &str, + ) -> Result { + match (expected_type, value) { + (ParamType::Address, Value::Bytes(b)) => { + Ok(Token::Address(H160::from_slice(b.as_slice()))) + } + (ParamType::Bytes, Value::Bytes(b)) => Ok(Token::Bytes(b.as_ref().to_vec())), + (ParamType::FixedBytes(size), Value::Bytes(b)) if b.len() == *size => { + Ok(Token::FixedBytes(b.as_ref().to_vec())) + } + (ParamType::String, Value::String(s)) => Ok(Token::String(s.to_string())), + (ParamType::Bool, Value::Bool(b)) => Ok(Token::Bool(*b)), + (ParamType::Int(_), Value::Int(i)) => Ok(Token::Int((*i).into())), + (ParamType::Int(_), Value::Int8(i)) => Ok(Token::Int((*i).into())), + (ParamType::Int(_), Value::BigInt(i)) => Ok(Token::Int(i.to_signed_u256())), + (ParamType::Uint(_), Value::Int(i)) if *i >= 0 => Ok(Token::Uint((*i).into())), + (ParamType::Uint(_), Value::BigInt(i)) if i.sign() == Sign::Plus => { + Ok(Token::Uint(i.to_unsigned_u256())) + } + (ParamType::Array(inner_type), Value::List(values)) => { + self.process_entity_array_values(values, inner_type.as_ref(), param_name) + } + _ => Err(anyhow!( + "type mismatch for param '{param_name}': cannot convert {:?} to {:?}", + value, + expected_type + )), + } + } + + fn process_entity_array_values( + &self, + values: &[Value], + inner_type: &ParamType, + param_name: &str, + ) -> Result { + let tokens: Result, Error> = values + .iter() + .enumerate() + .map(|(idx, v)| { + self.convert_entity_value_to_token(v, inner_type, &format!("{param_name}[{idx}]")) + }) + .collect(); + Ok(Token::Array(tokens?)) + } +} + +impl<'de> de::Deserialize<'de> for CallDecls { + fn deserialize(deserializer: D) -> Result + where + D: de::Deserializer<'de>, + { + let decls: std::collections::HashMap = + de::Deserialize::deserialize(deserializer)?; + let decls = decls + .into_iter() + .map(|(name, expr)| { + expr.parse::().map(|expr| CallDecl { + label: name, + expr, + readonly: (), + }) + }) + .collect::>() + .map(|decls| Arc::new(decls)) + .map_err(de::Error::custom)?; + Ok(CallDecls { + decls, + readonly: (), + }) + } +} + +#[derive(Clone, Debug, Hash, Eq, PartialEq)] +pub struct CallExpr { + pub abi: Word, + pub address: CallArg, + pub func: Word, + pub args: Vec, + readonly: (), +} + +impl CallExpr { + fn validate_args(&self) -> Result<(), anyhow::Error> { + // Consider address along with args for checking Ethereum/Subgraph mixing + let has_ethereum = matches!(self.address, CallArg::Ethereum(_)) + || self + .args + .iter() + .any(|arg| matches!(arg, CallArg::Ethereum(_))); + + let has_subgraph = matches!(self.address, CallArg::Subgraph(_)) + || self + .args + .iter() + .any(|arg| matches!(arg, CallArg::Subgraph(_))); + + if has_ethereum && has_subgraph { + return Err(anyhow!( + "Cannot mix Ethereum and Subgraph args in the same call expression" + )); + } + + Ok(()) + } +} +/// Parse expressions of the form `Contract[address].function(arg1, arg2, +/// ...)` where the `address` and the args are either `event.address` or +/// `event.params.`. +/// +/// The parser is pretty awful as it generates error messages that aren't +/// very helpful. We should replace all this with a real parser, most likely +/// `combine` which is what `graphql_parser` uses +impl FromStr for CallExpr { + type Err = anyhow::Error; + + fn from_str(s: &str) -> Result { + lazy_static! { + static ref RE: Regex = Regex::new( + r"(?x) + (?P[a-zA-Z0-9_]+)\[ + (?P
[^]]+)\] + \. + (?P[a-zA-Z0-9_]+)\( + (?P[^)]*) + \)" + ) + .unwrap(); + } + let x = RE + .captures(s) + .ok_or_else(|| anyhow!("invalid call expression `{s}`"))?; + let abi = Word::from(x.name("abi").unwrap().as_str()); + let address = x.name("address").unwrap().as_str().parse()?; + let func = Word::from(x.name("func").unwrap().as_str()); + let args: Vec = x + .name("args") + .unwrap() + .as_str() + .split(',') + .filter(|s| !s.is_empty()) + .map(|s| s.trim().parse::()) + .collect::>()?; + + let call_expr = CallExpr { + abi, + address, + func, + args, + readonly: (), + }; + + // Validate the arguments after constructing the CallExpr + call_expr.validate_args()?; + + Ok(call_expr) + } +} + +#[derive(Clone, Debug, Hash, Eq, PartialEq)] +pub enum CallArg { + // Hard-coded hex address + HexAddress(Address), + // Ethereum-specific variants + Ethereum(EthereumArg), + // Subgraph datasource specific variants + Subgraph(SubgraphArg), +} + +#[derive(Clone, Debug, Hash, Eq, PartialEq)] +pub enum EthereumArg { + Address, + Param(Word), +} + +#[derive(Clone, Debug, Hash, Eq, PartialEq)] +pub enum SubgraphArg { + EntityParam(Word), +} + +lazy_static! { + // Matches a 40-character hexadecimal string prefixed with '0x', typical for Ethereum addresses + static ref ADDR_RE: Regex = Regex::new(r"^0x[0-9a-fA-F]{40}$").unwrap(); +} + +impl FromStr for CallArg { + type Err = anyhow::Error; + + fn from_str(s: &str) -> Result { + if ADDR_RE.is_match(s) { + if let Ok(parsed_address) = Address::from_str(s) { + return Ok(CallArg::HexAddress(parsed_address)); + } + } + + let mut parts = s.split('.'); + match (parts.next(), parts.next(), parts.next()) { + (Some("event"), Some("address"), None) => Ok(CallArg::Ethereum(EthereumArg::Address)), + (Some("event"), Some("params"), Some(param)) => { + Ok(CallArg::Ethereum(EthereumArg::Param(Word::from(param)))) + } + (Some("entity"), Some(param), None) => Ok(CallArg::Subgraph(SubgraphArg::EntityParam( + Word::from(param), + ))), + _ => Err(anyhow!("invalid call argument `{}`", s)), + } + } +} + +pub trait FindMappingABI { + fn find_abi(&self, abi_name: &str) -> Result, Error>; +} + +#[derive(Clone, Debug, PartialEq)] +pub struct DeclaredCall { + /// The user-supplied label from the manifest + label: String, + contract_name: String, + address: Address, + function: Function, + args: Vec, +} + +impl DeclaredCall { + pub fn from_log_trigger( + mapping: &dyn FindMappingABI, + call_decls: &CallDecls, + log: &Log, + params: &[LogParam], + ) -> Result, anyhow::Error> { + Self::create_calls(mapping, call_decls, |decl, _| { + Ok(( + decl.address_for_log(log, params)?, + decl.args_for_log(log, params)?, + )) + }) + } + + pub fn from_entity_trigger( + mapping: &dyn FindMappingABI, + call_decls: &CallDecls, + entity: &EntityWithType, + ) -> Result, anyhow::Error> { + Self::create_calls(mapping, call_decls, |decl, function| { + let param_types = function + .inputs + .iter() + .map(|param| param.kind.clone()) + .collect::>(); + + Ok(( + decl.address_for_entity_handler(entity)?, + decl.args_for_entity_handler(entity, param_types) + .context(format!( + "Failed to parse arguments for call to function \"{}\" of contract \"{}\"", + decl.expr.func.as_str(), + decl.expr.abi.to_string() + ))?, + )) + }) + } + + fn create_calls( + mapping: &dyn FindMappingABI, + call_decls: &CallDecls, + get_address_and_args: F, + ) -> Result, anyhow::Error> + where + F: Fn(&CallDecl, &Function) -> Result<(Address, Vec), anyhow::Error>, + { + let mut calls = Vec::new(); + for decl in call_decls.decls.iter() { + let contract_name = decl.expr.abi.to_string(); + let function = decl.get_function(mapping)?; + let (address, args) = get_address_and_args(decl, &function)?; + + calls.push(DeclaredCall { + label: decl.label.clone(), + contract_name, + address, + function: function.clone(), + args, + }); + } + Ok(calls) + } + + pub fn as_eth_call(self, block_ptr: BlockPtr, gas: Option) -> (ContractCall, String) { + ( + ContractCall { + contract_name: self.contract_name, + address: self.address, + block_ptr, + function: self.function, + args: self.args, + gas, + }, + self.label, + ) + } +} +#[derive(Clone, Debug)] +pub struct ContractCall { + pub contract_name: String, + pub address: Address, + pub block_ptr: BlockPtr, + pub function: Function, + pub args: Vec, + pub gas: Option, +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn test_ethereum_call_expr() { + let expr: CallExpr = "ERC20[event.address].balanceOf(event.params.token)" + .parse() + .unwrap(); + assert_eq!(expr.abi, "ERC20"); + assert_eq!(expr.address, CallArg::Ethereum(EthereumArg::Address)); + assert_eq!(expr.func, "balanceOf"); + assert_eq!( + expr.args, + vec![CallArg::Ethereum(EthereumArg::Param("token".into()))] + ); + + let expr: CallExpr = + "Pool[event.params.pool].fees(event.params.token0, event.params.token1)" + .parse() + .unwrap(); + assert_eq!(expr.abi, "Pool"); + assert_eq!( + expr.address, + CallArg::Ethereum(EthereumArg::Param("pool".into())) + ); + assert_eq!(expr.func, "fees"); + assert_eq!( + expr.args, + vec![ + CallArg::Ethereum(EthereumArg::Param("token0".into())), + CallArg::Ethereum(EthereumArg::Param("token1".into())) + ] + ); + } + + #[test] + fn test_subgraph_call_expr() { + let expr: CallExpr = "Token[entity.id].symbol()".parse().unwrap(); + assert_eq!(expr.abi, "Token"); + assert_eq!( + expr.address, + CallArg::Subgraph(SubgraphArg::EntityParam("id".into())) + ); + assert_eq!(expr.func, "symbol"); + assert_eq!(expr.args, vec![]); + + let expr: CallExpr = "Pair[entity.pair].getReserves(entity.token0)" + .parse() + .unwrap(); + assert_eq!(expr.abi, "Pair"); + assert_eq!( + expr.address, + CallArg::Subgraph(SubgraphArg::EntityParam("pair".into())) + ); + assert_eq!(expr.func, "getReserves"); + assert_eq!( + expr.args, + vec![CallArg::Subgraph(SubgraphArg::EntityParam("token0".into()))] + ); + } + + #[test] + fn test_hex_address_call_expr() { + let addr = "0xDeaDbeefdEAdbeefdEadbEEFdeadbeEFdEaDbeeF"; + let hex_address = CallArg::HexAddress(web3::types::H160::from_str(addr).unwrap()); + + // Test HexAddress in address position + let expr: CallExpr = format!("Pool[{}].growth()", addr).parse().unwrap(); + assert_eq!(expr.abi, "Pool"); + assert_eq!(expr.address, hex_address.clone()); + assert_eq!(expr.func, "growth"); + assert_eq!(expr.args, vec![]); + + // Test HexAddress in argument position + let expr: CallExpr = format!("Pool[event.address].approve({}, event.params.amount)", addr) + .parse() + .unwrap(); + assert_eq!(expr.abi, "Pool"); + assert_eq!(expr.address, CallArg::Ethereum(EthereumArg::Address)); + assert_eq!(expr.func, "approve"); + assert_eq!(expr.args.len(), 2); + assert_eq!(expr.args[0], hex_address); + } + + #[test] + fn test_invalid_call_args() { + // Invalid hex address + assert!("Pool[0xinvalid].test()".parse::().is_err()); + + // Invalid event path + assert!("Pool[event.invalid].test()".parse::().is_err()); + + // Invalid entity path + assert!("Pool[entity].test()".parse::().is_err()); + + // Empty address + assert!("Pool[].test()".parse::().is_err()); + + // Invalid parameter format + assert!("Pool[event.params].test()".parse::().is_err()); + } + + #[test] + fn test_from_str() { + // Test valid hex address + let addr = "0xDeaDbeefdEAdbeefdEadbEEFdeadbeEFdEaDbeeF"; + let arg = CallArg::from_str(addr).unwrap(); + assert!(matches!(arg, CallArg::HexAddress(_))); + + // Test Ethereum Address + let arg = CallArg::from_str("event.address").unwrap(); + assert!(matches!(arg, CallArg::Ethereum(EthereumArg::Address))); + + // Test Ethereum Param + let arg = CallArg::from_str("event.params.token").unwrap(); + assert!(matches!(arg, CallArg::Ethereum(EthereumArg::Param(_)))); + + // Test Subgraph EntityParam + let arg = CallArg::from_str("entity.token").unwrap(); + assert!(matches!( + arg, + CallArg::Subgraph(SubgraphArg::EntityParam(_)) + )); + } +} diff --git a/graph/src/data_source/mod.rs b/graph/src/data_source/mod.rs index 3b600b7fbaf..751b71837e7 100644 --- a/graph/src/data_source/mod.rs +++ b/graph/src/data_source/mod.rs @@ -258,7 +258,7 @@ impl DataSource { Ok(ds.match_and_decode(trigger)) } (Self::Subgraph(ds), TriggerData::Subgraph(trigger)) => { - Ok(ds.match_and_decode(block, trigger)) + ds.match_and_decode(block, trigger) } (Self::Onchain(_), TriggerData::Offchain(_)) | (Self::Offchain(_), TriggerData::Onchain(_)) @@ -573,7 +573,7 @@ impl TriggerData { pub enum MappingTrigger { Onchain(C::MappingTrigger), Offchain(offchain::TriggerData), - Subgraph(subgraph::TriggerData), + Subgraph(subgraph::MappingEntityTrigger), } impl MappingTrigger { diff --git a/graph/src/data_source/subgraph.rs b/graph/src/data_source/subgraph.rs index cfd17905f63..bed226ea6af 100644 --- a/graph/src/data_source/subgraph.rs +++ b/graph/src/data_source/subgraph.rs @@ -5,17 +5,18 @@ use crate::{ subgraph::{calls_host_fn, SPEC_VERSION_1_3_0}, value::Word, }, - data_source, - prelude::{DataSourceContext, DeploymentHash, Link}, + data_source::{self, common::DeclaredCall}, + ensure, + prelude::{CheapClone, DataSourceContext, DeploymentHash, Link}, }; -use anyhow::{Context, Error}; +use anyhow::{anyhow, Context, Error, Result}; use futures03::{stream::FuturesOrdered, TryStreamExt}; use serde::Deserialize; use slog::{info, Logger}; use std::{fmt, sync::Arc}; use super::{ - common::{MappingABI, UnresolvedMappingABI}, + common::{CallDecls, FindMappingABI, MappingABI, UnresolvedMappingABI}, DataSourceTemplateInfo, TriggerWithHandler, }; @@ -74,25 +75,45 @@ impl DataSource { &self, block: &Arc, trigger: &TriggerData, - ) -> Option>> { + ) -> Result>>> { if self.source.address != trigger.source { - return None; + return Ok(None); } - let trigger_ref = self.mapping.handlers.iter().find_map(|handler| { - if handler.entity != trigger.entity_type() { - return None; - } + let mut matching_handlers: Vec<_> = self + .mapping + .handlers + .iter() + .filter(|handler| handler.entity == trigger.entity_type()) + .collect(); + + // Get the matching handler if any + let handler = match matching_handlers.pop() { + Some(handler) => handler, + None => return Ok(None), + }; - Some(TriggerWithHandler::new( - data_source::MappingTrigger::Subgraph(trigger.clone()), - handler.handler.clone(), - block.ptr(), - block.timestamp(), - )) - }); + ensure!( + matching_handlers.is_empty(), + format!( + "Multiple handlers defined for entity `{}`, only one is supported", + trigger.entity_type() + ) + ); + + let calls = + DeclaredCall::from_entity_trigger(&self.mapping, &handler.calls, &trigger.entity)?; + let mapping_trigger = MappingEntityTrigger { + data: trigger.clone(), + calls, + }; - return trigger_ref; + Ok(Some(TriggerWithHandler::new( + data_source::MappingTrigger::Subgraph(mapping_trigger), + handler.handler.clone(), + block.ptr(), + block.timestamp(), + ))) } pub fn address(&self) -> Option> { @@ -142,10 +163,23 @@ impl Mapping { } } +impl FindMappingABI for Mapping { + fn find_abi(&self, abi_name: &str) -> Result, Error> { + Ok(self + .abis + .iter() + .find(|abi| abi.name == abi_name) + .ok_or_else(|| anyhow!("No ABI entry with name `{}` found", abi_name))? + .cheap_clone()) + } +} + #[derive(Clone, Debug, Hash, Eq, PartialEq, Deserialize)] pub struct EntityHandler { pub handler: String, pub entity: String, + #[serde(default)] + pub calls: CallDecls, } #[derive(Clone, Debug, Default, Eq, PartialEq, Deserialize)] @@ -310,6 +344,12 @@ impl UnresolvedDataSourceTemplate { } } +#[derive(Clone, PartialEq, Debug)] +pub struct MappingEntityTrigger { + pub data: TriggerData, + pub calls: Vec, +} + #[derive(Clone, PartialEq, Eq)] pub struct TriggerData { pub source: DeploymentHash, diff --git a/runtime/wasm/src/module/mod.rs b/runtime/wasm/src/module/mod.rs index fa40ab3a65d..4b01b3a5fd8 100644 --- a/runtime/wasm/src/module/mod.rs +++ b/runtime/wasm/src/module/mod.rs @@ -80,6 +80,16 @@ impl ToAscPtr for subgraph::TriggerData { } } +impl ToAscPtr for subgraph::MappingEntityTrigger { + fn to_asc_ptr( + self, + heap: &mut H, + gas: &GasCounter, + ) -> Result, HostExportError> { + asc_new(heap, &self.data.entity, gas).map(|ptr| ptr.erase()) + } +} + impl ToAscPtr for MappingTrigger where C::MappingTrigger: ToAscPtr, diff --git a/store/test-store/tests/chain/ethereum/manifest.rs b/store/test-store/tests/chain/ethereum/manifest.rs index 0bd682ebb20..c750adb7b72 100644 --- a/store/test-store/tests/chain/ethereum/manifest.rs +++ b/store/test-store/tests/chain/ethereum/manifest.rs @@ -1489,3 +1489,74 @@ dataSources: assert_eq!(4, decls.len()); }); } + +#[test] +fn parses_eth_call_decls_for_subgraph_datasource() { + const YAML: &str = " +specVersion: 1.3.0 +schema: + file: + /: /ipfs/Qmschema +features: + - ipfsOnEthereumContracts +dataSources: + - kind: subgraph + name: Factory + entities: + - Gravatar + network: mainnet + source: + address: 'QmSWWT2yrTFDZSL8tRyoHEVrcEKAUsY2hj2TMQDfdDZU8h' + startBlock: 9562480 + mapping: + apiVersion: 0.0.6 + language: wasm/assemblyscript + entities: + - TestEntity + file: + /: /ipfs/Qmmapping + abis: + - name: Factory + file: + /: /ipfs/Qmabi + handlers: + - handler: handleEntity + entity: User + calls: + fake1: Factory[entity.address].get(entity.user) + fake3: Factory[0xDeaDbeefdEAdbeefdEadbEEFdeadbeEFdEaDbeeF].get(entity.address) + fake4: Factory[0xDeaDbeefdEAdbeefdEadbEEFdeadbeEFdEaDbeeF].get(0xDeaDbeefdEAdbeefdEadbEEFdeadbeEFdEaDbeeF) +"; + + test_store::run_test_sequentially(|store| async move { + let store = store.subgraph_store(); + let unvalidated: UnvalidatedSubgraphManifest = { + let mut resolver = TextResolver::default(); + let id = DeploymentHash::new("Qmmanifest").unwrap(); + resolver.add(id.as_str(), &YAML); + resolver.add("/ipfs/Qmabi", &ABI); + resolver.add("/ipfs/Qmschema", &GQL_SCHEMA); + resolver.add("/ipfs/Qmmapping", &MAPPING_WITH_IPFS_FUNC_WASM); + + let resolver: Arc = Arc::new(resolver); + + let raw = serde_yaml::from_str(YAML).unwrap(); + UnvalidatedSubgraphManifest::resolve( + id, + raw, + &resolver, + &LOGGER, + SPEC_VERSION_1_3_0.clone(), + ) + .await + .expect("Parsing simple manifest works") + }; + + let manifest = unvalidated.validate(store.clone(), true).await.unwrap(); + let ds = &manifest.data_sources[0].as_subgraph().unwrap(); + // For more detailed tests of parsing CallDecls see the data_soure + // module in chain/ethereum + let decls = &ds.mapping.handlers[0].calls.decls; + assert_eq!(3, decls.len()); + }); +}