refactor (#18)

Author: aelmanaa

.github/workflows/ci.yml

@@ -42,8 +42,14 @@ jobs:
       - name: Install dependencies
         run: pnpm install --frozen-lockfile
 
-      - name: Run ESLint
-        run: pnpm lint:check
+      - name: Lint
+        run: |
+          # Enforce zero warnings policy
+          pnpm lint:check 2>&1 | tee lint-output.txt
+          if grep -qE "✖.*problem" lint-output.txt; then
+            echo "Error: Linting issues detected. Run 'pnpm lint:fix' to resolve."
+            exit 1
+          fi
 
       - name: Run Prettier
         run: pnpm format:check
@@ -105,8 +111,9 @@ jobs:
       - name: Run tests
         run: pnpm test
 
-      - name: Run tests with coverage
+      - name: Test with coverage
         run: pnpm test:coverage
+        # Coverage thresholds enforced by jest.config.ts
 
       - name: Upload coverage artifacts
         if: matrix.node-version == '22.x'

.gitignore

@@ -32,5 +32,5 @@ pnpm-debug.log*
 .DS_Store
 Thumbs.db 
 
-output/
+/output/
 coverage

README.md

@@ -78,7 +78,8 @@ module.exports = [
     },
   },
 
-  // Configuration for test files
+  // Configuration for test files - Following FAANG best practices
+  // Tests have different type safety requirements than production code
   {
     files: ['**/*.test.ts', '**/*.spec.ts', '**/test/**/*.ts'],
 
@@ -109,6 +110,7 @@ module.exports = [
         beforeAll: 'readonly',
         afterAll: 'readonly',
         jest: 'readonly',
+        fail: 'readonly',
       },
     },
 
@@ -126,22 +128,26 @@ module.exports = [
       ...prettier.rules,
       'prettier/prettier': 'error',
 
-      // Custom TypeScript-specific rules
-      '@typescript-eslint/explicit-function-return-type': 'error',
+      // Rules turned OFF for test files (incompatible with testing patterns)
+      '@typescript-eslint/unbound-method': 'off', // Jest mocks are unbound by design
+      '@typescript-eslint/only-throw-error': 'off', // Tests verify non-Error throw handling
+      '@typescript-eslint/require-await': 'off', // Async test helpers often don't await
+      '@typescript-eslint/explicit-function-return-type': 'off', // Test arrow functions are self-documenting
+
+      // Rules downgraded to WARN for test files (useful but not blocking)
+      '@typescript-eslint/no-explicit-any': 'warn', // Relax from error to warn
+      '@typescript-eslint/no-unsafe-assignment': 'warn', // Keep as warn
+      '@typescript-eslint/no-unsafe-member-access': 'warn', // Keep as warn
+      '@typescript-eslint/no-unsafe-call': 'warn', // Keep as warn
+      '@typescript-eslint/no-unsafe-return': 'warn', // Downgrade from error to warn
+      '@typescript-eslint/no-unsafe-argument': 'warn', // Add for consistency
+
+      // Standard test file overrides
       '@typescript-eslint/no-unused-vars': [
         'error',
         { argsIgnorePattern: '^_' },
       ],
-      '@typescript-eslint/no-explicit-any': 'error',
-      '@typescript-eslint/no-unsafe-assignment': 'warn',
-      '@typescript-eslint/no-unsafe-member-access': 'warn',
-      '@typescript-eslint/no-unsafe-call': 'warn',
-      '@typescript-eslint/no-unsafe-return': 'error',
-      
-      // Allow empty interfaces in tests
       '@typescript-eslint/no-empty-object-type': 'off',
-      
-      // Disable no-undef in test files since Jest globals are defined
       'no-undef': 'off',
     },
   },

eslint.config.js

@@ -0,0 +1,7 @@
+{
+  "removes": [],
+  "adds": [
+    "0x779877A7B0D9E8603169DdbD7836e478b4624789",
+    "0xa469F39796Cad956bE2E51117693880dB3E6438d"
+  ]
+}

examples/allow-list-updates.json

@@ -33,7 +33,8 @@
         "isEnabled": false,
         "capacity": "0",
         "rate": "0"
-      }
+      },
+      "remoteChainType": "evm"
     }
   ]
 ]

examples/chain-update.json

@@ -0,0 +1,4 @@
+{
+  "pool": "0x1234567890123456789012345678901234567890",
+  "roleType": "both"
+}

examples/grant-roles.json

@@ -0,0 +1,4 @@
+{
+  "receiver": "0x1234567890123456789012345678901234567890",
+  "amount": "1000000000000000000000"
+}

examples/mint.json

@@ -0,0 +1,13 @@
+{
+  "remoteChainSelector": "3478487238524512106",
+  "outboundConfig": {
+    "isEnabled": true,
+    "capacity": "1000000000000000000000",
+    "rate": "100000000000000000000"
+  },
+  "inboundConfig": {
+    "isEnabled": true,
+    "capacity": "1000000000000000000000",
+    "rate": "100000000000000000000"
+  }
+}

examples/rate-limiter-config.json

@@ -0,0 +1,5 @@
+{
+  "pool": "0x1234567890123456789012345678901234567890",
+  "roleType": "both",
+  "action": "revoke"
+}