chore(contracts): linting & formatting updates, including CI workflow (…

…#77) * chore: upgrade to latest/consistent eslint dependencies * chore(contracts): fix ESLint errors * chore(contracts): .eslintrc.js -> .eslintrc * chore(contracts): run prettier --fix on contracts * chore(contracts): remove comments from tsconfig.json * chore(contracts): fix type errors in contracts.test.ts * ci(contracts): add GitHub Action for CI/CD
algorandfoundation · Apr 16, 2024 · fd8ff7a · fd8ff7a
1 parent 0b37394
commit fd8ff7a
Show file tree

Hide file tree

Showing 19 changed files with 404 additions and 583 deletions.
diff --git a/.github/workflows/ci-contracts.yaml b/.github/workflows/ci-contracts.yaml
@@ -0,0 +1,65 @@
+name: CI Workflow (Contracts)
+
+on:
+  push:
+    branches: [ dev, main ]
+    paths:
+      - 'contracts/**'
+      - '.github/workflows/ci-contracts.yaml'
+
+  pull_request:
+    branches: [ dev, main ]
+    paths:
+      - 'contracts/**'
+      - '.github/workflows/ci-contracts.yaml'
+
+jobs:
+  run-ci:
+    if: "!contains(github.event.head_commit.message, 'chore: release v')"
+    name: Lint, Typecheck
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Install Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+
+      - uses: pnpm/action-setup@v2
+        name: Install pnpm
+        with:
+          version: 8
+          run_install: false
+
+      - name: Get pnpm store directory
+        shell: bash
+        run: |
+          echo "STORE_PATH=$(pnpm store path --silent)" >> $GITHUB_ENV
+
+      - uses: actions/cache@v4
+        name: Setup pnpm cache
+        with:
+          path: ${{ env.STORE_PATH }}
+          key: ${{ runner.os }}-pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }}
+          restore-keys: |
+            ${{ runner.os }}-pnpm-store-
+
+      - name: Install dependencies
+        run: pnpm --filter ./contracts install
+
+      - name: Install dependencies (bootstrap)
+        run: pnpm --filter ./contracts/bootstrap install
+
+      - name: Lint
+        run: pnpm --filter ./contracts run lint
+
+      - name: Prettier
+        run: pnpm --filter ./contracts run prettier
+
+      - name: Typecheck (bootstrap)
+        run: pnpm --filter ./contracts/bootstrap run typecheck
diff --git a/contracts/.devcontainer.json b/contracts/.devcontainer.json
@@ -2,15 +2,15 @@
     "forwardPorts": [4001, 4002, 8980],
     "portsAttributes": {
         "4001": {
-          "label": "algod"
+            "label": "algod"
         },
         "4002": {
-          "label": "kmd"
+            "label": "kmd"
         },
         "8980": {
-          "label": "indexer"
+            "label": "indexer"
         }
     },
     "postCreateCommand": "pipx install algokit-cli",
     "postStartCommand": "algokit localnet start"
-}
+}
diff --git a/contracts/.eslintrc b/contracts/.eslintrc
@@ -0,0 +1,81 @@
+{
+    "env": {
+        "browser": true,
+        "es2021": true
+    },
+    "extends": [
+        "airbnb-base",
+        "plugin:import/errors",
+        "plugin:import/warnings",
+        "plugin:import/typescript",
+        "plugin:prettier/recommended"
+    ],
+    "parser": "@typescript-eslint/parser",
+    "parserOptions": {
+        "ecmaVersion": "latest",
+        "sourceType": "module"
+    },
+    "plugins": ["@typescript-eslint"],
+    "rules": {
+        "@typescript-eslint/no-explicit-any": "error",
+        "@typescript-eslint/ban-ts-comment": "warn",
+        "import/prefer-default-export": "off",
+        "import/extensions": [
+            "error",
+            "ignorePackages",
+            {
+                "js": "never",
+                "jsx": "never",
+                "ts": "never",
+                "tsx": "never"
+            }
+        ],
+        "import/no-extraneous-dependencies": [
+            "error",
+            {
+                "devDependencies": ["**/*.test.ts"]
+            }
+        ],
+        "prettier/prettier": [
+            "error",
+            {
+                "tabWidth": 4
+            }
+        ]
+    },
+    "overrides": [
+        {
+            "files": ["*.ts"],
+            "rules": {
+                "no-continue": "off",
+                "no-console": "off",
+                "max-classes-per-file": "off",
+                "import/no-extraneous-dependencies": "off"
+            }
+        },
+        {
+            "files": ["*.algo.ts"],
+            "rules": {
+                "object-shorthand": "off",
+                "class-methods-use-this": "off",
+                "no-undef": "off",
+                "max-classes-per-file": "off",
+                "no-bitwise": "off",
+                "operator-assignment": "off",
+                "prefer-template": "off",
+                "prefer-destructuring": "off",
+                "no-param-reassign": "off",
+                "no-restricted-syntax": "off",
+                "no-continue": "off",
+                "no-unused-vars": "off",
+                "@typescript-eslint/ban-ts-comment": "off"
+            }
+        },
+        {
+            "files": ["*.test.ts"],
+            "rules": {
+                "no-await-in-loop": "off"
+            }
+        }
+    ]
+}
diff --git a/contracts/.eslintrc.js b/contracts/.eslintrc.js
diff --git a/contracts/.prettierignore b/contracts/.prettierignore
@@ -0,0 +1,2 @@
+contracts/artifacts
+contracts/clients
diff --git a/contracts/.vscode/extensions.json b/contracts/.vscode/extensions.json
@@ -1,5 +1,3 @@
 {
-    "recommendations": [
-        "dbaeumer.vscode-eslint",
-    ]
-  }
+    "recommendations": ["dbaeumer.vscode-eslint"]
+}
diff --git a/contracts/.vscode/settings.json b/contracts/.vscode/settings.json
@@ -1,5 +1,7 @@
 {
+    "editor.formatOnSave": true,
+    "editor.defaultFormatter": "esbenp.prettier-vscode",
     "editor.codeActionsOnSave": {
-      "source.fixAll.eslint": "explicit"
-    },
-}
+        "source.fixAll.eslint": "explicit"
+    }
+}
diff --git a/contracts/README.md b/contracts/README.md
@@ -4,17 +4,17 @@
 
 These contracts, node daemon, and UI are for the proposal described in [Reti Open Pooling](../docs/reti-open-pooling.md).
 
-The contracts themselves are written in Tealscript.  See [Tealscript](https://tealscript.algo.xyz) for details.
+The contracts themselves are written in Tealscript. See [Tealscript](https://tealscript.algo.xyz) for details.
 
 ## Usage
 
 ### Algokit
 
-This repository assumes you have [AlgoKit](https://github.com/algorandfoundation/algokit-cli) installed and have a local network running on your machine.  The default 'devmode' sandbox (`algokit localnet start`) is required for the system tests as they manipulate the block time offsets.template assumes you have a local network running on your machine. 
+This repository assumes you have [AlgoKit](https://github.com/algorandfoundation/algokit-cli) installed and have a local network running on your machine. The default 'devmode' sandbox (`algokit localnet start`) is required for the system tests as they manipulate the block time offsets.template assumes you have a local network running on your machine.
 
 ### PNPM
 
-The PNPM package manager was used for this project.  See [pnpm](https://pnpm.io/) for installation details.  Be sure to `pnpm install` first.
+The PNPM package manager was used for this project. See [pnpm](https://pnpm.io/) for installation details. Be sure to `pnpm install` first.
 
 ### Build Contracts
 
@@ -24,11 +24,10 @@ The PNPM package manager was used for this project.  See [pnpm](https://pnpm.io/
 
 ### Run Tests
 
-`pnpm run test` will execute the tests defined in [./\_\_test\_\_](./__test__) 
+`pnpm run test` will execute the tests defined in [./\_\_test\_\_](./__test__)
 
 ## Deploying
 
 ### Bootstrap script
 
-A bootstrap script is in the ./bootstrap directory.  Running `pnpm run bootstrap --network {network}` will bootstrap the validator.  The localnet networkbootstraps the local sandbox and also funds two new test accounts - updating an .env.sandbox file inside the nodemgr directory for local CLI use/testing.  It is recommended to use a named sandbox configuration that has devmode disabled so blocks proceed normally.
-
+A bootstrap script is in the ./bootstrap directory. Running `pnpm run bootstrap --network {network}` will bootstrap the validator. The localnet networkbootstraps the local sandbox and also funds two new test accounts - updating an .env.sandbox file inside the nodemgr directory for local CLI use/testing. It is recommended to use a named sandbox configuration that has devmode disabled so blocks proceed normally.
diff --git a/contracts/__test__/contracts.test.ts b/contracts/__test__/contracts.test.ts
@@ -440,16 +440,15 @@ describe('StakeAdds', () => {
     });
 
     test('addMaxPoolsAndFill', async () => {
-        const pools = [];
-        const stakers = [];
+        const pools: ValidatorPoolKey[] = [];
+        const stakers: Account[] = [];
         const poolsToCreate = MaxPoolsPerNode;
 
         // capture current 'total' state for all pools
         const origValidatorState = await getValidatorState(validatorMasterClient, validatorId);
 
         // we create 'max pools per node' new pools on new node (first pool is still there which wee added as part of beforeAll)
         for (let i = 0; i < poolsToCreate; i += 1) {
-            // eslint-disable-next-line no-await-in-loop
             const newPool = await addStakingPool(
                 fixture.context,
                 validatorMasterClient,

diff --git a/contracts/__test__/helpers.ts b/contracts/__test__/helpers.ts
@@ -422,14 +422,14 @@ export function getValidatorListBoxName(validatorId: number) {
     return concatUint8Arrays(prefix, encodeUint64(validatorId));
 }
 
-function getStakerPoolSetBoxName(stakerAccount: Account) {
-    const prefix = new TextEncoder().encode('sps');
-    return concatUint8Arrays(prefix, decodeAddress(stakerAccount.addr).publicKey);
-}
+// function getStakerPoolSetBoxName(stakerAccount: Account) {
+//     const prefix = new TextEncoder().encode('sps');
+//     return concatUint8Arrays(prefix, decodeAddress(stakerAccount.addr).publicKey);
+// }
 
-function getStakersBoxName() {
-    return new TextEncoder().encode('stakers');
-}
+// function getStakersBoxName() {
+//     return new TextEncoder().encode('stakers');
+// }
 
 export async function getMbrAmountsFromValidatorClient(validatorClient: ValidatorRegistryClient) {
     return (await validatorClient.compose().getMbrAmounts({}, {}).simulate()).returns![0];
@@ -518,6 +518,7 @@ export async function addStakingPool(
         suggestedParams,
     });
 
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
     let addPoolResults: any;
     // Before validator can add pools it needs to be funded
     try {