chore: final changes to use interfaces package

tmigone · tmigone · commit 2c94da447982 · 2025-06-17T11:47:17.000-03:00
Signed-off-by: Tomás Migone &lt;tomas@edgeandnode.com&gt;
diff --git a/packages/horizon/tasks/test/seed.ts b/packages/horizon/tasks/test/seed.ts
@@ -1,11 +1,9 @@
 import { generateLegacyAllocationProof, randomAllocationMetadata } from '@graphprotocol/toolshed'
+import { delegators, indexers } from '@graphprotocol/toolshed/fixtures'
 import { requireLocalNetwork, setGRTBalance } from '@graphprotocol/toolshed/hardhat'
 import { printBanner } from '@graphprotocol/toolshed/utils'
 import { task } from 'hardhat/config'
 
-import { delegators } from './fixtures/delegators'
-import { indexers } from './fixtures/indexers'
-
 task('test:seed', 'Sets up some protocol state for testing').setAction(async (_, hre) => {
   printBanner('PROTOCOL STATE SETUP')
 
diff --git a/packages/horizon/test/integration/after-transition-period/delegator.test.ts b/packages/horizon/test/integration/after-transition-period/delegator.test.ts
@@ -1,12 +1,11 @@
 import { ONE_MILLION, ZERO_ADDRESS } from '@graphprotocol/toolshed'
+import { delegators } from '@graphprotocol/toolshed/fixtures'
 import { setGRTBalance } from '@graphprotocol/toolshed/hardhat'
 import type { HardhatEthersSigner } from '@nomicfoundation/hardhat-ethers/signers'
 import { expect } from 'chai'
 import hre from 'hardhat'
 import { ethers } from 'hardhat'
 
-import { delegators } from '../../../tasks/test/fixtures/delegators'
-
 describe('Delegator', () => {
   let delegator: HardhatEthersSigner
   let serviceProvider: HardhatEthersSigner
diff --git a/packages/horizon/test/integration/after-transition-period/service-provider.test.ts b/packages/horizon/test/integration/after-transition-period/service-provider.test.ts
@@ -1,12 +1,11 @@
 import { ONE_MILLION, PaymentTypes } from '@graphprotocol/toolshed'
+import { indexers } from '@graphprotocol/toolshed/fixtures'
 import { setGRTBalance } from '@graphprotocol/toolshed/hardhat'
 import type { HardhatEthersSigner } from '@nomicfoundation/hardhat-ethers/signers'
 import { expect } from 'chai'
 import hre from 'hardhat'
 import { ethers } from 'hardhat'
 
-import { indexers } from '../../../tasks/test/fixtures/indexers'
-
 describe('Service provider', () => {
   let verifier: string
   const thawingPeriod = 2419200n
diff --git a/packages/horizon/test/integration/during-transition-period/delegator.test.ts b/packages/horizon/test/integration/during-transition-period/delegator.test.ts
@@ -1,11 +1,10 @@
 import { ZERO_ADDRESS } from '@graphprotocol/toolshed'
+import { delegators } from '@graphprotocol/toolshed/fixtures'
 import type { HardhatEthersSigner } from '@nomicfoundation/hardhat-ethers/signers'
 import { expect } from 'chai'
 import hre from 'hardhat'
 import { ethers } from 'hardhat'
 
-import { delegators } from '../../../tasks/test/fixtures/delegators'
-
 describe('Delegator', () => {
   let snapshotId: string
 
diff --git a/packages/horizon/test/integration/during-transition-period/operator.test.ts b/packages/horizon/test/integration/during-transition-period/operator.test.ts
@@ -1,12 +1,11 @@
 import { generatePOI } from '@graphprotocol/toolshed'
+import { indexers } from '@graphprotocol/toolshed/fixtures'
 import { getEventData } from '@graphprotocol/toolshed/hardhat'
 import type { HardhatEthersSigner } from '@nomicfoundation/hardhat-ethers/signers'
 import { expect } from 'chai'
 import hre from 'hardhat'
 import { ethers } from 'hardhat'
 
-import { indexers } from '../../../tasks/test/fixtures/indexers'
-
 describe('Operator', () => {
   let snapshotId: string
 
diff --git a/packages/horizon/test/integration/during-transition-period/permissionless.test.ts b/packages/horizon/test/integration/during-transition-period/permissionless.test.ts
@@ -1,11 +1,10 @@
 import { generatePOI } from '@graphprotocol/toolshed'
+import { indexers } from '@graphprotocol/toolshed/fixtures'
 import type { HardhatEthersSigner } from '@nomicfoundation/hardhat-ethers/signers'
 import { expect } from 'chai'
 import hre from 'hardhat'
 import { ethers } from 'hardhat'
 
-import { indexers } from '../../../tasks/test/fixtures/indexers'
-
 describe('Permissionless', () => {
   let snapshotId: string
 
diff --git a/packages/horizon/test/integration/during-transition-period/service-provider.test.ts b/packages/horizon/test/integration/during-transition-period/service-provider.test.ts
@@ -1,12 +1,11 @@
 import { generatePOI, ONE_MILLION } from '@graphprotocol/toolshed'
+import { indexers } from '@graphprotocol/toolshed/fixtures'
 import { getEventData, setGRTBalance } from '@graphprotocol/toolshed/hardhat'
 import type { HardhatEthersSigner } from '@nomicfoundation/hardhat-ethers/signers'
 import { expect } from 'chai'
 import hre from 'hardhat'
 import { ethers } from 'hardhat'
 
-import { indexers } from '../../../tasks/test/fixtures/indexers'
-
 describe('Service Provider', () => {
   let snapshotId: string
 
diff --git a/packages/horizon/test/integration/during-transition-period/slasher.test.ts b/packages/horizon/test/integration/during-transition-period/slasher.test.ts
@@ -1,10 +1,9 @@
+import { indexers } from '@graphprotocol/toolshed/fixtures'
 import type { HardhatEthersSigner } from '@nomicfoundation/hardhat-ethers/signers'
 import { expect } from 'chai'
 import hre from 'hardhat'
 import { ethers } from 'hardhat'
 
-import { indexers } from '../../../tasks/test/fixtures/indexers'
-
 describe('Slasher', () => {
   let snapshotId: string
 
diff --git a/packages/interfaces/README.md b/packages/interfaces/README.md
@@ -1,13 +1,66 @@
 # @graphprotocol/interfaces
 
-Contract interfaces for The Graph protocol.
+Contract interfaces and types for The Graph protocol.
 
 ## Overview
 
-This package contains interfaces used in dependent packages, which makes building systems that interact with Balancer contracts simpler, as the implementation information is not included.
+This package contains contract interfaces and types used in dependent packages, which makes building systems that interact with The Graph contracts simpler, as the implementation information is not included.
 
 ## Installation
 
 ```bash
 pnpm add @graphprotocol/interfaces
 ```
+
+## Usage
+
+### Contract interfaces
+
+Solidity contract interfaces can be imported from `@graphprotocol/interfaces/contracts/...`:
+
+```solidity
+pragma solidity 0.8.27;
+
+import { IGraphPayments } from "@graphprotocol/interfaces/contracts/horizon/IGraphPayments.sol";
+
+contract GraphPayments is IGraphPayments {
+    ...
+}
+```
+
+Note that contracts in the `toolshed/` directory are not meant to be imported by Solidity code, they only exist to
+generate complete TypeScript types.
+
+### TypeScript types
+
+This package provides types generated with [Typechain](https://github.com/dethcrypto/TypeChain) compatible with ethers v6. To use them import with:
+
+```ts
+import {
+  GraphPayments,
+  GraphTallyCollector,
+  HorizonStaking,
+  L2GraphToken,
+  PaymentsEscrow,
+  SubgraphService,
+} from '@graphprotocol/interfaces'
+```
+
+### TypeScript library
+
+Additionally, the package exposes a few helper functions to facilitate the creation of fully typed ethers v6 contracts:
+
+| Function Name        | Description                                                 |
+| -------------------- | ----------------------------------------------------------- |
+| `getInterface`       | Retrieves the contract interface for a given contract name. |
+| `getMergedInterface` | Loads and merges interfaces from multiple contract names.   |
+| `getAbi`             | Gets the ABI for a given contract name.                     |
+
+```ts
+import {
+    getInterface,
+    SubgraphService
+} from '@graphprotocol/interfaces
+
+const subgraphService = new ethers.Contract('0x12...90', getInterface('SubgraphService')) as SubgraphService
+```
diff --git a/packages/interfaces/contracts/toolshed/IDisputeManagerToolshed.sol b/packages/interfaces/contracts/toolshed/IDisputeManagerToolshed.sol
@@ -2,7 +2,7 @@
 pragma solidity 0.8.27;
 
 import { IDisputeManager } from "../subgraph-service/IDisputeManager.sol";
-import { IOwnable } from "../subgraph-service/internal/IOwnable.sol";
+import { IOwnable } from "./internal/IOwnable.sol";
 
 interface IDisputeManagerToolshed is IDisputeManager, IOwnable {
     /**
diff --git a/packages/interfaces/contracts/toolshed/IServiceRegistryToolshed.sol b/packages/interfaces/contracts/toolshed/IServiceRegistryToolshed.sol
@@ -4,5 +4,13 @@ pragma solidity ^0.7.6 || 0.8.27;
 import { IServiceRegistry } from "../contracts/discovery/IServiceRegistry.sol";
 
 interface IServiceRegistryToolshed is IServiceRegistry {
-    function services(address indexer) external view returns (IServiceRegistry.IndexerService memory);
+    /**
+     * @notice Gets the indexer details
+     * @dev Note that this storage getter actually returns a ISubgraphService.Indexer struct, but ethers v6 is not
+     *      good at dealing with dynamic types on return values.
+     * @param indexer The address of the indexer
+     * @return url The URL where the indexer can be reached at for queries
+     * @return geoHash The indexer's geo location, expressed as a geo hash
+     */
+    function indexers(address indexer) external view returns (string memory url, string memory geoHash);
 }
diff --git a/packages/interfaces/contracts/toolshed/ISubgraphServiceToolshed.sol b/packages/interfaces/contracts/toolshed/ISubgraphServiceToolshed.sol
@@ -2,16 +2,24 @@
 pragma solidity 0.8.27;
 
 import { ISubgraphService } from "../subgraph-service/ISubgraphService.sol";
-import { IOwnable } from "../subgraph-service/internal/IOwnable.sol";
-import { IPausable } from "../subgraph-service/internal/IPausable.sol";
-
-interface ISubgraphServiceToolshed is ISubgraphService, IOwnable, IPausable {
+import { IOwnable } from "./internal/IOwnable.sol";
+import { IPausable } from "./internal/IPausable.sol";
+import { ILegacyAllocation } from "../subgraph-service/internal/ILegacyAllocation.sol";
+import { IProvisionManager } from "./internal/IProvisionManager.sol";
+import { IProvisionTracker } from "./internal/IProvisionTracker.sol";
+import { IDataServicePausable } from "../data-service/IDataServicePausable.sol";
+
+interface ISubgraphServiceToolshed is ISubgraphService, IOwnable, IPausable, IDataServicePausable, ILegacyAllocation, IProvisionManager, IProvisionTracker {
     /**
      * @notice Gets the indexer details
+     * @dev Note that this storage getter actually returns a ISubgraphService.Indexer struct, but ethers v6 is not
+     *      good at dealing with dynamic types on return values.
      * @param indexer The address of the indexer
-     * @return The indexer details
+     * @return registeredAt The timestamp when the indexer registered
+     * @return url The URL where the indexer can be reached at for queries
+     * @return geoHash The indexer's geo location, expressed as a geo hash
      */
-    function indexers(address indexer) external view returns (Indexer memory);
+    function indexers(address indexer) external view returns (uint256 registeredAt, string memory url, string memory geoHash);
 
     /**
      * @notice Gets the allocation provision tracker
diff --git a/packages/interfaces/contracts/toolshed/internal/IOwnable.sol b/packages/interfaces/contracts/toolshed/internal/IOwnable.sol
@@ -4,6 +4,11 @@ pragma solidity 0.8.27;
 /// @title IOwnable
 /// @notice Interface for Ownable contracts
 interface IOwnable {
+    /**
+     * @dev The caller account is not authorized to perform an operation.
+     */
+    error OwnableUnauthorizedAccount(address account);
+
     /// @notice Returns the address of the current owner
     function owner() external view returns (address);
 
diff --git a/packages/interfaces/contracts/toolshed/internal/IPausable.sol b/packages/interfaces/contracts/toolshed/internal/IPausable.sol
@@ -4,16 +4,16 @@ pragma solidity 0.8.27;
 /// @title IPausable
 /// @notice Interface for Pausable contract
 interface IPausable {
-    /// @notice Returns true if the contract is paused, and false otherwise
-    function paused() external view returns (bool);
-
     /**
-     * @notice Pauses the contract
+     * @dev The operation failed because the contract is paused.
      */
-    function pause() external;
+    error EnforcedPause();
 
     /**
-     * @notice Unpauses the contract
+     * @dev The operation failed because the contract is not paused.
      */
-    function unpause() external;
+    error ExpectedPause();
+
+    /// @notice Returns true if the contract is paused, and false otherwise
+    function paused() external view returns (bool);
 }
diff --git a/packages/interfaces/contracts/toolshed/internal/IProvisionManager.sol b/packages/interfaces/contracts/toolshed/internal/IProvisionManager.sol
@@ -0,0 +1,16 @@
+// SPDX-License-Identifier: GPL-3.0-or-later
+pragma solidity 0.8.27;
+
+interface IProvisionManager {
+    // Events
+    event ProvisionTokensRangeSet(uint256 min, uint256 max);
+    event DelegationRatioSet(uint32 ratio);
+    event VerifierCutRangeSet(uint32 min, uint32 max);
+    event ThawingPeriodRangeSet(uint64 min, uint64 max);
+
+    // Errors
+    error ProvisionManagerInvalidValue(bytes message, uint256 value, uint256 min, uint256 max);
+    error ProvisionManagerInvalidRange(uint256 min, uint256 max);
+    error ProvisionManagerNotAuthorized(address serviceProvider, address caller);
+    error ProvisionManagerProvisionNotFound(address serviceProvider);
+}
diff --git a/packages/interfaces/contracts/toolshed/internal/IProvisionTracker.sol b/packages/interfaces/contracts/toolshed/internal/IProvisionTracker.sol
@@ -0,0 +1,7 @@
+// SPDX-License-Identifier: GPL-3.0-or-later
+pragma solidity 0.8.27;
+
+interface IProvisionTracker {
+    // Errors
+    error ProvisionTrackerInsufficientTokens(uint256 tokensAvailable, uint256 tokensRequired);
+}
diff --git a/packages/interfaces/src/index.ts b/packages/interfaces/src/index.ts
@@ -75,7 +75,7 @@ export function getAbi(contractName: string): unknown[] {
  * @returns {Record<string, ContractFactoryStatic>} A map of contract names to their factory instances
  * @private
  */
-export function collectFactoriesMap(obj: unknown): Record<string, ContractFactoryStatic> {
+function collectFactoriesMap(obj: unknown): Record<string, ContractFactoryStatic> {
   const factoriesMap: Record<string, ContractFactoryStatic> = {}
 
   // For factory name 'x', use contract name 'y'
diff --git a/packages/interfaces/src/types/subgraph-service.ts b/packages/interfaces/src/types/subgraph-service.ts
@@ -17,5 +17,4 @@ import type {
     IServiceRegistryToolshed as LegacyServiceRegistry,
     ISubgraphNFT as SubgraphNFT,
     ISubgraphServiceToolshed as SubgraphService,
-  }
-  
+  }
diff --git a/packages/subgraph-service/tasks/test/seed.ts b/packages/subgraph-service/tasks/test/seed.ts
@@ -5,10 +5,9 @@ import {
   generatePOI,
   PaymentTypes,
 } from '@graphprotocol/toolshed'
+import { indexersData as indexers } from '@graphprotocol/toolshed/fixtures'
 import { task } from 'hardhat/config'
 
-import { indexers } from './fixtures/indexers'
-
 task('test:seed', 'Seed the test environment, must be run after deployment').setAction(async (_, hre) => {
   // Get contracts
   const graph = hre.graph()
diff --git a/packages/subgraph-service/test/integration/after-transition-period/dispute-manager/indexing-disputes.test.ts b/packages/subgraph-service/test/integration/after-transition-period/dispute-manager/indexing-disputes.test.ts
@@ -1,13 +1,12 @@
 import { DisputeManager, HorizonStaking, L2GraphToken, SubgraphService } from '@graphprotocol/interfaces'
 import { generatePOI } from '@graphprotocol/toolshed'
+import { indexersData as indexers } from '@graphprotocol/toolshed/fixtures'
 import { HardhatEthersSigner } from '@nomicfoundation/hardhat-ethers/signers'
 import { expect } from 'chai'
 import { EventLog } from 'ethers'
 import { ethers } from 'hardhat'
 import hre from 'hardhat'
 
-import { indexers } from '../../../../tasks/test/fixtures/indexers'
-
 describe('Indexing Disputes', () => {
   let disputeManager: DisputeManager
   let graphToken: L2GraphToken
diff --git a/packages/subgraph-service/test/integration/after-transition-period/dispute-manager/query-conflict-disputes.test.ts b/packages/subgraph-service/test/integration/after-transition-period/dispute-manager/query-conflict-disputes.test.ts
@@ -1,13 +1,12 @@
 import { DisputeManager, HorizonStaking, L2GraphToken, SubgraphService } from '@graphprotocol/interfaces'
 import { generateAttestationData } from '@graphprotocol/toolshed'
+import { indexersData as indexers } from '@graphprotocol/toolshed/fixtures'
 import { HardhatEthersSigner } from '@nomicfoundation/hardhat-ethers/signers'
 import { expect } from 'chai'
 import { EventLog } from 'ethers'
 import { ethers } from 'hardhat'
 import hre from 'hardhat'
 
-import { indexers } from '../../../../tasks/test/fixtures/indexers'
-
 describe('Query Conflict Disputes', () => {
   let disputeManager: DisputeManager
   let graphToken: L2GraphToken
diff --git a/packages/subgraph-service/test/integration/after-transition-period/dispute-manager/query-disputes.test.ts b/packages/subgraph-service/test/integration/after-transition-period/dispute-manager/query-disputes.test.ts
@@ -1,14 +1,13 @@
 import { DisputeManager, HorizonStaking, L2GraphToken, SubgraphService } from '@graphprotocol/interfaces'
 import { generateAttestationData } from '@graphprotocol/toolshed'
+import { indexersData as indexers } from '@graphprotocol/toolshed/fixtures'
 import { setGRTBalance } from '@graphprotocol/toolshed/hardhat'
 import { HardhatEthersSigner } from '@nomicfoundation/hardhat-ethers/signers'
 import { expect } from 'chai'
 import { EventLog } from 'ethers'
 import { ethers } from 'hardhat'
 import hre from 'hardhat'
 
-import { indexers } from '../../../../tasks/test/fixtures/indexers'
-
 describe('Query Disputes', () => {
   let disputeManager: DisputeManager
   let graphToken: L2GraphToken
diff --git a/packages/subgraph-service/test/integration/after-transition-period/subgraph-service/indexer.test.ts b/packages/subgraph-service/test/integration/after-transition-period/subgraph-service/indexer.test.ts
@@ -1,4 +1,3 @@
-import { delegators } from '@graphprotocol/horizon/tasks/test/fixtures/delegators.js'
 import {
   GraphPayments,
   GraphTallyCollector,
@@ -18,15 +17,14 @@ import {
   generateSignerProof,
   PaymentTypes,
 } from '@graphprotocol/toolshed'
+import { delegators, IndexerData as Indexer, indexersData as indexers } from '@graphprotocol/toolshed/fixtures'
 import { setGRTBalance } from '@graphprotocol/toolshed/hardhat'
 import { HardhatEthersSigner } from '@nomicfoundation/hardhat-ethers/signers'
 import { expect } from 'chai'
 import { HDNodeWallet } from 'ethers'
 import { ethers } from 'hardhat'
 import hre from 'hardhat'
 
-import { Indexer, indexers } from '../../../../tasks/test/fixtures/indexers'
-
 describe('Indexer', () => {
   let escrow: PaymentsEscrow
   let graphPayments: GraphPayments
diff --git a/packages/subgraph-service/test/integration/after-transition-period/subgraph-service/operator.test.ts b/packages/subgraph-service/test/integration/after-transition-period/subgraph-service/operator.test.ts
diff --git a/packages/subgraph-service/test/integration/after-transition-period/subgraph-service/paused.test.ts b/packages/subgraph-service/test/integration/after-transition-period/subgraph-service/paused.test.ts
diff --git a/packages/subgraph-service/test/integration/after-transition-period/subgraph-service/permisionless.test.ts b/packages/subgraph-service/test/integration/after-transition-period/subgraph-service/permisionless.test.ts
diff --git a/packages/subgraph-service/test/integration/during-transition-period/dispute-manager.test.ts b/packages/subgraph-service/test/integration/during-transition-period/dispute-manager.test.ts
diff --git a/packages/subgraph-service/test/integration/during-transition-period/indexer.test.ts b/packages/subgraph-service/test/integration/during-transition-period/indexer.test.ts
diff --git a/packages/subgraph-service/test/integration/during-transition-period/legacy-dispute-manager.test.ts b/packages/subgraph-service/test/integration/during-transition-period/legacy-dispute-manager.test.ts
diff --git a/packages/toolshed/package.json b/packages/toolshed/package.json
diff --git a/packages/toolshed/src/fixtures/delegators.ts b/packages/toolshed/src/fixtures/delegators.ts
diff --git a/packages/toolshed/src/fixtures/index.ts b/packages/toolshed/src/fixtures/index.ts
diff --git a/packages/toolshed/src/fixtures/indexers-subgraph-service.ts b/packages/toolshed/src/fixtures/indexers-subgraph-service.ts
diff --git a/packages/toolshed/src/fixtures/indexers.ts b/packages/toolshed/src/fixtures/indexers.ts
