devDeps: bump @metamask/eslint-config* to ^12.0.0

.eslintrc.js

@@ -7,6 +7,23 @@ module.exports = {
     {
       files: ['*.ts'],
       extends: ['@metamask/eslint-config-typescript'],
+      rules: {
+        // TODO: resolve warnings and remove to make into errors
+        '@typescript-eslint/consistent-type-definitions': 'off',
+        '@typescript-eslint/naming-convention': 'off',
+        '@typescript-eslint/prefer-optional-chain': 'warn',
+        '@typescript-eslint/restrict-template-expressions': 'off',
+        'id-denylist': 'off',
+        'id-length': 'off',
+        'import/no-nodejs-modules': 'off',
+        'jsdoc/require-jsdoc': 'off',
+        'jsdoc/require-param-description': 'warn',
+        'jsdoc/require-hyphen-before-param-description': 'warn',
+        'jsdoc/match-description': 'warn',
+        'jsdoc/no-types': 'warn',
+        'no-restricted-globals': 'off',
+        'no-restricted-syntax': 'warn',
+      },
     },
 
     {
@@ -18,9 +35,11 @@ module.exports = {
     },
 
     {
-      files: ['*.test.ts', '*.test.js'],
+      files: ['*.test.ts', '*.test.js', 'test/**/*.ts'],
       extends: ['@metamask/eslint-config-jest'],
       rules: {
+        '@typescript-eslint/no-floating-promises': 'warn',
+        '@typescript-eslint/unbound-method': 'off',
         'jest/expect-expect': [
           'error',
           {
@@ -30,6 +49,9 @@ module.exports = {
             ],
           },
         ],
+        'jsdoc/check-param-names': 'off',
+        'jsdoc/require-jsdoc': 'off',
+        'jsdoc/require-param': 'off',
       },
     },
   ],

package.json

@@ -42,23 +42,25 @@
     "@jest/globals": "^27.5.1",
     "@lavamoat/allow-scripts": "^2.3.1",
     "@metamask/auto-changelog": "^3.1.0",
-    "@metamask/eslint-config": "^8.0.0",
-    "@metamask/eslint-config-jest": "^8.0.0",
-    "@metamask/eslint-config-nodejs": "^8.0.0",
-    "@metamask/eslint-config-typescript": "^8.0.0",
+    "@metamask/eslint-config": "^12.1.0",
+    "@metamask/eslint-config-jest": "^12.1.0",
+    "@metamask/eslint-config-nodejs": "^12.1.0",
+    "@metamask/eslint-config-typescript": "^12.1.0",
     "@types/btoa": "^1.2.3",
     "@types/clone": "^2.1.0",
     "@types/jest": "^27.4.1",
     "@types/node": "^17.0.23",
     "@types/pify": "^3.0.2",
-    "@typescript-eslint/eslint-plugin": "^4.21.0",
-    "@typescript-eslint/parser": "^4.21.0",
-    "eslint": "^7.14.0",
+    "@typescript-eslint/eslint-plugin": "^5.42.1",
+    "@typescript-eslint/parser": "^5.42.1",
+    "eslint": "^8.44.0",
     "eslint-config-prettier": "^8.1.0",
-    "eslint-plugin-import": "^2.22.1",
-    "eslint-plugin-jest": "^24.1.3",
-    "eslint-plugin-node": "^11.1.0",
-    "eslint-plugin-prettier": "^3.3.1",
+    "eslint-plugin-import": "^2.27.5",
+    "eslint-plugin-jest": "^27.1.5",
+    "eslint-plugin-jsdoc": "^39.6.2",
+    "eslint-plugin-n": "^15.7.0",
+    "eslint-plugin-prettier": "^4.2.1",
+    "eslint-plugin-promise": "^6.1.1",
     "jest": "^27.5.1",
     "prettier": "^2.2.1",
     "prettier-plugin-packagejson": "^2.2.11",

src/block-cache.test.ts

@@ -1,9 +1,10 @@
+import { providerFromEngine } from '@metamask/eth-json-rpc-provider';
 import { PollingBlockTracker } from 'eth-block-tracker';
 import { JsonRpcEngine } from 'json-rpc-engine';
 import pify from 'pify';
-import { providerFromEngine } from '@metamask/eth-json-rpc-provider';
-import createHitTrackerMiddleware from '../test/util/createHitTrackerMiddleware';
+
 import { createBlockCacheMiddleware } from '.';
+import createHitTrackerMiddleware from '../test/util/createHitTrackerMiddleware';
 
 function createTestSetup() {
   // raw data source
@@ -53,8 +54,8 @@ describe('block cache', () => {
     });
     expect(hitCountMiddleware.getHits('eth_getBalance')).toHaveLength(2);
     expect(hitCount).toBe(1);
-    expect(response.result).toStrictEqual('0x0');
-    expect(response2.result).toStrictEqual('0x0');
+    expect(response.result).toBe('0x0');
+    expect(response2.result).toBe('0x0');
     expect(spy).toHaveBeenCalled();
   });
 });

src/block-cache.ts

@@ -1,20 +1,23 @@
-import { PollingBlockTracker } from 'eth-block-tracker';
-import { createAsyncMiddleware, JsonRpcRequest } from 'json-rpc-engine';
+import type { PollingBlockTracker } from 'eth-block-tracker';
+import type { JsonRpcRequest } from 'json-rpc-engine';
+import { createAsyncMiddleware } from 'json-rpc-engine';
+
 import { projectLogger, createModuleLogger } from './logging-utils';
-import {
-  cacheIdentifierForRequest,
-  blockTagForRequest,
-  cacheTypeForMethod,
-  canCache,
-  CacheStrategy,
-} from './utils/cache';
 import type {
   Block,
   BlockCache,
+  // eslint-disable-next-line @typescript-eslint/no-shadow
   Cache,
   JsonRpcCacheMiddleware,
   JsonRpcRequestToCache,
 } from './types';
+import {
+  cacheIdentifierForRequest,
+  blockTagForRequest,
+  cacheTypeForMethod,
+  canCache,
+  CacheStrategy,
+} from './utils/cache';
 
 const log = createModuleLogger(projectLogger, 'block-cache');
 // `<nil>` comes from https://github.com/ethereum/go-ethereum/issues/16925
@@ -29,7 +32,7 @@
 //
 
 class BlockCacheStrategy {
   private cache: Cache;
 
   constructor() {
     this.cache = {};
@@ -107,7 +110,7 @@
       )
     ) {
       if (
         !result ||
         !result.blockHash ||
         result.blockHash ===
           '0x0000000000000000000000000000000000000000000000000000000000000000'
@@ -209,7 +212,7 @@
           'No cache stored under block number %o, carrying request forward',
           requestedBlockNumber,
         );
-        // eslint-disable-next-line node/callback-return
+        // eslint-disable-next-line n/callback-return
         await next();
 
         // add result to cache

src/block-ref-rewrite.ts

@@ -1,5 +1,7 @@
-import { PollingBlockTracker } from 'eth-block-tracker';
-import { createAsyncMiddleware, JsonRpcMiddleware } from 'json-rpc-engine';
+import type { PollingBlockTracker } from 'eth-block-tracker';
+import type { JsonRpcMiddleware } from 'json-rpc-engine';
+import { createAsyncMiddleware } from 'json-rpc-engine';
+
 import { blockTagParamIndex } from './utils/cache';
 
 interface BlockRefRewriteMiddlewareOptions {

src/block-ref.test.ts

@@ -1,7 +1,10 @@
-import { PollingBlockTracker } from 'eth-block-tracker';
-import { JsonRpcEngine, JsonRpcMiddleware } from 'json-rpc-engine';
 import { providerFromEngine } from '@metamask/eth-json-rpc-provider';
 import type { SafeEventEmitterProvider } from '@metamask/eth-json-rpc-provider';
+import { PollingBlockTracker } from 'eth-block-tracker';
+import type { JsonRpcMiddleware } from 'json-rpc-engine';
+import { JsonRpcEngine } from 'json-rpc-engine';
+
+import { createBlockRefMiddleware } from '.';
 import {
   buildMockParamsWithBlockParamAt,
   stubProviderRequests,
@@ -11,7 +14,6 @@ import {
   buildMockParamsWithoutBlockParamAt,
   expectProviderRequestNotToHaveBeenMade,
 } from '../test/util/helpers';
-import { createBlockRefMiddleware } from '.';
 
 /**
  * Objects used in each test.

src/block-ref.ts

@@ -1,15 +1,16 @@
-import { PollingBlockTracker } from 'eth-block-tracker';
-import {
-  createAsyncMiddleware,
+import type { SafeEventEmitterProvider } from '@metamask/eth-json-rpc-provider';
+import clone from 'clone';
+import type { PollingBlockTracker } from 'eth-block-tracker';
+import type {
   JsonRpcMiddleware,
   PendingJsonRpcResponse,
 } from 'json-rpc-engine';
-import clone from 'clone';
+import { createAsyncMiddleware } from 'json-rpc-engine';
 import pify from 'pify';
-import type { SafeEventEmitterProvider } from '@metamask/eth-json-rpc-provider';
+
 import { projectLogger, createModuleLogger } from './logging-utils';
-import { blockTagParamIndex } from './utils/cache';
 import type { Block } from './types';
+import { blockTagParamIndex } from './utils/cache';
 
 interface BlockRefMiddlewareOptions {
   blockTracker?: PollingBlockTracker;
@@ -66,7 +67,7 @@ export function createBlockRefMiddleware({
     // perform child request
     log('Performing another request %o', childRequest);
     const childRes: PendingJsonRpcResponse<Block> = await pify(
-      (provider as SafeEventEmitterProvider).sendAsync,
+      provider.sendAsync,
     ).call(provider, childRequest);
     // copy child response onto original response
     res.result = childRes.result;

src/block-tracker-inspector.ts

@@ -1,9 +1,10 @@
-import { PollingBlockTracker } from 'eth-block-tracker';
-import {
-  createAsyncMiddleware,
+import type { PollingBlockTracker } from 'eth-block-tracker';
+import type {
   JsonRpcMiddleware,
   PendingJsonRpcResponse,
 } from 'json-rpc-engine';
+import { createAsyncMiddleware } from 'json-rpc-engine';
+
 import { projectLogger, createModuleLogger } from './logging-utils';
 
 const log = createModuleLogger(projectLogger, 'block-tracker-inspector');
@@ -26,7 +27,7 @@ type ValidPropertyType = string | number | symbol;
  *
  * @param objectToCheck - The object to check.
  * @param property - The property to look for.
- * @returns - Whether the object has the property.
+ * @returns Whether the object has the property.
  */
 function hasProperty<ObjectToCheck, Property extends ValidPropertyType>(
   objectToCheck: ObjectToCheck,
@@ -64,7 +65,7 @@ export function createBlockTrackerInspectorMiddleware({
     if (!futureBlockRefRequests.includes(req.method)) {
       return next();
     }
-    // eslint-disable-next-line node/callback-return
+    // eslint-disable-next-line n/callback-return
     await next();
     // abort if no result or no block number
     const responseBlockNumber = getResultBlockNumber(res);

src/fetch.ts

@@ -1,11 +1,10 @@
-import {
-  createAsyncMiddleware,
-  JsonRpcMiddleware,
-  JsonRpcRequest,
-} from 'json-rpc-engine';
-import { EthereumRpcError, ethErrors } from 'eth-rpc-errors';
-import { timeout } from './utils/timeout';
+import type { EthereumRpcError } from 'eth-rpc-errors';
+import { ethErrors } from 'eth-rpc-errors';
+import type { JsonRpcMiddleware, JsonRpcRequest } from 'json-rpc-engine';
+import { createAsyncMiddleware } from 'json-rpc-engine';
+
 import type { Block } from './types';
+import { timeout } from './utils/timeout';
 
 const RETRIABLE_ERRORS: string[] = [
   // ignore server overload errors
@@ -34,7 +33,7 @@
 /**
  * Create middleware for sending a JSON-RPC request to the given RPC URL.
  *
  * @param options - Options
  * @param options.btoa - Generates a base64-encoded string from a binary string.
  * @param options.fetch - The `fetch` function; expected to be equivalent to `window.fetch`.
  * @param options.rpcUrl - The URL to send the request to.
@@ -141,11 +140,12 @@
 /**
  * Generate `fetch` configuration for sending the given request to an RPC API.
  *
  * @param options - Options
  * @param options.btoa - Generates a base64-encoded string from a binary string.
  * @param options.rpcUrl - The URL to send the request to.
  * @param options.originHttpHeaderKey - If provider, the origin field for each JSON-RPC request
  * will be attached to each outgoing fetch request under this header.
+ * @param options.req
  * @returns The fetch middleware.
  */
 export function createFetchConfigFromReq({

src/inflight-cache.test.ts

@@ -1,5 +1,6 @@
 import { JsonRpcEngine } from 'json-rpc-engine';
 import pify from 'pify';
+
 import { createInflightCacheMiddleware } from '.';
 
 function createTestSetup() {

src/inflight-cache.ts

@@ -1,8 +1,10 @@
 import clone from 'clone';
-import { createAsyncMiddleware, PendingJsonRpcResponse } from 'json-rpc-engine';
+import type { PendingJsonRpcResponse } from 'json-rpc-engine';
+import { createAsyncMiddleware } from 'json-rpc-engine';
+
 import { projectLogger, createModuleLogger } from './logging-utils';
-import { cacheIdentifierForRequest } from './utils/cache';
 import type { JsonRpcRequestToCache, JsonRpcCacheMiddleware } from './types';
+import { cacheIdentifierForRequest } from './utils/cache';
 
 type RequestHandlers = (handledRes: PendingJsonRpcResponse<unknown>) => void;
 interface InflightRequest {
@@ -49,7 +51,7 @@ export function createInflightCacheMiddleware(): JsonRpcCacheMiddleware<
       inflightRequests[cacheId] = activeRequestHandlers;
       // allow request to be handled normally
       log('Carrying original request forward %o', req);
-      // eslint-disable-next-line node/callback-return
+      // eslint-disable-next-line n/callback-return
       await next();
       // clear inflight requests
       delete inflightRequests[cacheId];
@@ -65,7 +67,7 @@ export function createInflightCacheMiddleware(): JsonRpcCacheMiddleware<
     },
   );
 
-  function createActiveRequestHandler(
+  async function createActiveRequestHandler(
     res: PendingJsonRpcResponse<unknown>,
     activeRequestHandlers: RequestHandlers[],
   ): Promise<void> {

src/providerAsMiddleware.ts

@@ -1,5 +1,8 @@
-import { JsonRpcMiddleware, PendingJsonRpcResponse } from 'json-rpc-engine';
 import type { SafeEventEmitterProvider } from '@metamask/eth-json-rpc-provider';
+import type {
+  JsonRpcMiddleware,
+  PendingJsonRpcResponse,
+} from 'json-rpc-engine';
 
 export function providerAsMiddleware(
   provider: SafeEventEmitterProvider,

src/retryOnEmpty.test.ts

@@ -1,23 +1,21 @@
-import { PollingBlockTracker } from 'eth-block-tracker';
-import {
-  JsonRpcEngine,
-  JsonRpcMiddleware,
-  JsonRpcRequest,
-} from 'json-rpc-engine';
 import { providerFromEngine } from '@metamask/eth-json-rpc-provider';
 import type { SafeEventEmitterProvider } from '@metamask/eth-json-rpc-provider';
+import { PollingBlockTracker } from 'eth-block-tracker';
+import type { JsonRpcMiddleware, JsonRpcRequest } from 'json-rpc-engine';
+import { JsonRpcEngine } from 'json-rpc-engine';
+
+import { createRetryOnEmptyMiddleware } from '.';
+import type { ProviderRequestStub } from '../test/util/helpers';
 import {
   buildFinalMiddlewareWithDefaultResponse,
   buildMockParamsWithBlockParamAt,
   buildMockParamsWithoutBlockParamAt,
   buildSimpleFinalMiddleware,
   buildStubForBlockNumberRequest,
   expectProviderRequestNotToHaveBeenMade,
-  ProviderRequestStub,
   requestMatches,
   stubProviderRequests,
 } from '../test/util/helpers';
-import { createRetryOnEmptyMiddleware } from '.';
 
 /**
  * Objects used in each test.

src/retryOnEmpty.ts

@@ -1,16 +1,17 @@
+import type { SafeEventEmitterProvider } from '@metamask/eth-json-rpc-provider';
 import clone from 'clone';
-import { PollingBlockTracker } from 'eth-block-tracker';
-import {
-  createAsyncMiddleware,
+import type { PollingBlockTracker } from 'eth-block-tracker';
+import type {
   JsonRpcMiddleware,
   PendingJsonRpcResponse,
 } from 'json-rpc-engine';
-import type { SafeEventEmitterProvider } from '@metamask/eth-json-rpc-provider';
+import { createAsyncMiddleware } from 'json-rpc-engine';
 import pify from 'pify';
+
 import { projectLogger, createModuleLogger } from './logging-utils';
+import type { Block } from './types';
 import { blockTagParamIndex } from './utils/cache';
 import { timeout } from './utils/timeout';
-import { Block } from './types';
 
 //
 // RetryOnEmptyMiddleware will retry any request with an empty response that has
@@ -103,7 +104,7 @@ export function createRetryOnEmptyMiddleware({
       async () => {
         log('Performing request %o', childRequest);
         const attemptResponse: PendingJsonRpcResponse<Block> = await pify(
-          (provider as SafeEventEmitterProvider).sendAsync,
+          provider.sendAsync,
         ).call(provider, childRequest);
         log('Response is %o', attemptResponse);
         // verify result

src/types.ts

@@ -1,4 +1,4 @@
-import { JsonRpcMiddleware, JsonRpcRequest } from 'json-rpc-engine';
+import type { JsonRpcMiddleware, JsonRpcRequest } from 'json-rpc-engine';
 
 export interface JsonRpcRequestToCache<T> extends JsonRpcRequest<T> {
   skipCache?: boolean;