[pallet-revive] Add eth_get_logs

prdoc/pr_7506.prdoc

@@ -0,0 +1,9 @@
+title: '[pallet-revive] Add eth_get_logs'
+doc:
+- audience: Runtime Dev
+  description: "Add support for eth_get_logs rpc method\r\n"
+crates:
+- name: pallet-revive-eth-rpc
+  bump: minor
+- name: pallet-revive
+  bump: minor

substrate/frame/revive/rpc/Cargo.toml

@@ -70,6 +70,7 @@ tokio = { workspace = true, features = ["full"] }
 
 [dev-dependencies]
 env_logger = { workspace = true }
+pretty_assertions = { workspace = true }
 static_init = { workspace = true }
 substrate-cli-test-utils = { workspace = true }
 subxt-signer = { workspace = true, features = ["unstable-eth"] }

substrate/frame/revive/rpc/examples/js/src/geth-diff.test.ts

@@ -364,5 +364,42 @@ for (const env of envs) {
 				],
 			})
 		})
+
+		test('logs', async () => {
+			let address = await getEventExampleAddr()
+			let { request } = await env.serverWallet.simulateContract({
+				address,
+				abi: EventExampleAbi,
+				functionName: 'triggerEvent',
+			})
+
+			let hash = await env.serverWallet.writeContract(request)
+			let receipt = await env.serverWallet.waitForTransactionReceipt({ hash })
+			const logs = await env.serverWallet.getLogs({
+				address,
+				blockHash: receipt.blockHash,
+			})
+			expect(logs).toHaveLength(1)
+			expect(logs[0]).toMatchObject({
+				address,
+				data: '0x00000000000000000000000000000000000000000000000000000000000030390000000000000000000000000000000000000000000000000000000000000040000000000000000000000000000000000000000000000000000000000000000b48656c6c6f20776f726c64000000000000000000000000000000000000000000',
+				transactionHash: hash,
+			})
+
+			expect(
+				decodeEventLog({
+					abi: EventExampleAbi,
+					data: logs[0].data,
+					topics: logs[0].topics,
+				})
+			).toEqual({
+				eventName: 'ExampleEvent',
+				args: {
+					sender: env.serverWallet.account.address,
+					value: 12345n,
+					message: 'Hello world',
+				},
+			})
+		})
 	})
 }

substrate/frame/revive/rpc/migrations/0002_create_log_table.sql

@@ -0,0 +1,28 @@
+CREATE TABLE IF NOT EXISTS logs (
+	block_hash BLOB NOT NULL,
+	transaction_index INTEGER NOT NULL,
+	log_index INTEGER NOT NULL,
+    address BLOB NOT NULL,
+    block_number INTEGER NOT NULL,
+	transaction_hash BLOB NOT NULL,
+    topic_0 BLOB,
+    topic_1 BLOB,
+    topic_2 BLOB,
+    topic_3 BLOB,
+    data BLOB,
+	PRIMARY KEY (block_hash, transaction_index, log_index)
+);
+
+CREATE INDEX IF NOT EXISTS idx_block_number_address_topics ON logs (
+	block_number,
+	address,
+	topic_0,
+	topic_1,
+	topic_2,
+	topic_3
+);
+
+CREATE INDEX IF NOT EXISTS idx_block_hash ON logs (
+	block_hash
+);
+

substrate/frame/revive/rpc/src/block_info_provider.rs

@@ -38,6 +38,11 @@ pub trait BlockInfoProvider: Send + Sync {
 	/// Return the latest ingested block.
 	async fn latest_block(&self) -> Option<Arc<SubstrateBlock>>;
 
+	/// Return the latest block number
+	async fn latest_block_number(&self) -> Option<SubstrateBlockNumber> {
+		return self.latest_block().await.map(|block| block.number());
+	}
+
 	/// Get block by block_number.
 	async fn block_by_number(
 		&self,
@@ -225,6 +230,10 @@ pub mod test {
 			None
 		}
 
+		async fn latest_block_number(&self) -> Option<SubstrateBlockNumber> {
+			Some(2u32)
+		}
+
 		async fn block_by_number(
 			&self,
 			_block_number: SubstrateBlockNumber,

substrate/frame/revive/rpc/src/client.rs

@@ -25,9 +25,9 @@ use crate::{
 use jsonrpsee::types::{error::CALL_EXECUTION_FAILED_CODE, ErrorObjectOwned};
 use pallet_revive::{
 	evm::{
-		extract_revert_message, Block, BlockNumberOrTag, BlockNumberOrTagOrHash,
-		GenericTransaction, ReceiptInfo, SyncingProgress, SyncingStatus, TransactionSigned, H160,
-		H256, U256,
+		extract_revert_message, Block, BlockNumberOrTag, BlockNumberOrTagOrHash, Filter,
+		GenericTransaction, Log, ReceiptInfo, SyncingProgress, SyncingStatus, TransactionSigned,
+		H160, H256, U256,
 	},
 	EthTransactError, EthTransactInfo,
 };
@@ -132,6 +132,9 @@ pub enum ClientError {
 	/// The cache is empty.
 	#[error("cache is empty")]
 	CacheEmpty,
+	/// Failed to filter logs.
+	#[error("Failed to filter logs")]
+	LogFilterFailed(#[from] anyhow::Error),
 }
 
 const REVERT_CODE: i32 = 3;
@@ -712,4 +715,11 @@ impl Client {
 	pub fn max_block_weight(&self) -> Weight {
 		self.max_block_weight
 	}
+
+	/// Get the logs matching the given filter.
+	pub async fn logs(&self, filter: Option<Filter>) -> Result<Vec<Log>, ClientError> {
+		let logs =
+			self.receipt_provider.logs(filter).await.map_err(ClientError::LogFilterFailed)?;
+		Ok(logs)
+	}
 }

substrate/frame/revive/rpc/src/lib.rs

@@ -287,6 +287,11 @@ impl EthRpcServer for EthRpcServerImpl {
 		Ok(self.client.receipts_count_per_block(&block.hash).await.map(U256::from))
 	}
 
+	async fn get_logs(&self, filter: Option<Filter>) -> RpcResult<FilterResults> {
+		let logs = self.client.logs(filter).await?;
+		Ok(FilterResults::Logs(logs))
+	}
+
 	async fn get_storage_at(
 		&self,
 		address: H160,

substrate/frame/revive/rpc/src/receipt_provider.rs

@@ -16,7 +16,7 @@
 // limitations under the License.
 
 use jsonrpsee::core::async_trait;
-use pallet_revive::evm::{ReceiptInfo, TransactionSigned, H256};
+use pallet_revive::evm::{Filter, Log, ReceiptInfo, TransactionSigned, H256};
 use tokio::join;
 
 mod cache;
@@ -34,6 +34,9 @@ pub trait ReceiptProvider: Send + Sync {
 	/// Similar to `insert`, but intended for archiving receipts from historical blocks.
 	async fn archive(&self, block_hash: &H256, receipts: &[(TransactionSigned, ReceiptInfo)]);
 
+	/// Get logs that match the given filter.
+	async fn logs(&self, filter: Option<Filter>) -> anyhow::Result<Vec<Log>>;
+
 	/// Deletes receipts associated with the specified block hash.
 	async fn remove(&self, block_hash: &H256);
 
@@ -102,4 +105,8 @@ impl<Cache: ReceiptProvider, Archive: ReceiptProvider> ReceiptProvider for (Cach
 		}
 		self.1.signed_tx_by_hash(hash).await
 	}
+
+	async fn logs(&self, filter: Option<Filter>) -> anyhow::Result<Vec<Log>> {
+		self.1.logs(filter).await
+	}
 }

substrate/frame/revive/rpc/src/receipt_provider/cache.rs

@@ -16,7 +16,7 @@
 // limitations under the License.
 use super::ReceiptProvider;
 use jsonrpsee::core::async_trait;
-use pallet_revive::evm::{ReceiptInfo, TransactionSigned, H256};
+use pallet_revive::evm::{Filter, Log, ReceiptInfo, TransactionSigned, H256};
 use std::{collections::HashMap, sync::Arc};
 use tokio::sync::RwLock;
 
@@ -37,6 +37,10 @@ impl CacheReceiptProvider {
 impl ReceiptProvider for CacheReceiptProvider {
 	async fn archive(&self, _block_hash: &H256, _receipts: &[(TransactionSigned, ReceiptInfo)]) {}
 
+	async fn logs(&self, _filter: Option<Filter>) -> anyhow::Result<Vec<Log>> {
+		anyhow::bail!("Not implemented")
+	}
+
 	async fn insert(&self, block_hash: &H256, receipts: &[(TransactionSigned, ReceiptInfo)]) {
 		let mut cache = self.cache.write().await;
 		cache.insert(block_hash, receipts);