{"_id":"@graphprotocol/network-monitor","_rev":"33-d3d5aa25919d60721b9989dba75c9b95","name":"@graphprotocol/network-monitor","dist-tags":{"latest":"0.5.2"},"versions":{"0.5.0":{"name":"@graphprotocol/network-monitor","version":"0.5.0","author":{"name":"Graph Protocol"},"license":"MIT","_id":"@graphprotocol/network-monitor@0.5.0","maintainers":[{"name":"neysofu","email":"filippo+npm@neysofu.me"},{"name":"ebox86","email":"evan@edgeandnode.com"},{"name":"tmigone","email":"npm@tmigone.com"},{"name":"cawfree","email":"hello@cawfree.com"},{"name":"hasparus","email":"hasparus@gmail.com"},{"name":"iamlexieonearth","email":"iamlexieonearth@gmail.com"},{"name":"dotansimha","email":"dotansimha@gmail.com"},{"name":"nasmr","email":"nasmunawar@gmail.com"},{"name":"tilacog","email":"tilacog@gmail.com"},{"name":"benface","email":"benoit.rouleau@icloud.com"},{"name":"ytal","email":"yaniv@thegraph.com"},{"name":"jannispohlmann","email":"jannis@thegraph.com"},{"name":"nenadjaja","email":"nena@edgeandnode.com"},{"name":"fordn","email":"ford@edgeandnode.com"},{"name":"lutter","email":"lutter@watzmann.net"},{"name":"zerim","email":"brandon.ramirez@live.com"},{"name":"rhlsthrm","email":"rksethuram9@gmail.com"},{"name":"martintel","email":"me@martintel.co"},{"name":"abarmat","email":"abarmat@gmail.com"},{"name":"that3percent","email":"That3Percent@gmail.com"},{"name":"nachobonilla","email":"ignacio@openzeppelin.com"},{"name":"jcarpanelli","email":"juanbanelli@gmail.com"},{"name":"leoyvens","email":"leoyvens@gmail.com"},{"name":"hex0punk","email":"alex.useche@trailofbits.com"},{"name":"xaler","email":"dariolobuglio@gmail.com"},{"name":"alexo382","email":"alexandrumanuelolteanu@gmail.com"},{"name":"juanmardefago","email":"juanma.rdefago@gmail.com"},{"name":"baboialex95","email":"baboialex95@gmail.com"},{"name":"dnfodjo","email":"nfodjodk@gmail.com"},{"name":"promaty","email":"promaty@gmail.com"},{"name":"theodus","email":"theodusbutler@gmail.com"},{"name":"iain_mccown","email":"iain@edgeandnode.com"},{"name":"cmwhited","email":"cmwhited1990@gmail.com"},{"name":"adam-en","email":"adam@edgeandnode.com"},{"name":"schmidsi","email":"simon@schmid.io"},{"name":"pdiogo-tgf","email":"pedro@thegraph.foundation"},{"name":"otaviopace","email":"otaviopp8@gmail.com"}],"homepage":"https://github.com/graphprotocol/network-monitor#readme","bugs":{"url":"https://github.com/graphprotocol/network-monitor/issues"},"bin":{"graph-network-monitor":"bin/graph-network-monitor"},"dist":{"shasum":"cd579b2b6c229635874ef9c7327a45018dc63fd3","tarball":"https://registry.npmjs.org/@graphprotocol/network-monitor/-/network-monitor-0.5.0.tgz","fileCount":54,"integrity":"sha512-4Ni5cLldF36faT0wFtdJiXb9baMR5F+NGeVJesP2LDTk9xO81RyrknQhV+YVJfmjvh/meYZK91XC1ZdT769bHw==","signatures":[{"sig":"MEQCIAtPnPS9uCIBHZsXxLpoIjrVpzxKbDv3bih60ZRQpMKlAiB4Jk6pAlrrvkHVG9OMpy4749H93jwWal20/TN3w8yRPQ==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":114140,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjuBLmACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmpRrw/8CuI78JE0UrSUr9Hrv8/xY3zn9jS+9hWj+/ia9gwNs72GPrip\r\nAFZef2ecBeZbDwNYPsPoEN7gEqORWQSUM3NnMEtZw82qr6aOPv//oqpY6TrM\r\n0CwC97w5PnZ/IDmtKkzmuxlDfXRqaTnZCHxUsJWP09GB5asv8YR1ZLD5j2nJ\r\nwjOMZcD9qWbCmeqKAMNrwFLvJJLPBTKZ4CEaHYfY5rfOjRe7XGnzjWBgnKk2\r\nj08jIz8/D7zyokKTNQ7rMQBTXW3GHykRa3y3kmoiBvowGVa9/zBZfxpiMD/8\r\npbdTJKJ+axxzK32EW6mMB5uARrZRaZcKyMUQsGVUXFQhKjZapeyQCgjUQTP6\r\ngZPaFPKi/sVvQfICfe33JrpibWhBXhwvzL1QGR2LbGbbNcDzqyJZ33bJXgiV\r\nHKDeEz36FyFpYfYKUCZK96FNFPXwT4kj+ftMToGzBF5KeICgelCIX2yc4DHi\r\nDByKPPVxTD3Gy4cen/4CIogKJ1oU0pY/qPaJ8rBmYT47TmRlbVYZAggaCKD2\r\nqP6wFC7J4xYPL796MHlPT7Usi0cv4Rnt37BrLd5Ll4V6lPrQVZsODWLiEEMB\r\nrv/ZysAn5xpwrW+MpcqlfYuz2pt+uXw53Z37v0w7/RPlWGTJl/lGiL5yieBa\r\nMFZ7QruX7d26tE1uxeVQkS8Fkbe3LJDPv8w=\r\n=8oBd\r\n-----END PGP SIGNATURE-----\r\n"},"main":"dist/index.js","types":"dist/index.d.ts","gitHead":"e77aa76f9d1219aa72585ab29e901d49a5546d95","scripts":{"lint":"eslint . --ext .ts,.tsx","clean":"rm -rf node_modules dist .graphclient","start":"yarn prepare && node ./dist/src/index.js start","format":"prettier --write src/*.ts src/**/*.ts src/**/**/*.ts","prepare":"yarn format && yarn lint && yarn graphclient build && tsc"},"_npmUser":{"name":"tmigone","email":"npm@tmigone.com"},"repository":{"url":"git+https://github.com/graphprotocol/network-monitor.git","type":"git"},"_npmVersion":"6.14.17","description":"Graph Network Monitor","directories":{},"_nodeVersion":"14.20.0","dependencies":{"yargs":"^16.2.0","eslint":"^7.17.0","ethers":"5.7.0","js-yaml":"^4.0.0","p-queue":"^6.6.1","prettier":"^2.2.1","typescript":"^4.9.3","@types/yargs":"^15.0.12","@types/js-yaml":"^4.0.0","@types/p-queue":"^3.2.1","eslint-config-prettier":"^7.1.0","eslint-plugin-prettier":"^3.3.1","@graphprotocol/common-ts":"2.0.0","@graphprotocol/contracts":"2.1.0","@graphprotocol/client-cli":"^2.1.0","@typescript-eslint/parser":"^4.13.0","@typescript-eslint/eslint-plugin":"^4.13.0"},"_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/network-monitor_0.5.0_1673007846102_0.34389381452107326","host":"s3://npm-registry-packages"}},"0.5.1":{"name":"@graphprotocol/network-monitor","version":"0.5.1","author":{"name":"Graph Protocol"},"license":"MIT","_id":"@graphprotocol/network-monitor@0.5.1","maintainers":[{"name":"neysofu","email":"filippo+npm@neysofu.me"},{"name":"ebox86","email":"evan@edgeandnode.com"},{"name":"tmigone","email":"npm@tmigone.com"},{"name":"cawfree","email":"hello@cawfree.com"},{"name":"hasparus","email":"hasparus@gmail.com"},{"name":"iamlexieonearth","email":"iamlexieonearth@gmail.com"},{"name":"dotansimha","email":"dotansimha@gmail.com"},{"name":"nasmr","email":"nasmunawar@gmail.com"},{"name":"tilacog","email":"tilacog@gmail.com"},{"name":"benface","email":"benoit.rouleau@icloud.com"},{"name":"ytal","email":"yaniv@thegraph.com"},{"name":"jannispohlmann","email":"jannis@thegraph.com"},{"name":"nenadjaja","email":"nena@edgeandnode.com"},{"name":"fordn","email":"ford@edgeandnode.com"},{"name":"lutter","email":"lutter@watzmann.net"},{"name":"zerim","email":"brandon.ramirez@live.com"},{"name":"rhlsthrm","email":"rksethuram9@gmail.com"},{"name":"martintel","email":"me@martintel.co"},{"name":"abarmat","email":"abarmat@gmail.com"},{"name":"that3percent","email":"That3Percent@gmail.com"},{"name":"nachobonilla","email":"ignacio@openzeppelin.com"},{"name":"jcarpanelli","email":"juanbanelli@gmail.com"},{"name":"leoyvens","email":"leoyvens@gmail.com"},{"name":"hex0punk","email":"alex.useche@trailofbits.com"},{"name":"xaler","email":"dariolobuglio@gmail.com"},{"name":"alexo382","email":"alexandrumanuelolteanu@gmail.com"},{"name":"juanmardefago","email":"juanma.rdefago@gmail.com"},{"name":"baboialex95","email":"baboialex95@gmail.com"},{"name":"dnfodjo","email":"nfodjodk@gmail.com"},{"name":"promaty","email":"promaty@gmail.com"},{"name":"theodus","email":"theodusbutler@gmail.com"},{"name":"iain_mccown","email":"iain@edgeandnode.com"},{"name":"cmwhited","email":"cmwhited1990@gmail.com"},{"name":"adam-en","email":"adam@edgeandnode.com"},{"name":"schmidsi","email":"simon@schmid.io"},{"name":"pdiogo-tgf","email":"pedro@thegraph.foundation"},{"name":"otaviopace","email":"otaviopp8@gmail.com"}],"homepage":"https://github.com/graphprotocol/network-monitor#readme","bugs":{"url":"https://github.com/graphprotocol/network-monitor/issues"},"bin":{"graph-network-monitor":"bin/graph-network-monitor"},"dist":{"shasum":"6250281b28acd4fc6913bd8ddaef3b121c19bc32","tarball":"https://registry.npmjs.org/@graphprotocol/network-monitor/-/network-monitor-0.5.1.tgz","fileCount":54,"integrity":"sha512-4ncOMZEGtmZYutL785Ag6eULmTG8mnZOY2vG7lHguRrd37Gz7ZJ4l4LwAgXLNdW8AHeO2SEuZsBwJA3Kmeh1dA==","signatures":[{"sig":"MEUCIBagU9OqzR+IY+O6D6RGeoWEcA4GdRYaOIYWp0KMI2hFAiEApuU8ArmpupcBhBT+rBipwIQv61Y9Uk9WUqRA9RwMawg=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":114140,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjvxWKACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmoGpg//QwlrQS93PYhlQ3PPD6ewO31s3IX6fSGhPzZcLdQjlueEq89U\r\njxZlQuxuxOWbjeeGktbW8u5c0im6fQCUmBj6GrbR9q4LnAZYLghUW9lvcIaF\r\n/5cv6qt52Poaee5043v3csN5bNPnMKgifYIaoKjyxgDf2X5ITa/CxHVob8O1\r\nCDKOZ8E8nqIDNxmKLEOnCcmIrfuwFis45tcV//j1uNQh33r/wvxGcNuyjxvv\r\nMJN5OZxhOsWinOb9++yA1TZw1QWEXXVJWug8TzL7MFkmNWgnDbTCmbRc7wcm\r\noU2yve0q0dNE+94Y9EOSG3dVTesC5cN8HqsAvJZdcSOfP7ajcwAOOYmn0waH\r\nZvkUWjHmkG8DiTVtkfevKA096r32LUBdvWTOkRTiKy9mNX7Q2X1MKZLGTKZt\r\n9hbPaISBJ2RlPXrficzMmay6rkKzx4QagcHmWNvRBQueVphiNhSWhbUB+ptg\r\nqOxxelgoqYT72V7k2asBT5zS7LHyoE+WCjqMlbQDVK/wceZgq7Ab6BNkO1a5\r\nsSalJG23UCWDJPgsC3paIuumy3uzQnqgFrMKBTiWmYy9NvAl4uT4B2R79kvR\r\n7fYrT6UoGARnfYlMArNI8d33covLl9ErRcZTgdRkIWAp4DN2kxo8xOCuOEbr\r\ngLB0t8jR1Etdz1dC6E+gA+FtoK9KMNgOkEI=\r\n=vUL5\r\n-----END PGP SIGNATURE-----\r\n"},"main":"dist/index.js","types":"dist/index.d.ts","gitHead":"ba4d93a976060d8d48a59dfbcdcb54e92ea7112b","scripts":{"lint":"eslint . --ext .ts,.tsx","clean":"rm -rf node_modules dist .graphclient","start":"yarn prepare && node ./dist/src/index.js start","format":"prettier --write src/*.ts src/**/*.ts src/**/**/*.ts","prepare":"yarn format && yarn lint && yarn graphclient build && tsc"},"_npmUser":{"name":"tmigone","email":"npm@tmigone.com"},"repository":{"url":"git+https://github.com/graphprotocol/network-monitor.git","type":"git"},"_npmVersion":"8.19.3","description":"Graph Network Monitor","directories":{},"_nodeVersion":"18.13.0","dependencies":{"yargs":"^16.2.0","eslint":"^7.17.0","ethers":"5.7.0","js-yaml":"^4.0.0","p-queue":"^6.6.1","prettier":"^2.2.1","typescript":"^4.9.3","@types/yargs":"^15.0.12","@types/js-yaml":"^4.0.0","@types/p-queue":"^3.2.1","eslint-config-prettier":"^7.1.0","eslint-plugin-prettier":"^3.3.1","@graphprotocol/common-ts":"2.0.0","@graphprotocol/contracts":"2.1.0","@graphprotocol/client-cli":"^2.1.0","@typescript-eslint/parser":"^4.13.0","@typescript-eslint/eslint-plugin":"^4.13.0"},"_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/network-monitor_0.5.1_1673467274354_0.5785527822982159","host":"s3://npm-registry-packages"}},"0.5.2":{"name":"@graphprotocol/network-monitor","version":"0.5.2","author":{"name":"Graph Protocol"},"license":"MIT","_id":"@graphprotocol/network-monitor@0.5.2","maintainers":[{"name":"neysofu","email":"filippo+npm@neysofu.me"},{"name":"ebox86","email":"evan@edgeandnode.com"},{"name":"tmigone","email":"npm@tmigone.com"},{"name":"cawfree","email":"hello@cawfree.com"},{"name":"hasparus","email":"hasparus@gmail.com"},{"name":"iamlexieonearth","email":"iamlexieonearth@gmail.com"},{"name":"dotansimha","email":"dotansimha@gmail.com"},{"name":"nasmr","email":"nasmunawar@gmail.com"},{"name":"tilacog","email":"tilacog@gmail.com"},{"name":"benface","email":"benoit.rouleau@icloud.com"},{"name":"ytal","email":"yaniv@thegraph.com"},{"name":"jannispohlmann","email":"jannis@thegraph.com"},{"name":"nenadjaja","email":"nena@edgeandnode.com"},{"name":"fordn","email":"ford@edgeandnode.com"},{"name":"lutter","email":"lutter@watzmann.net"},{"name":"zerim","email":"brandon.ramirez@live.com"},{"name":"rhlsthrm","email":"rksethuram9@gmail.com"},{"name":"martintel","email":"me@martintel.co"},{"name":"abarmat","email":"abarmat@gmail.com"},{"name":"that3percent","email":"That3Percent@gmail.com"},{"name":"nachobonilla","email":"ignacio@openzeppelin.com"},{"name":"jcarpanelli","email":"juanbanelli@gmail.com"},{"name":"leoyvens","email":"leoyvens@gmail.com"},{"name":"hex0punk","email":"alex.useche@trailofbits.com"},{"name":"xaler","email":"dariolobuglio@gmail.com"},{"name":"alexo382","email":"alexandrumanuelolteanu@gmail.com"},{"name":"juanmardefago","email":"juanma.rdefago@gmail.com"},{"name":"baboialex95","email":"baboialex95@gmail.com"},{"name":"dnfodjo","email":"nfodjodk@gmail.com"},{"name":"promaty","email":"promaty@gmail.com"},{"name":"theodus","email":"theodusbutler@gmail.com"},{"name":"iain_mccown","email":"iain@edgeandnode.com"},{"name":"cmwhited","email":"cmwhited1990@gmail.com"},{"name":"adam-en","email":"adam@edgeandnode.com"},{"name":"schmidsi","email":"simon@schmid.io"},{"name":"pdiogo-tgf","email":"pedro@thegraph.foundation"},{"name":"otaviopace","email":"otaviopp8@gmail.com"}],"homepage":"https://github.com/graphprotocol/network-monitor#readme","bugs":{"url":"https://github.com/graphprotocol/network-monitor/issues"},"bin":{"graph-network-monitor":"bin/graph-network-monitor"},"dist":{"shasum":"e03fb59040b6a0be7bbea70c73aea50e62299297","tarball":"https://registry.npmjs.org/@graphprotocol/network-monitor/-/network-monitor-0.5.2.tgz","fileCount":54,"integrity":"sha512-3+38x7dwkwKE2sSheUPaik19ozyA1F9cqvYu5vqZN8j1PSh9ciAJZv8ymAeYHKZelgYvgr1Vff0Zw+bR4INNAQ==","signatures":[{"sig":"MEUCIHRP/VOTS2CQJMIAgFCfbB5qPiWwgAigAy+JrbbOGDqJAiEAsvxENAaX1jGQnjBGRe19JaDomwa/lY8WQsZ2DVzsgmw=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":114938,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjvy1nACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmqUDw/+Pp1EqKrnOhBrMD7XZqWC1pm6dYIX5mCopBtpSbc8hJwi+geW\r\nl011sG5R+IMwhK4e4nK+cgIUpVhN63ESmKMaTnK9pjImBE9KWkvX78ICm1dL\r\nnJc2JYsIh1mZluDh4RziWeVl2HYUMn9YS7DxPt9M2/HphNjN3n1U78SKxEzz\r\nZgcUp1ru36HmzaYrLXwTCw0X2FDED6zcCapKgP6FGVfcvXlhV+hxcQtFREfF\r\nfJctqKHUk3bu8SfGE0Xdy2SduDt3ljo5X1/8LDY8Wh5uxikfV3yEtkpRLxHk\r\n4wFAjZha2d2UGbxrvOhbhdesVuJc/fKCEXCcg4U/C32da1Uy3X1kJQ7zoQUL\r\nClBmpAsL+6AJUm92iGdHGCrCdRB9xAPgM9SWP+gMpX/bSValpimNYXzYS7U2\r\nesDbnpTAbXlT9o2dfio8m91l9kI3frwbwq9wJLRBkm/V36gbTv+CuvClxxi6\r\nJd0Rw3OS9HHEFfA40pyoamSiGmxnj+6xVOvyDqkOvvSck3qCp45IEhIULqqq\r\nydNHmv8O5LCLSs26hya8Y6JOpcHcRw0+qworQ+/SQiB0pj7ITb4pKe2Um6w1\r\n5vlMmVJijnEHaBLjv8Mk6QP3gFtnUlg5ASdeTkiED7nKnxLkbf66hTW9cmeW\r\nFoV4gREo2yozLuHKcWr96ry8IBRNX+4GZwY=\r\n=GwVH\r\n-----END PGP SIGNATURE-----\r\n"},"main":"dist/index.js","types":"dist/index.d.ts","gitHead":"62543fa5564ba5953ec9b1bf850dddda4753caf0","scripts":{"lint":"eslint . --ext .ts,.tsx","clean":"rm -rf node_modules dist .graphclient","start":"yarn prepare && node ./dist/src/index.js start","format":"prettier --write src/*.ts src/**/*.ts src/**/**/*.ts","prepare":"yarn format && yarn lint && yarn graphclient build && tsc"},"_npmUser":{"name":"tmigone","email":"npm@tmigone.com"},"repository":{"url":"git+https://github.com/graphprotocol/network-monitor.git","type":"git"},"_npmVersion":"8.19.3","description":"Graph Network Monitor","directories":{},"_nodeVersion":"18.13.0","dependencies":{"yargs":"^16.2.0","eslint":"^7.17.0","ethers":"5.7.0","js-yaml":"^4.0.0","p-queue":"^6.6.1","prettier":"^2.2.1","typescript":"^4.9.3","@types/yargs":"^15.0.12","@types/js-yaml":"^4.0.0","@types/p-queue":"^3.2.1","eslint-config-prettier":"^7.1.0","eslint-plugin-prettier":"^3.3.1","@graphprotocol/common-ts":"2.0.0","@graphprotocol/contracts":"2.1.0","@graphprotocol/client-cli":"^2.1.0","@typescript-eslint/parser":"^4.13.0","@typescript-eslint/eslint-plugin":"^4.13.0"},"_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/network-monitor_0.5.2_1673473382971_0.05607802090066327","host":"s3://npm-registry-packages"}}},"time":{"created":"2023-01-06T12:24:06.017Z","modified":"2026-09-09T22:31:00.184Z","0.5.0":"2023-01-06T12:24:06.331Z","0.5.1":"2023-01-11T20:01:14.513Z","0.5.2":"2023-01-11T21:43:03.147Z"},"bugs":{"url":"https://github.com/graphprotocol/network-monitor/issues"},"author":{"name":"Graph Protocol"},"license":"MIT","homepage":"https://github.com/graphprotocol/network-monitor#readme","repository":{"url":"git+https://github.com/graphprotocol/network-monitor.git","type":"git"},"description":"Graph Network Monitor","maintainers":[{"email":"ford@edgeandnode.com","name":"fordn"},{"email":"npm@tmigone.com","name":"tmigone"},{"email":"juanma.rdefago@gmail.com","name":"juanmardefago"},{"email":"miguel.deelias@gmail.com","name":"migueldeelias"},{"email":"pdiogo@duck.com","name":"pdiogo-tgf"}],"readme":"# Graph Network Monitor\n\nThe network monitor runs at a regular interval and checks that a number of conditions pass. If any of these tests fails it will issue an alert through Pager Duty.\n\nAlerts are deduplicated by test name and epoch when it was raised to avoid multiple notifications.\n\n## Configuration\n\nThe monitor uses the network subgragh, deployed contracts and protocol config files as source of information.\n\nTo correctly configure the monitor you'll need to:\n\n- Create a config file to describe the tests you want to run. Use `--config` to pass the path to the file (default: `config.yaml`).\n- Create a providers file to describe the providers you want to use. Use `--providers` to pass the path to the file (default: `providers.yaml`).\n- Specify the network subgraph using `--network-subgraph` (default: `graphprotocol/graph-network-mainnet`).\n\n## Running from NPM packages\n\nInstall the network monitor as NPM package, using:\n\n```sh\nnpm install -g @graphprotocol/network-monitor\n```\n\nAfter that, it can be run with the following command:\n\n```sh\n# Network monitor\ngraph-network-monitor start ...\n```\n\n## Running locally\n\nClone the repository and run `yarn install` followed by `yarn prepare`.\n\nAfter that, it can be run with the following command:\n\n```sh\n# Mainnet\nts-node src/index.ts start\n\n# Other network\nts-node src/index.ts start \\\n  --network-subgraph <NETWORK_SUBGRAPH_NAME_> \\\n  --config <CONFIG_FILE> \\\n  --providers <PROVIDERS_FILE>\n```\n\n## Running with Docker\n\nBuild the docker image and run it using:\n\n```sh\n\n# Build the image\ndocker build -t graph-network-monitor .\n\n# Run on mainnet\ndocker run \\\n  --env NETWORK_MONITOR_ETHEREUM=<ETHEREUM_RPC> \\\n  --env NETWORK_MONITOR_ARBITRUM=<ARBITRUM_RPC> \\\n  graph-network-monitor\n\n# Run on other network\ndocker run \\\n  --env NETWORK_MONITOR_ETHEREUM=<ETHEREUM_RPC> \\\n  --env NETWORK_MONITOR_ARBITRUM=<ARBITRUM_RPC> \\\n  --env NETWORK_MONITOR_NETWORK_SUBGRAPH=<NETWORK_SUBGRAPH_NAME> \\\n  --env NETWORK_MONITOR_CONFIG=<CONFIG_FILE> \\\n  graph-network-monitor\n```\n\n## Usage\n\n### Network Monitor\n\n```sh\n$ graph-network-monitor start --help\n\nRun monitoring tests\n\nLogging\n  --metrics-port  Port to serve Prometheus metrics at   [number] [default: 7300]\n  --log-level     Log level                          [string] [default: \"debug\"]\n\nNetwork Subgraph\n  --network-subgraph  Subgraph name to query the network subgraph from\n            [string] [required] [default: \"graphprotocol/graph-network-mainnet\"]\n\nMonitor\n  --interval   Number of seconds interval for monitoring [number] [default: 300]\n  --config     Config file        [string] [required] [default: \"./config.yaml\"]\n  --providers  Providers config file\n                               [string] [required] [default: \"./providers.yaml\"]\n  --dry-run    Don't send alerts if tests fail        [boolean] [default: false]\n\nOptions:\n  --version  Show version number                                       [boolean]\n  --help     Show help                                                 [boolean]\n```\n\n## Adding tests\n\nThe monitor will execute each configured test sequentially, and raise alerts whenever these tests return a non-ok status.\n\nEach test is a simple function with a defined interface.\n\n### Interface\n\nTo add a new test, create a function under the `/tests` folder that receives the following parameters:\n\n```\n  logger: Logger,\n  contracts: NetworkContracts,\n  testFunctionConfig: TestFunctionConfig,\n```\n\n- You can use `logger` as a structured logging facility.\n- The `contracts` objects has all the contract interfaces connected to the Ethereum provider using ethers.js\n- `testFunctionConfig` provides an interface with access to:\n  - `networkSubgraph`: the name of the network subgraph to query\n  - `providers` contains credentials to connect to JSON RPC nodes in different networks\n\nThis function must return a TestResult with the following interface:\n\n```\nexport interface TestResult {\n  ok: boolean\n  summary?: string\n  details?: Record<string, string>\n}\n```\n\n- Whenever `ok` is set to _false_, the monitor will raise an alert for that test.\n- `summary` should contain a descriptive message about the error. If left empty, the monitor will create a summary based on the function name.\n- Use `details` to store any additional information about how the test failed for debugging purposes.\n\n### Enable\n\nFinally, import the function and add it to the `monitor.addTests()` function located in the `/command/monitor.ts` file.\n\n# Copyright\n\nCopyright © 2021 The Graph Foundation\n\nLicensed under the MIT license.\n","readmeFilename":"README.md"}