refactor(protocol): slightly change defender monitors (#18086)

taikoxyz · Sep 26, 2024 · b93d056 · b93d056
1 parent 8dda47b
commit b93d056
Show file tree

Hide file tree

Showing 28 changed files with 11,157 additions and 7,793 deletions.
diff --git a/.github/workflows/protocol-monitors.yml b/.github/workflows/protocol-monitors.yml
@@ -0,0 +1,37 @@
+name: Monitors
+
+on:
+  pull_request:
+    types: [opened, synchronize, reopened, ready_for_review]
+    paths:
+      - "packages/monitors/**"
+
+jobs:
+  deploy-protocol-monitors:
+    if: github.event.pull_request.draft == false
+    runs-on: [taiko-runner]
+    permissions:
+      # Give the necessary permissions for stefanzweifel/git-auto-commit-action.
+      contents: write
+    steps:
+      - name: Cancel previous runs
+        uses: styfle/cancel-workflow-action@0.12.1
+        with:
+          access_token: ${{ github.token }}
+
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          submodules: recursive
+
+      - name: Install pnpm dependencies
+        uses: ./.github/actions/install-pnpm-dependencies
+
+      - name: Deploy Monitors on OZ Defender
+        working-directory: packages/monitors/defender/mainnet
+        env:
+          DEFENDER_API_KEY: ${{ secrets.DEFENDER_API_KEY }}
+          DEFENDER_API_SECRET: ${{ secrets.DEFENDER_API_SECRET }}
+          SERVERLESS_ACCESS_KEY: ${{ secrets.SERVERLESS_ACCESS_KEY }}
+        run: |
+          npx serverless deploy
diff --git a/.github/workflows/protocol.yml b/.github/workflows/protocol.yml
@@ -5,6 +5,10 @@ on:
     types: [opened, synchronize, reopened, ready_for_review]
     paths:
       - "packages/protocol/**"
+      - "!packages/protocol/audit/**"
+      - "!packages/protocol/docs/**"
+      - "!packages/protocol/simulation/**"
+      - "!packages/protocol/deployments/**"
 
 jobs:
   build-protocol:

diff --git a/packages/monitors/.gitignore b/packages/monitors/.gitignore
@@ -0,0 +1 @@
+.defender
diff --git a/packages/monitors/defender/mainnet/.defender/deployment-log.mystack.json b/packages/monitors/defender/mainnet/.defender/deployment-log.mystack.json
diff --git a/packages/monitors/defender/mainnet/.env.example b/packages/monitors/defender/mainnet/.env.example
@@ -0,0 +1,2 @@
+DEFENDER_API_SECRET=
+DEFENDER_API_KEY=
diff --git a/packages/protocol/monitors/README.md → packages/monitors/defender/mainnet/README.md b/packages/protocol/monitors/README.md → packages/monitors/defender/mainnet/README.md
diff --git a/...nitors/actions/Bridge-MessageProcessed.js → .../actions/Bridge-MessageProcessed/index.js b/...nitors/actions/Bridge-MessageProcessed.js → .../actions/Bridge-MessageProcessed/index.js
@@ -262,7 +262,7 @@ function findUnmatchedMessages(processedMessages, sentMessages) {
 }
 
 function alertOrg(notificationClient, missingCount) {
-  const outputMessage = `Bridge Health Alert! \nThere are ${missingCount} missing MessageSent events for the processed messages on the other chain.`;
+  const outputMessage = `@cyberhorsey @soylent_ @xiaodino007 Bridge Health Alert! \nThere are ${missingCount} missing MessageSent events for the processed messages on the other chain.`;
 
   notificationClient.send({
     channelAlias: "discord_bridging",

diff --git a/.../actions/ER20Vault-BridgedTokenChanged.js → ...ns/ER20Vault-BridgedTokenChanged/index.js b/.../actions/ER20Vault-BridgedTokenChanged.js → ...ns/ER20Vault-BridgedTokenChanged/index.js
diff --git a/...onitors/actions/ERC20Vault-BalanceDrop.js → ...t/actions/ERC20Vault-BalanceDrop/index.js b/...onitors/actions/ERC20Vault-BalanceDrop.js → ...t/actions/ERC20Vault-BalanceDrop/index.js
diff --git a/...s/actions/GuardianProver-ApprovedCount.js → ...ons/GuardianProver-ApprovedCount/index.js b/...s/actions/GuardianProver-ApprovedCount.js → ...ons/GuardianProver-ApprovedCount/index.js
@@ -31,7 +31,7 @@ const ABI = [
 
 function alertOrg(notificationClient, message) {
   notificationClient.send({
-    channelAlias: "discord_configs",
+    channelAlias: "discord_bridging",
     subject: "⚠️ GuardianProver: Approved Count",
     message,
   });
@@ -56,7 +56,7 @@ async function calculateBlockTime(provider) {
 async function calculateBlockRange(provider) {
   const currentBlockNumber = await getLatestBlockNumber(provider);
   const blockTimeInSeconds = await calculateBlockTime(provider);
-  const blocksInOneHour = Math.floor((16 * 60) / blockTimeInSeconds);
+  const blocksInOneHour = Math.floor((15 * 60) / blockTimeInSeconds);
 
   const fromBlock = currentBlockNumber - blocksInOneHour;
   const toBlock = currentBlockNumber;
@@ -132,7 +132,7 @@ exports.handler = async function (event, context) {
   if (logs.length > 0) {
     alertOrg(
       notificationClient,
-      `Detected ${logs.length} Approved events in the last 15 mins on Guardian!`,
+      `@taiko|guardians Detected ${logs.length} Approved events in the last 15 mins on Guardian!`,
     );
   }
 

diff --git a/...tions/GuardianProver-ConflictingProofs.js → ...GuardianProver-ConflictingProofs/index.js b/...tions/GuardianProver-ConflictingProofs.js → ...GuardianProver-ConflictingProofs/index.js
@@ -43,7 +43,13 @@ const ABI = [
 
 function alertOrg(notificationClient, message) {
   notificationClient.send({
-    channelAlias: "discord_configs",
+    channelAlias: "discord_bridging",
+    subject: "🚨 GuardianProver: ConflictingProofs Alert",
+    message,
+  });
+
+  notificationClient.send({
+    channelAlias: "tg_taiko_guardians",
     subject: "🚨 GuardianProver: ConflictingProofs Alert",
     message,
   });

diff --git a/...ctions/GuardianProver-GuardiansUpdated.js → .../GuardianProver-GuardiansUpdated/index.js b/...ctions/GuardianProver-GuardiansUpdated.js → .../GuardianProver-GuardiansUpdated/index.js
@@ -25,7 +25,13 @@ const ABI = [
 
 function alertOrg(notificationClient, message) {
   notificationClient.send({
-    channelAlias: "discord_configs",
+    channelAlias: "discord_bridging",
+    subject: "⚠️ GuardianProver: GuardiansUpdated Alert",
+    message,
+  });
+
+  notificationClient.send({
+    channelAlias: "tg_taiko_guardians",
     subject: "⚠️ GuardianProver: GuardiansUpdated Alert",
     message,
   });

diff --git a/...GuardianProver-ProvingAutoPauseEnabled.js → ...anProver-ProvingAutoPauseEnabled/index.js b/...GuardianProver-ProvingAutoPauseEnabled.js → ...anProver-ProvingAutoPauseEnabled/index.js
@@ -19,7 +19,12 @@ const ABI = [
 
 function alertOrg(notificationClient, message) {
   notificationClient.send({
-    channelAlias: "discord_configs",
+    channelAlias: "discord_bridging",
+    subject: "⚠️ GuardianProver: ProvingAutoPauseEnabled Alert",
+    message,
+  });
+  notificationClient.send({
+    channelAlias: "tg_taiko_guardians",
     subject: "⚠️ GuardianProver: ProvingAutoPauseEnabled Alert",
     message,
   });

diff --git a/...actions/SGXVerifier-verifyProofFailure.js → ...s/SGXVerifier-verifyProofFailure/index.js b/...actions/SGXVerifier-verifyProofFailure.js → ...s/SGXVerifier-verifyProofFailure/index.js
@@ -8,7 +8,7 @@ const verifyProofSelector = ethers.utils
 
 function alertOrg(notificationClient, message) {
   notificationClient.send({
-    channelAlias: "discord_blocks",
+    channelAlias: "discord_bridging",
     subject: "⚠️ SGXVerifier: verifyProof Failure Alert",
     message,
   });

diff --git a/...monitors/actions/TaikoL1-BlockProposed.js → ...et/actions/TaikoL1-BlockProposed/index.js b/...monitors/actions/TaikoL1-BlockProposed.js → ...et/actions/TaikoL1-BlockProposed/index.js
@@ -258,7 +258,13 @@ const ABI = [
 
 function alertOrg(notificationClient, message) {
   notificationClient.send({
-    channelAlias: "discord_blocks",
+    channelAlias: "discord_bridging",
+    subject: "🚨 TaikoL1: BlockProposed Alert",
+    message,
+  });
+
+  notificationClient.send({
+    channelAlias: "tg_taiko_guardians",
     subject: "🚨 TaikoL1: BlockProposed Alert",
     message,
   });
@@ -340,7 +346,7 @@ exports.handler = async function (event, context) {
 
   const currentBlockNumber = await getLatestBlockNumber(taikoL1Provider);
   const blockTimeInSeconds = await calculateBlockTime(taikoL1Provider);
-  const blocksInFiveMinutes = Math.floor((5 * 60) / blockTimeInSeconds);
+  const blocksInFiveMinutes = Math.floor((15 * 60) / blockTimeInSeconds);
 
   const fromBlock = currentBlockNumber - blocksInFiveMinutes;
   const toBlock = currentBlockNumber;
@@ -359,7 +365,7 @@ exports.handler = async function (event, context) {
   if (logs.length === 0) {
     alertOrg(
       notificationClient,
-      `No BlockProposed event detected in the last 5 mins on TaikoL1!`,
+      `No BlockProposed event detected in the last 15 mins on TaikoL1!`,
     );
   }
 

diff --git a/...monitors/actions/TaikoL1-BlockVerified.js → ...et/actions/TaikoL1-BlockVerified/index.js b/...monitors/actions/TaikoL1-BlockVerified.js → ...et/actions/TaikoL1-BlockVerified/index.js
@@ -80,7 +80,13 @@ const ABI = [
 
 function alertOrg(notificationClient, message) {
   notificationClient.send({
-    channelAlias: "discord_blocks",
+    channelAlias: "discord_bridging",
+    subject: "🚨 TaikoL1: BlockVerified Alert",
+    message,
+  });
+
+  notificationClient.send({
+    channelAlias: "tg_taiko_guardians",
     subject: "🚨 TaikoL1: BlockVerified Alert",
     message,
   });
@@ -156,7 +162,7 @@ exports.handler = async function (event, context) {
 
   const currentBlockNumber = await getLatestBlockNumber(taikoL1Provider);
   const blockTimeInSeconds = await calculateBlockTime(taikoL1Provider);
-  const blocksInFiveMinutes = Math.floor((5 * 60) / blockTimeInSeconds);
+  const blocksInFiveMinutes = Math.floor((30 * 60) / blockTimeInSeconds);
 
   const fromBlock = currentBlockNumber - blocksInFiveMinutes;
   const toBlock = currentBlockNumber;
@@ -173,7 +179,7 @@ exports.handler = async function (event, context) {
   if (logs.length === 0) {
     alertOrg(
       notificationClient,
-      `No BlockVerified event detected in the last 5 mins in TaikoL1!`,
+      `@davidcai @yuea7583 No BlockVerified event detected in the last 30 mins in TaikoL1!`,
     );
   }
 

diff --git a/...rs/actions/TaikoL1-CalldataTxListCount.js → ...ions/TaikoL1-CalldataTxListCount/index.js b/...rs/actions/TaikoL1-CalldataTxListCount.js → ...ions/TaikoL1-CalldataTxListCount/index.js
@@ -25,7 +25,7 @@ const ABI = [
 
 function alertOrg(notificationClient, message) {
   notificationClient.send({
-    channelAlias: "discord_blocks",
+    channelAlias: "discord_bridging",
     subject: "ℹ️ TaikoL1: CalldataTxList Count",
     message,
   });

diff --git a/...monitors/actions/TaikoL1-ProvingPaused.js → ...et/actions/TaikoL1-ProvingPaused/index.js b/...monitors/actions/TaikoL1-ProvingPaused.js → ...et/actions/TaikoL1-ProvingPaused/index.js
@@ -19,7 +19,7 @@ const ABI = [
 
 function alertOrg(notificationClient, message) {
   notificationClient.send({
-    channelAlias: "discord_configs",
+    channelAlias: "discord_bridging",
     subject: "⚠️ TaikoL1: ProvingPaused Alert",
     message,
   });

diff --git a/...tions/TaikoL1-TransitionContestedCount.js → ...TaikoL1-TransitionContestedCount/index.js b/...tions/TaikoL1-TransitionContestedCount.js → ...TaikoL1-TransitionContestedCount/index.js
@@ -124,7 +124,7 @@ const ABI = [
 
 function alertOrg(notificationClient, message) {
   notificationClient.send({
-    channelAlias: "discord_blocks",
+    channelAlias: "discord_bridging",
     subject: "ℹ️ TaikoL1: TransitionContested Count",
     message,
   });

diff --git a/...itors/actions/TaikoL1-TransitionProved.js → ...actions/TaikoL1-TransitionProved/index.js b/...itors/actions/TaikoL1-TransitionProved.js → ...actions/TaikoL1-TransitionProved/index.js
@@ -124,7 +124,7 @@ const ABI = [
 
 function alertOrg(notificationClient, message) {
   notificationClient.send({
-    channelAlias: "discord_blocks",
+    channelAlias: "discord_bridging",
     subject: "🚨 TaikoL1: TransitionProved Alert",
     message,
   });

diff --git a/...rs/actions/Vaults-BridgedTokenDeployed.js → ...ions/Vaults-BridgedTokenDeployed/index.js b/...rs/actions/Vaults-BridgedTokenDeployed.js → ...ions/Vaults-BridgedTokenDeployed/index.js
@@ -130,8 +130,8 @@ const ABIs = {
 function alertOrg(notificationClient, subject, message) {
   notificationClient.send({
     channelAlias: "discord_bridging",
-    subject,
-    message,
+    subject: subject,
+    message: message,
   });
 }
 
@@ -226,9 +226,11 @@ async function monitorEvent(
   const eventCount = logs.length;
 
   if (eventCount > 0) {
-    const alertMessage = `Detected ${eventCount} ${subject} events on ${provider.network.name} in the last 24 hours!`;
+    const alertMessage = `ℹ️ Detected ${eventCount} ${subject} events on ${provider.network.name} in the last 24 hours!`;
     alertOrg(notificationClient, subject, alertMessage);
   }
+
+  return;
 }
 
 exports.handler = async function (event, context) {
@@ -260,15 +262,14 @@ exports.handler = async function (event, context) {
   const { fromBlock: l2FromBlock, toBlock: l2ToBlock } =
     await calculateBlockRange(l2Provider);
 
-  // Monitor ERC1155Vault events
   await monitorEvent(
     l1Provider,
     "BridgedTokenDeployed",
     l1FromBlock,
     l1ToBlock,
     "0xaf145913EA4a56BE22E120ED9C24589659881702", // L1
     ABIs.ERC1155Vault,
-    "ℹ️ ERC1155Vault BridgedTokenDeployed",
+    " ERC1155Vault.BridgedTokenDeployed",
     notificationClient,
   );
 
@@ -279,19 +280,18 @@ exports.handler = async function (event, context) {
     l2ToBlock,
     "0x1670000000000000000000000000000000000004", // L2
     ABIs.ERC1155Vault,
-    "ℹ️ ERC1155Vault BridgedTokenDeployed",
+    " ERC1155Vault.BridgedTokenDeployed",
     notificationClient,
   );
 
-  // Monitor ERC721Vault events
   await monitorEvent(
     l1Provider,
     "BridgedTokenDeployed",
     l1FromBlock,
     l1ToBlock,
     "0x0b470dd3A0e1C41228856Fb319649E7c08f419Aa", // L1
     ABIs.ERC721Vault,
-    "ℹ️ ERC721Vault BridgedTokenDeployed",
+    " ERC721Vault.BridgedTokenDeployed",
     notificationClient,
   );
 
@@ -302,19 +302,18 @@ exports.handler = async function (event, context) {
     l2ToBlock,
     "0x1670000000000000000000000000000000000003", // L2
     ABIs.ERC721Vault,
-    "ℹ️ ERC721Vault BridgedTokenDeployed",
+    " ERC721Vault.BridgedTokenDeployed",
     notificationClient,
   );
 
-  // Monitor ERC20Vault events
   await monitorEvent(
     l1Provider,
     "BridgedTokenDeployed",
     l1FromBlock,
     l1ToBlock,
     "0x996282cA11E5DEb6B5D122CC3B9A1FcAAD4415Ab", // L1
     ABIs.ERC20Vault,
-    "ℹ️ ERC20 BridgedTokenDeployed",
+    " ERC20Vault.BridgedTokenDeployed",
     notificationClient,
   );
 
@@ -325,7 +324,7 @@ exports.handler = async function (event, context) {
     l2ToBlock,
     "0x1670000000000000000000000000000000000002", // L2
     ABIs.ERC20Vault,
-    "ℹ️  ERC20Vault BridgedTokenDeployed",
+    " ERC20Vault.BridgedTokenDeployed",
     notificationClient,
   );