docker image POC

.devcontainer/Dockerfile

@@ -0,0 +1,16 @@
+# [Choice] Node.js version (use -bullseye variants on local arm64/Apple Silicon): 18, 16, 14, 18-bullseye, 16-bullseye, 14-bullseye, 18-buster, 16-buster, 14-buster
+ARG VARIANT=16-bullseye
+FROM mcr.microsoft.com/vscode/devcontainers/typescript-node:0-${VARIANT}
+
+
+# [Optional] Uncomment this section to install additional OS packages.
+# RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \
+#     && apt-get -y install --no-install-recommends <your-package-list-here>
+
+# [Optional] Uncomment if you want to install an additional version of node using nvm
+# ARG EXTRA_NODE_VERSION=10
+# RUN su node -c "source /usr/local/share/nvm/nvm.sh && nvm install ${EXTRA_NODE_VERSION}"
+
+# [Optional] Uncomment if you want to install more global node packages
+# RUN su node -c "npm install -g <your-package-list -here>"
+

.devcontainer/base.Dockerfile

@@ -0,0 +1,55 @@
+# [Choice] Node.js version (use -bullseye variants on local arm64/Apple Silicon): 18-bullseye, 16-bullseye, 14-bullseye, 18-buster, 16-buster, 14-buster
+ARG VARIANT=16-bullseye
+FROM node:${VARIANT}
+
+# [Option] Install zsh
+ARG INSTALL_ZSH="true"
+# [Option] Upgrade OS packages to their latest versions
+ARG UPGRADE_PACKAGES="true"
+
+# Install needed packages, yarn, nvm and setup non-root user. Use a separate RUN statement to add your own dependencies.
+ARG USERNAME=node
+ARG USER_UID=1000
+ARG USER_GID=$USER_UID
+ARG NPM_GLOBAL=/usr/local/share/npm-global
+ENV NVM_DIR=/usr/local/share/nvm
+ENV NVM_SYMLINK_CURRENT=true \ 
+    PATH=${NPM_GLOBAL}/bin:${NVM_DIR}/current/bin:${PATH}
+COPY library-scripts/*.sh library-scripts/*.env /tmp/library-scripts/
+RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \
+    # Remove imagemagick due to https://security-tracker.debian.org/tracker/CVE-2019-10131
+    && apt-get purge -y imagemagick imagemagick-6-common \
+    # Install common packages, non-root user, update yarn and install nvm
+    && bash /tmp/library-scripts/common-debian.sh "${INSTALL_ZSH}" "${USERNAME}" "${USER_UID}" "${USER_GID}" "${UPGRADE_PACKAGES}" "true" "true" \
+    # Install yarn, nvm
+    && rm -rf /opt/yarn-* /usr/local/bin/yarn /usr/local/bin/yarnpkg \
+    && bash /tmp/library-scripts/node-debian.sh "${NVM_DIR}" "none" "${USERNAME}" \
+    # Configure global npm install location, use group to adapt to UID/GID changes
+    && if ! cat /etc/group | grep -e "^npm:" > /dev/null 2>&1; then groupadd -r npm; fi \
+    && usermod -a -G npm ${USERNAME} \
+    && umask 0002 \
+    && mkdir -p ${NPM_GLOBAL} \
+    && touch /usr/local/etc/npmrc \
+    && chown ${USERNAME}:npm ${NPM_GLOBAL} /usr/local/etc/npmrc \
+    && chmod g+s ${NPM_GLOBAL} \
+    && npm config -g set prefix ${NPM_GLOBAL} \
+    && sudo -u ${USERNAME} npm config -g set prefix ${NPM_GLOBAL} \
+    # Install eslint
+    && su ${USERNAME} -c "umask 0002 && npm install -g eslint" \
+    && npm cache clean --force > /dev/null 2>&1 \
+    # Install python-is-python3 on bullseye to prevent node-gyp regressions
+    && . /etc/os-release \
+    && if [ "${VERSION_CODENAME}" = "bullseye" ]; then apt-get -y install --no-install-recommends python-is-python3; fi \
+    # Clean up
+    && apt-get autoremove -y && apt-get clean -y && rm -rf /var/lib/apt/lists/* /root/.gnupg /tmp/library-scripts
+
+# [Optional] Uncomment this section to install additional OS packages.
+# RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \
+#     && apt-get -y install --no-install-recommends <your-package-list-here>
+
+# [Optional] Uncomment if you want to install an additional version of node using nvm
+# ARG EXTRA_NODE_VERSION=10
+# RUN su node -c "source /usr/local/share/nvm/nvm.sh && nvm install ${EXTRA_NODE_VERSION}"
+
+# [Optional] Uncomment if you want to install more global node modules
+# RUN su node -c "npm install -g <your-package-list-here>""

.devcontainer/devcontainer.json

@@ -0,0 +1,21 @@
+//devcontainer.json
+{
+  "mounts": ["source=${localEnv:HOME}/docker/volumes2/yalc,target=/yalc,type=bind,consistency=cached"],
+  "forwardPorts": [8545],
+  "build": {
+    "dockerfile": "Dockerfile",
+    "args": {
+      "VARIANT": "16-bullseye"
+    }
+  },
+  "features": {
+    "git": "latest"
+  },
+  "customizations": {
+    "vscode": {
+      "extensions": ["dbaeumer.vscode-eslint"]
+    }
+  },
+  "remoteUser": "node",
+  "postStartCommand": "npm run localnode"
+}

.dockerignore

@@ -0,0 +1,5 @@
+artifacts
+cache
+node_modules
+test
+*.log

.nvmrc

@@ -0,0 +1 @@
+v16.16

Dockerfile

@@ -0,0 +1,13 @@
+# [Choice] Node.js version (use -bullseye variants on local arm64/Apple Silicon): 18, 16, 14, 18-bullseye, 16-bullseye, 14-bullseye, 18-buster, 16-buster, 14-buster
+ARG VARIANT=16-bullseye
+FROM mcr.microsoft.com/vscode/devcontainers/typescript-node:0-${VARIANT}
+
+COPY . /app
+
+WORKDIR /app
+
+RUN npm install
+
+COPY $PWD/docker/entrypoint.sh /usr/local/bin
+
+ENTRYPOINT ["/bin/sh", "/usr/local/bin/entrypoint.sh"]

docker/entrypoint.sh

@@ -0,0 +1,15 @@
+#!/bin/sh
+
+# Change to the correct directory
+cd /app;
+# cd /workspaces/core-evm-contracts/
+
+# Run hardhat
+npm run localnodetest;
+
+# Keep node alive
+set -e
+if [ "${1#-}" != "${1}" ] || [ -z "$(command -v "${1}")" ]; then
+  set -- node "$@"
+fi
+exec "$@"

dockerREADME.md

@@ -0,0 +1,57 @@
+# Docker Environment Instructions
+
+## Prerequisites
+
+Docker for desktop  
+VS Code  
+Dev Containers extension installed
+
+Once the extension is installed  
+Choose Command + Shift + P and type in open folder and type open folder and choose  
+Devcontainers:Open folder in container choose core-evm  
+you can also choose from bottom left hand screen green button and choose open folder in container This will open a new VS CODE window  
+You'll notice you can directly work within the container and bottom green portion should say Dev container  
+From here it should automatically install the necessary packages and run a hardhat node in vs code terminal  
+Your deployment files should be created in deployments directory
+
+## Consuming the contracts in your APP
+
+1.  You can publish directly to NPM and have the app consume them
+2.  You can publish them locally using a tool like Yalc and your seperate application can consume them automatically (Instructions below)
+
+## Using Yalc with your dev container for local development
+
+Create a directory on your mac in your home folder  
+docker/volumes/yalc `mkdir -p ~/docker/volumes/yalc`  
+In your devcontainer open a separate terminal and run
+
+```
+yalc publish --store-folder /yalc
+```
+
+The above command should publish your npm/yalc package to the host directory you created above  
+You can change the directory if you wish in the devcontainer.json file under mounts
+
+Now you can switch to the consumning application/repo and map core-evm-contracts to that package  
+if you haven't already install yalc on your host machine  
+`npm i yalc -g`  
+and then link the package (dont forget to change you username - e.g. jamesdaly)
+
+```
+yalc link core-evm-contracts --store-folder /Users/${your-username}/docker/volumes2/yalc
+```
+
+the output should be something like
+`Package core-evm-contracts@1.1.0 linked ==> /Users/jamesdaly/projects/xyz/node_modules/core-evm-contracts`
+
+## Hardhat Docker Image/Container without using plugin
+
+## Prerequisites
+
+Docker for desktop
+
+## WIP Not full functioning
+
+Run the following commands
+`docker build . -t hardhat-docker`
+`docker run -it -d -p 8545:8545 --name hardhat-container hardhat-docker --mount type=bind, source=/Users/jamesdaly/docker/volumes2/yalc, target=/yalc`

hardhat.config.ts

@@ -40,6 +40,7 @@ const config: HardhatUserConfig = {
       accounts: process.env.GOERLI_KEY !== undefined ? [process.env.GOERLI_KEY] : [],
     },
     hardhat: {
+      chainId: 31337,
       mining: {
         auto: false,
         interval: 2000,