feat: add GNS to deployments

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

Author: tmigone

packages/contracts/contracts/discovery/IGNS.sol

@@ -1,6 +1,6 @@
 // SPDX-License-Identifier: GPL-2.0-or-later
 
-pragma solidity ^0.7.6;
+pragma solidity ^0.7.6 || 0.8.27;
 
 /**
  * @title Interface for GNS

packages/contracts/contracts/discovery/ISubgraphNFT.sol

@@ -1,6 +1,6 @@
 // SPDX-License-Identifier: GPL-2.0-or-later
 
-pragma solidity ^0.7.6;
+pragma solidity ^0.7.6 || 0.8.27;
 
 import "@openzeppelin/contracts/token/ERC721/IERC721.sol";
 

packages/hardhat-graph-protocol/CHANGELOG.md

@@ -1,5 +1,12 @@
 # hardhat-graph-protocol
 
+## 0.1.19
+
+### Patch Changes
+
+- Updated dependencies
+  - @graphprotocol/toolshed@0.5.1
+
 ## 0.1.18
 
 ### Patch Changes

packages/hardhat-graph-protocol/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hardhat-graph-protocol",
-  "version": "0.1.18",
+  "version": "0.1.19",
   "publishConfig": {
     "access": "public"
   },

packages/horizon/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @graphprotocol/horizon
 
+## 0.3.3
+
+### Patch Changes
+
+- Add GNS to deployments
+
 ## 0.3.2
 
 ### Patch Changes

packages/horizon/contracts/mocks/imports.sol

@@ -10,12 +10,14 @@ import "@openzeppelin/contracts/proxy/transparent/ProxyAdmin.sol";
 import "@graphprotocol/contracts/contracts/governance/Controller.sol";
 import "@graphprotocol/contracts/contracts/upgrades/GraphProxyAdmin.sol";
 import "@graphprotocol/contracts/contracts/staking/IStaking.sol";
+import "@graphprotocol/contracts/contracts/discovery/ISubgraphNFT.sol";
 
 // Also for toolshed, solidity version in @graphprotocol/contracts does not support overriding public getters
 // in interface file, so we need to amend them here.
 import { IRewardsManager } from "@graphprotocol/contracts/contracts/rewards/IRewardsManager.sol";
 import { IL2Curation } from "@graphprotocol/contracts/contracts/l2/curation/IL2Curation.sol";
 import { IEpochManager } from "@graphprotocol/contracts/contracts/epochs/IEpochManager.sol";
+import { IGNS } from "@graphprotocol/contracts/contracts/discovery/IGNS.sol";
 
 interface IRewardsManagerToolshed is IRewardsManager {
     function subgraphService() external view returns (address);
@@ -28,3 +30,7 @@ interface IL2CurationToolshed is IL2Curation {
 interface IEpochManagerToolshed is IEpochManager {
     function epochLength() external view returns (uint256);
 }
+
+interface IGNSToolshed is IGNS {
+    function subgraphNFT() external view returns (address);
+}

packages/horizon/ignition/configs/migrate.default.json5

@@ -12,6 +12,9 @@
     "graphTokenGatewayAddress": "0xB24Ce0f8c18c4DdDa584A7EeC132F49C966813bb",
     "rewardsManagerAddress": "0x1F49caE7669086c8ba53CC35d1E9f80176d67E79",
     "curationAddress": "0xDe761f075200E75485F4358978FB4d1dC8644FD5",
+    "gnsAddress": "0x3133948342F35b8699d8F94aeE064AbB76eDe965",
+    "gnsImplementationAddress": "0x00CBF5024d454255577Bf2b0fB6A43328a6828c9",
+    "subgraphNFTAddress": "0xF21Df5BbA7EB9b54D8F60C560aFb9bA63e6aED1A",
 
     // Must be set for step 2 of the migration
     "graphPaymentsAddress": "",

packages/horizon/ignition/configs/migrate.fork1.json5

@@ -12,6 +12,9 @@
     "graphTokenGatewayAddress": "0xB24Ce0f8c18c4DdDa584A7EeC132F49C966813bb",
     "rewardsManagerAddress": "0x1F49caE7669086c8ba53CC35d1E9f80176d67E79",
     "curationAddress": "0xDe761f075200E75485F4358978FB4d1dC8644FD5",
+    "gnsAddress": "0x3133948342F35b8699d8F94aeE064AbB76eDe965",
+    "gnsImplementationAddress": "0x00CBF5024d454255577Bf2b0fB6A43328a6828c9",
+    "subgraphNFTAddress": "0xF21Df5BbA7EB9b54D8F60C560aFb9bA63e6aED1A",
 
     // Must be set for step 2 of the migration
     "graphPaymentsAddress": "0x1A7Fb71014d4395903eC56662f32dD02344D361C",

packages/horizon/ignition/configs/migrate.integration.json5

@@ -12,6 +12,9 @@
     "graphTokenGatewayAddress": "0xB24Ce0f8c18c4DdDa584A7EeC132F49C966813bb",
     "rewardsManagerAddress": "0x1F49caE7669086c8ba53CC35d1E9f80176d67E79",
     "curationAddress": "0xDe761f075200E75485F4358978FB4d1dC8644FD5",
+    "gnsAddress": "0x3133948342F35b8699d8F94aeE064AbB76eDe965",
+    "gnsImplementationAddress": "0x00CBF5024d454255577Bf2b0fB6A43328a6828c9",
+    "subgraphNFTAddress": "0xF21Df5BbA7EB9b54D8F60C560aFb9bA63e6aED1A",
 
     // Must be set for step 2 of the migration
     "graphPaymentsAddress": "",

packages/horizon/ignition/modules/deploy.ts

@@ -17,6 +17,9 @@ export default buildModule('GraphHorizon_Deploy', (m) => {
     RewardsManagerImplementation,
     L2Curation,
     L2CurationImplementation,
+    L2GNS,
+    L2GNSImplementation,
+    SubgraphNFT,
   } = m.useModule(GraphPeripheryModule)
   const {
     HorizonStaking,
@@ -46,6 +49,9 @@ export default buildModule('GraphHorizon_Deploy', (m) => {
     Implementation_EpochManager: EpochManagerImplementation,
     Graph_Proxy_L2Curation: L2Curation,
     Implementation_L2Curation: L2CurationImplementation,
+    Graph_Proxy_L2GNS: L2GNS,
+    Implementation_L2GNS: L2GNSImplementation,
+    SubgraphNFT,
     Graph_Proxy_RewardsManager: RewardsManager,
     Implementation_RewardsManager: RewardsManagerImplementation,
     Graph_Proxy_L2GraphTokenGateway: L2GraphTokenGateway,

packages/horizon/ignition/modules/migrate/migrate-3.ts

@@ -14,6 +14,9 @@ export default buildModule('GraphHorizon_Migrate_3', (m) => {
     EpochManager,
     L2GraphToken,
     L2GraphTokenGateway,
+    L2GNS,
+    L2GNSImplementation,
+    SubgraphNFT,
   } = m.useModule(MigratePeripheryModule)
 
   const {
@@ -29,6 +32,9 @@ export default buildModule('GraphHorizon_Migrate_3', (m) => {
   return {
     Graph_Proxy_L2Curation: L2Curation,
     Implementation_L2Curation: L2CurationImplementation,
+    Graph_Proxy_L2GNS: L2GNS,
+    Implementation_L2GNS: L2GNSImplementation,
+    SubgraphNFT,
     Graph_Proxy_RewardsManager: RewardsManager,
     Implementation_RewardsManager: RewardsManagerImplementation,
     Graph_Proxy_HorizonStaking: HorizonStaking,

packages/horizon/ignition/modules/periphery/Curation.ts

@@ -10,6 +10,9 @@ import GraphCurationTokenArtifact from '@graphprotocol/contracts/build/contracts
 import GraphProxyAdminArtifact from '@graphprotocol/contracts/build/contracts/contracts/upgrades/GraphProxyAdmin.sol/GraphProxyAdmin.json'
 import GraphProxyArtifact from '@graphprotocol/contracts/build/contracts/contracts/upgrades/GraphProxy.sol/GraphProxy.json'
 
+// Curation deployment should be managed by ignition scripts in subgraph-service package however
+// due to tight coupling with Controller it's easier to do it on the horizon package.
+
 export default buildModule('L2Curation', (m) => {
   const { Controller } = m.useModule(ControllerModule)
   const { GraphProxyAdmin } = m.useModule(GraphProxyAdminModule)

packages/horizon/ignition/modules/periphery/GNS.ts

@@ -0,0 +1,55 @@
+import { buildModule } from '@nomicfoundation/hardhat-ignition/modules'
+import { deployWithGraphProxy } from '../proxy/GraphProxy'
+
+import ControllerModule from './Controller'
+import CurationModule from './Curation'
+import GraphProxyAdminModule from './GraphProxyAdmin'
+import GraphTokenModule from './GraphToken'
+
+import L2GNSArtifact from '@graphprotocol/contracts/build/contracts/contracts/l2/discovery/L2GNS.sol/L2GNS.json'
+import SubgraphNFTArtifact from '@graphprotocol/contracts/build/contracts/contracts/discovery/SubgraphNFT.sol/SubgraphNFT.json'
+import SubgraphNFTDescriptorArtifact from '@graphprotocol/contracts/build/contracts/contracts/discovery/SubgraphNFTDescriptor.sol/SubgraphNFTDescriptor.json'
+
+// GNS deployment should be managed by ignition scripts in subgraph-service package however
+// due to tight coupling with Controller it's easier to do it on the horizon package.
+
+export default buildModule('L2GNS', (m) => {
+  const { Controller } = m.useModule(ControllerModule)
+  const { GraphProxyAdmin } = m.useModule(GraphProxyAdminModule)
+  const { L2GraphToken } = m.useModule(GraphTokenModule)
+  const { L2Curation } = m.useModule(CurationModule)
+
+  const deployer = m.getAccount(0)
+  const governor = m.getAccount(1)
+
+  const SubgraphNFTDescriptor = m.contract('SubgraphNFTDescriptor', SubgraphNFTDescriptorArtifact)
+  const SubgraphNFT = m.contract('SubgraphNFT', SubgraphNFTArtifact, [deployer])
+
+  m.call(SubgraphNFT, 'setTokenDescriptor', [SubgraphNFTDescriptor])
+
+  const { proxy: L2GNS, implementation: L2GNSImplementation } = deployWithGraphProxy(m, GraphProxyAdmin, {
+    name: 'L2GNS',
+    artifact: L2GNSArtifact,
+    initArgs: [Controller, SubgraphNFT],
+  })
+  m.call(L2GNS, 'approveAll', [], { after: [L2GraphToken, L2Curation] })
+
+  const setMinterCall = m.call(SubgraphNFT, 'setMinter', [L2GNS])
+  m.call(SubgraphNFT, 'transferOwnership', [governor], { after: [setMinterCall] })
+
+  return { L2GNS, L2GNSImplementation, SubgraphNFT }
+})
+
+// L2GNS and SubgraphNFT are already deployed and are not being upgraded
+// This is a no-op to get the addresses into the address book
+export const MigrateL2GNSModule = buildModule('L2GNS', (m) => {
+  const gnsProxyAddress = m.getParameter('gnsAddress')
+  const gnsImplementationAddress = m.getParameter('gnsImplementationAddress')
+  const subgraphNFTAddress = m.getParameter('subgraphNFTAddress')
+
+  const SubgraphNFT = m.contractAt('SubgraphNFT', SubgraphNFTArtifact, subgraphNFTAddress)
+  const L2GNS = m.contractAt('L2GNS', L2GNSArtifact, gnsProxyAddress)
+  const L2GNSImplementation = m.contractAt('L2GNSAddressBook', L2GNSArtifact, gnsImplementationAddress)
+
+  return { L2GNS, L2GNSImplementation, SubgraphNFT }
+})

packages/horizon/ignition/modules/periphery/periphery.ts

@@ -5,6 +5,7 @@ import { ethers } from 'ethers'
 import ControllerModule, { MigrateControllerDeployerModule } from './Controller'
 import CurationModule, { MigrateCurationDeployerModule } from './Curation'
 import EpochManagerModule, { MigrateEpochManagerModule } from './EpochManager'
+import GNSModule, { MigrateL2GNSModule } from './GNS'
 import GraphProxyAdminModule, { MigrateGraphProxyAdminModule } from './GraphProxyAdmin'
 import GraphTokenGatewayModule, { MigrateGraphTokenGatewayModule } from './GraphTokenGateway'
 import GraphTokenModule, { MigrateGraphTokenModule } from './GraphToken'
@@ -16,6 +17,7 @@ export default buildModule('GraphHorizon_Periphery', (m) => {
 
   const { EpochManager, EpochManagerImplementation } = m.useModule(EpochManagerModule)
   const { L2Curation, L2CurationImplementation } = m.useModule(CurationModule)
+  const { L2GNS, L2GNSImplementation, SubgraphNFT } = m.useModule(GNSModule)
   const { RewardsManager, RewardsManagerImplementation } = m.useModule(RewardsManagerModule)
   const { L2GraphTokenGateway, L2GraphTokenGatewayImplementation } = m.useModule(GraphTokenGatewayModule)
   const { L2GraphToken, L2GraphTokenImplementation } = m.useModule(GraphTokenModule)
@@ -26,13 +28,17 @@ export default buildModule('GraphHorizon_Periphery', (m) => {
   m.call(Controller, 'setContractProxy', [ethers.keccak256(ethers.toUtf8Bytes('GraphTokenGateway')), L2GraphTokenGateway], { id: 'setContractProxy_GraphTokenGateway' })
   m.call(Controller, 'setContractProxy', [ethers.keccak256(ethers.toUtf8Bytes('GraphProxyAdmin')), GraphProxyAdmin], { id: 'setContractProxy_GraphProxyAdmin' })
   m.call(Controller, 'setContractProxy', [ethers.keccak256(ethers.toUtf8Bytes('Curation')), L2Curation], { id: 'setContractProxy_L2Curation' })
+  m.call(Controller, 'setContractProxy', [ethers.keccak256(ethers.toUtf8Bytes('GNS')), L2GNS], { id: 'setContractProxy_L2GNS' })
 
   return {
     Controller,
     EpochManager,
     EpochManagerImplementation,
     L2Curation,
     L2CurationImplementation,
+    L2GNS,
+    L2GNSImplementation,
+    SubgraphNFT,
     GraphProxyAdmin,
     L2GraphToken,
     L2GraphTokenImplementation,
@@ -45,6 +51,7 @@ export default buildModule('GraphHorizon_Periphery', (m) => {
 
 export const MigratePeripheryModule = buildModule('GraphHorizon_Periphery', (m) => {
   const { L2CurationProxy: L2Curation, L2CurationImplementation } = m.useModule(MigrateCurationDeployerModule)
+  const { L2GNS, L2GNSImplementation, SubgraphNFT } = m.useModule(MigrateL2GNSModule)
   const { RewardsManagerProxy: RewardsManager, RewardsManagerImplementation } = m.useModule(MigrateRewardsManagerDeployerModule)
   const { Controller } = m.useModule(MigrateControllerDeployerModule)
   const { GraphProxyAdmin } = m.useModule(MigrateGraphProxyAdminModule)
@@ -53,12 +60,14 @@ export const MigratePeripheryModule = buildModule('GraphHorizon_Periphery', (m)
   const { L2GraphTokenGateway } = m.useModule(MigrateGraphTokenGatewayModule)
 
   // Load these contracts so they are available in the address book
-
   return {
     Controller,
     EpochManager,
     L2Curation,
     L2CurationImplementation,
+    L2GNS,
+    L2GNSImplementation,
+    SubgraphNFT,
     GraphProxyAdmin,
     L2GraphToken,
     L2GraphTokenGateway,

packages/horizon/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@graphprotocol/horizon",
-  "version": "0.3.2",
+  "version": "0.3.3",
   "publishConfig": {
     "access": "public"
   },
@@ -55,7 +55,7 @@
     "hardhat": "^2.22.18",
     "hardhat-contract-sizer": "^2.10.0",
     "hardhat-gas-reporter": "^1.0.8",
-    "hardhat-graph-protocol": "workspace:^0.1.18",
+    "hardhat-graph-protocol": "workspace:^0.1.19",
     "hardhat-secure-accounts": "^1.0.5",
     "lint-staged": "^15.2.2",
     "prettier": "^3.2.5",

packages/horizon/scripts/pre-verify

@@ -52,6 +52,7 @@ cp "$DBG_DIR_DEST/GraphProxy#GraphProxy.dbg.json" "$DBG_DIR_DEST/L2GraphTokenGat
 cp "$DBG_DIR_DEST/GraphProxy#GraphProxy.dbg.json" "$DBG_DIR_DEST/RewardsManager#GraphProxy.dbg.json"
 cp "$DBG_DIR_DEST/GraphProxy#GraphProxy.dbg.json" "$DBG_DIR_DEST/BridgeEscrow#GraphProxy.dbg.json"
 cp "$DBG_DIR_DEST/GraphProxy#GraphProxy.dbg.json" "$DBG_DIR_DEST/EpochManager#GraphProxy.dbg.json"
+cp "$DBG_DIR_DEST/GraphProxy#GraphProxy.dbg.json" "$DBG_DIR_DEST/L2GNS#GraphProxy.dbg.json"
 
 cp "$DBG_DIR_DEST/TransparentUpgradeableProxy#TransparentUpgradeableProxy.dbg.json" "$DBG_DIR_DEST/HorizonProxiesDeployer#TransparentUpgradeableProxy_GraphPayments.dbg.json"
 cp "$DBG_DIR_DEST/TransparentUpgradeableProxy#TransparentUpgradeableProxy.dbg.json" "$DBG_DIR_DEST/HorizonProxies#TransparentUpgradeableProxy_GraphPayments.dbg.json"

packages/horizon/test/deployment/GNS.test.ts

@@ -0,0 +1,20 @@
+import hre from 'hardhat'
+
+import { expect } from 'chai'
+import { graphProxyTests } from './lib/GraphProxy.test'
+
+const graph = hre.graph()
+
+const graphProxyAdminAddressBookEntry = graph.horizon.addressBook.getEntry('GraphProxyAdmin')
+const gnsAddressBookEntry = graph.horizon.addressBook.getEntry('L2GNS')
+const GNS = graph.horizon.contracts.L2GNS
+const SubgraphNFT = graph.horizon.contracts.SubgraphNFT
+
+describe('GNS', function () {
+  it('should set the right subgraphNFT address', async function () {
+    const subgraphNFT = await GNS.subgraphNFT()
+    expect(subgraphNFT).to.equal(SubgraphNFT)
+  })
+})
+
+graphProxyTests('GNS', gnsAddressBookEntry, graphProxyAdminAddressBookEntry.address)

packages/horizon/test/deployment/lib/GraphProxy.test.ts

@@ -4,11 +4,9 @@ import { assert, expect } from 'chai'
 import { AddressBookEntry } from '@graphprotocol/toolshed/deployments'
 import { zeroPadValue } from 'ethers'
 
-export function graphProxyTests(contractName: string, addressBookEntry: AddressBookEntry, proxyAdmin: string, upgraded = false): void {
-  const testIf = () => (upgraded ? it : it.skip)
-
+export function graphProxyTests(contractName: string, addressBookEntry: AddressBookEntry, proxyAdmin: string): void {
   describe(`${contractName}: GraphProxy`, function () {
-    testIf()('should target the correct implementation', async function () {
+    it('should target the correct implementation', async function () {
       const implementation = await hre.ethers.provider.getStorage(addressBookEntry.address, '0x360894a13ba1a3210667c828492db98dca3e2076cc3735a920a3ca505d382bbc')
       if (!addressBookEntry.implementation) {
         assert.fail('Implementation address is not set')

packages/subgraph-service/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @graphprotocol/subgraph-service
 
+## 0.3.5
+
+### Patch Changes
+
+- Add GNS to deployments
+
 ## 0.3.4
 
 ### Patch Changes

packages/subgraph-service/ignition/configs/migrate.default.json5

@@ -9,6 +9,9 @@
     "controllerAddress": "0x9DB3ee191681f092607035d9BDA6e59FbEaCa695",
     "curationProxyAddress": "0xDe761f075200E75485F4358978FB4d1dC8644FD5",
     "curationImplementationAddress": "0xd90022aB67920212D0F902F5c427DE82732DE136",
+    "gnsProxyAddress": "0x3133948342F35b8699d8F94aeE064AbB76eDe965",
+    "gnsImplementationAddress": "0x00CBF5024d454255577Bf2b0fB6A43328a6828c9",
+    "subgraphNFTAddress": "0xF21Df5BbA7EB9b54D8F60C560aFb9bA63e6aED1A",
 
     // Must be set for step 2 of the deployment
     "disputeManagerProxyAddress": "",

packages/subgraph-service/ignition/configs/migrate.fork1.json5

@@ -9,6 +9,9 @@
     "controllerAddress": "0x9DB3ee191681f092607035d9BDA6e59FbEaCa695",
     "curationProxyAddress": "0xDe761f075200E75485F4358978FB4d1dC8644FD5",
     "curationImplementationAddress": "0xd90022aB67920212D0F902F5c427DE82732DE136",
+    "gnsProxyAddress": "0x3133948342F35b8699d8F94aeE064AbB76eDe965",
+    "gnsImplementationAddress": "0x00CBF5024d454255577Bf2b0fB6A43328a6828c9",
+    "subgraphNFTAddress": "0xF21Df5BbA7EB9b54D8F60C560aFb9bA63e6aED1A",
 
     // Must be set for step 2 of the deployment
     "disputeManagerProxyAddress": "0x1CEBe1C314Cc454baf4bd553409d957C833623c0",

packages/subgraph-service/ignition/configs/migrate.integration.json5

@@ -9,6 +9,10 @@
     "controllerAddress": "0x9DB3ee191681f092607035d9BDA6e59FbEaCa695",
     "curationProxyAddress": "0xDe761f075200E75485F4358978FB4d1dC8644FD5",
     "curationImplementationAddress": "0xd90022aB67920212D0F902F5c427DE82732DE136",
+    "gnsProxyAddress": "0x3133948342F35b8699d8F94aeE064AbB76eDe965",
+    "gnsImplementationAddress": "0x00CBF5024d454255577Bf2b0fB6A43328a6828c9",
+    "subgraphNFTAddress": "0xF21Df5BbA7EB9b54D8F60C560aFb9bA63e6aED1A",
+
 
     // Must be set for step 2 of the deployment
     "disputeManagerProxyAddress": "",

packages/subgraph-service/ignition/configs/protocol.default.json5

@@ -9,6 +9,9 @@
     "controllerAddress": "",
     "curationProxyAddress": "",
     "curationImplementationAddress": "",
+    "gnsProxyAddress": "",
+    "gnsImplementationAddress": "",
+    "subgraphNFTAddress": "",
 
     // Must be set for step 2 of the deployment
     "disputeManagerProxyAddress": "",

packages/subgraph-service/ignition/configs/protocol.localNetwork.json5

@@ -1,4 +1,3 @@
-
 {
   "$global": {
     // Accounts for new deployment - derived from local network mnemonic
@@ -10,6 +9,9 @@
     "controllerAddress": "",
     "curationProxyAddress": "",
     "curationImplementationAddress": "",
+    "gnsProxyAddress": "",
+    "gnsImplementationAddress": "",
+    "subgraphNFTAddress": "",
 
     // Must be set for step 2 of the deployment
     "disputeManagerProxyAddress": "",