Merge b3c0c03 into a7b5dea

web3 · Sep 20, 2022 · ada912e · ada912e
2 parents a7b5dea + b3c0c03
commit ada912e
Show file tree

Hide file tree

Showing 5 changed files with 10 additions and 7 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -555,6 +555,7 @@ Released with 1.0.0-beta.37 code base.
 -  Updated libraries using BN and the BN library (#5072)
 
 ### Added
+- Generic types for `Contract`, now you can add types for your contract methods and events
 - Exposing `web3.eth.Contract.setProvider()` as per public documentation (#4822) (#5001)
 - Improve npm script commands for development purposes (#4848)
 

diff --git a/packages/web3-eth-contract/types/index.d.ts b/packages/web3-eth-contract/types/index.d.ts
@@ -22,8 +22,8 @@ import {Common, PromiEvent, provider, hardfork, chain, BlockNumber, PastLogsOpti
 import {Accounts} from 'web3-eth-accounts';
 import {AbiItem} from 'web3-utils';
 
-// TODO: Add generic type!
-export class Contract {
+// Here you can provide generated types for methods and events from your contract
+export class Contract<Methods = any, Events = any> {
     constructor(
         jsonInterface: AbiItem[],
         address?: string,
@@ -50,7 +50,7 @@ export class Contract {
 
     deploy(options: DeployOptions): ContractSendMethod;
 
-    methods: any;
+    methods: Methods;
 
     once(
         event: string,
@@ -62,7 +62,7 @@ export class Contract {
         callback: (error: Error, event: EventData) => void
     ): void;
 
-    events: any;
+    events: Events;
 
     getPastEvents(event: string): Promise<EventData[]>;
     getPastEvents(

diff --git a/packages/web3-eth/types/index.d.ts b/packages/web3-eth/types/index.d.ts
@@ -65,11 +65,12 @@ export class Eth {
     constructor(provider: provider);
     constructor(provider: provider, net: net.Socket);
 
-    Contract: new (
+    // Here you can provide generated types for methods and events from your contract
+    Contract: new <Methods = any, Events = any>(
         jsonInterface: AbiItem[] | AbiItem,
         address?: string,
         options?: ContractOptions
-    ) => Contract;
+    ) => Contract<Methods, Events>;
     Iban: new (iban: string) => Iban;
     personal: Personal;
     accounts: Accounts;

diff --git a/packages/web3-eth/types/tests/eth.tests.ts b/packages/web3-eth/types/tests/eth.tests.ts
@@ -77,7 +77,7 @@ eth.transactionBlockTimeout;
 // $ExpectType boolean
 eth.handleRevert;
 
-// $ExpectType new (jsonInterface: AbiItem | AbiItem[], address?: string | undefined, options?: ContractOptions | undefined) => Contract
+// $ExpectType new <Methods = any, Events = any>(jsonInterface: AbiItem | AbiItem[], address?: string | undefined, options?: ContractOptions | undefined) => Contract<Methods, Events>
 eth.Contract;
 
 // $ExpectType new (iban: string) => Iban

diff --git a/packages/web3-eth/types/tslint.json b/packages/web3-eth/types/tslint.json
@@ -1,6 +1,7 @@
 {
     "extends": "dtslint/dtslint.json",
     "rules": {
+        "no-unnecessary-generics": false,
         "semicolon": false,
         "no-import-default-of-export-equals": false,
         "file-name-casing": [true, "kebab-case"],