Merge pull request #1 from matejdrazic/mdrazic/pause-effect

early draft of pause functionality

.env.example

@@ -0,0 +1 @@
+GOERLI_RPC_URL=

README.md

@@ -1 +1,12 @@
-# maintenance-utils
+# maintenance-utils
+NodeCLI for various purposes
+
+## Commands
+
+```pause``` - Pause all transfers across all bridges on selected enviroment (devnet, testnet or mainnet)
+
+Run with:
+
+```
+node pause -pk "private-key" -m "mnemonic words" -e "environment"
+```

src/bridgePausing.ts

@@ -1,24 +1,56 @@
+import 'dotenv/config';
 import axios from 'axios';
-import {Command, Option} from 'commander';
-import {ConfigUrl} from "./constants";
-import {RawConfig} from "@buildwithsygma/sygma-sdk-core";
+import { ethers } from 'ethers';
+import { Command, Option } from 'commander';
+import { SharedConfig } from "./constants";
+import { getWalletsForDifferentProviders, deriveWalletsFromMnemonic, sendPauseTransactions } from "./utils";
+import { RawConfig, Domain } from '@buildwithsygma/sygma-sdk-core';
 
 const program = new Command();
-console.log("pero");
 
 program
   .name("pause-bridge")
   .description("Pauses all bridge instances across all networks")
-  .argument("<string>", "mnemonic or private key of the wallet")
+  .version("0.0.1")
+
+program
+  .command("pause")
   .addOption(
-    new Option('--environment, -e', 'Environment on which to pause bridge instances')
+    new Option('-e, --environment <environment>', 'Environment on which to pause bridge instances')
       .choices(['devnet', 'testnet', 'mainnet'])
   )
-  .action(async (mnemonic: string, environment: keyof typeof ConfigUrl) => {
+  .addOption(
+    new Option('-pk, --private-key <privateKey>', 'Private key to use for signing transactions')
+  )
+  .addOption(
+    new Option('-m, --mnemonic <mnemonic>', 'Mnemonic to use for signing transactions').conflicts('private-key')
+  )
+  .action(async (configs: any) => {
     try {
-      console.log("pero");
-      const response = await axios.get(ConfigUrl[environment]) as unknown as RawConfig;
-      console.log(response)
+      const network: keyof typeof SharedConfig = configs.environment;
+      const {
+        privateKey,
+        mnemonic
+      } = configs;
+
+      const {
+        data
+      } = await axios.get(SharedConfig[network]) as unknown as { data: RawConfig };
+
+      const networks: Array<Domain> = data.domains.filter((network: Domain) => network.name === "ethereum"); // just evms for now
+
+      let wallets: Array<ethers.Wallet | ethers.HDNodeWallet> = [];
+
+      if (mnemonic) {
+        wallets = await deriveWalletsFromMnemonic(mnemonic, networks);
+      } else if (privateKey) {
+        wallets = await getWalletsForDifferentProviders(privateKey, networks);
+      } else {
+        throw new Error('Either mnemonic or private key must be provided');
+      }
+
+      await sendPauseTransactions(networks, wallets);
+
     } catch (err) {
       if (err instanceof Error) {
         throw new Error(`Failed to fetch shared config because of: ${err.message}`);
@@ -27,3 +59,5 @@ program
       }
     }
   })
+
+program.parse(process.argv);

src/constants/index.ts

@@ -0,0 +1,2 @@
+export { chainIdToRpc } from "./rpc";
+export { SharedConfig } from "./sharedConfig";

src/constants/rpc.ts

@@ -0,0 +1,5 @@
+// chain id -> provider url
+export const chainIdToRpc = {
+    5: process.env.GOERLI_RPC_URL,
+}
+

src/constants/sharedConfig.ts

@@ -0,0 +1,5 @@
+export const SharedConfig = {
+    devnet: "https://chainbridge-assets-stage.s3.us-east-2.amazonaws.com/shared-config-dev.json",
+    testnet: "https://chainbridge-assets-stage.s3.us-east-2.amazonaws.com/shared-config-test.json",
+    mainnet: "https://sygma-assets-mainnet.s3.us-east-2.amazonaws.com/shared-config-mainnet.json"
+};

src/utils.ts

@@ -0,0 +1,47 @@
+import { ethers } from 'ethers';
+import { chainIdToRpc } from "./constants";
+import { Bridge__factory } from "@buildwithsygma/sygma-contracts";
+import { Domain } from "@buildwithsygma/sygma-sdk-core";
+
+export async function getWalletsForDifferentProviders(privateKey: string, networks: Array<Domain>) {
+  const wallets = [];
+  for (let i = 0; i < networks.length; i++) {
+    const network = networks[i];
+    const chainId = network.chainId;
+    const rpc = chainIdToRpc[chainId as keyof typeof chainIdToRpc];
+    if (rpc) {
+      const provider = new ethers.JsonRpcProvider(rpc);
+      const wallet = new ethers.Wallet(privateKey, provider); // add error handling for invalid private key
+      wallets.push(wallet);
+    }
+  }
+  return wallets;
+}
+
+export async function deriveWalletsFromMnemonic(mnemonic: string, networks: Array<Domain>) {
+  const wallets = [];
+  for (let i = 0; i < networks.length; i++) {
+    const network = networks[i];
+    const chainId = network.chainId;
+    const rpc = chainIdToRpc[chainId as keyof typeof chainIdToRpc];
+    if (rpc) {
+      const provider = new ethers.JsonRpcProvider(rpc);
+      const wallet = ethers.Wallet.fromPhrase(mnemonic, provider);
+      wallets.push(wallet);
+    }
+  }
+  return wallets;
+}
+
+export async function sendPauseTransactions(networks: Array<any>, wallets: Array<ethers.Wallet | ethers.HDNodeWallet>) {
+  const receipts = [];
+  for (let i = 0; i < networks.length; i++) {
+    const network = networks[i];
+    const wallet = wallets[i];
+    const bridge = Bridge__factory.connect(network.bridge, wallet);
+    const tx = await bridge.adminPauseTransfers();
+    console.log(`Transaction no. ${i + 1} completed, bridge on ${network.name} paused`);
+    receipts.push(tx);
+  }
+  return receipts;
+}

tsconfig.cjs.json

@@ -8,6 +8,6 @@
     "declaration": true,
     "esModuleInterop": true,
     "module": "commonjs",
-    "outDir": "./dis-cjs"
+    "outDir": "./dist-cjs"
   }
 }

types/bridgePausing.d.ts

@@ -1,2 +1,2 @@
-export {};
+import 'dotenv/config';
 //# sourceMappingURL=bridgePausing.d.ts.map

types/constants/index.d.ts

@@ -0,0 +1,3 @@
+export { chainIdToRpc } from "./rpc";
+export { SharedConfig } from "./sharedConfig";
+//# sourceMappingURL=index.d.ts.map

types/constants/rpc.d.ts

@@ -0,0 +1,4 @@
+export declare const chainIdToRpc: {
+    5: string | undefined;
+};
+//# sourceMappingURL=rpc.d.ts.map

types/constants/sharedConfig.d.ts

@@ -0,0 +1,6 @@
+export declare const SharedConfig: {
+    devnet: string;
+    testnet: string;
+    mainnet: string;
+};
+//# sourceMappingURL=sharedConfig.d.ts.map

types/utils.d.ts

@@ -0,0 +1,6 @@
+import { ethers } from 'ethers';
+import { Domain } from "@buildwithsygma/sygma-sdk-core";
+export declare function getWalletsForDifferentProviders(privateKey: string, networks: Array<Domain>): Promise<ethers.Wallet[]>;
+export declare function deriveWalletsFromMnemonic(mnemonic: string, networks: Array<Domain>): Promise<ethers.HDNodeWallet[]>;
+export declare function sendPauseTransactions(networks: Array<any>, wallets: Array<ethers.Wallet | ethers.HDNodeWallet>): Promise<ethers.ContractTransaction[]>;
+//# sourceMappingURL=utils.d.ts.map

yarn.lock

@@ -165,6 +165,7 @@ __metadata:
     "@buildwithsygma/sygma-sdk-core": ^2.1.0
     axios: ^1.4.0
     commander: ^11.0.0
+    dotenv: ^16.3.1
     ethers: ^6.6.2
     typescript: ^5.1.6
   languageName: unknown
@@ -3005,6 +3006,13 @@ __metadata:
   languageName: node
   linkType: hard
 
+"dotenv@npm:^16.3.1":
+  version: 16.3.1
+  resolution: "dotenv@npm:16.3.1"
+  checksum: b95ff1bbe624ead85a3cd70dbd827e8e06d5f05f716f2d0cbc476532d54c7c9469c3bc4dd93ea519f6ad711cb522c00ac9a62b6eb340d5affae8008facc3fbd7
+  languageName: node
+  linkType: hard
+
 "eastasianwidth@npm:^0.2.0":
   version: 0.2.0
   resolution: "eastasianwidth@npm:0.2.0"