feat: reporter scripts

packages/reporter/.env.example

@@ -0,0 +1,17 @@
+PRIVATE_KEY=
+
+GOERLI_RPC_URL=
+GNOSIS_RPC_URL=
+SOURCE_CHAIN=goerli
+DEST_CHAIN=gnosis
+
+
+AMB_CONTROLLER=false
+GAS=30000
+
+SYGMA_CONTROLLER=false
+SYGMA_FEE_DATA=0x
+
+TELEPATHY_CONTROLLER=false
+TELEPATHY_PROOF_API_URL=https://api.telepathy.xyz/api/hashi/
+

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/.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/README.md

@@ -0,0 +1,26 @@
+# reporter
+
+Script to call Header Reporter contracts of different oracle from source chain to destination chain.
+
+## Run the script
+
+1. Configure the correct node version by running `nvm use`
+2. Installing packages by running `npm install`
+3. Create `.env` file and define the configuration to run.
+4. run `ts-node src/index.ts`
+
+## Configuration
+
+Configure the mode you want to run by editing the variable in `.env`
+
+1. `_CONTROLLER` (true/false): to enable the controller
+2. `SOURCE_CHAIN` (string value of chain): Define the source chain to collect the block header from.
+3. `DEST_CHAIN` (string value of chain): Define the destination chain to report the source chain's block header to.
+
+## Adding a new controller
+
+1. Add a new file under `/controller`, create the constructor and `onBlocks` function to call block header reporter
+   contract periodically.
+2. Add the contract addresses under `utils/address.json`.
+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"
+  }