✨ feat(ethers): Make events typesafe (#479)

## Description

Make ethers events typesafe

## Testing

Explain the quality checks that have been done on the code changes

## Additional Information

- [ ] I read the [contributing docs](../docs/contributing.md) (if this
is your first contribution)

Your ENS/address:

Co-authored-by: Will Cory <[email protected]>

.changeset/cyan-trainers-change.md

@@ -0,0 +1,5 @@
+---
+"@evmts/ethers": minor
+---
+
+Add typesafe event inputs. The input type will have autocomplete but still is widened to accept the ethers type. The return type is extremely difficult to override to being generic

ethers/src/Contract.spec.ts

@@ -289,24 +289,4 @@ describe('ethers.Contract', () => {
 			await c.balanceOf('0x32307adfFE088e383AFAa721b06436aDaBA47DBE'),
 		).toMatchInlineSnapshot('0n')
 	})
-
-	test('should work with custom address with chainId supplied even though the chainId is unnecessary', async () => {
-		const c = new Contract(addresses[420], abi, provider)
-		expect(c).toBeInstanceOf(Contract)
-		expect(await c.name({ blockTag: 12865720 })).toMatchInlineSnapshot(
-			'"OptimismUselessToken-1"',
-		)
-		expect(await c.symbol({ blockTag: 12865720 })).toMatchInlineSnapshot(
-			'"OUT-1"',
-		)
-		expect(await c.decimals({ blockTag: 12865720 })).toMatchInlineSnapshot(
-			'18n',
-		)
-		expect(await c.totalSupply({ blockTag: 12865720 })).toMatchInlineSnapshot(
-			'71000000000000000000000n',
-		)
-		expect(
-			await c.balanceOf('0x32307adfFE088e383AFAa721b06436aDaBA47DBE'),
-		).toMatchInlineSnapshot('0n')
-	})
 })

ethers/src/TypesafeEthersContract.ts

@@ -2,11 +2,19 @@ import type { BaseContractMethod } from './BaseContractMethod'
 import type {
 	Abi,
 	AbiParametersToPrimitiveTypes,
+	ExtractAbiEvent,
+	ExtractAbiEventNames,
 	ExtractAbiFunction,
 	ExtractAbiFunctionNames,
 } from 'abitype'
-import type { ContractTransactionResponse } from 'ethers'
-import type { BaseContract } from 'ethers'
+import type { Log } from 'ethers'
+import type { EventLog } from 'ethers'
+import type { BlockTag } from 'ethers'
+import type {
+	BaseContract,
+	ContractEventName,
+	ContractTransactionResponse,
+} from 'ethers'
 
 export type TypesafeEthersContract<TAbi extends Abi> = BaseContract & {
 	// readonly methods
@@ -43,4 +51,23 @@ export type TypesafeEthersContract<TAbi extends Abi> = BaseContract & {
 		>[0],
 		ContractTransactionResponse
 	>
+} & {
+	// events
+	queryFilter: <
+		TContractEventName extends
+			| Omit<ContractEventName, ExtractAbiEventNames<TAbi>>
+			| ExtractAbiEventNames<TAbi>,
+	>(
+		event: TContractEventName,
+		fromBlock?: BlockTag,
+		toBlock?: BlockTag,
+		// TODO this return type does not work
+		// this is extremely difficult to override the return type into being generic
+	) => Promise<
+		Array<
+			TContractEventName extends ExtractAbiEventNames<TAbi>
+				? ExtractAbiEvent<TAbi, TContractEventName>
+				: EventLog | Log
+		>
+	>
 }