✨ Added provider.getLogs fn

src/providers/BaseProvider.ts

@@ -454,14 +454,51 @@ export abstract class BaseProvider {
   }
 
   /**
+   * Returns transaction receipt event logs that match a specified filter
+   * May return [] if parameters are too broad, even if logs exist
    *
+   * * Identical to ["ethers.provider.getLogs" in ethers.js](https://docs.ethers.io/v5/api/providers/provider/#Provider-getLogs)
+   * * Identical to ["web3.eth.getPastLogs" in web3.js](https://web3js.readthedocs.io/en/v1.7.3/web3-eth.html#getpastlogs)
    *
+   * @param filter parameters to filter the logs by
    *
+   * @returns an array of logs matching the specified filter
+   *
+   * @example
+   * ```javascript
+   * provider.getLogs({
+   *   address: "0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2",
+   *   topics: [
+   *     "0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef",
+   *     "0x00000000000000000000000021b8065d10f73ee2e260e5b47d3344d3ced7596e",
+   *   ],
+   *   fromBlock: 14825027,
+   *   toBlock: 14825039,
+   * });
+   *
+   * [        
+   *   {      
+   *     address: '0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2',
+   *     blockHash: '0x8e0dfac2f704851960f866c8708b3bef2f66c0fee0329cf25ff0261b264ca6bc',
+   *     blockNumber: 14825029,
+   *     data: '0x000000000000000000000000000000000000000000000000005f862ee352a38a',
+   *     logIndex: 384,
+   *     removed: false,
+   *     topics: [
+   *       '0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef',
+   *       '0x00000000000000000000000021b8065d10f73ee2e260e5b47d3344d3ced7596e',
+   *       '0x00000000000000000000000068b3465833fb72a70ecdf485e0e4c7bd8665fc45'
+   *     ],
+   *     transactionHash: '0xbd49031be16f8fd1775f4e0fe79b408ffd8ae9c65b2827ee47e3238e3f51f4c0',
+   *     transactionIndex: 226
+   *   }
+   * ]
+   * ```
    */
   public async getLogs(
     filter: Filter | FilterByBlockHash,
   ): Promise<Array<Log>> {
-    let filterByRange = filter as Filter;
+    const filterByRange = filter as Filter;
     if (filterByRange.fromBlock)
       filterByRange.fromBlock = prepBlockTag(filterByRange.fromBlock);
     if (filterByRange.toBlock)

src/providers/test/json-rpc-provider/get-logs.test.ts

@@ -1,6 +1,8 @@
 import { StaticJsonRpcProvider } from '@ethersproject/providers';
 import Web3 from 'web3';
 import { JsonRpcProvider } from '../../../index';
+import { Log } from '../../../types/Transaction.types';
+import { Filter } from './../../../types/Filter.types';
 import { rpcUrls } from './../rpc-urls';
 
 const rpcUrl = rpcUrls.mainnet;
@@ -10,31 +12,77 @@ describe('provider.getLogs', () => {
   const ethersProvider = new StaticJsonRpcProvider(rpcUrl);
   const web3Provider = new Web3(rpcUrl);
 
-  it('should match ethers.js', async () => {
-    const filter = {
-      fromBlock: '0xE1F8F1',
-      toBlock: '0xE1F8F1',
-      address: '0xfbddadd80fe7bda00b901fbaf73803f2238ae655',
-    };
+  const filterAddressFromTo: Filter = {
+    address: '0xfbddadd80fe7bda00b901fbaf73803f2238ae655',
+    fromBlock: '0xE1F8F1',
+    toBlock: '0xE1F8F1',
+  };
+
+  const filterAddressTopics: Filter = {
+    address: '0x596a0f276ee432d8a28441e55737ff55cf30d0f7',
+    topics: [
+      '0x8c5be1e5ebec7d5bd14f71427d1e84f3dd0314c0f7b2291e5b200ac8c7c3b925',
+    ],
+  };
+
+  const filterAll: Filter = {
+    address: '0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2',
+    topics: [
+      '0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef',
+      '0x00000000000000000000000021b8065d10f73ee2e260e5b47d3344d3ced7596e',
+    ],
+    fromBlock: 14825027,
+    toBlock: 14825039,
+  };
+
+  function testLogEquality(ee: Array<Log>, other: Array<any>) {
+    expect(ee).not.toBe([]); // indicates that filter needs to be updated; logs are from blocks too long ago to retrieve without full archive
+    other.forEach((log: any) => {
+      if (log.id) delete log.id;
+    });
+    expect(ee).toStrictEqual(other);
+  }
+
+  it('should match ethers.js -- address, from, to', async () => {
+    const [eeLogs, ethersLogs] = await Promise.all([
+      essentialEthProvider.getLogs(filterAddressFromTo),
+      ethersProvider.getLogs(filterAddressFromTo),
+    ]);
+    testLogEquality(eeLogs, ethersLogs);
+  });
+  it('should match ethers.js -- address, topics', async () => {
+    const [eeLogs, ethersLogs] = await Promise.all([
+      essentialEthProvider.getLogs(filterAddressTopics),
+      ethersProvider.getLogs(filterAddressTopics),
+    ]);
+    testLogEquality(eeLogs, ethersLogs);
+  });
+  it('should match ethers.js -- address, topics, from, to', async () => {
     const [eeLogs, ethersLogs] = await Promise.all([
-      essentialEthProvider.getLogs(filter),
-      ethersProvider.getLogs(filter),
+      essentialEthProvider.getLogs(filterAll),
+      ethersProvider.getLogs(filterAll),
     ]);
-    expect(eeLogs).toStrictEqual(ethersLogs);
+    testLogEquality(eeLogs, ethersLogs);
   });
-  it('should match web3.js', async () => {
-    const filter = {
-      fromBlock: '0xE1F8F1',
-      toBlock: '0xE1F8F1',
-      address: '0xfbddadd80fe7bda00b901fbaf73803f2238ae655',
-    };
+  it('should match web3.js -- address, from, to', async () => {
     const [eeLogs, web3Logs] = await Promise.all([
-      essentialEthProvider.getLogs(filter),
-      web3Provider.eth.getPastLogs(filter),
+      essentialEthProvider.getLogs(filterAddressFromTo),
+      web3Provider.eth.getPastLogs(filterAddressFromTo),
     ]);
-    web3Logs.forEach((log: any) => {
-      delete log.id;
-    });
-    expect(eeLogs).toStrictEqual(web3Logs);
+    testLogEquality(eeLogs, web3Logs);
+  });
+  it('should match web3.js -- address, topics', async () => {
+    const [eeLogs, web3Logs] = await Promise.all([
+      essentialEthProvider.getLogs(filterAddressTopics),
+      web3Provider.eth.getPastLogs(filterAddressTopics),
+    ]);
+    testLogEquality(eeLogs, web3Logs);
+  });
+  it('should match web3.js -- address, topics, from, to', async () => {
+    const [eeLogs, web3Logs] = await Promise.all([
+      essentialEthProvider.getLogs(filterAll),
+      web3Provider.eth.getPastLogs(filterAll),
+    ]);
+    testLogEquality(eeLogs, web3Logs);
   });
 });