.eslintrc.js

@@ -6,6 +6,7 @@ module.exports = {
   extends: ['eslint:recommended', 'plugin:prettier/recommended'],
   env: {
     node: true,
+    es2022: true,
   },
   plugins: ['unicorn'],
   rules: {

.github/actions/setup/action.yml

@@ -0,0 +1,13 @@
+name: Setup
+
+runs:
+  using: composite
+  steps:
+    - uses: actions/setup-node@v3
+      with:
+        node-version: 14.x
+        cache: yarn
+
+    - name: Install dependencies
+      run: yarn --frozen-lockfile --prefer-offline
+      shell: bash

.github/workflows/checks.yml

@@ -0,0 +1,57 @@
+name: checks
+
+on:
+  push:
+    branches: [master]
+  pull_request: {}
+
+concurrency:
+  group: checks-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+
+    - name: Set up environment
+      uses: ./.github/actions/setup
+
+    - name: Run linter
+      run: yarn lint
+
+  tests:
+    strategy:
+      matrix:
+        package:
+          - core
+          - plugin-hardhat
+          - plugin-truffle
+          - plugin-defender-hardhat
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+
+    - name: Set up environment
+      uses: ./.github/actions/setup
+
+    - name: Run tests
+      run: yarn --cwd "packages/${{matrix.package}}" run test
+
+  coverage:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+
+    - name: Set up environment
+      uses: ./.github/actions/setup
+
+    - name: Run coverage
+      run: yarn coverage
+
+    - uses: codecov/codecov-action@v3

.github/workflows/pack.yml

@@ -9,33 +9,16 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v2
-    - uses: actions/setup-node@v2
-      with:
-        node-version: 12.x
-
-    - name: Get yarn cache directory
-      id: yarn-cache-dir-path
-      run: echo "::set-output name=dir::$(yarn cache dir)"
-
-    - name: Cache node modules
-      uses: actions/cache@v2
-      with:
-        path: |
-          ${{steps.yarn-cache-dir-path.outputs.dir}}
-          ~/.cache/node-gyp-cache
-        key: ${{runner.os}}-yarn-${{env.cache-version}}-${{hashFiles('yarn.lock')}}
-      env:
-        cache-version: 2
+    - uses: actions/checkout@v3
 
-    - name: Install dependencies
-      run: yarn --frozen-lockfile
+    - name: Set up environment
+      uses: ./.github/actions/setup
 
     - name: Pack tarballs
       run: bash scripts/bundle-pack.sh
 
     - name: Uplaod tarballs as artifacts
-      uses: actions/upload-artifact@v2
+      uses: actions/upload-artifact@v3
       with:
         name: package
         path: "*.tgz"

.node-version

@@ -0,0 +1 @@
+16

docs/modules/ROOT/pages/api-core.adoc

@@ -4,55 +4,92 @@ The core logic to check for upgrade safety as well as storage layout compatibili
 
 The package exports a standalone interface that works with https://docs.soliditylang.org/en/latest/using-the-compiler.html#compiler-input-and-output-json-description[Solidity input and output JSON objects].
 
-[.hljs-theme-light.nopadding]
-```javascript
+[source,ts]
+----
 import { UpgradeableContract } from '@openzeppelin/upgrades-core';
-```
+----
 
 == UpgradeableContract
 
 This class represents the implementation for an upgradeable contract and gives access to error reports.
 
-[.hljs-theme-light.nopadding]
-```javascript
-new UpgradeableContract(name, solcInput, solcOutput, opts?);
-```
-
-`opts` is an object with options as defined in xref:api-hardhat-upgrades.adoc#common-options[Common Options].
+=== constructor UpgradeableContract
+[source,ts]
+----
+constructor UpgradeableContract(
+  name: string,
+  solcInput: SolcInput,
+  solcOutput: SolcOutput,
+  opts?: {
+    unsafeAllow?: ValidationError[],
+    unsafeAllowRenames?: boolean,
+    unsafeSkipStorageCheck?: boolean,
+    kind?: 'uups' | 'transparent' | 'beacon',
+  },
+): UpgradeableContract
+----
+
+Creates a new instance of `UpgradeableContract`.
+
+*Parameters:*
+
+* `name` - the name of the implementation contract as either a fully qualified name or contract name. If multiple contracts have the same name, you must use the fully qualified name e.g., `contracts/Bar.sol:Bar`.
+* `solcInput` - the Solidity input JSON object for the implementation contract.
+* `solcOutput` - the Solidity output JSON object for the implementation contract.
+* `opts` - an object with options as defined in xref:api-hardhat-upgrades.adoc#common-options[Common Options].
 
 TIP: In Hardhat, `solcInput` and `solcOutput` can be obtained from the Build Info file, which itself can be retrieved with `hre.artifacts.getBuildInfo`.
 
-=== getErrorReport
+=== .getErrorReport
+[source,ts]
+----
+getErrorReport(): Report
+----
 
-Returns a report about errors pertaining to proxied contracts, e.g. the use of `selfdestruct`.
+**Returns:**
 
-[.hljs-theme-light.nopadding]
-```javascript
-contract.getErrorReport()
-```
+* a report about errors pertaining to proxied contracts, e.g. the use of `selfdestruct`.
 
-=== getStorageUpgradeReport
+=== .getStorageUpgradeReport
+[source,ts]
+----
+getStorageUpgradeReport(
+  upgradedContract: UpgradeableContract,
+  opts?: {
+    unsafeAllow?: ValidationError[],
+    unsafeAllowRenames?: boolean,
+    unsafeSkipStorageCheck?: boolean,
+    kind?: 'uups' | 'transparent' | 'beacon',
+  },
+): Report
+----
 
-Compares the storage layout of an upgradeable contract with that of a proposed upgrade. Receives as an argument another instance of `UpgradeableContract`.
+Compares the storage layout of an upgradeable contract with that of a proposed upgrade.
 
-[.hljs-theme-light.nopadding]
-```javascript
-contract.getStorageUpgradeReport(upgradedContract)
-```
+*Parameters:*
 
-== Report
+* `upgradedContract` - another instance of `UpgradeableContract` representing the proposed upgrade.
 
-An object that represents the results of an analysis.
+* `opts` - an object with options as defined in xref:api-hardhat-upgrades.adoc#common-options[Common Options].
+
+**Returns:**
+
+* a report about errors pertaining to proxied contracts, e.g. the use of `selfdestruct`, and storage layout conflicts.
 
-[.hljs-theme-light.nopadding]
-```typescript
+== Report
+[source,ts]
+----
 interface Report {
   ok: boolean;
   explain(color?: boolean): string;
 }
-```
+----
+
+An object that represents the results of an analysis.
+
+**Members:**
 
-The field `ok` is `false` if any errors were found, and `true` otherwise.
+* `ok` - `false` if any errors were found, otherwise `true`.
 
-The method `explain()` will return a message explaining the errors in detail, if any.
+* `explain()` - returns a message explaining the errors in detail, if any.