feat: add --flavor feature (ganache chain plugins)

CONTRIBUTING.md

@@ -105,10 +105,10 @@ Where `<module>` is the npm-module you want to add and `<package>` is where you
 Example:
 
 ```bash
-npx lerna add @ganache/options -E --scope=@ganache/filecoin
+npx lerna add @ganache/options -E --scope=@ganache/ethereum
 ```
 
-will add our local `@ganache/options` package to the `@ganache/filecoin` package.
+will add our local `@ganache/options` package to the `@ganache/ethereum` package.
 
 ## To remove a module from another package:
 

src/chains/ethereum/console.log/tests/index.test.ts

@@ -49,7 +49,7 @@ describe("@ganache/console.log", () => {
 
   after("shut down the provider", async () => {
     provider && (await provider.disconnect());
-    provider = null;
+    provider = null!;
   });
 
   beforeEach("snapshot", async () => {
@@ -65,7 +65,7 @@ describe("@ganache/console.log", () => {
         method: "evm_revert",
         params: [snapshotId]
       }));
-    snapshotId = null;
+    snapshotId = null!;
   });
 
   /**
@@ -369,7 +369,7 @@ describe("@ganache/console.log", () => {
       });
 
       describe(`${name}(${params.join(", ")})`, () => {
-        const possibleValues = params.map(param => staticValues.get(param));
+        const possibleValues = params.map(param => staticValues.get(param)!);
 
         const method = get4ByteForSignature(
           `${functionName}(${params.map(toAbiType)})`
@@ -388,7 +388,7 @@ describe("@ganache/console.log", () => {
     describe("miscellaneous", () => {
       const func = functions.find(
         f => f.params.length === 1 && f.params[0].type === "string memory"
-      );
+      )!;
       const method = get4ByteForSignature(`${func.functionName}(string)`);
       const params = [{ type: func.params[0].type, value: "Hello, World!" }];
 
@@ -415,7 +415,7 @@ describe("@ganache/console.log", () => {
       });
 
       it("does NOT log when `console.log` is called within an `eth_estimateGas`", async () => {
-        const allLogs = [];
+        const allLogs: any[] = [];
         logger.log = (...logs: any[]) => {
           if (logs[0] === "eth_estimateGas") return;
 
@@ -509,7 +509,7 @@ contract ${CONTRACT_NAME} {
           assert.strictEqual(receipt.status, "0x1");
           assert.strictEqual(receipt.transactionIndex, "0x1");
 
-          const allLogs = [];
+          const allLogs: any[] = [];
           logger.log = (...logs: any[]) => {
             if (logs[0] === "debug_storageRangeAt") return;
             allLogs.push(logs);

src/chains/ethereum/ethereum/index.ts

@@ -5,5 +5,169 @@
  * @license MIT
  */
 
+import chalk from "chalk";
+import { TruffleColors } from "@ganache/colors";
+import { Executor, WEI } from "@ganache/utils";
+import { toChecksumAddress } from "ethereumjs-util";
+import { EthereumProvider } from "./src/provider";
+import { Connector } from "./src/connector";
+import {
+  EthereumLegacyProviderOptions,
+  EthereumOptionsConfig,
+  EthereumProviderOptions
+} from "@ganache/ethereum-options";
+import type { Flavor } from "@ganache/flavor";
+import { CliOptionsConfig, ServerOptionsConfig } from "@ganache/flavor";
+
 export * from "./src/connector";
 export * from "./src/api-types";
+
+function capitalizeFirstLetter(string: string) {
+  return string[0].toUpperCase() + string.slice(1);
+}
+function color(str: string) {
+  return chalk`{hex("${TruffleColors.porsche}") ${str}}`;
+}
+
+type EthereumFlavor = Flavor<
+  "ethereum",
+  Connector,
+  EthereumOptionsConfig,
+  ServerOptionsConfig,
+  CliOptionsConfig
+>;
+const EthereumFlavor: EthereumFlavor = {
+  flavor: "ethereum",
+  connect: (
+    options: EthereumProviderOptions | EthereumLegacyProviderOptions,
+    executor: Executor
+  ) => new Connector(options, executor),
+  options: {
+    provider: EthereumOptionsConfig,
+    server: ServerOptionsConfig,
+    cli: CliOptionsConfig
+  },
+  initialize
+};
+// flavors are exported as a default export
+export default EthereumFlavor;
+
+function initialize(
+  provider: EthereumProvider,
+  cliSettings: { host: string; port: number }
+) {
+  const liveOptions = provider.getOptions();
+  const accounts = provider.getInitialAccounts();
+
+  const addresses = Object.keys(accounts);
+  const logs = [];
+  logs.push("");
+  logs.push("Available Accounts");
+  logs.push("==================");
+  if (addresses.length > 0) {
+    addresses.forEach(function (address, index) {
+      const balance = accounts[address].balance;
+      const strBalance = balance / WEI;
+      const about = balance % WEI === 0n ? "" : "~";
+      let line = `(${index}) ${toChecksumAddress(
+        address
+      )} (${about}${strBalance} ETH)`;
+
+      if (!accounts[address].unlocked) {
+        line += " 🔒";
+      }
+
+      logs.push(line);
+    });
+
+    logs.push("");
+    logs.push("Private Keys");
+    logs.push("==================");
+
+    addresses.forEach(function (address, index) {
+      logs.push(`(${index}) ${accounts[address].secretKey}`);
+    });
+
+    if (liveOptions.wallet.accountKeysPath != null) {
+      logs.push("");
+      logs.push(
+        `Accounts and keys saved to ${liveOptions.wallet.accountKeysPath}`
+      );
+    }
+  } else {
+    logs.push("(no accounts unlocked)");
+  }
+
+  if (liveOptions.wallet.accounts == null) {
+    logs.push("");
+    logs.push("HD Wallet");
+    logs.push("==================");
+    logs.push(`Mnemonic:      ${color(liveOptions.wallet.mnemonic)}`);
+    logs.push(
+      `Base HD Path:  ${color(
+        liveOptions.wallet.hdPath.join("/") + "/{account_index}"
+      )}`
+    );
+  }
+
+  if (liveOptions.miner.defaultGasPrice) {
+    logs.push("");
+    logs.push("Default Gas Price");
+    logs.push("==================");
+    logs.push(color(liveOptions.miner.defaultGasPrice.toBigInt().toString()));
+  }
+
+  if (liveOptions.miner.blockGasLimit) {
+    logs.push("");
+    logs.push("BlockGas Limit");
+    logs.push("==================");
+    logs.push(color(liveOptions.miner.blockGasLimit.toBigInt().toString()));
+  }
+
+  if (liveOptions.miner.callGasLimit) {
+    logs.push("");
+    logs.push("Call Gas Limit");
+    logs.push("==================");
+    logs.push(color(liveOptions.miner.callGasLimit.toBigInt().toString()));
+  }
+
+  if (liveOptions.fork.network || liveOptions.fork.url) {
+    logs.push("");
+    logs.push("Forked Chain");
+    logs.push("==================");
+    let location: string;
+    if (liveOptions.fork.network) {
+      location = `Ethereum ${capitalizeFirstLetter(
+        liveOptions.fork.network.replace("goerli", "görli")
+      )}, via ${chalk`{hex("${TruffleColors.infura}") 丕Infura}`}`;
+    } else {
+      location = (liveOptions.fork.url as any).toString();
+    }
+
+    logs.push(`Location:        ${color(location)}`);
+    logs.push(
+      `Block:           ${color(liveOptions.fork.blockNumber.toString())}`
+    );
+    logs.push(
+      `Network ID:      ${color(liveOptions.chain.networkId.toString())}`
+    );
+    logs.push(`Time:            ${color(liveOptions.chain.time.toString())}`);
+
+    if (liveOptions.fork.requestsPerSecond !== 0) {
+      logs.push(
+        `Requests/Second: ${color(
+          liveOptions.fork.requestsPerSecond.toString()
+        )}`
+      );
+    }
+  }
+
+  logs.push("");
+  logs.push("Chain Id");
+  logs.push("==================");
+  logs.push(color(liveOptions.chain.chainId.toString()));
+
+  logs.push("");
+  logs.push("RPC Listening on " + cliSettings.host + ":" + cliSettings.port);
+  console.log(logs.join("\n"));
+}

src/chains/ethereum/ethereum/package.json

@@ -56,6 +56,7 @@
     "@ethereumjs/tx": "4.1.1",
     "@ethereumjs/util": "8.0.5",
     "@ethereumjs/vm": "6.4.1",
+    "@ganache/colors": "0.4.0",
     "@ganache/console.log": "0.4.0",
     "@ganache/ethereum-address": "0.8.0",
     "@ganache/ethereum-block": "0.8.0",
@@ -87,6 +88,7 @@
     "ws": "8.2.3"
   },
   "devDependencies": {
+    "@ganache/flavor": "0.9.0",
     "@trufflesuite/uws-js-unofficial": "20.10.0-unofficial.2",
     "@types/encoding-down": "5.0.0",
     "@types/fs-extra": "9.0.2",

src/chains/ethereum/ethereum/src/connector.ts

@@ -1,7 +1,5 @@
-import Emittery from "emittery";
 import EthereumApi from "./api";
 import {
-  Connector as IConnector,
   Executor,
   makeError,
   makeResponse,
@@ -12,20 +10,19 @@ import {
 } from "@ganache/utils";
 export type { EthereumProvider } from "./provider";
 import { EthereumProvider } from "./provider";
-import {
+import type {
   RecognizedString,
   WebSocket,
-  HttpRequest
-} from "@trufflesuite/uws-js-unofficial";
+  HttpRequest,
+  Connector as IConnector
+} from "@ganache/flavor";
 import { CodedError } from "@ganache/ethereum-utils";
 import {
   EthereumProviderOptions,
   EthereumLegacyProviderOptions
 } from "@ganache/ethereum-options";
 import { bufferify } from "./helpers/bufferify";
 
-type ProviderOptions = EthereumProviderOptions | EthereumLegacyProviderOptions;
-
 function isHttp(
   connection: HttpRequest | WebSocket
 ): connection is HttpRequest {
@@ -36,35 +33,28 @@ function isHttp(
 }
 
 export class Connector<
-    R extends JsonRpcRequest<
-      EthereumApi,
-      KnownKeys<EthereumApi>
-    > = JsonRpcRequest<EthereumApi, KnownKeys<EthereumApi>>
-  >
-  extends Emittery<{ ready: undefined; close: undefined }>
-  implements IConnector<EthereumApi, R | R[], JsonRpcResponse>
+  R extends JsonRpcRequest<
+    EthereumApi,
+    KnownKeys<EthereumApi>
+  > = JsonRpcRequest<EthereumApi, KnownKeys<EthereumApi>>
+> implements IConnector<EthereumProvider, R | R[], JsonRpcResponse>
 {
   #provider: EthereumProvider;
 
   static BUFFERIFY_THRESHOLD: number = 100000;
 
-  get provider() {
+  get provider(): EthereumProvider {
     return this.#provider;
   }
 
-  constructor(providerOptions: ProviderOptions = null, executor: Executor) {
-    super();
-
+  constructor(providerOptions: EthereumProviderOptions | EthereumLegacyProviderOptions = null, executor: Executor) {
     this.#provider = new EthereumProvider(providerOptions, executor);
   }
 
   public BUFFERIFY_THRESHOLD = Connector.BUFFERIFY_THRESHOLD;
 
   async connect() {
     await this.#provider.initialize();
-    // no need to wait for #provider.once("connect") as the initialize()
-    // promise has already accounted for that after the promise is resolved
-    await this.emit("ready");
   }
 
   parse(message: Buffer) {

src/chains/ethereum/ethereum/src/forking/handlers/http-handler.ts

@@ -112,6 +112,7 @@ export class HttpHandler extends BaseHandler implements Handler {
       const postData = `${JSONRPC_PREFIX}${this.id++},${key.slice(1)}`;
       this.headers["content-length"] = postData.length;
 
+      // @ts-ignore
       const req = this._request(requestOptions);
       req.on("response", res => {
         const { headers } = res;

src/chains/ethereum/ethereum/src/provider.ts

@@ -4,7 +4,6 @@ import {
   Executor,
   hasOwn,
   KnownKeys,
-  Provider,
   JsonRpcRequest,
   JsonRpcResponse,
   JsonRpcError,
@@ -124,20 +123,17 @@ type RequestParams<Method extends RequestMethods> = {
   readonly method: Method;
   readonly params: OverloadedParameters<EthereumApi[Method]> | undefined;
 };
-export class EthereumProvider
-  extends Emittery<{
-    message: MessageEvent;
-    data: DataEvent;
-    error: Error;
-    "ganache:vm:tx:step": VmStepEvent;
-    "ganache:vm:tx:before": VmBeforeTransactionEvent;
-    "ganache:vm:tx:after": VmAfterTransactionEvent;
-    "ganache:vm:tx:console.log": VmConsoleLogEvent;
-    connect: undefined;
-    disconnect: undefined;
-  }>
-  implements Provider<EthereumApi>
-{
+export class EthereumProvider extends Emittery<{
+  message: MessageEvent;
+  data: DataEvent;
+  error: Error;
+  "ganache:vm:tx:step": VmStepEvent;
+  "ganache:vm:tx:before": VmBeforeTransactionEvent;
+  "ganache:vm:tx:after": VmAfterTransactionEvent;
+  "ganache:vm:tx:console.log": VmConsoleLogEvent;
+  connect: undefined;
+  disconnect: undefined;
+}> {
   #options: EthereumInternalOptions;
   #api: EthereumApi;
   #wallet: Wallet;

src/chains/ethereum/ethereum/tsconfig.json

@@ -53,6 +53,14 @@
     {
       "name": "@ganache/console.log",
       "path": "../console.log"
+    },
+    {
+      "name": "@ganache/flavor",
+      "path": "../../../packages/flavor"
+    },
+    {
+      "name": "@ganache/colors",
+      "path": "../../../packages/colors"
     }
   ]
 }