Prepare bot for public use

.dockerignore

@@ -0,0 +1,23 @@
+# NOTE: Keep in sync with .gitignore.
+#
+# From: https://shisho.dev/blog/posts/how-to-use-dockerignore/
+#
+# In .gitignore, the file or directory name is ignored in any hierarchy below the .gitignore file, but in .dockerignore,
+# all paths must be relative to the way where .dockerignore is located. However, in .dockerignore, all paths must be
+# listed relative to the path.
+**/.build
+**/.env
+**/.idea
+**/.log
+**/.tsbuildinfo
+**/.vscode
+**/build
+**/dist
+**/node_modules
+**/coverage
+**/.DS_Store
+**/secrets.env
+**/.eslintcache
+
+# Custom ignore files
+**/*.ignore

.env.example

@@ -0,0 +1,10 @@
+LOGGER_ENABLED=true
+LOG_COLORIZE=true
+LOG_LEVEL=debug
+LOG_FORMAT=pretty
+
+# Bot variables
+MNEMONIC="test test test test test test test test test test test junk"
+
+# Optional: PERSIST_ACCOUNTS_TO_WATCH=true
+# Optional: ETHER_LIQUIDATOR_ADDRESS=0xAb6702A6Fd7f0F2596f70c273376036B44a10709

.eslintignore

@@ -0,0 +1 @@
+.gitignore

.eslintrc.js

@@ -0,0 +1,42 @@
+module.exports = {
+  root: true, // https://github.com/eslint/eslint/issues/13385#issuecomment-641252879
+  env: {
+    es6: true,
+    jest: true,
+    node: true,
+  },
+  parser: '@typescript-eslint/parser',
+  parserOptions: {
+    project: ['./tsconfig.json'],
+    ecmaVersion: 11,
+    sourceType: 'module',
+  },
+  globals: {
+    Atomics: 'readonly',
+    SharedArrayBuffer: 'readonly',
+  },
+  extends: ['./node_modules/@api3/commons/dist/eslint/universal', './node_modules/@api3/commons/dist/eslint/jest'],
+  plugins: ['@typescript-eslint', 'import', 'jest'],
+  rules: {
+    'unicorn/no-process-exit': 'off',
+    'unicorn/prefer-top-level-await': 'off',
+
+    // Typescript
+    '@typescript-eslint/consistent-return': 'off', // Does not play with no useless undefined when function return type is "T | undefined" and does not have a fixer.
+    '@typescript-eslint/max-params': 'off',
+    '@typescript-eslint/no-dynamic-delete': 'off',
+    '@typescript-eslint/no-var-requires': 'off',
+    '@typescript-eslint/use-unknown-in-catch-callback-variable': 'off',
+
+    // Lodash
+    'lodash/prefer-immutable-method': 'off',
+    'lodash/prop-shorthand': 'off',
+
+    // Jest
+    'jest/no-hooks': 'off',
+    'jest/prefer-importing-jest-globals': 'off',
+
+    // Removal of typechain
+    '@typescript-eslint/no-unsafe-call': 'off',
+  },
+};

.github/workflows/main.yml

@@ -0,0 +1,40 @@
+name: Continuous Build
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+jobs:
+  lint-build:
+    runs-on: ubuntu-latest
+    name: Build, lint and test
+    steps:
+      - name: Clone repo
+        uses: actions/checkout@v4
+      - name: Install pnpm
+        uses: pnpm/action-setup@v3
+        with:
+          version: 8.x
+      - name: Setup Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: '20.x'
+          cache: 'pnpm'
+      - name: Install Dependencies
+        run: pnpm install --frozen-lockfile
+      - name: Build
+        run: pnpm run build
+      - name: Lint
+        run: pnpm run prettier:check && pnpm run eslint:check
+      - name: Lint Typescript
+        run: pnpm run tsc
+
+  # Leaving this as we may want to re-add tests and docs later
+  required-checks-passed:
+    name: All required checks passed
+    runs-on: ubuntu-latest
+    needs: [lint-build]
+    steps:
+      - run: exit 0

.gitignore

@@ -0,0 +1,19 @@
+.build
+.env
+.idea
+.log
+.tsbuildinfo
+.vscode
+artifacts
+cache
+build
+dist
+node_modules
+coverage
+.DS_Store
+secrets.env
+.eslintcache
+
+# Custom ignore files
+*.ignore
+hardhat.config.ts

.husky/pre-push

@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+pnpm run prettier:check && pnpm run eslint:check

.prettierignore

@@ -0,0 +1 @@
+.gitignore

.prettierrc

@@ -0,0 +1,17 @@
+{
+  "bracketSpacing": true,
+  "printWidth": 120,
+  "singleQuote": true,
+  "tabWidth": 2,
+  "trailingComma": "es5",
+  "useTabs": false,
+  "overrides": [
+    {
+      "files": "*.md",
+      "options": {
+        "parser": "markdown",
+        "proseWrap": "always"
+      }
+    }
+  ]
+}

Dockerfile

@@ -0,0 +1,36 @@
+# =============================================================================================
+# Base image
+# =============================================================================================
+FROM node:20-slim AS base
+WORKDIR /app
+
+ENV PNPM_HOME="/pnpm"
+ENV PATH="$PNPM_HOME:$PATH"
+RUN corepack enable
+
+# Fetch all packages into a virtual store (specifically intended for Docker images)
+# See: https://pnpm.io/cli/fetch
+COPY pnpm-lock.yaml /app
+RUN pnpm fetch
+
+# Install and build dependencies
+COPY . /app
+RUN pnpm install --prefer-offline --recursive
+RUN pnpm run build
+
+# =============================================================================================
+# OEV Bot image
+# =============================================================================================
+# Prepare the app image
+FROM base AS oev-bot
+ENV name="oev-bot"
+LABEL application="oev-bot" description="OEV Bot container"
+WORKDIR /app
+
+# "node" Docker images come with a built-in, least-privileged user called "node"
+USER node
+COPY --chown=node:node --from=base /app/ .
+
+ENV NODE_ENV=production
+
+ENTRYPOINT ["node", "dist/src/index.js"]

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 API3
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.