chore: update hardhat-graph-protocol to latest linting config

Signed-off-by: Tomás Migone <[email protected]>

Author: tmigone

packages/hardhat-graph-protocol/README.md

@@ -21,15 +21,16 @@ pnpm add --dev hardhat-graph-protocol
 Add the plugin to your `hardhat.config.ts`:
 
 ```ts
-import "hardhat-graph-protocol";
+import 'hardhat-graph-protocol'
 ```
 
 ### Using @graphprotocol/toolshed
+
 To use the plugin you'll need to configure the target networks. We recommend using our base hardhat configuration which can be imported from `@graphprotocol/toolshed`:
 
 ```ts
 import { hardhatBaseConfig, networksUserConfig } from '@graphprotocol/toolshed/hardhat'
-import "hardhat-graph-protocol";
+import 'hardhat-graph-protocol'
 
 const config: HardhatUserConfig = {
   ...networksUserConfig,
@@ -40,12 +41,14 @@ export default config // or just "export default hardhatBaseConfig"
 ```
 
 ### Manual configuration
+
 To manually configure target networks:
 
 **Hardhat: Network config**
+
 ```ts
   networks: {
-    arbitrumOne: { 
+    arbitrumOne: {
       chainId: 42161,
       url: `https://arbitrum-one.infura.io/v3/123456`
       deployments: {
@@ -55,6 +58,7 @@ To manually configure target networks:
     },
   }
 ```
+
 **Hardhat: Graph config**
 
 Additionally, the plugin adds a new config field to hardhat's config file: `graph`. This can be used used to define defaults for all networks:
@@ -86,10 +90,10 @@ The interface for the graph object can be found [here](src/types.ts), it's expan
 ```ts
 export type GraphRuntimeEnvironment = {
   [deploymentName]: {
-    contracts: DeploymentContractsType,
-    addressBook: DeploymentAddressBookType,
+    contracts: DeploymentContractsType
+    addressBook: DeploymentAddressBookType
     actions: DeplyomentActionsType
-  },
+  }
   provider: HardhatEthersProvider
   chainId: number
   accounts: {
@@ -110,26 +114,31 @@ export type GraphRuntimeEnvironment = {
 The plugin provides one object for each configured deployment, this object allows easily interacting with the associated deployment with a few additional features. The current deployments that are supported: `horizon` and `subgraphService`.
 
 Each deployment will be of the form:
+
 ```ts
   [deploymentName]: {
     contracts: DeploymentContractsType,
     addressBook: DeploymentAddressBookType,
     actions: DeplyomentActionsType
   },
 ```
+
 Where:
+
 - `contracts`: an object with all the contracts available in the deployment, already instanced, fully typed and ready to go.
 - `addressBook`: an object allowing read and write access to the deployment's address book.
 - `actions`: (optional) an object with helper functions to perform common actions in the associated deployment.
 
 **Transaction logging**
 
 Any transactions made using the `contracts` object will be automatically logged both to the console and to a file:
+
 - `file`, in the project's root directory: `tx-YYYY-MM-DD.log`
 - `console`, not shown by default. Run with `DEBUG=toolshed:tx` to enable them.
 
 Note that this does not apply to getter functions (`view` or `pure`) as those are not state modifying calls.
 An example log output:
+
 ```
 [2025-04-10T20:32:37.182Z] > Sending transaction: HorizonStaking.addToProvision
 [2025-04-10T20:32:37.182Z]    = Sender: 0xACa94ef8bD5ffEE41947b4585a84BdA5a3d3DA6E
@@ -145,7 +154,7 @@ An example log output:
 [2025-04-10T20:32:40.946Z]    ✔ Transaction succeeded!
 ```
 
-__Note__ Transaction logging requires using js Proxy which strips down some type definitions from contract methods. This means that when transaction logging is enabled `contract.functionName.estimateGas` for example will not be available.
+**Note** Transaction logging requires using js Proxy which strips down some type definitions from contract methods. This means that when transaction logging is enabled `contract.functionName.estimateGas` for example will not be available.
 
 **Transaction auto-awaiting**
 
@@ -162,6 +171,7 @@ await tx.wait(10)
 ```
 
 **Examples**
+
 ```js
 const graph = hre.graph()
 const { GraphPayments, HorizonStaking, GraphToken } = graph.horizon.contracts
@@ -179,7 +189,7 @@ await HorizonStaking.connect(signer).provision(signer.address, dataService.addre
 // Do the same but using actions - in this case the `provision` helper also approves and stakes
 await provision(signer, [signer.address, dataService.address, 100_000_000, 10_000, 42_690])
 
-// Read the address book 
+// Read the address book
 const entry = graph.horizon.addressBook.getEntry('HorizonStaking')
 console.log(entry.address) // HorizonStaking proxy address
 console.log(entry.implementation) // HorizonStaking implementation address
@@ -188,6 +198,7 @@ console.log(entry.implementation) // HorizonStaking implementation address
 ### Accounts
 
 The plugin provides helper functions to derive signers from the configured accounts in hardhat config:
+
 ```ts
   hardhat: {
     chainId: 31337,
@@ -198,16 +209,16 @@ The plugin provides helper functions to derive signers from the configured accou
   },
 ```
 
-| Function | Description | Default account derivation index |
-|----------|-------------|-------------|
-| `getAccounts()` | Returns all the accounts listed below | - |
-| `getDeployer()` | Returns the deployer signer | 0 |
-| `getGovernor()` | Returns the governor signer | 1 |
-| `getArbitrator()` | Returns the arbitrator signer | 2 |
-| `getPauseGuardian()` | Returns the pause guardian signer | 3 |
-| `getSubgraphAvailabilityOracle()` | Returns a service provider signer | 4 |
-| `getGateway()` | Returns the gateway signer | 5 |
-| `getTestAccounts()` | Returns the test signers | 6-20 |
+| Function                          | Description                           | Default account derivation index |
+| --------------------------------- | ------------------------------------- | -------------------------------- |
+| `getAccounts()`                   | Returns all the accounts listed below | -                                |
+| `getDeployer()`                   | Returns the deployer signer           | 0                                |
+| `getGovernor()`                   | Returns the governor signer           | 1                                |
+| `getArbitrator()`                 | Returns the arbitrator signer         | 2                                |
+| `getPauseGuardian()`              | Returns the pause guardian signer     | 3                                |
+| `getSubgraphAvailabilityOracle()` | Returns a service provider signer     | 4                                |
+| `getGateway()`                    | Returns the gateway signer            | 5                                |
+| `getTestAccounts()`               | Returns the test signers              | 6-20                             |
 
 Note that these are just helper functions to enforce a convention on which index to use for each account. These might not match what is configured in the target protocol deployment.
 

packages/hardhat-graph-protocol/eslint.config.js

@@ -27,7 +27,7 @@
   "scripts": {
     "build": "tsc",
     "clean": "rm -rf dist",
-    "lint": "eslint '**/*.{js,ts}' --fix",
+    "lint": "eslint --fix --cache '**/*.{js,ts,cjs,mjs,jsx,tsx}'; prettier -w --cache --log-level warn '**/*.{js,ts,cjs,mjs,jsx,tsx}'",
     "test": "mocha --exit --recursive 'test/**/*.test.ts'",
     "prepublishOnly": "npm run build"
   },

packages/hardhat-graph-protocol/package.json

@@ -2,14 +2,17 @@ import {
   getAccounts as getAccountsToolshed,
   getArbitrator,
   getDeployer,
-  getGateway, getGovernor, getPauseGuardian, getSubgraphAvailabilityOracle, getTestAccounts,
+  getGateway,
+  getGovernor,
+  getPauseGuardian,
+  getSubgraphAvailabilityOracle,
+  getTestAccounts,
   TEN_MILLION,
 } from '@graphprotocol/toolshed'
 import { setGRTBalance } from '@graphprotocol/toolshed/hardhat'
-
-import type { Addressable } from 'ethers'
 import type { HardhatEthersProvider } from '@nomicfoundation/hardhat-ethers/internal/hardhat-ethers-provider'
 import type { HardhatEthersSigner } from '@nomicfoundation/hardhat-ethers/signers'
+import type { Addressable } from 'ethers'
 
 type Accounts = {
   getAccounts: () => ReturnType<typeof getAccountsToolshed>
@@ -22,7 +25,11 @@ type Accounts = {
   getTestAccounts: () => ReturnType<typeof getTestAccounts>
 }
 
-export function getAccounts(provider: HardhatEthersProvider, chainId: number, grtTokenAddress: string | Addressable | undefined): Accounts {
+export function getAccounts(
+  provider: HardhatEthersProvider,
+  chainId: number,
+  grtTokenAddress: string | Addressable | undefined,
+): Accounts {
   return {
     getAccounts: async () => {
       const accounts = await getAccountsToolshed(provider)
@@ -77,7 +84,12 @@ export function getAccounts(provider: HardhatEthersProvider, chainId: number, gr
   }
 }
 
-async function setBalanceIfLocal(provider: HardhatEthersProvider, chainId: number, grtTokenAddress: string | Addressable | undefined, account: HardhatEthersSigner) {
+async function setBalanceIfLocal(
+  provider: HardhatEthersProvider,
+  chainId: number,
+  grtTokenAddress: string | Addressable | undefined,
+  account: HardhatEthersSigner,
+) {
   if (grtTokenAddress && [1337, 31337].includes(chainId)) {
     await setGRTBalance(provider, grtTokenAddress, account.address, TEN_MILLION)
   }

packages/hardhat-graph-protocol/src/accounts.ts

@@ -1,4 +1,5 @@
 import { HardhatPluginError } from 'hardhat/plugins'
+
 import { logError } from './logger'
 
 export class GraphPluginError extends HardhatPluginError {

packages/hardhat-graph-protocol/src/error.ts

@@ -1,18 +1,16 @@
-/* eslint-disable no-case-declarations */
+import type { GraphDeployments } from '@graphprotocol/toolshed/deployments'
+import { loadGraphHorizon, loadSubgraphService } from '@graphprotocol/toolshed/deployments'
+import { HardhatEthersProvider } from '@nomicfoundation/hardhat-ethers/internal/hardhat-ethers-provider'
+import { lazyFunction } from 'hardhat/plugins'
+import type { HardhatConfig, HardhatRuntimeEnvironment, HardhatUserConfig } from 'hardhat/types'
 import path from 'path'
 
-import { loadGraphHorizon, loadSubgraphService } from '@graphprotocol/toolshed/deployments'
-import { logDebug, logError } from './logger'
 import { getAccounts } from './accounts'
 import { getAddressBookPath } from './config'
 import { GraphPluginError } from './error'
-import { HardhatEthersProvider } from '@nomicfoundation/hardhat-ethers/internal/hardhat-ethers-provider'
-import { isGraphDeployment } from './types'
-import { lazyFunction } from 'hardhat/plugins'
-
-import type { HardhatConfig, HardhatRuntimeEnvironment, HardhatUserConfig } from 'hardhat/types'
-import type { GraphDeployments } from '@graphprotocol/toolshed/deployments'
+import { logDebug, logError } from './logger'
 import type { GraphRuntimeEnvironmentOptions } from './types'
+import { isGraphDeployment } from './types'
 
 export const greExtendConfig = (config: HardhatConfig, userConfig: Readonly<HardhatUserConfig>) => {
   const userPath = userConfig.paths?.graph
@@ -41,11 +39,15 @@ export const greExtendEnvironment = (hre: HardhatRuntimeEnvironment) => {
     }
     logDebug(`Chain Id: ${chainId}`)
 
-    const deployments = [...new Set([
-      ...Object.keys(opts.deployments ?? {}),
-      ...Object.keys(hre.network.config.deployments ?? {}),
-      ...Object.keys(hre.config.graph?.deployments ?? {}),
-    ].filter(v => isGraphDeployment(v)))]
+    const deployments = [
+      ...new Set(
+        [
+          ...Object.keys(opts.deployments ?? {}),
+          ...Object.keys(hre.network.config.deployments ?? {}),
+          ...Object.keys(hre.config.graph?.deployments ?? {}),
+        ].filter((v) => isGraphDeployment(v)),
+      ),
+    ]
     logDebug(`Detected deployments: ${deployments.join(', ')}`)
 
     // Build the Graph Runtime Environment (GRE) for each deployment
@@ -70,7 +72,6 @@ export const greExtendEnvironment = (hre: HardhatRuntimeEnvironment) => {
             greDeployments.subgraphService = loadSubgraphService(addressBookPath, chainId, provider)
             break
           default:
-            // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
             logError(`Skipping deployment ${deployment} - Reason: unknown deployment`)
             break
         }

packages/hardhat-graph-protocol/src/gre.ts

@@ -1,10 +1,11 @@
-import { extendConfig, extendEnvironment } from 'hardhat/config'
-import { greExtendConfig, greExtendEnvironment } from './gre'
-
 // This import is needed to let the TypeScript compiler know that it should include your type
 // extensions in your npm package's types file.
 import './type-extensions'
 
+import { extendConfig, extendEnvironment } from 'hardhat/config'
+
+import { greExtendConfig, greExtendEnvironment } from './gre'
+
 // ** Graph Runtime Environment (GRE) extensions for the HRE **
 extendConfig(greExtendConfig)
 extendEnvironment(greExtendEnvironment)

packages/hardhat-graph-protocol/src/index.ts

@@ -1,7 +1,6 @@
-import { GraphDeploymentsList } from '@graphprotocol/toolshed/deployments'
-
-import type { GraphDeploymentName, GraphDeployments } from '@graphprotocol/toolshed/deployments'
 import type { GraphAccounts } from '@graphprotocol/toolshed'
+import type { GraphDeploymentName, GraphDeployments } from '@graphprotocol/toolshed/deployments'
+import { GraphDeploymentsList } from '@graphprotocol/toolshed/deployments'
 import type { HardhatEthersProvider } from '@nomicfoundation/hardhat-ethers/internal/hardhat-ethers-provider'
 import type { HardhatEthersSigner } from '@nomicfoundation/hardhat-ethers/signers'
 export type GraphDeploymentOptions = {

packages/hardhat-graph-protocol/src/types.ts

@@ -1,6 +1,6 @@
+import { expect } from 'chai'
 import path from 'path'
 
-import { expect } from 'chai'
 import { getAddressBookPath } from '../src/config'
 import { loadHardhatContext } from './helpers'
 
@@ -12,7 +12,7 @@ describe('GRE init functions', function () {
       expect(() => getAddressBookPath('horizon', this.hre, {})).to.throw('Must set a an addressBook path!')
     })
 
-    it('should throw if address book doesn\'t exist', function () {
+    it("should throw if address book doesn't exist", function () {
       this.hre = loadHardhatContext('invalid-address-book', 'mainnet')
       expect(() => getAddressBookPath('horizon', this.hre, {})).to.throw(/Address book not found: /)
     })

packages/hardhat-graph-protocol/test/config.test.ts

@@ -106,10 +106,7 @@
     },
     "L2GNS": {
       "address": "0x3133948342F35b8699d8F94aeE064AbB76eDe965",
-      "initArgs": [
-        "0x9DB3ee191681f092607035d9BDA6e59FbEaCa695",
-        "0xF21Df5BbA7EB9b54D8F60C560aFb9bA63e6aED1A"
-      ],
+      "initArgs": ["0x9DB3ee191681f092607035d9BDA6e59FbEaCa695", "0xF21Df5BbA7EB9b54D8F60C560aFb9bA63e6aED1A"],
       "creationCodeHash": "0xcdd28bb3db05f1267ca0f5ea29536c61841be5937ce711b813924f8ff38918cc",
       "runtimeCodeHash": "0x4ca8c37c807bdfda1d6dcf441324b7ea14c6ddec5db37c20c2bf05aeae49bc0d",
       "txHash": "0x137140783a99a3e9a60048d607124626ca87e2b972e8cc05efb41ac87c3cbcc4",