feat: admin scripts

scripts/admin/tripGlobal.ts

@@ -0,0 +1,156 @@
+import { Contract, Wallet, utils } from "ethers";
+import {
+  IntegrationTypes,
+  ChainSlug,
+  DeploymentMode,
+  isTestnet,
+  isMainnet,
+} from "../../src";
+import { mode, overrides } from "../deploy/config";
+import { arrayify, defaultAbiCoder, keccak256 } from "ethers/lib/utils";
+import { checkRole, getSiblings } from "../common";
+import {
+  getAllAddresses,
+  DeploymentAddresses,
+  ROLES,
+} from "@socket.tech/dl-core";
+import dotenv from "dotenv";
+import {
+  getSwitchboardInstance,
+  TRIP_GLOBAL_SIG_IDENTIFIER,
+  TRIP_NATIVE_SIG_IDENTIFIER,
+} from "../common";
+
+dotenv.config();
+const deploymentMode = process.env.DEPLOYMENT_MODE as DeploymentMode;
+
+/**
+ * Usable flags
+ * --sendtx         Send trip tx 
+ *                  Default is false, only check trip status.
+ *                  Eg. npx --sendtx ts-node scripts/admin/rescueFunds.ts
+
+ * --chains         Run only for specified chains.
+ *                  Default is all chains.
+ *                  Eg. npx --chains=10,2999 ts-node scripts/admin/tripGlobal.ts
+ *
+ * --testnets       Run for testnets.
+ *                  Default is false.
+ * 
+ * --integration  Run for sepcified integration type. Can be fast or optimistic.
+ *                  Default is fast.
+ */
+
+const addresses: DeploymentAddresses = getAllAddresses(mode);
+const testnets = process.env.npm_config_testnets == "true";
+let activeChainSlugs: string[];
+if (testnets)
+  activeChainSlugs = Object.keys(addresses).filter((c) =>
+    isTestnet(parseInt(c))
+  );
+else
+  activeChainSlugs = Object.keys(addresses).filter((c) =>
+    isMainnet(parseInt(c))
+  );
+const sendTx = process.env.npm_config_sendtx == "true";
+const integrationType = process.env.npm_config_integration
+  ? process.env.npm_config_integration.toUpperCase()
+  : IntegrationTypes.fast;
+let filterChains = process.env.npm_config_chains
+  ? process.env.npm_config_chains.split(",").map((c) => Number(c))
+  : activeChainSlugs;
+
+const main = async () => {
+  if (
+    integrationType &&
+    !Object.values(IntegrationTypes).includes(
+      integrationType as IntegrationTypes
+    )
+  ) {
+    throw new Error(
+      "Invalid integration type. Can be FAST, NATIVE_BRIDGE or OPTIMISTIC"
+    );
+  }
+  filterChains = filterChains.map((c) => Number(c));
+  console.log({ filterChains });
+  for (const chain of filterChains) {
+    let siblingChains = getSiblings(deploymentMode, Number(chain) as ChainSlug);
+
+    if (siblingChains.length)
+      console.log("======= Checking ", { chain }, "==============");
+    for (const siblingChain of siblingChains) {
+      const switchboard = getSwitchboardInstance(
+        chain,
+        siblingChain,
+        integrationType as IntegrationTypes,
+        mode
+      );
+      if (switchboard === undefined) {
+        console.log(
+          "Switchboard address not found for ",
+          chain,
+          "continuing..."
+        );
+        continue;
+      }
+
+      let tripStatus: boolean;
+      try {
+        tripStatus = await switchboard.isGlobalTipped();
+        console.log({ type: integrationType, tripStatus });
+      } catch (error) {
+        console.log("RPC Error while fetching trip status: ", error);
+        break;
+      }
+
+      if (tripStatus) break; // as global trip, check for a single siblingChain is enough
+
+      if (sendTx) {
+        let hasRole = await checkRole(ROLES.TRIP_ROLE, switchboard);
+        if (!hasRole) break;
+        console.log("tripping", { chain });
+
+        const nonce = await switchboard.nextNonce(
+          switchboard.signer.getAddress()
+        );
+
+        let sigIdentifier =
+          integrationType == IntegrationTypes.native
+            ? TRIP_NATIVE_SIG_IDENTIFIER
+            : TRIP_GLOBAL_SIG_IDENTIFIER;
+        const digest = keccak256(
+          defaultAbiCoder.encode(
+            ["bytes32", "address", "uint32", "uint256", "bool"],
+            [sigIdentifier, switchboard.address, chain, nonce, true]
+          )
+        );
+
+        const signature = await switchboard.signer.signMessage(
+          arrayify(digest)
+        );
+
+        const tx = await switchboard.tripGlobal(nonce, signature, {
+          ...overrides(chain),
+        });
+        console.log(tx.hash);
+
+        await tx.wait();
+        console.log("done");
+      }
+      break;
+    }
+  }
+};
+
+main()
+  .then(() => process.exit(0))
+  .catch((error: Error) => {
+    console.error(error);
+    process.exit(1);
+  });
+
+// npx ts-node scripts/admin/tripGlobal.ts  - check trip status for all mainnet chains
+// npx --chains=421614  ts-node scripts/admin/tripGlobal.ts
+// npx --sendtx --chains=421614  ts-node scripts/admin/tripGlobal.ts
+// npx --sendtx --chains=421614 --integration=fast ts-node scripts/admin/tripGlobal.ts
+// npx --sendtx --chains=421614 --testnets --integration=fast ts-node scripts/admin/tripGlobal.ts

scripts/admin/unTripGlobal.ts

@@ -0,0 +1,158 @@
+import { Contract, Wallet, utils } from "ethers";
+import {
+  IntegrationTypes,
+  ChainSlug,
+  DeploymentMode,
+  isTestnet,
+  isMainnet,
+} from "../../src";
+import { mode, overrides } from "../deploy/config";
+import { arrayify, defaultAbiCoder, keccak256 } from "ethers/lib/utils";
+import {
+  UN_TRIP_GLOBAL_SIG_IDENTIFIER,
+  UN_TRIP_NATIVE_SIG_IDENTIFIER,
+  checkRole,
+  getSiblings,
+} from "../common";
+import {
+  getAllAddresses,
+  DeploymentAddresses,
+  ROLES,
+} from "@socket.tech/dl-core";
+import dotenv from "dotenv";
+import { getSwitchboardInstance } from "../common";
+
+dotenv.config();
+const deploymentMode = process.env.DEPLOYMENT_MODE as DeploymentMode;
+
+/**
+ * Usable flags
+ * --sendtx         Send trip tx 
+ *                  Default is false, only check trip status.
+ *                  Eg. npx --sendtx ts-node scripts/admin/rescueFunds.ts
+
+ * --chains         Run only for specified chains.
+ *                  Default is all chains.
+ *                  Eg. npx --chains=10,2999 ts-node scripts/admin/tripGlobal.ts
+ *
+ * --testnets       Run for testnets.
+ *                  Default is false.
+ * 
+ * --integration  Run for sepcified integration type. Can be fast or optimistic.
+ *                  Default is fast.
+ */
+
+const addresses: DeploymentAddresses = getAllAddresses(mode);
+const testnets = process.env.npm_config_testnets == "true";
+let activeChainSlugs: string[];
+if (testnets)
+  activeChainSlugs = Object.keys(addresses).filter((c) =>
+    isTestnet(parseInt(c))
+  );
+else
+  activeChainSlugs = Object.keys(addresses).filter((c) =>
+    isMainnet(parseInt(c))
+  );
+const sendTx = process.env.npm_config_sendtx == "true";
+const integrationType = process.env.npm_config_integration
+  ? process.env.npm_config_integration.toUpperCase()
+  : IntegrationTypes.fast;
+let filterChains = process.env.npm_config_chains
+  ? process.env.npm_config_chains.split(",").map((c) => Number(c))
+  : activeChainSlugs;
+
+const main = async () => {
+  console.log({ integrationType });
+  if (
+    integrationType &&
+    !Object.values(IntegrationTypes).includes(
+      integrationType as IntegrationTypes
+    )
+  ) {
+    throw new Error(
+      "Invalid integration type. Can be FAST, NATIVE_BRIDGE or OPTIMISTIC"
+    );
+  }
+  filterChains = filterChains.map((c) => Number(c));
+  console.log({ filterChains });
+  for (const chain of filterChains) {
+    let siblingChains = getSiblings(deploymentMode, Number(chain) as ChainSlug);
+    if (siblingChains.length)
+      console.log("======= Checking ", { chain }, "==============");
+    for (const siblingChain of siblingChains) {
+      const switchboard = getSwitchboardInstance(
+        chain,
+        siblingChain,
+        integrationType as IntegrationTypes,
+        mode
+      );
+      if (switchboard === undefined) {
+        console.log(
+          "Switchboard address not found for ",
+          chain,
+          "continuing..."
+        );
+        continue;
+      }
+
+      let tripStatus: boolean;
+      try {
+        tripStatus = await switchboard.isGlobalTipped();
+        console.log({ type: integrationType, tripStatus });
+      } catch (error) {
+        console.log("RPC Error while fetching trip status: ", error);
+        break;
+      }
+
+      if (!tripStatus) break; // as global trip, check for a single siblingChain is enough
+
+      if (sendTx) {
+        let hasRole = await checkRole(ROLES.UN_TRIP_ROLE, switchboard);
+        if (!hasRole) break;
+        console.log("untripping", { chain });
+
+        const nonce = await switchboard.nextNonce(
+          switchboard.signer.getAddress()
+        );
+
+        let sigIdentifier =
+          integrationType == IntegrationTypes.native
+            ? UN_TRIP_NATIVE_SIG_IDENTIFIER
+            : UN_TRIP_GLOBAL_SIG_IDENTIFIER;
+
+        const digest = keccak256(
+          defaultAbiCoder.encode(
+            ["bytes32", "address", "uint32", "uint256", "bool"],
+            [sigIdentifier, switchboard.address, chain, nonce, false]
+          )
+        );
+
+        const signature = await switchboard.signer.signMessage(
+          arrayify(digest)
+        );
+
+        const tx = await switchboard.unTrip(nonce, signature, {
+          ...overrides(chain),
+        });
+        console.log(tx.hash);
+
+        await tx.wait();
+        console.log("done");
+      }
+      break;
+    }
+  }
+};
+
+main()
+  .then(() => process.exit(0))
+  .catch((error: Error) => {
+    console.error(error);
+    process.exit(1);
+  });
+
+// npx ts-node scripts/admin/unTripGlobal.ts  - check trip status for all mainnet chains
+// npx --chains=421614  ts-node scripts/admin/unTripGlobal.ts
+// npx --sendtx --chains=421614  ts-node scripts/admin/unTripGlobal.ts
+// npx --sendtx --chains=421614 --integration=fast ts-node scripts/admin/unTripGlobal.ts
+// npx --sendtx --chains=421614 --testnets --integration=fast ts-node scripts/admin/unTripGlobal.ts