feat: reporter scripts

.gitignore

@@ -14,7 +14,6 @@
 **/.coverage_contracts
 **/dist
 **/node_modules
-**/types
 **/.yarn
 
 # files

packages/evm/.gitignore

@@ -0,0 +1 @@
+types/

packages/reporter/.dockerignore

@@ -0,0 +1,7 @@
+node_modules
+npm - debug.log
+Dockerfile
+    .git
+    .gitignore
+    .yarn
+logs

packages/reporter/.env.example

@@ -0,0 +1,39 @@
+PRIVATE_KEY=
+
+REPORTERS_ENABLED2=AMBReporterController,TelepathyReporterController,SygmaReporterController
+REPORTERS_ENABLED=AMBReporterController,SygmaReporterController,TelepathyReporterController
+
+GNOSIS_RPC_URL=https://rpc.ankr.com/gnosis	
+MAINNET_RPC_URL=
+GOERLI_RPC_URL=
+POLYGON_RPC_URL=
+OPTIMISM_RPC_URL=https://optimism.llamarpc.com
+ARBITRUM_RPC_URL=https://arbitrum.llamarpc.com
+
+AMB_REPORTER_HEADERS_GAS=300000
+SYGMA_REPORT_HEADERS_TO_DOMAIN_MSG_VALUE=0.0001
+
+TELEPATHY_PROOF_API_URL=
+TELEPATHY_BLOCK_BUFFER=10
+TELEPATHY_INTERVAL_FETCH_HEAD_UPDATES=30000
+
+TIME_FETCH_BLOCKS_MS=3600000
+BLOCK_BUFFER=10
+QUERY_BLOCK_LENGTH=200
+
+SOURCE_CHAIN_ID=5
+DESTINATION_CHAIN_IDS=100
+
+AMB_ADAPTER=0x4efB95c26bB2ebD3281749A5eAA388bc302b4445
+SYMGA_ADAPTER=0x9AD7a6f4FDA8247cC0bF5932B68c5b619937dB15
+GNOSIS_TELEPATHY_ADAPTER=0xDeF29f44f8315d0079A25EF03cfB0b0D8CdA3cF8
+MAINNET_AMB_REPORTER=0x6be796cb66CdB3566b8AbebA2C516CbDF93fE831
+MAINNET_HEADER_REPORTER=0x11378C54aA4e2Daf4603f9be86ae0Cb70786682a
+POLYGON_TELEPATHY_ADAPTER=0x04413A4795dD1f5347eAD1CD7C76Bd9E5e48b461
+POLYGON_AXELAR_ADAPTER=0x4694E10017Ed7E0E87bfE386e5f051a7C64286A2
+BSC_TELEPATHY_ADAPTER=0x2E5685F20f42cC3b01e4A9ADE49F6848E242f022
+BSC_AXELAR_ADAPTER=0x856dcc80f75a9737D9D498266E1Af013668316Fb
+OPTIMISM_TELEPATHY_ADAPTER=0x856dcc80f75a9737D9D498266E1Af013668316Fb
+OPTIMISM_AXELAR_ADAPTER=0x6E9ce437c46e7fA4F0888c21AAC0d9099Ad133ea
+ARBITRUM_TELEPATHY_ADAPTER=0x2E5685F20f42cC3b01e4A9ADE49F6848E242f022
+ARBITRUM_AXELAR_ADAPTER=0x6E9ce437c46e7fA4F0888c21AAC0d9099Ad133ea

packages/reporter/.eslintignore

@@ -0,0 +1,2 @@
+**/dist
+**/node_modules

packages/reporter/.eslintrc.yml

@@ -0,0 +1,21 @@
+extends:
+  - "eslint:recommended"
+  - "plugin:@typescript-eslint/eslint-recommended"
+  - "plugin:@typescript-eslint/recommended"
+  - "prettier"
+parser: "@typescript-eslint/parser"
+parserOptions:
+  project: "tsconfig.json"
+plugins:
+  - "@typescript-eslint"
+root: true
+rules:
+  "@typescript-eslint/no-floating-promises":
+    - error
+    - ignoreIIFE: true
+      ignoreVoid: true
+  "@typescript-eslint/no-inferrable-types": "off"
+  "@typescript-eslint/no-unused-vars":
+    - error
+    - argsIgnorePattern: "_"
+      varsIgnorePattern: "_"

packages/reporter/.gitignore

@@ -0,0 +1 @@
+logs/

packages/reporter/.nvmrc

@@ -0,0 +1 @@
+v18

packages/reporter/.prettierignore

@@ -0,0 +1,2 @@
+**/dist
+**/node_modules

packages/reporter/.prettierrc.yml

@@ -0,0 +1,7 @@
+bracketSpacing: true
+printWidth: 120
+proseWrap: "always"
+singleQuote: false
+tabWidth: 2
+trailingComma: "all"
+semi: false

packages/reporter/Dockerfile

@@ -0,0 +1,13 @@
+FROM node:alpine
+
+WORKDIR /usr/src/app
+
+COPY package.json yarn.lock .env ./
+
+RUN yarn install
+
+ADD . /usr/src/app
+
+RUN yarn compile
+
+CMD ["node", "dist/index.js"]

packages/reporter/README.md

@@ -0,0 +1,65 @@
+# reporter
+
+Script to call Header Reporter contracts of different oracle from source chain to destination chain.
+
+ 
+
+---
+
+ 
+
+## Getting Started
+
+These instructions will cover the usage information and how to run the code using Docker.
+
+### Create the .env file
+
+Configure the mode you want to run by editing the variable in `.env` by checking `.env.example`
+
+### Building the Docker Image
+
+To build the Docker image, run the following command from the root of the project:
+
+```sh
+docker build -t reporter .
+```
+
+### Running the reporter
+
+After building the image, you can run it using the following command:
+
+```sh
+docker run -d -p reporter
+```
+
+### Viewing Logs
+
+To view the logs from the running container, use:
+
+```sh
+docker logs -f [CONTAINER_ID or CONTAINER_NAME]
+```
+
+You can find the `CONTAINER_ID` or `CONTAINER_NAME` using `docker ps`.
+
+### Stopping the reporter
+
+To stop the running container:
+
+```sh
+docker stop [CONTAINER_ID or CONTAINER_NAME]
+```
+
+ 
+
+---
+
+ 
+
+## How to add a new controller
+
+1. Add a new file under `/controllers`, create the constructor and `onBlocks` function to call block header reporter
+   contract periodically.
+2. Configure the settings under `settings/index.ts`.
+3. Add the new controller instant in `index.ts`.
+4. Add the env variable in `.env.example`.

packages/reporter/nodemon.json

@@ -0,0 +1,6 @@
+{
+  "watch": ["src"],
+  "ext": "ts,json",
+  "ignore": ["src/**/*.spec.ts"],
+  "exec": "ts-node ./src/index.ts"
+}

packages/reporter/package.json

@@ -0,0 +1,34 @@
+{
+  "name": "reporter",
+  "author": {
+    "name": "gnosis",
+    "url": "https://github.com/gnosis"
+  },
+  "scripts": {
+    "compile": "tsc",
+    "lint": "eslint --ignore-path ./.eslintignore --ext .js,.ts .",
+    "prettier:check": "prettier --check \"**/*.{js,json,md,sol,ts,yml}\"",
+    "prettier:write": "prettier --write \"**/*.{js,json,md,sol,ts,yml}\"",
+    "start:dev": "nodemon"
+  },
+  "packageManager": "[email protected]",
+  "dependencies": {
+    "async-mutex": "^0.4.0",
+    "axios": "^1.5.1",
+    "dotenv": "^16.3.1",
+    "viem": "^1.16.5",
+    "winston": "^3.11.0"
+  },
+  "devDependencies": {
+    "@types/node": "^20.8.9",
+    "@types/node-cron": "^3.0.9",
+    "@typescript-eslint/eslint-plugin": "^6.7.5",
+    "@typescript-eslint/parser": "^6.7.5",
+    "eslint": "^8.51.0",
+    "eslint-config-prettier": "^9.0.0",
+    "nodemon": "^3.0.1",
+    "prettier": "^3.0.3",
+    "ts-node": "^10.9.1",
+    "typescript": "^5.2.2"
+  }
+}

packages/reporter/src/ABIs/AMBReporterContractABI.json

@@ -0,0 +1,98 @@
+[
+  {
+    "inputs": [
+      {
+        "internalType": "contract IAMB",
+        "name": "_amb",
+        "type": "address"
+      },
+      {
+        "internalType": "contract HeaderStorage",
+        "name": "_headerStorage",
+        "type": "address"
+      }
+    ],
+    "stateMutability": "nonpayable",
+    "type": "constructor"
+  },
+  {
+    "anonymous": false,
+    "inputs": [
+      {
+        "indexed": true,
+        "internalType": "address",
+        "name": "emitter",
+        "type": "address"
+      },
+      {
+        "indexed": true,
+        "internalType": "uint256",
+        "name": "blockNumber",
+        "type": "uint256"
+      },
+      {
+        "indexed": true,
+        "internalType": "bytes32",
+        "name": "blockHeader",
+        "type": "bytes32"
+      }
+    ],
+    "name": "HeaderReported",
+    "type": "event"
+  },
+  {
+    "inputs": [],
+    "name": "amb",
+    "outputs": [
+      {
+        "internalType": "contract IAMB",
+        "name": "",
+        "type": "address"
+      }
+    ],
+    "stateMutability": "view",
+    "type": "function"
+  },
+  {
+    "inputs": [],
+    "name": "headerStorage",
+    "outputs": [
+      {
+        "internalType": "contract HeaderStorage",
+        "name": "",
+        "type": "address"
+      }
+    ],
+    "stateMutability": "view",
+    "type": "function"
+  },
+  {
+    "inputs": [
+      {
+        "internalType": "uint256[]",
+        "name": "blockNumbers",
+        "type": "uint256[]"
+      },
+      {
+        "internalType": "address",
+        "name": "ambAdapter",
+        "type": "address"
+      },
+      {
+        "internalType": "uint256",
+        "name": "gas",
+        "type": "uint256"
+      }
+    ],
+    "name": "reportHeaders",
+    "outputs": [
+      {
+        "internalType": "bytes32",
+        "name": "receipt",
+        "type": "bytes32"
+      }
+    ],
+    "stateMutability": "nonpayable",
+    "type": "function"
+  }
+]