Add EIP-1193 compatible provider to AbstractProvider interface

CHANGELOG.md

@@ -179,12 +179,15 @@ Released with 1.0.0-beta.37 code base.
 ### Added
 
 - Introduce review and release guidelines. (#3460)
+- Add EIP-1193 compatible provider to `AbstractProvider` interface. (#3499)
+- Add Typescript definitions for contract `methods` and `call`. (#3454)
 
 ### Changed
 
 - Change CI provider from Travis to Github Actions. (#3468)
 - Update `web3-eth-abi` ABICoder dependency. (#3490)
 - Improve code clarity of HttpProvider keepAlive option setting. (#3463)
+- Updated type definitions for Web3 HTTP Provider. (#3482)
 
 ### Fixed
 

packages/web3-core/package.json

@@ -1,7 +1,7 @@
 {
     "name": "web3-core",
     "version": "1.2.7",
-    "description": "Web3 core tools for sub packages. This is an internal package.",
+    "description": "Web3 core tools for sub-packages. This is an internal package.",
     "repository": "https://github.com/ethereum/web3.js/tree/1.x/packages/web3-core",
     "license": "LGPL-3.0",
     "engines": {

packages/web3-core/types/index.d.ts

@@ -19,7 +19,6 @@
  */
 
 import * as net from 'net';
-import { EventEmitter } from "events"
 import {
     HttpProviderBase,
     HttpProviderOptions,
@@ -411,9 +410,16 @@ export interface LogsOptions {
 
 export type BlockNumber = string | number | BN | BigNumber | 'latest' | 'pending' | 'earliest' | 'genesis';
 
+export interface RequestArguments {
+    method: string;
+    params?: any;
+    [key: string]: any;
+}
+
 export interface AbstractProvider {
-    send(payload: JsonRpcPayload, callback: (error: Error | null, result?: JsonRpcResponse) => void): void;
     sendAsync(payload: JsonRpcPayload, callback: (error: Error | null, result?: JsonRpcResponse) => void): void;
+    send?(payload: JsonRpcPayload, callback: (error: Error | null, result?: JsonRpcResponse) => void): void;
+    request?(args: RequestArguments): Promise<any>;
   }
 
 export type provider =

packages/web3/types/tests/web3-test.ts

@@ -19,9 +19,8 @@
 
 import Web3 from 'web3';
 import * as net from 'net';
-import { AbstractProvider } from 'web3-core';
-import { JsonRpcPayload, JsonRpcResponse } from "web3-core-helpers"
-import { EventEmitter } from 'events';
+import { AbstractProvider, RequestArguments } from 'web3-core';
+import { JsonRpcPayload, JsonRpcResponse } from 'web3-core-helpers';
 
 // $ExpectType Utils
 Web3.utils;
@@ -89,9 +88,25 @@ web3 = new Web3('https://localhost:5000/', netSocket);
 // $ExpectType Web3
 web3 = new Web3();
 
-class CustomProvider implements AbstractProvider {
+class CustomProvider1 implements AbstractProvider {
+    sendAsync(payload: JsonRpcPayload, callback: (error: Error | null, result?: JsonRpcResponse) => void) {}
+}
+
+// $ExpectType Web3
+web3 = new Web3(new CustomProvider1());
+
+class CustomProvider2 implements AbstractProvider {
     send(payload: JsonRpcPayload, callback: (error: Error | null, result?: JsonRpcResponse) => void) {}
     sendAsync(payload: JsonRpcPayload, callback: (error: Error | null, result?: JsonRpcResponse) => void) {}
 }
+
+// $ExpectType Web3
+web3 = new Web3(new CustomProvider2());
+
+class CustomProvider3 implements AbstractProvider {
+    async request(args: RequestArguments) {}
+    sendAsync(payload: JsonRpcPayload, callback: (error: Error | null, result?: JsonRpcResponse) => void) {}
+}
+
 // $ExpectType Web3
-web3 = new Web3(new CustomProvider());
+web3 = new Web3(new CustomProvider3());