Merge branch 'main' into plat-1635-expose-approval-process-endpoints-…

…to-external-api-and
OpenZeppelin · Mar 28, 2024 · 38108dc · 38108dc
2 parents 817f654 + 5315a9e
commit 38108dc
Show file tree

Hide file tree

Showing 117 changed files with 1,949 additions and 1,377 deletions.
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -90,11 +90,6 @@ updates:
     schedule:
       interval: daily
 
-  - package-ecosystem: npm
-    directory: /examples/update-notification-category
-    schedule:
-      interval: daily
-
   - package-ecosystem: npm
     directory: /examples/update-relayer
     schedule:

diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -17,7 +17,7 @@ jobs:
     runs-on: ubuntu-22.04
     steps:
     - name: Harden Runner
-      uses: step-security/harden-runner@eb238b55efaa70779f274895e782ed17c84f2895 # v2.6.1
+      uses: step-security/harden-runner@63c24ba6bd7ba022e95695ff85de572c04a18142 # v2.7.0
       with:
         egress-policy: audit
 

diff --git a/.github/workflows/codeql.yml b/.github/workflows/codeql.yml
@@ -49,7 +49,7 @@ jobs:
 
     steps:
     - name: Harden Runner
-      uses: step-security/harden-runner@eb238b55efaa70779f274895e782ed17c84f2895 # v2.6.1
+      uses: step-security/harden-runner@63c24ba6bd7ba022e95695ff85de572c04a18142 # v2.7.0
       with:
         egress-policy: audit
 
@@ -58,7 +58,7 @@ jobs:
 
     # Initializes the CodeQL tools for scanning.
     - name: Initialize CodeQL
-      uses: github/codeql-action/init@379614612a29c9e28f31f39a59013eb8012a51f0 # v3.24.3
+      uses: github/codeql-action/init@8a470fddafa5cbb6266ee11b37ef4d8aae19c571 # v3.24.6
       with:
         languages: ${{ matrix.language }}
         # If you wish to specify custom queries, you can do so here or in a config file.
@@ -72,7 +72,7 @@ jobs:
     # Autobuild attempts to build any compiled languages (C/C++, C#, Go, Java, or Swift).
     # If this step fails, then you should remove it and run the build manually (see below)
     - name: Autobuild
-      uses: github/codeql-action/autobuild@379614612a29c9e28f31f39a59013eb8012a51f0 # v3.24.3
+      uses: github/codeql-action/autobuild@8a470fddafa5cbb6266ee11b37ef4d8aae19c571 # v3.24.6
 
     # ℹ️ Command-line programs to run using the OS shell.
     # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
@@ -85,6 +85,6 @@ jobs:
     #     ./location_of_script_within_repo/buildscript.sh
 
     - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@379614612a29c9e28f31f39a59013eb8012a51f0 # v3.24.3
+      uses: github/codeql-action/analyze@8a470fddafa5cbb6266ee11b37ef4d8aae19c571 # v3.24.6
       with:
         category: "/language:${{matrix.language}}"
diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml
@@ -36,7 +36,7 @@ jobs:
       id-token: write # For signing
     steps:
       - name: Harden Runner
-        uses: step-security/harden-runner@eb238b55efaa70779f274895e782ed17c84f2895 # v2.6.1
+        uses: step-security/harden-runner@63c24ba6bd7ba022e95695ff85de572c04a18142 # v2.7.0
         with:
           egress-policy: audit
 

diff --git a/.github/workflows/rc.yml b/.github/workflows/rc.yml
@@ -20,7 +20,7 @@ jobs:
     runs-on: ubuntu-22.04
     steps:
       - name: Harden Runner
-        uses: step-security/harden-runner@eb238b55efaa70779f274895e782ed17c84f2895 # v2.6.1
+        uses: step-security/harden-runner@63c24ba6bd7ba022e95695ff85de572c04a18142 # v2.7.0
         with:
           egress-policy: audit
 
@@ -34,7 +34,7 @@ jobs:
         uses: ./.github/actions/prepare
 
       - name: Create Release Pull Request
-        uses: changesets/action@f13b1baaa620fde937751f5d2c3572b9da32af23 # v1.4.5
+        uses: changesets/action@aba318e9165b45b7948c60273e0b72fce0a64eb9 # v1.4.7
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
@@ -67,7 +67,7 @@ jobs:
   #     changed_packages: ${{ steps.tag_check_changes.outputs.changed_packages }}
   #   steps:
   #     - name: Harden Runner
-  #       uses: step-security/harden-runner@eb238b55efaa70779f274895e782ed17c84f2895 # v2.6.1
+  #       uses: step-security/harden-runner@63c24ba6bd7ba022e95695ff85de572c04a18142 # v2.7.0
   #       with:
   #         egress-policy: audit
 

diff --git a/.github/workflows/release-drafter.yml b/.github/workflows/release-drafter.yml
@@ -15,10 +15,10 @@ jobs:
     runs-on: ubuntu-22.04
     steps:
       - name: Harden Runner
-        uses: step-security/harden-runner@eb238b55efaa70779f274895e782ed17c84f2895 # v2.6.1
+        uses: step-security/harden-runner@63c24ba6bd7ba022e95695ff85de572c04a18142 # v2.7.0
         with:
           egress-policy: audit
 
-      - uses: release-drafter/release-drafter@09c613e259eb8d4e7c81c2cb00618eb5fc4575a7 # v5.25.0
+      - uses: release-drafter/release-drafter@3f0f87098bd6b5c5b9a36d49c41d998ea58f9348 # v6.0.0
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -30,7 +30,7 @@ jobs:
       contents: write
     steps:
       - name: Harden Runner
-        uses: step-security/harden-runner@eb238b55efaa70779f274895e782ed17c84f2895 # v2.6.1
+        uses: step-security/harden-runner@63c24ba6bd7ba022e95695ff85de572c04a18142 # v2.7.0
         with:
           egress-policy: audit
 

diff --git a/.github/workflows/scorecard.yml b/.github/workflows/scorecard.yml
@@ -32,7 +32,7 @@ jobs:
 
     steps:
       - name: Harden Runner
-        uses: step-security/harden-runner@eb238b55efaa70779f274895e782ed17c84f2895 # v2.6.1
+        uses: step-security/harden-runner@63c24ba6bd7ba022e95695ff85de572c04a18142 # v2.7.0
         with:
           egress-policy: audit
 
@@ -72,6 +72,6 @@ jobs:
 
       # Upload the results to GitHub's code scanning dashboard.
       - name: "Upload to code-scanning"
-        uses: github/codeql-action/upload-sarif@379614612a29c9e28f31f39a59013eb8012a51f0 # v2.3.5
+        uses: github/codeql-action/upload-sarif@8a470fddafa5cbb6266ee11b37ef4d8aae19c571 # v2.3.5
         with:
           sarif_file: results.sarif
diff --git a/.github/workflows/stable.yml b/.github/workflows/stable.yml
@@ -16,7 +16,7 @@ jobs:
       next_stable_version: ${{ steps.update_version.outputs.next_stable_version }}
     steps:
       - name: Harden Runner
-        uses: step-security/harden-runner@eb238b55efaa70779f274895e782ed17c84f2895 # v2.6.1
+        uses: step-security/harden-runner@63c24ba6bd7ba022e95695ff85de572c04a18142 # v2.7.0
         with:
           egress-policy: audit
 
@@ -32,7 +32,7 @@ jobs:
           node-version: 16.20.0
 
       - name: Import GPG key
-        uses: crazy-max/ghaction-import-gpg@82a020f1f7f605c65dd2449b392a52c3fcfef7ef # v6.0.0
+        uses: crazy-max/ghaction-import-gpg@01dd5d3ca463c7f10f7f4f7b4f177225ac661ee4 # v6.1.0
         with:
           gpg_private_key: ${{ secrets.SVC_GPG_KEY }}
           passphrase: ${{ secrets.SVC_GPG_PASSPHRASE }}

diff --git a/examples/create-action/CHANGELOG.md b/examples/create-action/CHANGELOG.md
@@ -1,5 +1,18 @@
 # @openzeppelin/defender-sdk-example-create-action
 
+## 1.11.0
+
+### Minor Changes
+
+- 49c1994: refactor: Deprecate optimism-goerli network
+  chore: Enable zkEVM networks
+  chore: Upgrade npm packages
+
+### Patch Changes
+
+- Updated dependencies [49c1994]
+  - @openzeppelin/defender-sdk@1.11.0
+
 ## 1.10.0
 
 ### Minor Changes

diff --git a/examples/create-action/index.js b/examples/create-action/index.js
@@ -3,7 +3,12 @@ require('dotenv').config();
 const { Defender } = require('@openzeppelin/defender-sdk');
 
 async function main() {
-  const creds = { apiKey: process.env.API_KEY, apiSecret: process.env.API_SECRET };
+  const creds = {
+    apiKey: process.env.API_KEY,
+    apiSecret: process.env.API_SECRET,
+    //optional https config to keep connection alive. You can pass any configs that are accepted by https.Agent
+    httpsAgent: https.Agent({ keepAlive: true }),
+  };
   const client = new Defender(creds);
 
   client.action.validatePath('./code');

diff --git a/examples/create-action/package.json b/examples/create-action/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@openzeppelin/defender-sdk-example-create-action",
-  "version": "1.10.0",
+  "version": "1.11.0",
   "private": true,
   "main": "index.js",
   "author": "Nami Shah <nami@openzeppelin.com>",
@@ -9,7 +9,7 @@
     "start": "node index.js"
   },
   "dependencies": {
-    "@openzeppelin/defender-sdk": "1.10.0",
+    "@openzeppelin/defender-sdk": "1.11.0",
     "dotenv": "^16.3.1"
   }
 }
diff --git a/examples/create-batch-proposal/CHANGELOG.md b/examples/create-batch-proposal/CHANGELOG.md
@@ -1,5 +1,18 @@
 # @openzeppelin/defender-sdk-example-create-batch-proposal
 
+## 1.11.0
+
+### Minor Changes
+
+- 49c1994: refactor: Deprecate optimism-goerli network
+  chore: Enable zkEVM networks
+  chore: Upgrade npm packages
+
+### Patch Changes
+
+- Updated dependencies [49c1994]
+  - @openzeppelin/defender-sdk@1.11.0
+
 ## 1.10.0
 
 ### Minor Changes

diff --git a/examples/create-batch-proposal/index.js b/examples/create-batch-proposal/index.js
@@ -56,7 +56,12 @@ const steps = [
 ];
 
 async function main() {
-  const creds = { apiKey: process.env.API_KEY, apiSecret: process.env.API_SECRET };
+  const creds = {
+    apiKey: process.env.API_KEY,
+    apiSecret: process.env.API_SECRET,
+    //optional https config to keep connection alive. You can pass any configs that are accepted by https.Agent
+    httpsAgent: https.Agent({ keepAlive: true }),
+  };
   const client = new Defender(creds);
 
   const { url } = await client.proposal.create({

diff --git a/examples/create-batch-proposal/package.json b/examples/create-batch-proposal/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@openzeppelin/defender-sdk-example-create-batch-proposal",
-  "version": "1.10.0",
+  "version": "1.11.0",
   "private": true,
   "main": "index.js",
   "author": "Nami Shah <nami@openzeppelin.com>",
@@ -9,7 +9,7 @@
     "start": "node index.js"
   },
   "dependencies": {
-    "@openzeppelin/defender-sdk": "1.10.0",
+    "@openzeppelin/defender-sdk": "1.11.0",
     "dotenv": "^16.3.1"
   }
 }
diff --git a/examples/create-forked-network/CHANGELOG.md b/examples/create-forked-network/CHANGELOG.md
@@ -1,5 +1,18 @@
 # @openzeppelin/defender-sdk-example-create-forked-network
 
+## 1.11.0
+
+### Minor Changes
+
+- 49c1994: refactor: Deprecate optimism-goerli network
+  chore: Enable zkEVM networks
+  chore: Upgrade npm packages
+
+### Patch Changes
+
+- Updated dependencies [49c1994]
+  - @openzeppelin/defender-sdk@1.11.0
+
 ## 1.10.0
 
 ### Minor Changes

diff --git a/examples/create-forked-network/index.js b/examples/create-forked-network/index.js
@@ -3,7 +3,12 @@ require('dotenv').config();
 const { Defender } = require('@openzeppelin/defender-sdk');
 
 async function main() {
-  const creds = { apiKey: process.env.API_KEY, apiSecret: process.env.API_SECRET };
+  const creds = {
+    apiKey: process.env.API_KEY,
+    apiSecret: process.env.API_SECRET,
+    //optional https config to keep connection alive. You can pass any configs that are accepted by https.Agent
+    httpsAgent: https.Agent({ keepAlive: true }),
+  };
   const client = new Defender(creds);
 
   // Create Forked Network

diff --git a/examples/create-forked-network/package.json b/examples/create-forked-network/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@openzeppelin/defender-sdk-example-create-forked-network",
-  "version": "1.10.0",
+  "version": "1.11.0",
   "private": true,
   "main": "index.js",
   "author": "Zeljko Markovic <zeljko@openzeppelin.com>",
@@ -9,7 +9,7 @@
     "start": "node index.js"
   },
   "dependencies": {
-    "@openzeppelin/defender-sdk": "1.10.0",
+    "@openzeppelin/defender-sdk": "1.11.0",
     "dotenv": "^16.3.1"
   }
 }
diff --git a/examples/create-monitor/index.js b/examples/create-monitor/index.js
@@ -5,7 +5,12 @@ const abi = require('./abis/erc721.json');
 const { Defender } = require('@openzeppelin/defender-sdk');
 
 async function main() {
-  const creds = { apiKey: process.env.API_KEY, apiSecret: process.env.API_SECRET };
+  const creds = {
+    apiKey: process.env.API_KEY,
+    apiSecret: process.env.API_SECRET,
+    //optional https config to keep connection alive. You can pass any configs that are accepted by https.Agent
+    httpsAgent: https.Agent({ keepAlive: true }),
+  };
   const client = new Defender(creds);
 
   let notification;
@@ -58,6 +63,8 @@ async function main() {
     // optional
     alertTimeoutMs: 0,
     notificationChannels: [notification.notificationId],
+    // optional (LOW, MEDIUM, HIGH)
+    severityLevel: 'LOW',
     // optional
     riskCategory: 'TECHNICAL',
   };

diff --git a/examples/create-monitor/package.json b/examples/create-monitor/package.json
@@ -9,7 +9,7 @@
     "start": "node index.js"
   },
   "dependencies": {
-    "@openzeppelin/defender-sdk": "1.10.0",
+    "@openzeppelin/defender-sdk": "1.11.0",
     "dotenv": "^16.3.1"
   }
 }
diff --git a/examples/create-private-network/CHANGELOG.md b/examples/create-private-network/CHANGELOG.md
@@ -1,5 +1,18 @@
 # @openzeppelin/defender-sdk-example-create-private-network
 
+## 1.11.0
+
+### Minor Changes
+
+- 49c1994: refactor: Deprecate optimism-goerli network
+  chore: Enable zkEVM networks
+  chore: Upgrade npm packages
+
+### Patch Changes
+
+- Updated dependencies [49c1994]
+  - @openzeppelin/defender-sdk@1.11.0
+
 ## 1.8.0
 
 ### Minor Changes

diff --git a/examples/create-private-network/index.js b/examples/create-private-network/index.js
@@ -3,7 +3,12 @@ require('dotenv').config();
 const { Defender } = require('@openzeppelin/defender-sdk');
 
 async function main() {
-  const creds = { apiKey: process.env.API_KEY, apiSecret: process.env.API_SECRET };
+  const creds = {
+    apiKey: process.env.API_KEY,
+    apiSecret: process.env.API_SECRET,
+    //optional https config to keep connection alive. You can pass any configs that are accepted by https.Agent
+    httpsAgent: https.Agent({ keepAlive: true }),
+  };
   const client = new Defender(creds);
 
   // Create Private Network

diff --git a/examples/create-private-network/package.json b/examples/create-private-network/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@openzeppelin/defender-sdk-example-create-private-network",
-  "version": "1.10.0",
+  "version": "1.11.0",
   "private": true,
   "main": "index.js",
   "author": "Nami Shah <nami@openzeppelin.com>",
@@ -9,7 +9,7 @@
     "start": "node index.js"
   },
   "dependencies": {
-    "@openzeppelin/defender-sdk": "1.10.0",
+    "@openzeppelin/defender-sdk": "1.11.0",
     "dotenv": "^16.3.1"
   }
 }
diff --git a/examples/create-proposal/CHANGELOG.md b/examples/create-proposal/CHANGELOG.md
@@ -1,5 +1,18 @@
 # @openzeppelin/defender-sdk-example-create-proposal
 
+## 1.11.0
+
+### Minor Changes
+
+- 49c1994: refactor: Deprecate optimism-goerli network
+  chore: Enable zkEVM networks
+  chore: Upgrade npm packages
+
+### Patch Changes
+
+- Updated dependencies [49c1994]
+  - @openzeppelin/defender-sdk@1.11.0
+
 ## 1.10.0
 
 ### Minor Changes