Implement EIP1193

package.json

@@ -6,7 +6,7 @@
  "private": true,
  "devDependencies": {
  "@types/mocha": "^5.2.6",
- "@types/node": "^8.10.44",
+ "@types/node": "^10.17.24",
  "@types/shelljs": "^0.8.6",
  "chai": "^4.2.0",
  "ganache-cli": "^6.4.3",

packages/buidler-core/src/builtin-tasks/utils/watch.ts

@@ -8,12 +8,12 @@ import {
  SOLC_OUTPUT_FILENAME,
 } from "../../internal/constants";
 import { Reporter } from "../../internal/sentry/reporter";
-import { EthereumProvider, ProjectPaths, SolcConfig } from "../../types";
+import { EIP1193Provider, ProjectPaths, SolcConfig } from "../../types";
 
 const log = debug("buidler:core:compilation-watcher");
 
 export async function watchCompilerOutput(
- provider: EthereumProvider,
+ provider: EIP1193Provider,
  solcConfig: SolcConfig,
  paths: ProjectPaths
 ) {
@@ -46,11 +46,10 @@ export async function watchCompilerOutput(
  encoding: "utf8",
  });
 
- await provider.send("buidler_addCompilationResult", [
- compilerVersion,
- compilerInput,
- compilerOutput,
- ]);
+ await provider.request({
+ method: "buidler_addCompilationResult",
+ params: [compilerVersion, compilerInput, compilerOutput],
+ });
  } catch (error) {
  console.warn(
  chalk.yellow(

packages/buidler-core/src/internal/buidler-evm/jsonrpc/handler.ts

@@ -1,9 +1,8 @@
-import debug from "debug";
 import { IncomingMessage, ServerResponse } from "http";
 import getRawBody from "raw-body";
 import WebSocket from "ws";
 
-import { EthereumProvider } from "../../../types";
+import { EIP1193Provider } from "../../../types";
 import {
  isSuccessfulJsonResponse,
  isValidJsonRequest,
@@ -20,14 +19,8 @@ import {
 
 // tslint:disable only-buidler-error
 
-const log = debug("buidler:core:buidler-evm:jsonrpc");
-
 export default class JsonRpcHandler {
- private _provider: EthereumProvider;
-
- constructor(provider: EthereumProvider) {
- this._provider = provider;
- }
+ constructor(private readonly _provider: EIP1193Provider) {}
 
  public handleHttp = async (req: IncomingMessage, res: ServerResponse) => {
  this._setCorsHeaders(res);
@@ -132,7 +125,10 @@ export default class JsonRpcHandler {
  // Clear any active subscriptions for the closed websocket connection.
  isClosed = true;
  subscriptions.forEach(async (subscriptionId) => {
- await this._provider.send("eth_unsubscribe", [subscriptionId]);
+ await this._provider.request({
+ method: "eth_unsubscribe",
+ params: [subscriptionId],
+ });
  });
  });
  };
@@ -188,7 +184,10 @@ export default class JsonRpcHandler {
  private _handleRequest = async (
  req: JsonRpcRequest
  ): Promise<JsonRpcResponse> => {
- const result = await this._provider.send(req.method, req.params);
+ const result = await this._provider.request({
+ method: req.method,
+ params: req.params,
+ });
 
  return {
  jsonrpc: "2.0",

packages/buidler-core/src/internal/buidler-evm/jsonrpc/server.ts

@@ -1,8 +1,9 @@
 import debug from "debug";
 import http, { Server } from "http";
+import { AddressInfo } from "net";
 import { Server as WSServer } from "ws";
 
-import { EthereumProvider } from "../../../types";
+import { EIP1193Provider } from "../../../types";
 import { HttpProvider } from "../../core/providers/http";
 
 import JsonRpcHandler from "./handler";
@@ -13,7 +14,7 @@ export interface JsonRpcServerConfig {
  hostname: string;
  port: number;
 
- provider: EthereumProvider;
+ provider: EIP1193Provider;
 }
 
 export class JsonRpcServer {
@@ -35,8 +36,8 @@ export class JsonRpcServer {
  this._wsServer.on("connection", handler.handleWs);
  }
 
- public getProvider = (name = "json-rpc"): EthereumProvider => {
- const { address, port } = this._httpServer.address();
+ public getProvider = (name = "json-rpc"): EIP1193Provider => {
+ const { address, port } = this._httpServer.address() as AddressInfo; // TCP sockets return AddressInfo
 
  return new HttpProvider(`http://${address}:${port}/`, name);
  };
@@ -46,7 +47,8 @@ export class JsonRpcServer {
  log(`Starting JSON-RPC server on port ${this._config.port}`);
  this._httpServer.listen(this._config.port, this._config.hostname, () => {
  // We get the address and port directly from the server in order to handle random port allocation with `0`.
- resolve(this._httpServer.address());
+ const address = this._httpServer.address() as AddressInfo; // TCP sockets return AddressInfo
+ resolve(address);
  });
  });
  };

packages/buidler-core/src/internal/buidler-evm/provider/errors.ts

@@ -15,7 +15,11 @@
 // -32002 Resource unavailable Requested resource not available non-standard
 // -32003 Transaction rejected Transaction creation failed non-standard
 
-export class BuidlerEVMProviderError extends Error {
+import { ProviderRpcError } from "../../../types";
+import { CustomError } from "../../core/errors";
+
+export class BuidlerEVMProviderError extends CustomError
+ implements ProviderRpcError {
  public static isBuidlerEVMProviderError(
  other: any
  ): other is BuidlerEVMProviderError {

packages/buidler-core/src/internal/buidler-evm/provider/provider.ts

@@ -9,10 +9,13 @@ import path from "path";
 import semver from "semver";
 import util from "util";
 
-import {
+import type {
  BoundExperimentalBuidlerEVMMessageTraceHook,
- EthereumProvider,
+ EIP1193Provider,
+ EthSubscription,
  ProjectPaths,
+ ProviderConnectInfo,
+ RequestArguments,
 } from "../../../types";
 import { SOLC_INPUT_FILENAME, SOLC_OUTPUT_FILENAME } from "../../constants";
 import { CompilerInput, CompilerOutput } from "../stack-traces/compiler-types";
@@ -22,6 +25,7 @@ import { Mutex } from "../vendor/await-semaphore";
 
 import {
  BuidlerEVMProviderError,
+ InvalidInputError,
  MethodNotFoundError,
  MethodNotSupportedError,
 } from "./errors";
@@ -41,7 +45,7 @@ const PRIVATE_RPC_METHODS = new Set(["buidler_getStackTraceFailuresCount"]);
 // tslint:disable only-buidler-error
 
 export class BuidlerEVMProvider extends EventEmitter
- implements EthereumProvider {
+ implements EIP1193Provider {
  private _common?: Common;
  private _node?: BuidlerNode;
  private _ethModule?: EthModule;
@@ -74,15 +78,21 @@ export class BuidlerEVMProvider extends EventEmitter
  super();
  }
 
- public async send(method: string, params: any[] = []): Promise<any> {
+ public async request(args: RequestArguments): Promise<unknown> {
  const release = await this._mutex.acquire();
 
+ if (args.params !== undefined && !Array.isArray(args.params)) {
+ throw new InvalidInputError(
+ "Buidler EVM doesn't support JSON-RPC params sent as an object"
+ );
+ }
+
  try {
- if (this._loggingEnabled && !PRIVATE_RPC_METHODS.has(method)) {
- return await this._sendWithLogging(method, params);
+ if (this._loggingEnabled && !PRIVATE_RPC_METHODS.has(args.method)) {
+ return await this._sendWithLogging(args.method, args.params);
  }
 
- return await this._send(method, params);
+ return await this._send(args.method, args.params);
  } finally {
  release();
  }
@@ -300,15 +310,37 @@ export class BuidlerEVMProvider extends EventEmitter
  this._evmModule = new EvmModule(node);
  this._buidlerModule = new BuidlerModule(node);
 
- const listener = (payload: { filterId: BN; result: any }) => {
- this.emit("notifications", {
- subscription: `0x${payload.filterId.toString(16)}`,
- result: payload.result,
- });
- };
+ this._forwardNodeEvents(node);
+ }
 
+ private _forwardNodeEvents(node: BuidlerNode) {
+ // TODO: This can leak a listener when the provider is restarted
  // Handle eth_subscribe events and proxy them to handler
- this._node.addListener("ethEvent", listener);
+ node.addListener("ethEvent", (payload: { filterId: BN; result: any }) => {
+ const subscription = `0x${payload.filterId.toString(16)}`;
+ const result = payload.result;
+ this._emitLegacySubscriptionEvent(subscription, result);
+ this._emitEip1193SubscriptionEvent(subscription, result);
+ });
+ }
+
+ private _emitLegacySubscriptionEvent(subscription: string, result: any) {
+ this.emit("notifications", {
+ subscription,
+ result,
+ });
+ }
+
+ private _emitEip1193SubscriptionEvent(subscription: string, result: unknown) {
+ const message: EthSubscription = {
+ type: "eth_subscription",
+ data: {
+ subscription,
+ result,
+ },
+ };
+
+ this.emit("message", message);
  }
 
  private _logModuleMessages(): boolean {

packages/buidler-core/src/internal/buidler-evm/stack-traces/solidity-errors.ts

@@ -1,5 +1,4 @@
 import { bufferToHex } from "ethereumjs-util";
-import { inspect } from "util";
 
 import { decodeRevertReason } from "./revert-reasons";
 import {
@@ -14,6 +13,8 @@ import {
  UNRECOGNIZED_FUNCTION_NAME,
 } from "./solidity-stack-trace";
 
+const inspect = Symbol.for("nodejs.util.inspect.custom");
+
 export function getCurrentStack(): NodeJS.CallSite[] {
  const previousPrepareStackTrace = Error.prepareStackTrace;
 
@@ -286,7 +287,7 @@ export class SolidityError extends Error {
  this.stackTrace = stackTrace;
  }
 
- public [inspect.custom](): string {
+ public [inspect](): string {
  return this.inspect();
  }
 

packages/buidler-core/src/internal/core/errors.ts

@@ -5,7 +5,7 @@ import { ErrorDescriptor, ERRORS, getErrorCode } from "./errors-list";
 
 const inspect = Symbol.for("nodejs.util.inspect.custom");
 
-class CustomError extends Error {
+export class CustomError extends Error {
  constructor(message: string, public readonly parent?: Error) {
  // WARNING: Using super when extending a builtin class doesn't work well
  // with TS if you are compiling to a version of JavaScript that doesn't have