chore: Upgrade to ESlint 9 and forbid import cycles (#4897)

### Description

- Upgrade from eslint 8 -> 9
- Forbid import cycles and self imports
- Fix lint errors caught by v9 but not v8
- Include utils package in CI linting

**No semantic changes, just some shuffling of things around to avoid
cycles**

Fixes #4898


https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-cycle.md

https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-self-import.md

.changeset/spotty-pumpkins-buy.md

@@ -0,0 +1,5 @@
+---
+'@hyperlane-xyz/utils': minor
+---
+
+Add toUpperCamelCase and deepFind functionss

.changeset/yellow-baboons-kneel.md

@@ -0,0 +1,5 @@
+---
+'@hyperlane-xyz/sdk': minor
+---
+
+Add decodeIsmMetadata function

.github/workflows/test.yml

@@ -72,6 +72,12 @@ jobs:
             .yarn
           key: ${{ runner.os }}-yarn-4.5.1-cache-${{ hashFiles('./yarn.lock') }}
           fail-on-cache-miss: true
+
+      # Build required before linting or the intra-monorepo package cycle checking won't work
+      - name: yarn-build
+        uses: ./.github/actions/yarn-build-with-cache
+        with:
+          ref: ${{ github.event.pull_request.head.sha || github.sha }}
 
       - name: lint
         run: yarn lint

eslint.config.mjs

@@ -0,0 +1,115 @@
+import { FlatCompat } from '@eslint/eslintrc';
+import js from '@eslint/js';
+import typescriptEslint from '@typescript-eslint/eslint-plugin';
+import tsParser from '@typescript-eslint/parser';
+import importPlugin from 'eslint-plugin-import';
+import jest from 'eslint-plugin-jest';
+import globals from 'globals';
+import path from 'node:path';
+import { fileURLToPath } from 'node:url';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+export const compat = new FlatCompat({
+  baseDirectory: __dirname,
+  recommendedConfig: js.configs.recommended,
+  allConfig: js.configs.all,
+});
+
+export default [
+  {
+    ignores: [
+      '**/node_modules',
+      '**/dist',
+      '**/coverage',
+      '**/*.cjs',
+      '**/*.cts',
+      '**/*.mjs',
+      'jest.config.js',
+    ],
+  },
+  ...compat.extends(
+    'eslint:recommended',
+    'plugin:import/recommended',
+    'plugin:import/typescript',
+    'plugin:@typescript-eslint/recommended',
+    'prettier',
+  ),
+  {
+    plugins: {
+      import: importPlugin,
+      '@typescript-eslint': typescriptEslint,
+      jest,
+    },
+
+    languageOptions: {
+      globals: {
+        ...globals.node,
+        ...globals.browser,
+      },
+
+      parser: tsParser,
+      ecmaVersion: 12,
+      sourceType: 'module',
+
+      parserOptions: {
+        project: './tsconfig.json',
+      },
+    },
+
+    settings: {
+      'import/resolver': {
+        typescript: true,
+        node: true,
+      },
+    },
+
+    rules: {
+      'guard-for-in': ['error'],
+      'import/no-cycle': ['error'],
+      'import/no-self-import': ['error'],
+      'import/no-named-as-default-member': ['off'],
+      'no-console': ['error'],
+      'no-eval': ['error'],
+      'no-extra-boolean-cast': ['error'],
+      'no-ex-assign': ['error'],
+      'no-constant-condition': ['off'],
+      'no-return-await': ['error'],
+
+      'no-restricted-imports': [
+        'error',
+        {
+          name: 'console',
+          message: 'Please use a logger and/or the utils package assert',
+        },
+        {
+          name: 'fs',
+          message: 'Avoid use of node-specific libraries',
+        },
+      ],
+
+      '@typescript-eslint/ban-ts-comment': ['off'],
+      '@typescript-eslint/explicit-module-boundary-types': ['off'],
+      '@typescript-eslint/no-explicit-any': ['off'],
+      '@typescript-eslint/no-floating-promises': ['error'],
+      '@typescript-eslint/no-non-null-assertion': ['off'],
+      '@typescript-eslint/no-require-imports': ['warn'],
+      '@typescript-eslint/no-unused-expressions': ['off'],
+      '@typescript-eslint/no-empty-object-type': ['off'],
+      '@typescript-eslint/no-unused-vars': [
+        'error',
+        {
+          argsIgnorePattern: '^_',
+          varsIgnorePattern: '^_',
+          caughtErrorsIgnorePattern: '^_',
+        },
+      ],
+
+      'jest/no-disabled-tests': 'warn',
+      'jest/no-focused-tests': 'error',
+      'jest/no-identical-title': 'error',
+      'jest/prefer-to-have-length': 'warn',
+      'jest/valid-expect': 'error',
+    },
+  },
+];

package.json

@@ -3,11 +3,14 @@
   "description": "A yarn workspace of core Hyperlane packages",
   "version": "0.0.0",
   "devDependencies": {
+    "@eslint/js": "^9.15.0",
     "@trivago/prettier-plugin-sort-imports": "^4.2.1",
-    "@typescript-eslint/eslint-plugin": "^7.4.0",
-    "@typescript-eslint/parser": "^7.4.0",
-    "eslint": "^8.57.0",
+    "@typescript-eslint/eslint-plugin": "^8.1.6",
+    "@typescript-eslint/parser": "^8.1.6",
+    "eslint": "^9.15.0",
     "eslint-config-prettier": "^9.1.0",
+    "eslint-import-resolver-typescript": "^3.6.3",
+    "eslint-plugin-import": "^2.31.0",
     "eslint-plugin-jest": "^28.2.0",
     "husky": "^8.0.0",
     "lint-staged": "^12.4.3",
@@ -41,6 +44,7 @@
     "async": "^2.6.4",
     "fetch-ponyfill": "^7.1",
     "flat": "^5.0.2",
+    "globals": "^14.0.0",
     "lodash": "^4.17.21",
     "recursive-readdir": "^2.2.3",
     "underscore": "^1.13",

typescript/ccip-server/eslint.config.mjs

@@ -0,0 +1,17 @@
+import MonorepoDefaults from '../../eslint.config.mjs';
+
+export default [
+  ...MonorepoDefaults,
+  {
+    files: ['./src/**/*.ts'],
+  },
+  {
+    rules: {
+      'no-console': ['off'],
+      'no-restricted-imports': ['off'],
+    },
+  },
+  {
+    ignores: ['**/__mocks__/*','**/tests/*',]
+  }
+];

typescript/ccip-server/package.json

@@ -12,16 +12,19 @@
     "node": ">=16"
   },
   "scripts": {
+    "build": "tsc -p tsconfig.json",
     "start": "tsx src/server.ts",
     "dev": "nodemon src/server.ts",
     "test": "jest",
+    "lint": "eslint -c ./eslint.config.mjs",
     "prettier": "prettier --write ./src/* ./tests/"
   },
   "author": "brolee",
   "license": "Apache-2.0",
   "devDependencies": {
     "@jest/globals": "^29.7.0",
     "@types/node": "^16.9.1",
+    "eslint": "^9.15.0",
     "jest": "^29.7.0",
     "nodemon": "^3.0.3",
     "prettier": "^2.8.8",

typescript/ccip-server/src/server.ts

@@ -6,12 +6,14 @@ import { ProofsService } from './services/ProofsService';
 
 // Initialize Services
 const proofsService = new ProofsService(
-  config.LIGHT_CLIENT_ADDR,
-  config.RPC_ADDRESS,
-  config.STEP_FN_ID,
-  config.CHAIN_ID,
-  config.SUCCINCT_PLATFORM_URL,
-  config.SUCCINCT_API_KEY,
+  {
+    lightClientAddress: config.LIGHT_CLIENT_ADDR,
+    stepFunctionId: config.STEP_FN_ID,
+    platformUrl: config.SUCCINCT_PLATFORM_URL,
+    apiKey: config.SUCCINCT_API_KEY,
+  },
+  { url: config.RPC_ADDRESS, chainId: config.CHAIN_ID },
+  { url: `${config.SERVER_URL_PREFIX}:${config.SERVER_PORT}` },
 );
 
 // Initialize Server and add Service handlers

typescript/ccip-server/src/services/LightClientService.ts

@@ -27,8 +27,8 @@ class LightClientService {
    * @param slot
    * @returns
    */
-  async getSyncCommitteePoseidons(slot: bigint): Promise<string> {
-    return await this.lightClientContract.syncCommitteePoseidons(
+  getSyncCommitteePoseidons(slot: bigint): Promise<string> {
+    return this.lightClientContract.syncCommitteePoseidons(
       this.getSyncCommitteePeriod(slot),
     );
   }

typescript/ccip-server/src/services/ProofsService.ts

@@ -4,8 +4,7 @@ import { TelepathyCcipReadIsmAbi } from '../abis/TelepathyCcipReadIsmAbi';
 
 import { HyperlaneService } from './HyperlaneService';
 import { LightClientService, SuccinctConfig } from './LightClientService';
-import { RPCService } from './RPCService';
-import { ProofResult } from './RPCService';
+import { ProofResult, RPCService } from './RPCService';
 import { ProofStatus } from './common/ProofStatusEnum';
 
 type RPCConfig = {
@@ -100,10 +99,7 @@ class ProofsService {
     );
     const slot = await this.lightClientService.calculateSlot(BigInt(timestamp));
     const syncCommitteePoseidon = ''; // TODO get from LC
-    return await this.lightClientService.requestProof(
-      syncCommitteePoseidon,
-      slot,
-    );
+    return this.lightClientService.requestProof(syncCommitteePoseidon, slot);
   }
 
   /**

typescript/ccip-server/tsconfig.json

@@ -0,0 +1,9 @@
+{
+  "extends": "../tsconfig.json",
+  "compilerOptions": {
+    "outDir": "./dist/",
+    "rootDir": "./src"
+  },
+  "exclude": ["./node_modules/", "./dist/"],
+  "include": ["./src/*.ts"]
+}

typescript/cli/eslint.config.mjs

@@ -0,0 +1,20 @@
+import MonorepoDefaults from '../../eslint.config.mjs';
+
+export default [
+  ...MonorepoDefaults,
+  {
+    files: ['./src/**/*.ts', './cli.ts', './env.ts'],
+  },
+  {
+    rules: {
+      'no-console': ['off'],
+      'no-restricted-imports': ['off'],
+    },
+  },
+  {
+    ignores: ['./src/tests/**/*.ts'],
+    rules: {
+      'import/no-cycle': ['off'],
+    },
+  },
+];