Bill broker (#203)

* bill broker

* BB Internal audit fixes (#210)

* internal audit fixes

* code review fixes

* Update spot-vaults/contracts/_interfaces/BillBrokerErrors.sol

Co-authored-by: Brandon Iles <brandon@fragments.org>

---------

Co-authored-by: Brandon Iles <brandon@fragments.org>

---------

Co-authored-by: Brandon Iles <brandon@fragments.org>

.github/workflows/nightly.yml

@@ -34,3 +34,12 @@ jobs:
         with:
           github-token: ${{ secrets.GITHUB_TOKEN }}
           path-to-lcov: "./spot-contracts/coverage/lcov.info"
+
+      - name: spot-vaults run coverage
+        run: yarn workspace @ampleforthorg/spot-vaults run coverage
+
+      - name: spot-vaults report coverage
+        uses: coverallsapp/github-action@v2.2.3
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          path-to-lcov: "./spot-vaults/coverage/lcov.info"

.github/workflows/test.yml

@@ -4,7 +4,7 @@ on:
   push:
     branches: [main]
   pull_request:
-    branches: [main]
+    branches: [main,dev]
 
 jobs:
   test:

.nvmrc

@@ -1 +1 @@
-16
+20

package.json

@@ -8,6 +8,7 @@
   "packageManager": "yarn@3.2.1",
   "workspaces": [
     "spot-contracts",
-    "spot-subgraph"
+    "spot-subgraph",
+    "spot-vaults"
   ]
 }

spot-vaults/.eslintignore

@@ -0,0 +1,4 @@
+node_modules
+artifacts
+cache
+coverage

spot-vaults/.eslintrc.js

@@ -0,0 +1,46 @@
+module.exports = {
+  env: {
+    browser: false,
+    es2021: true,
+    mocha: true,
+    node: true,
+  },
+  plugins: ["@typescript-eslint", "no-only-tests", "unused-imports"],
+  extends: ["standard", "plugin:prettier/recommended", "plugin:node/recommended"],
+  parser: "@typescript-eslint/parser",
+  parserOptions: {
+    ecmaVersion: 12,
+    warnOnUnsupportedTypeScriptVersion: false,
+  },
+  rules: {
+    "node/no-unsupported-features/es-syntax": ["error", { ignores: ["modules"] }],
+    "node/no-missing-import": [
+      "error",
+      {
+        tryExtensions: [".ts", ".js", ".json"],
+      },
+    ],
+    "node/no-unpublished-import": [
+      "error",
+      {
+        allowModules: [
+          "hardhat",
+          "ethers",
+          "@openzeppelin/upgrades-core",
+          "chai",
+          "@nomicfoundation/hardhat-ethers",
+          "@nomicfoundation/hardhat-chai-matchers",
+          "@nomicfoundation/hardhat-verify",
+          "@nomicfoundation/hardhat-toolbox",
+          "@openzeppelin/hardhat-upgrades",
+          "solidity-coverage",
+          "hardhat-gas-reporter",
+          "dotenv",
+        ],
+      },
+    ],
+    "no-only-tests/no-only-tests": "error",
+    "unused-imports/no-unused-imports": "error",
+    "unused-imports/no-unused-vars": ["warn", { vars: "all" }],
+  },
+};

spot-vaults/.gitignore

@@ -0,0 +1,14 @@
+node_modules
+.env
+
+# Hardhat files
+/cache
+/artifacts
+
+# TypeChain files
+/typechain
+/typechain-types
+
+# solidity-coverage files
+/coverage
+/coverage.json

spot-vaults/.prettierignore

@@ -0,0 +1,12 @@
+# folders
+artifacts/
+build/
+cache/
+coverage/
+dist/
+lib/
+node_modules/
+typechain/
+
+# files
+coverage.json

spot-vaults/.prettierrc

@@ -0,0 +1,17 @@
+{
+  "arrowParens": "avoid",
+  "bracketSpacing": true,
+  "endOfLine":"auto",
+  "printWidth": 90,
+  "singleQuote": false,
+  "tabWidth": 2,
+  "trailingComma": "all",
+  "overrides": [
+    {
+      "files": "*.sol",
+      "options": {
+        "tabWidth": 4
+      }
+    }
+  ]
+}

spot-vaults/.solcover.js

@@ -0,0 +1,3 @@
+module.exports = {
+  skipFiles: ["_test", "_interfaces", "_external"],
+};

spot-vaults/.solhint.json

@@ -0,0 +1,10 @@
+{
+  "extends": "solhint:recommended",
+  "rules": {
+    "compiler-version": ["error", "^0.8.0"],
+    "func-visibility": ["warn", { "ignoreConstructors": true }],
+    "reason-string": ["warn", { "maxLength": 64 }],
+    "not-rely-on-time": "off",
+    "max-states-count": ["warn", 17]
+  }
+}

spot-vaults/.solhintignore

@@ -0,0 +1 @@
+node_modules

spot-vaults/README.md

@@ -0,0 +1,34 @@
+# spot-vaults
+
+This repository is a collection of vault strategies leveraging the SPOT system.
+
+## Install
+
+```bash
+# Install project dependencies
+yarn
+```
+
+## Testing
+
+```bash
+# Run all unit tests (compatible with node v12+)
+yarn test
+```
+
+## Contribute
+
+To report bugs within this package, create an issue in this repository.
+For security issues, please contact dev-support@ampleforth.org.
+When submitting code ensure that it is free of lint errors and has 100% test coverage.
+
+```bash
+# Lint code
+yarn lint:fix
+
+# Run solidity coverage report (compatible with node v12)
+yarn coverage
+
+# Run solidity gas usage report
+yarn profile
+```