types updated

Author: Samuel Furter

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

@@ -22,12 +22,13 @@ import BN = require('bn.js');
 import {AbstractMethodFactory} from 'web3-core-method';
 import {
     BatchRequest,
-    EthereumProvider,
+    Web3EthereumProvider,
     HttpProvider,
     HttpProviderOptions,
     IpcProvider,
     provider,
     WebsocketProvider,
+    CustomProvider,
     WebsocketProviderOptions
 } from 'web3-providers';
 
@@ -48,8 +49,8 @@ export class AbstractWeb3Module {
     defaultGas: number;
     static readonly providers: Providers;
     defaultAccount: string | null;
-    readonly currentProvider: EthereumProvider | HttpProvider | IpcProvider | WebsocketProvider;
-    readonly givenProvider: object | null;
+    readonly currentProvider: Web3EthereumProvider | HttpProvider | IpcProvider | WebsocketProvider | CustomProvider;
+    readonly givenProvider: any;
 
     setProvider(provider: provider, net?: net.Socket): boolean;
 

packages/web3-core/types/tests/abstract-web3-module-test.ts

@@ -57,13 +57,13 @@ abstractWeb3Module.defaultGas;
 // $ExpectType Providers
 AbstractWeb3Module.providers;
 
-// $ExpectType object | null
+// $ExpectType any
 abstractWeb3Module.givenProvider;
 
 // $ExpectType string | null
 abstractWeb3Module.defaultAccount;
 
-// $ExpectType HttpProvider | IpcProvider | WebsocketProvider | EthereumProvider
+// $ExpectType HttpProvider | IpcProvider | WebsocketProvider | Web3EthereumProvider | CustomProvider
 abstractWeb3Module.currentProvider;
 
 // $ExpectType boolean

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

@@ -71,7 +71,7 @@ eth.subscribe('pendingTransactions', null, (error: Error, transactionHash: strin
 // $ExpectType Providers
 Eth.providers;
 
-// $ExpectType object | null
+// $ExpectType any
 eth.givenProvider;
 
 // $ExpectType BatchRequest
@@ -83,7 +83,7 @@ eth.defaultAccount;
 // $ExpectType string | number
 eth.defaultBlock;
 
-// $ExpectType HttpProvider | IpcProvider | WebsocketProvider | EthereumProvider
+// $ExpectType HttpProvider | IpcProvider | WebsocketProvider | Web3EthereumProvider | CustomProvider
 eth.currentProvider;
 
 // $ExpectType Promise<string>

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

@@ -16,7 +16,7 @@
 */
 /**
  * @file index.d.ts
- * @author Josh Stevens <joshstevens19@hotmail.co.uk>
+ * @author Josh Stevens <joshstevens19@hotmail.co.uk>, Samuel Furter <samuel@ethereum.org>
  * @date 2018
  */
 
@@ -65,6 +65,18 @@ export class HttpProvider {
     disconnect(): boolean;
 }
 
+export class CustomProvider {
+    constructor(injectedProvider: any);
+
+    host: string;
+
+    supportsSubscriptions(): boolean;
+
+    send(method: string, parameters: any[]): Promise<any>;
+
+    sendBatch(methods: AbstractMethod[], moduleInstance: AbstractWeb3Module): Promise<any[]>;
+}
+
 export class AbstractSocketProvider {
     constructor(connection: any, timeout?: number);
 
@@ -108,29 +120,8 @@ export class WebsocketProvider extends AbstractSocketProvider {
     isConnecting(): boolean;
 }
 
-export class Web3EthereumProvider {
-    constructor();
-
-    host: string;
-    registerEventListeners(): void;
-
-    send(method: string, parameters: any[]): Promise<any>;
-
-    sendBatch(methods: AbstractMethod[], moduleInstance: AbstractWeb3Module): Promise<any[]>;
-
-    subscribe(subscribeMethod: string, subscriptionMethod: string, parameters: any[]): Promise<string>;
-
-    unsubscribe(subscriptionId: string, unsubscribeMethod: string): Promise<boolean>;
-
-    clearSubscriptions(unsubscribeMethod: string): Promise<boolean>;
-
-    on(type: string, callback: () => void): void;
-
-    removeListener(type: string, callback: () => void): void;
-
-    removeAllListeners(type: string): void;
-
-    reset(): void;
+export class Web3EthereumProvider extends AbstractSocketProvider {
+    constructor(ethereumProvider: any);
 }
 
 export class JsonRpcMapper {
@@ -147,7 +138,7 @@ export class JsonRpcResponseValidator {
     static isResponseItemValid(response: JsonRpcPayload): boolean;
 }
 
-export type provider = HttpProvider | IpcProvider | WebsocketProvider | Web3EthereumProvider | string;
+export type provider = HttpProvider | IpcProvider | WebsocketProvider | Web3EthereumProvider | CustomProvider | string;
 
 export interface JsonRpcPayload {
     jsonrpc: string;

packages/web3-providers/types/tests/provider-detector-test.ts

@@ -22,5 +22,5 @@
 
 import {ProviderDetector} from 'web3-providers';
 
-// $ExpectType string | HttpProvider | IpcProvider | WebsocketProvider | EthereumProvider | undefined
+// $ExpectType string | HttpProvider | IpcProvider | WebsocketProvider | Web3EthereumProvider | CustomProvider | undefined
 ProviderDetector.detect();

packages/web3-providers/types/tests/provider-module-factory-test.ts

@@ -40,8 +40,8 @@ providersModuleFactory.createHttpProvider('http://localhost:8545');
 // $ExpectType WebsocketProvider
 providersModuleFactory.createWebsocketProvider('http://localhost:8545');
 
-// $ExpectType EthereumProvider
-providersModuleFactory.createEthereumProvider({});
+// $ExpectType Web3EthereumProvider
+providersModuleFactory.createWeb3EthereumProvider({});
 
 // $ExpectType IpcProvider
 providersModuleFactory.createIpcProvider('http://localhost:8545', new net.Server());

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

@@ -27,10 +27,10 @@ shh.setProvider('https://localhost:3000');
 // $ExpectType Providers
 Shh.providers;
 
-// $ExpectType object | null
+// $ExpectType any
 shh.givenProvider;
 
-// $ExpectType HttpProvider | IpcProvider | WebsocketProvider | EthereumProvider
+// $ExpectType HttpProvider | IpcProvider | WebsocketProvider | Web3EthereumProvider | CustomProvider
 shh.currentProvider;
 
 // $ExpectType BatchRequest

packages/web3/types/index.d.ts

@@ -35,7 +35,7 @@ export default class Web3 extends AbstractWeb3Module {
     );
 
     static modules: Modules;
-    static readonly givenProvider: provider | null;
+    static readonly givenProvider: any;
 
     utils: Utils;
     eth: Eth;

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

@@ -22,18 +22,15 @@ import Web3 from 'web3';
 // $ExpectType Modules
 Web3.modules;
 
-// $ExpectType string | HttpProvider | IpcProvider | WebsocketProvider | EthereumProvider | null
-Web3.givenProvider;
-
-const web3 = new Web3('https://localhost:5000/');
-
-// $ExpectType string | HttpProvider | IpcProvider | WebsocketProvider | EthereumProvider | null
+// $ExpectType any
 Web3.givenProvider;
 
 // $ExpectType Providers
 Web3.providers;
 
-// $ExpectType HttpProvider | IpcProvider | WebsocketProvider | EthereumProvider
+const web3 = new Web3('https://localhost:5000/');
+
+// $ExpectType HttpProvider | IpcProvider | WebsocketProvider | Web3EthereumProvider | CustomProvider
 web3.currentProvider;
 
 // $ExpectType Utils