Update ganache dependency

.github/workflows/docker.yml

@@ -8,18 +8,30 @@ jobs:
   docker:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v2
 
-      - name: GitHub Login
-        uses: azure/docker-login@v1
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v2
+        id: buildx
         with:
-          login-server: docker.pkg.github.com
+          install: true
+
+      - name: GitHub Container Registry Login
+        uses: docker/login-action@v2
+        with:
+          registry: ghcr.io
           username: ${{ github.actor }}
           password: ${{ secrets.GITHUB_TOKEN }}
 
+      - name: DockerHub Login
+        uses: docker/login-action@v2
+        with:
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_ACCESS_TOKEN }}
+
       - name: Set Docker Package and Version
-        env:
-          ACTIONS_ALLOW_UNSECURE_COMMANDS: true
+        id: version
         run: |
           set +e
           _=$(echo "$GITHUB_REF" | grep "^refs/heads/")
@@ -41,20 +53,18 @@ jobs:
             PKG=etheno
           fi
           set -e
-          echo "::set-env name=PKG::$PKG"
-          echo "::set-env name=VER::$VER"
+          echo "::set-output name=PKG::$PKG"
+          echo "::set-output name=VER::$VER"
 
-      - name: Docker Build
-        run: docker build -t $PKG:$VER .
 
-      - name: DockerHub Login
-        uses: azure/docker-login@v1
+      - name: Docker build and push
+        uses: docker/build-push-action@v3
         with:
-          login-server: registry.hub.docker.com
-          username: ${{ secrets.DOCKERHUB_USERNAME }}
-          password: ${{ secrets.DOCKERHUB_ACCESS_TOKEN }}
-
-      - name: Docker Push
-        run: |
-          docker tag $PKG:$VER registry.hub.docker.com/trailofbits/$PKG:$VER
-          docker push registry.hub.docker.com/trailofbits/$PKG:$VER
+          push: true
+          target: final
+          platforms: |
+            linux/arm64/v8
+            linux/amd64
+          tags: |
+            ghcr.io/${{ github.repository }}/${{ steps.version.outputs.PKG }}:${{ steps.version.outputs.VER }}
+            registry.hub.docker.com/trailofbits/${{ steps.version.outputs.PKG }}:${{ steps.version.outputs.VER }}

Dockerfile

@@ -1,61 +1,84 @@
-FROM ubuntu:bionic
-MAINTAINER Evan Sultanik
-
-RUN DEBIAN_FRONTEND=noninteractive \
-    apt-get update && apt-get install -y --no-install-recommends \
+# syntax=docker/dockerfile:1.3
+FROM ubuntu:focal AS python-wheels
+RUN apt-get update && DEBIAN_FRONTEND=noninteractive apt-get install -y --no-install-recommends \
+    build-essential \
+    ca-certificates \
+    cmake \
     curl \
+    python3-dev \
+    python3-pip \
+    python3-setuptools
+
+# Needed for rusty-rlp wheel
+RUN curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y
+ENV PATH="/root/.cargo/bin:${PATH}"
+
+RUN --mount=type=bind,target=/etheno \
+    cd /etheno && \
+    pip3 install --no-cache-dir --upgrade pip setuptools && \
+    pip3 wheel --no-cache-dir -w /wheels \
+    https://github.com/cburgdorf/rusty-rlp/archive/refs/tags/0.1.15.tar.gz \
+    .
+
+
+FROM ubuntu:focal AS ganache
+RUN apt-get update && DEBIAN_FRONTEND=noninteractive apt-get install -y --no-install-recommends \
+    build-essential \
     ca-certificates \
+    curl \
+    gnupg \
+    lsb-release
+RUN curl -fsSL https://deb.nodesource.com/setup_16.x | bash && \
+    DEBIAN_FRONTEND=noninteractive apt-get install -y --no-install-recommends nodejs
+RUN npm install --omit=dev --location=global --prefix /opt/node ganache truffle
+
+
+FROM ubuntu:focal AS final
+LABEL org.opencontainers.image.authors="Evan Sultanik"
+
+RUN apt-get update && DEBIAN_FRONTEND=noninteractive apt-get install -y --no-install-recommends \
     bash-completion \
-    sudo \
+    ca-certificates \
+    curl \
+    gpg-agent \
+    libudev-dev \
+    locales \
     python3 \
-    libpython3-dev \
     python3-pip \
-    python3-setuptools \
-    git \
-    build-essential \
     software-properties-common \
-    locales-all locales \
-    libudev-dev \
-    gpg-agent \
-&& apt-get clean \
+    sudo \
 && rm -rf /var/lib/apt/lists/*
 
-RUN DEBIAN_FRONTEND=noninteractive add-apt-repository -y ppa:ethereum/ethereum && \
+# NOTE: solc was removed from the below command since the echidna integration is being removed
+# If the solc option is added back, --platform linux-amd64 needs to be added to the `docker build` command for M1 machines
+RUN add-apt-repository -y ppa:ethereum/ethereum && \
     apt-get update && apt-get install -y --no-install-recommends \
-    solc \
     ethereum \
-&& apt-get clean \
 && rm -rf /var/lib/apt/lists/*
 
-RUN curl -sL https://deb.nodesource.com/setup_12.x | sudo -E bash - && sudo apt-get install -y --no-install-recommends nodejs && apt-get clean && rm -rf /var/lib/apt/lists/*
+RUN curl -fsSL https://deb.nodesource.com/setup_16.x | bash && \
+    apt-get install -y --no-install-recommends nodejs \
+&& rm -rf /var/lib/apt/lists/*
 
-RUN npm install --production -g ganache-cli truffle && npm --force cache clean
+COPY --from=ganache /opt/node /usr/local/
 
-RUN useradd -m etheno
-RUN usermod -aG sudo etheno
-USER etheno
-WORKDIR /home/etheno
-USER root
-WORKDIR /root
+# BEGIN Install Etheno
+RUN --mount=type=bind,target=/mnt/etheno \
+    --mount=type=bind,target=/mnt/wheels,source=/wheels,from=python-wheels \
+    cd /mnt/etheno && \
+    pip3 install --no-cache-dir --upgrade pip setuptools && \
+    pip3 install --no-cache-dir --no-index --find-links /mnt/wheels .
 
-# Install Parity
-RUN curl https://get.parity.io -L | bash
+RUN useradd -m -G sudo etheno
 
 # Allow passwordless sudo for etheno
 RUN echo 'etheno ALL=(ALL) NOPASSWD: ALL' >> /etc/sudoers
 
 USER etheno
-ENV HOME=/home/etheno PATH=$PATH:/home/etheno/.local/bin
-WORKDIR /home/etheno
+ENV HOME=/home/etheno
 
-COPY --chown=etheno:etheno LICENSE setup.py etheno/
-COPY --chown=etheno:etheno etheno/*.py etheno/etheno/
-
-RUN cd etheno && \
-    pip3 install --no-cache-dir && \
-    cd .. && \
-    rm -rf etheno
-
-COPY --chown=etheno:etheno examples examples/
+# Use the DOCKER env variable to set hostname accordingly
+ENV DOCKER=1
+WORKDIR /home/etheno
 
 CMD ["/bin/bash"]

etheno/__main__.py

@@ -19,15 +19,20 @@
 from . import parity
 from . import truffle
 
+# Constant for converting whole units to wei
+ETHER = 1e18
+
 
 def main(argv = None):
     parser = argparse.ArgumentParser(description='An Ethereum JSON RPC multiplexer, differential fuzzer, and test framework integration tool.')
     parser.add_argument('--debug', action='store_true', default=False, help='Enable debugging from within the web server')
     parser.add_argument('--run-publicly', action='store_true', default=False, help='Allow the web server to accept external connections')
     parser.add_argument('-p', '--port', type=int, default=GETH_DEFAULT_RPC_PORT, help='Port on which to run the JSON RPC webserver (default=%d)' % GETH_DEFAULT_RPC_PORT)
-    parser.add_argument('-a', '--accounts', type=int, default=None, help='Number of accounts to create in the client (default=10)')
-    parser.add_argument('-b', '--balance', type=float, default=100.0, help='Default balance (in Ether) to seed to each account (default=100.0)')
-    parser.add_argument('-c', '--gas-price', type=int, default=None, help='Default gas price (default=20000000000)')
+    parser.add_argument('-a', '--accounts', type=int, default=10, help='Number of accounts to create in the client (default=10)')
+    parser.add_argument('-b', '--balance', type=float, default=1000.0, help='Default balance (in Ether) to seed to each account (default=100.0)')
+    # TODO: do we really need a gas price specified for ganache? is there a use case here?
+    parser.add_argument('-c', '--gas-price', type=int, default=20000000000, help='Default gas price (default=20000000000)')
+    # TODO: networkID can have a default value it seems like
     parser.add_argument('-i', '--network-id', type=int, default=None, help='Specify a network ID (default is the network ID of the master client)')
     '''
     We might need the Echidna feature later for differential fuzz testing but for reducing confusion we will remove the command-line arguments
@@ -42,7 +47,7 @@ def main(argv = None):
     parser.add_argument('-g', '--ganache', action='store_true', default=False,
                         help='Run Ganache as a master JSON RPC client (cannot be used in conjunction with --master)')
     parser.add_argument('--ganache-cmd', type=str, default=None, help='Specify a command that runs Ganache '
-                                                                      '(default="/usr/bin/env ganache-cli")')
+                                                                      '(default="/usr/bin/env ganache")')
     parser.add_argument('--ganache-args', type=str, default=None,
                         help='Additional arguments to pass to Ganache')
     parser.add_argument('--ganache-port', type=int, default=None,
@@ -164,6 +169,7 @@ def main(argv = None):
 
     accounts = []
 
+    # TODO: args.gas_price is not set if a genesis file is provided 
     if args.genesis:
         with open(args.genesis, 'rb') as f:
             genesis = json.load(f)
@@ -186,7 +192,7 @@ def main(argv = None):
         # We will generate it further below once we've resolved all of the parameters
         genesis = None
 
-    accounts += make_accounts(args.accounts, default_balance=int(args.balance * 1000000000000000000))
+    accounts += make_accounts(args.accounts, default_balance=int(args.balance * ETHER))
 
     if genesis is not None:
         # add the new accounts to the genesis
@@ -214,13 +220,14 @@ def main(argv = None):
         if args.network_id is None:
             args.network_id = 0x657468656E6F # 'etheno' in hex
 
-        ganache_accounts = ["--account=%s,0x%x" % (acct.private_key, acct.balance) for acct in accounts]
+        # Have to use hex() so that string is hex-encoded (prefixed with 0x) that is necessary for Ganache v7.0+
+        # https://github.com/trufflesuite/ganache/discussions/1075
+        ganache_accounts = ["--account=%s,0x%x" % (hex(acct.private_key), acct.balance) for acct in accounts]
 
         ganache_args = ganache_accounts + ['-g', str(args.gas_price), '-i', str(args.network_id)]
 
         if args.ganache_args is not None:
             ganache_args += shlex.split(args.ganache_args)
-
         ganache_instance = ganache.Ganache(cmd=args.ganache_cmd, args=ganache_args, port=args.ganache_port)
 
         ETHENO.master_client = ganache.GanacheClient(ganache_instance)

etheno/client.py

@@ -179,7 +179,8 @@ def create_account(self, balance: int = 0, address: Optional[int] = None):
 
     def wait_until_running(self):
         pass
-
+
+    # TODO: need to ensure that JSON RPC calls match latest API spec
     def post(self, data: Dict[str, Any]) -> Optional[Dict[str, Any]]:
         ret = self.client.post(data)
         if ret is not None and 'error' in ret:

etheno/etheno.py

@@ -1,6 +1,8 @@
 import pkg_resources
+import os
 from threading import Thread
 from typing import Any, Dict, List, Optional
+from werkzeug.serving import make_server
 
 from flask import Flask, jsonify, request, abort
 from flask.views import MethodView
@@ -31,6 +33,8 @@ def to_account_address(raw_address: int) -> str:
 _CONTROLLER = threadwrapper.MainThreadController()
 
 
+# Using 'werkzeug.server.shutdown' is deprecated after Flask 2.1.x
+# TODO: Will probably remove this function
 @app.route('/shutdown')
 def _etheno_shutdown():
     # shut down the Flask server
@@ -320,6 +324,9 @@ def shutdown(self, port: int = GETH_DEFAULT_RPC_PORT):
         for client in self.clients:
             client.shutdown()
         self.logger.close()
+        _CONTROLLER.quit()
+        """
+        Won't need this if shutdown() function is removed
         from urllib.request import urlopen
         import socket
         import urllib
@@ -329,29 +336,34 @@ def shutdown(self, port: int = GETH_DEFAULT_RPC_PORT):
             pass
         except urllib.error.URLError:
             pass
+        """
 
     def run(self, debug=True, run_publicly=False, port=GETH_DEFAULT_RPC_PORT):
         # Manticore only works in the main thread, so use a threadsafe wrapper:
-        def flask_thread():
-            if run_publicly:
+        def server_thread():
+            IS_DOCKER = os.environ.get("DOCKER", 0)
+            if run_publicly or IS_DOCKER:
                 host='0.0.0.0'
             else:
-                host = None        
+                host = "127.0.0.1"        
             # Do not use the reloader, because Flask needs to run in the main thread to use the reloader
-            app.run(debug=debug, host=host, port=port, use_reloader=False)
-        thread = Thread(target=flask_thread)
+            server = make_server(host=host, port=port, app=app, threaded=True)
+            return server
+            # app.run(debug=debug, host=host, port=port, use_reloader=False)
+        server = server_thread()
+        thread = Thread(target=server.serve_forever)
         thread.start()
-
         self.logger.info("Etheno v%s" % VERSION)
 
         for plugin in self.plugins:
             plugin.run()
 
         _CONTROLLER.run()
         self.shutdown()
+        self.logger.info("Shutting Etheno down")
+        server.shutdown()
         thread.join()
 
-
 ETHENO = Etheno()
 
 

etheno/ganache.py

@@ -19,18 +19,18 @@ def __init__(self, cmd=None, args=None, port=8546):
         if cmd is not None:
             cmd = shlex.split(cmd)
         else:
-            cmd = ['/usr/bin/env', 'ganache-cli']
+            cmd = ['/usr/bin/env', 'ganache']
         if args is None:
             args = []
-        self.args = cmd + ['-d', '-p', str(port)] + args
+        self.args = cmd + ['-d', '-p', str(port), '--chain.allowUnlimitedContractSize'] + args
         self.ganache = None
         self._client = None
 
     def start(self):
         if self.ganache:
             return
-        if shutil.which("ganache-cli") is None:
-            raise ValueError("`ganache-cli` is not installed! Install it by running `npm -g i ganache-cli`")
+        if shutil.which("ganache") is None:
+            raise ValueError("`ganache` is not installed! Install it by running `npm -g i ganache`")
         if self._client:
             self.ganache = PtyLogger(self._client.logger, self.args)
             self.ganache.start()