Implement the eth_getFilterLogs endpoint

api/pull.go

@@ -259,9 +259,51 @@ func (api *PullAPI) NewFilter(criteria filters.FilterCriteria) (rpc.ID, error) {
 }
 
 // GetFilterLogs returns the logs for the filter with the given id.
-// If the filter could not be found an empty array of logs is returned.
-func (api *PullAPI) GetFilterLogs(ctx context.Context, id rpc.ID) ([]*gethTypes.Log, error) {
-	panic("not implemented")
+// If the filter could not be found, `nil` is returned.
+func (api *PullAPI) GetFilterLogs(
+	ctx context.Context,
+	id rpc.ID,
+) ([]*gethTypes.Log, error) {
+	api.mux.Lock()
+	defer api.mux.Unlock()
+
+	filter, ok := api.filters[id]
+	if !ok {
+		return nil, errors.Join(
+			errs.ErrNotFound,
+			fmt.Errorf("filted by id %s does not exist", id),
+		)
+	}
+
+	if filter.expired() {
+		api.UninstallFilter(id)
+		return nil, errors.Join(
+			errs.ErrNotFound,
+			fmt.Errorf("filted by id %s has expired", id),
+		)
+	}
+
+	logsFilter, ok := filter.(*logsFilter)
+	if !ok {
+		return nil, fmt.Errorf("filted by id %s is not a logs filter", id)
+	}
+
+	current, err := api.blocks.LatestEVMHeight()
+	if err != nil {
+		return nil, err
+	}
+
+	result, err := api.getLogs(current, logsFilter)
+	if err != nil {
+		return nil, err
+	}
+
+	logs, ok := result.([]*gethTypes.Log)
+	if !ok {
+		return nil, fmt.Errorf("logs filter returned incorrect type: %T", logs)
+	}
+
+	return logs, nil
 }
 
 // GetFilterChanges returns the logs for the filter with the given id since

tests/e2e_web3js_test.go

@@ -26,6 +26,10 @@ func TestWeb3_E2E(t *testing.T) {
 		runWeb3Test(t, "eth_logs_filtering_test")
 	})
 
+	t.Run("eth_getFilterLogs", func(t *testing.T) {
+		runWeb3Test(t, "eth_get_filter_logs_test")
+	})
+
 	t.Run("streaming of entities and subscription", func(t *testing.T) {
 		runWeb3Test(t, "eth_streaming_test")
 	})

tests/web3js/eth_get_filter_logs_test.js

@@ -0,0 +1,77 @@
+const { assert } = require('chai')
+const conf = require('./config')
+const helpers = require('./helpers')
+const web3 = conf.web3
+
+it('returns a null result for missing filter', async () => {
+  // check that null is returned when the filter could not be found.
+  let response = await helpers.callRPCMethod('eth_getFilterLogs', ['0xffa1'])
+
+  assert.equal(200, response.status)
+  assert.isUndefined(response.body['result'])
+})
+
+it('create logs filter and call eth_getFilterLogs', async () => {
+  // deploy contract
+  let deployed = await helpers.deployContract('storage')
+  let contractAddress = deployed.receipt.contractAddress
+
+  // create logs filter on the address of the deployed contract
+  let response = await helpers.callRPCMethod('eth_newFilter', [{ 'address': contractAddress }])
+
+  assert.equal(200, response.status)
+  assert.isDefined(response.body['result'])
+  let filterID = response.body['result']
+
+  // make contract function call that emits a log
+  let res = await helpers.signAndSend({
+    from: conf.eoa.address,
+    to: contractAddress,
+    data: deployed.contract.methods.sum(15, 20).encodeABI(),
+    gas: 1000000,
+    gasPrice: 0
+  })
+  assert.equal(res.receipt.status, conf.successStatus)
+
+  // check the matching items from the logs filter
+  response = await helpers.callRPCMethod('eth_getFilterLogs', [filterID])
+
+  assert.equal(200, response.status)
+  assert.equal(1, response.body['result'].length)
+
+  let logs = response.body['result']
+  assert.equal(contractAddress.toLowerCase(), logs[0].address)
+  assert.lengthOf(logs[0].topics, 4)
+  assert.equal(
+    '35',
+    web3.eth.abi.decodeParameter("int256", logs[0].data)
+  )
+
+  // make contract function call that emits another log
+  res = await helpers.signAndSend({
+    from: conf.eoa.address,
+    to: contractAddress,
+    data: deployed.contract.methods.sum(30, 20).encodeABI(),
+    gas: 1000000,
+    gasPrice: 0
+  })
+
+  assert.equal(res.receipt.status, conf.successStatus)
+
+  // check the matching items from the logs filter include both logs
+  // from the above 2 contract function calls
+  response = await helpers.callRPCMethod('eth_getFilterLogs', [filterID])
+
+  assert.equal(200, response.status)
+  assert.equal(2, response.body['result'].length)
+  logs = response.body['result']
+  console.log()
+
+  assert.equal(contractAddress.toLowerCase(), logs[1].address)
+  assert.lengthOf(logs[1].topics, 4)
+  assert.equal(
+    '50',
+    web3.eth.abi.decodeParameter("int256", logs[1].data)
+  )
+
+}).timeout(10 * 1000)

tests/web3js/helpers.js

@@ -1,50 +1,70 @@
 const fs = require("fs")
 const conf = require("./config")
-const {assert} = require("chai");
+const chai = require("chai")
+const chaiHttp = require('chai-http')
 const web3 = conf.web3
 
+chai.use(chaiHttp);
+
 // deployContract deploys a contract by name, the contract files must be saved in
 // fixtures folder, each contract must have two files: ABI and bytecode,
 // the ABI file must be named {name}ABI.json and contain ABI definition for the contract
 // and bytecode file must be named {name}.byte and must contain compiled byte code of the contract.
 //
 // Returns the contract object as well as the receipt deploying the contract.
 async function deployContract(name) {
-    const abi = require(`../fixtures/${name}ABI.json`)
-    const code = await fs.promises.readFile(`${__dirname}/../fixtures/${name}.byte`, 'utf8')
-    const contractABI = new web3.eth.Contract(abi)
-
-    let data = contractABI
-        .deploy({ data: `0x${code}` })
-        .encodeABI()
-
-    let signed = await conf.eoa.signTransaction({
-        from: conf.eoa.address,
-        data: data,
-        value: '0',
-        gasPrice: '0',
-    })
+  const abi = require(`../fixtures/${name}ABI.json`)
+  const code = await fs.promises.readFile(`${__dirname}/../fixtures/${name}.byte`, 'utf8')
+  const contractABI = new web3.eth.Contract(abi)
+
+  let data = contractABI
+    .deploy({ data: `0x${code}` })
+    .encodeABI()
+
+  let signed = await conf.eoa.signTransaction({
+    from: conf.eoa.address,
+    data: data,
+    value: '0',
+    gasPrice: '0',
+  })
 
-    let receipt = await web3.eth.sendSignedTransaction(signed.rawTransaction)
+  let receipt = await web3.eth.sendSignedTransaction(signed.rawTransaction)
 
-    return {
-        contract: new web3.eth.Contract(abi, receipt.contractAddress),
-        receipt: receipt
-    }
+  return {
+    contract: new web3.eth.Contract(abi, receipt.contractAddress),
+    receipt: receipt
+  }
 }
 
 // signAndSend signs a transactions and submits it to the network,
 // returning a transaction hash and receipt
 async function signAndSend(tx) {
-    const signedTx = await conf.eoa.signTransaction(tx)
-    // send transaction and make sure interaction was success
-    const receipt = await web3.eth.sendSignedTransaction(signedTx.rawTransaction)
-
-    return {
-        hash: signedTx.transactionHash,
-        receipt: receipt,
-    }
+  const signedTx = await conf.eoa.signTransaction(tx)
+  // send transaction and make sure interaction was success
+  const receipt = await web3.eth.sendSignedTransaction(signedTx.rawTransaction)
+
+  return {
+    hash: signedTx.transactionHash,
+    receipt: receipt,
+  }
+}
+
+// callRPCMethod accepts a method name and its params and
+// makes a POST request to the JSON-RPC API server.
+// Returns a promise for the response.
+async function callRPCMethod(methodName, params) {
+  return chai.request('http://127.0.0.1:8545')
+    .post('/')
+    .set('Content-Type', 'application/json')
+    .set('Accept', 'application/json')
+    .send({
+      'jsonrpc': '2.0',
+      'method': methodName,
+      'id': 1,
+      'params': params
+    })
 }
 
 exports.signAndSend = signAndSend
-exports.deployContract = deployContract
+exports.deployContract = deployContract
+exports.callRPCMethod = callRPCMethod