Merge pull request #2123 from joshstevens19/web3-types

Web3 types
web3 · Dec 17, 2018 · 987429c · 987429c
2 parents df375c2 + 0c74c90
commit 987429c
Show file tree

Hide file tree

Showing 11 changed files with 531 additions and 6 deletions.
diff --git a/packages/web3-core/types/index.d.ts b/packages/web3-core/types/index.d.ts
@@ -37,6 +37,8 @@ export class AbstractWeb3Module {
     readonly defaultBlock: string | number;
     readonly defaultAccount: string | null;
     readonly currentProvider: AbstractProviderAdapter;
+    readonly providers: Providers;
+    readonly givenProvider: provider | null;
     setProvider(provider: AbstractProviderAdapter | provider, net?: net.Server): boolean;
     isSameProvider(provider: AbstractProviderAdapter | provider): boolean;
     clearSubscriptions(): void;

diff --git a/packages/web3-eth/types/index.d.ts b/packages/web3-eth/types/index.d.ts
@@ -48,7 +48,7 @@ export class Eth extends AbstractWeb3Module {
     setProvider(provider: AbstractProviderAdapter | provider, net?: net.Server): boolean;
     readonly providers: Providers;
     readonly givenProvider: provider | null;
-    BatchRequest(): BatchRequest;
+    BatchRequest: new () => BatchRequest;
     getProtocolVersion(callback?: (error: Error, protocolVersion: string) => void): Promise<string>;
     isSyncing(callback?: (error: Error, syncing: Syncing) => void): Promise<Syncing | boolean>;
     getCoinbase(callback?: (error: Error, coinbaseAddress: string) => void): Promise<string>;

diff --git a/packages/web3-eth/types/tests/eth.tests.ts b/packages/web3-eth/types/tests/eth.tests.ts
@@ -78,7 +78,7 @@ eth.providers;
 eth.givenProvider;
 
 // $ExpectType BatchRequest
-eth.BatchRequest();
+new eth.BatchRequest();
 
 // $ExpectType string | null
 eth.defaultAccount

diff --git a/packages/web3-providers/types/index.d.ts b/packages/web3-providers/types/index.d.ts
@@ -55,6 +55,7 @@ export class SocketProviderAdapter extends AbstractProviderAdapter {
 }
 
 export class BatchRequest {
+    constructor();
     constructor(provider: provider, jsonRpcMapper: JsonRpcMapper, jsonRpcResponseValidator: JsonRpcResponseValidator);
     add(request: any): void;
     execute(): void;

diff --git a/packages/web3-utils/types/index.d.ts b/packages/web3-utils/types/index.d.ts
@@ -123,13 +123,60 @@ export function jsonInterfaceMethodToString(abiItem: ABIItem): string;
 export function soliditySha3(...val: Mixed[]): string;
 export function getUnitValue(unit: Unit): string;
 export function unitMap(): Units;
-
 // bloom types
 export function testAddress(bloom: string, address: string): boolean;
 export function testTopic(bloom: string, topic: string): boolean;
 
 // interfaces
 
+export interface Utils {
+    isBN(value: string | number): boolean;
+    isBigNumber(value: BN): boolean;
+    toBN(value: number | string): BN;
+    toTwosComplement(value: number | string | BN): string;
+    isAddress(address: string): boolean;
+    isHex(hex: Hex): boolean;
+    isHexStrict(hex: Hex): boolean;
+    asciiToHex(string: string): string;
+    hexToAscii(string: string): string;
+    toAscii(string: string): string;
+    bytesToHex(bytes: number[]): string;
+    numberToHex(value: number | string | BN): string;
+    checkAddressChecksum(address: string): boolean;
+    fromAscii(string: string): string;
+    fromDecimal(value: string | number): string;
+    fromUtf8(string: string): string;
+    fromWei(value: BN, unit?: Unit): BN | string;
+    hexToBytes(hex: Hex): number[];
+    hexToNumber(hex: Hex): number;
+    hexToNumberString(hex: Hex): string;
+    hexToString(hex: Hex): string;
+    hexToUtf8(string: string): string;
+    keccak256(value: string | BN): string;
+    padLeft(value: string | number, characterAmount: number, sign?: string): string;
+    leftPad(string: string | number, characterAmount: number, sign?: string): string;
+    rightPad(string: string | number, characterAmount: number, sign?: string): string;
+    padRight(string: string | number, characterAmount: number, sign?: string): string;
+    sha3(value: string | BN): string;
+    randomHex(bytesSize: number): string;
+    utf8ToHex(string: string): string;
+    stringToHex(string: string): string;
+    toChecksumAddress(address: string): string;
+    toDecimal(hex: Hex): number;
+    toHex(value: number | string | BN): string;
+    toUtf8(string: string): string;
+    toWei(value: number | string | BN, unit?: Unit): string | BN;
+    isBloom(bloom: string): boolean;
+    isTopic(topic: string): boolean;
+    jsonInterfaceMethodToString(abiItem: ABIItem): string;
+    soliditySha3(...val: Mixed[]): string;
+    getUnitValue(unit: Unit): string;
+    unitMap(): Units;
+    // bloom types
+    testAddress(bloom: string, address: string): boolean;
+    testTopic(bloom: string, topic: string): boolean;
+}
+
 export interface Units {
     noether: string;
     wei: string;