chore: transaction info

.env.example

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

.gitignore

@@ -0,0 +1,40 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# dependencies
+/node_modules
+**/*/node_modules
+/.pnp
+.pnp.*
+
+# testing
+/coverage
+
+# production
+/build
+/dist-cjs
+
+# misc
+.DS_Store
+.env
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+.env
+.vscode
+.history
+
+# IDE
+.idea/
+
+.yarn/*
+!.yarn/patches
+!.yarn/plugins
+!.yarn/releases
+!.yarn/sdks
+!.yarn/versions

.yarnrc.yml

@@ -0,0 +1,9 @@
+compressionLevel: 0
+
+enableGlobalCache: true
+
+nmMode: hardlinks-local
+
+nodeLinker: node-modules
+
+yarnPath: .yarn/releases/yarn-3.6.1.cjs

README.md

@@ -1 +1,17 @@
-# maintenance-utils
+# maintenance-utils
+NodeCLI for various purposes
+
+## Commands
+
+```pause``` - Pause all transfers across all bridges on selected enviroment (devnet, testnet or mainnet)
+
+```debug``` - Provide information about transactions for a specific Sygma message
+
+Run with:
+
+```
+node pause -pk "private-key" -m "mnemonic words" -e "environment"
+```
+```
+node debug -e "environment" -txn "transaction hash" -cid "chain id" 
+```

eslintrc.cjs

@@ -0,0 +1,6 @@
+require("@rushstack/eslint-patch/modern-module-resolution");
+
+module.exports = {
+  root: true,
+  extends: "@chainsafe",
+}

package.json

@@ -0,0 +1,41 @@
+{
+  "name": "@buildwithsygma/sygma-sdk",
+  "description": "Sygma Maintenance",
+  "main": "index.js",
+  "private": true,
+  "type": "commonjs",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/sygmaprotocol/maintenance-utils"
+  },
+  "packageManager": "[email protected]",
+  "engines": {
+    "node": ">=16.0.0"
+  },
+  "scripts": {
+    "build:cjs": "tsc -p tsconfig.cjs.json && echo '{\"type\": \"commonjs\"}' > ./dist-cjs/package.json",
+    "build:types": "tsc -p tsconfig.types.json",
+    "build:all": "yarn run clean && yarn build:cjs && yarn build:types",
+    "lint": "eslint 'src/**/*.ts'",
+    "lint:fix": "yarn run lint --fix",
+    "clean": "rm -rf ./dist ./dist-cjs ./dist-esm ./types"
+  },
+  "keywords": [],
+  "author": "Sygma Protocol Product Team",
+  "license": "LGPL-3.0-or-later",
+  "dependencies": {
+    "axios": "^1.4.0",
+    "commander": "^11.0.0"
+  },
+  "devDependencies": {
+    "@buildwithsygma/sygma-contracts": "^2.3.0",
+    "@buildwithsygma/sygma-sdk-core": "^2.1.0",
+    "dotenv": "^16.3.1",
+    "ethers": "5",
+    "ts-node": "^10.9.1",
+    "typescript": "^5.1.6"
+  },
+  "resolutions": {
+    "typescript": "^5.0.4"
+  }
+}

prettierrc.json

@@ -0,0 +1,7 @@
+{
+  "printWidth": 100,
+  "singleQuote": true,
+  "trailingComma": "all",
+  "useTabs": false,
+  "arrowParens": "avoid"
+}

src/bridgeDebugging.ts

@@ -0,0 +1,47 @@
+import 'dotenv/config';
+import axios from 'axios';
+import { Command } from 'commander';
+import { SharedConfig } from "./constants";
+import { RawConfig, Domain } from '@buildwithsygma/sygma-sdk-core';
+import { getTransactionInfo } from './utils';
+
+const program = new Command();
+
+program
+    .name("debug")
+    .description("Enables quick debugging of specific Sygma messages (bridging request)")
+    .requiredOption(
+        "-e, --environment <environment>", "Environment on which to debug"
+    )
+    .requiredOption(
+        "-txn, --transaction-hash <transactionHash>", "Transaction on which to provide information"
+    )
+    .requiredOption(
+        "-cid, --chain-id <chainId>", "Chain on which the transaction happened"
+    )
+    .action(async(configs: any) => {
+        try {
+            const network: keyof typeof SharedConfig = configs.environment; 
+            const {
+                data
+            } = await axios.get(SharedConfig[network]) as unknown as { data: RawConfig };
+
+            const networks = data.domains.filter((domain: Domain) => 
+                domain.name === "ethereum" 
+                && domain.chainId == configs.chainId)
+            if (!networks){
+                throw new Error("Chain doesn't exist")
+            }
+
+            await getTransactionInfo(networks[0], configs.transactionHash)
+
+        } catch (err) {
+            if (err instanceof Error) {
+                throw new Error(`Failed to execute because of: ${err.message}`);
+              } else {
+                throw new Error('Something went wrong');
+              }
+        }
+    })
+
+program.parse(process.argv)

src/bridgePausing.ts

@@ -0,0 +1,63 @@
+import 'dotenv/config';
+import axios from 'axios';
+import { Command, Option } from 'commander';
+import { Wallet } from 'ethers';
+import { SharedConfig } from "./constants";
+import { getWalletsForDifferentProviders, deriveWalletsFromMnemonic, sendPauseTransactions } from "./utils";
+import { RawConfig, Domain } from '@buildwithsygma/sygma-sdk-core';
+
+const program = new Command();
+
+program
+  .name("pause-bridge")
+  .description("Pauses all bridge instances across all networks")
+  .version("0.0.1")
+
+program
+  .command("pause")
+  .addOption(
+    new Option('-e, --environment <environment>', 'Environment on which to pause bridge instances')
+      .choices(['devnet', 'testnet', 'mainnet'])
+  )
+  .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 {
+      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<Wallet | any> = [];
+
+      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}`);
+      } else {
+        throw new Error('Something went wrong while fetching config file');
+      }
+    }
+  })
+
+program.parse(process.argv);

src/constants/events.ts

@@ -0,0 +1,2 @@
+export const possibleEvents: string[] = 
+    ["deposit", "proposalexecution", "failedhandlerexecution"]

src/constants/index.ts

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

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/index.ts

@@ -0,0 +1,2 @@
+export * from "bridgePausing"
+export * from "bridgeDebugging"