feat: add subgraph service boilerplate

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

.github/actions/setup/action.yml

@@ -4,6 +4,8 @@ runs:
   using: composite
 
   steps:
+    - name: Install Foundry
+      uses: foundry-rs/foundry-toolchain@v1
     - name: Enable corepack for modern yarn
       shell: bash
       run: corepack enable

.github/workflows/build.yml

@@ -16,5 +16,7 @@ jobs:
     steps:
       - name: Checkout
         uses: actions/checkout@v4
+        with:
+          submodules: recursive
       - name: Set up environment
         uses: ./.github/actions/setup

.github/workflows/ci-contracts.yml

@@ -20,6 +20,8 @@ jobs:
     steps:
       - name: Checkout
         uses: actions/checkout@v4
+        with:
+          submodules: recursive
       - name: Set up environment
         uses: ./.github/actions/setup
       - name: Run tests

.github/workflows/ci-subgraph-service.yml

@@ -0,0 +1,30 @@
+name: CI - packages/subgraph-service
+
+env:
+  CI: true
+
+on:
+  push:
+    branches: "*"
+    paths:
+      - packages/subgraph-service/**
+  pull_request:
+    branches: "*"
+    paths:
+      - packages/subgraph-service/**
+  workflow_dispatch:
+
+jobs:
+  test-ci:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          submodules: recursive
+      - name: Set up environment
+        uses: ./.github/actions/setup
+      - name: Run tests
+        run: |
+          pushd packages/subgraph-service
+          yarn test

.github/workflows/ci-token-dist.yml

@@ -20,6 +20,8 @@ jobs:
     steps:
       - name: Checkout
         uses: actions/checkout@v4
+        with:
+          submodules: recursive
       - name: Set up environment
         uses: ./.github/actions/setup
       - name: Run tests

.github/workflows/e2e-contracts.yml

@@ -30,6 +30,8 @@ jobs:
     steps:
       - name: Checkout
         uses: actions/checkout@v4
+        with:
+          submodules: recursive
       - name: Set up environment
         uses: ./.github/actions/setup
       - name: Run e2e tests

.github/workflows/publish.yml

@@ -23,6 +23,8 @@ jobs:
     steps:
       - name: Checkout
         uses: actions/checkout@v4
+        with:
+          submodules: recursive
       - name: Set up environment
         uses: ./.github/actions/setup
       - name: Publish 🚀

.github/workflows/verifydeployed.yml

@@ -25,6 +25,8 @@ jobs:
     steps:
       - name: Checkout
         uses: actions/checkout@v3
+        with:
+          submodules: recursive
       - name: Set up environment
         uses: ./.github/actions/setup
 

.gitignore

@@ -21,6 +21,8 @@ cached/
 # Build artifacts
 dist/
 build/
+typechain/
+typechain-types/
 deployments/hardhat/
 
 # Ignore solc bin output
@@ -45,8 +47,10 @@ addresses-fork.json
 # Keys
 .keystore
 
+# Forge artifacts
+cache_forge
 # Graph client
 .graphclient
 
 tx-builder-*.json
-!tx-builder-template.json
+!tx-builder-template.json

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "packages/subgraph-service/lib/forge-std"]
+	path = packages/subgraph-service/lib/forge-std
+	url = https://github.com/foundry-rs/forge-std

.husky/pre-commit

@@ -2,5 +2,11 @@
 . "$(dirname -- "$0")/_/husky.sh"
 
 # contracts
-cd packages/contracts
+pushd packages/contracts
 npx --no-install lint-staged
+popd
+
+# subgraph service
+pushd packages/subgraph-service
+npx --no-install lint-staged
+popd

README.md

@@ -38,9 +38,10 @@ This repository is a Yarn workspaces monorepo containing the following packages:
 | --- | --- | --- |
 | [contracts](./packages/contracts) | [![npm version](https://badge.fury.io/js/@graphprotocol%2Fcontracts.svg)](https://badge.fury.io/js/@graphprotocol%2Fcontracts) | Contracts enabling the open and permissionless decentralized network known as The Graph protocol. |
 | [eslint-graph-config](./packages/eslint-graph-config) | [![npm version]()]() | Shared linting and formatting rules for TypeScript projects. |
-| [token-distribution](./packages/token-distribution) | - | Contracts managing token locks for network participants |
 | [sdk](./packages/sdk) | [![npm version](https://badge.fury.io/js/@graphprotocol%2Fsdk.svg)](https://badge.fury.io/js/@graphprotocol%2Fsdk) | TypeScript based SDK to interact with the protocol contracts |
 | [solhint-graph-config](./packages/eslint-graph-config) | [![npm version]()]() | Shared linting and formatting rules for Solidity projects. |
+| [subgraph-service](./packages/subgraph-service) | [![npm version]()]() | Contracts for the Subgraph data service in Graph Horizon. |
+| [token-distribution](./packages/token-distribution) | - | Contracts managing token locks for network participants |
 
 
 ## Development

package.json

@@ -11,6 +11,7 @@
     "packages/eslint-graph-config",
     "packages/sdk",
     "packages/solhint-graph-config",
+    "packages/subgraph-service",
     "packages/token-distribution"
   ],
   "scripts": {

packages/contracts/contracts/staking/IHorizonStaking.sol

@@ -1,8 +1,12 @@
 // SPDX-License-Identifier: GPL-2.0-or-later
 
-pragma solidity 0.7.6;
+pragma solidity >=0.7.6 <0.9.0;
 pragma abicoder v2;
 
+interface Test {
+    function test() external returns (uint256);
+}
+
 interface IHorizonStaking {
     struct Provision {
         // Service provider that created the provision
@@ -93,12 +97,7 @@ interface IHorizonStaking {
     function stake(uint256 tokens) external;
 
     // create a provision
-    function provision(
-        uint256 tokens,
-        address verifier,
-        uint256 maxVerifierCut,
-        uint256 thawingPeriod
-    ) external;
+    function provision(uint256 tokens, address verifier, uint256 maxVerifierCut, uint256 thawingPeriod) external;
 
     // initiate a thawing to remove tokens from a provision
     function thaw(bytes32 provisionId, uint256 tokens) external returns (bytes32 thawRequestId);
@@ -123,11 +122,7 @@ interface IHorizonStaking {
     ) external returns (bytes32 thawRequestId);
 
     // slash a service provider
-    function slash(
-        bytes32 provisionId,
-        uint256 tokens,
-        uint256 verifierAmount
-    ) external;
+    function slash(bytes32 provisionId, uint256 tokens, uint256 verifierAmount) external;
 
     // set the Service Provider's preferred provisions to be force thawed
     function setForceThawProvisions(bytes32[] calldata provisions) external;
@@ -148,10 +143,7 @@ interface IHorizonStaking {
     // `Provision.tokens - Provision.tokensThawing`
     function getTokensAvailable(bytes32 provision) external view returns (uint256 tokens);
 
-    function getServiceProvider(address serviceProvider)
-        external
-        view
-        returns (ServiceProvider memory);
+    function getServiceProvider(address serviceProvider) external view returns (ServiceProvider memory);
 
     function getProvision(bytes32 provision) external view returns (Provision memory);
 }

packages/sdk/src/deployments/lib/address-book.ts

@@ -33,7 +33,7 @@ export abstract class AddressBook<
    * @throws AssertionError if the target file is not a valid address book
    * @throws Error if the target file does not exist
    */
-  constructor(_file: string, _chainId: number, strictAssert: boolean = false) {
+  constructor(_file: string, _chainId: number, strictAssert = false) {
     this.strictAssert = strictAssert
     this.file = _file
     if (!fs.existsSync(this.file)) throw new Error(`Address book path provided does not exist!`)

packages/sdk/src/deployments/network/actions/staking.ts

@@ -48,7 +48,7 @@ export const allocateFrom: GraphNetworkAction<{
   const metadata = ethers.constants.HashZero
 
   console.log(`\nAllocating ${amount} tokens on ${allocationId}...`)
-  let extraArgs: ethers.Overrides = {}
+  const extraArgs: ethers.Overrides = {}
   if (process.env.CI) {
     extraArgs.gasLimit = BigNumber.from('400000')
   }
@@ -59,7 +59,7 @@ export const allocateFrom: GraphNetworkAction<{
     allocationId,
     metadata,
     proof,
-    extraArgs
+    extraArgs,
   )
   await tx.wait()
 }

packages/subgraph-service/README.md

@@ -0,0 +1,13 @@
+# Sample Hardhat Project
+
+This project demonstrates a basic Hardhat use case. It comes with a sample contract, a test for that contract, and a script that deploys that contract.
+
+Try running some of the following tasks:
+
+```shell
+npx hardhat help
+npx hardhat test
+REPORT_GAS=true npx hardhat test
+npx hardhat node
+npx hardhat run scripts/deploy.ts
+```

packages/subgraph-service/contracts/SubgraphService.sol

@@ -0,0 +1,10 @@
+// SPDX-License-Identifier: GPL-3.0
+pragma solidity >=0.4.0 <0.9.0;
+
+import {Test} from "@graphprotocol/contracts/contracts/staking/IHorizonStaking.sol";
+
+contract SimpleTest is Test {
+    function test() external pure returns (uint256) {
+        return 42;
+    }
+}

packages/subgraph-service/eslint.config.js

@@ -0,0 +1,12 @@
+// @ts-check
+/* eslint-disable no-undef */
+/* eslint-disable @typescript-eslint/no-var-requires */
+/* eslint-disable @typescript-eslint/no-unsafe-assignment */
+
+const eslintGraphConfig = require('eslint-graph-config')
+module.exports = [
+  ...eslintGraphConfig.default,
+  {
+    ignores: ['typechain-types/*'],
+  },
+]

packages/subgraph-service/foundry.toml

@@ -0,0 +1,6 @@
+[profile.default]
+src = 'contracts'
+out = 'build'
+libs = ['node_modules', 'lib']
+test = 'test'
+cache_path  = 'cache_forge'

packages/subgraph-service/hardhat.config.ts

@@ -0,0 +1,12 @@
+import '@nomicfoundation/hardhat-foundry'
+import '@nomicfoundation/hardhat-toolbox'
+import { HardhatUserConfig } from 'hardhat/config'
+
+const config: HardhatUserConfig = {
+  solidity: '0.8.25',
+  paths: {
+    artifacts: './build/contracts',
+  },
+}
+
+export default config

packages/subgraph-service/package.json

@@ -0,0 +1,54 @@
+{
+  "name": "@graphprotocol/subgraph-service",
+  "version": "0.0.1",
+  "description": "",
+  "author": "The Graph Team",
+  "license": "GPL-2.0-or-later",
+  "scripts": {
+    "lint:ts": "eslint '**/*.{js,ts}' --fix",
+    "lint:sol": "forge fmt",
+    "lint": "yarn lint:ts && yarn lint:sol",
+    "clean": "rm -rf build cache typechain-types",
+    "build": "hardhat compile",
+    "test": "forge test"
+  },
+  "devDependencies": {
+    "@graphprotocol/contracts": "workspace:^7.0.0",
+    "@nomicfoundation/hardhat-chai-matchers": "^2.0.0",
+    "@nomicfoundation/hardhat-ethers": "^3.0.0",
+    "@nomicfoundation/hardhat-foundry": "^1.1.1",
+    "@nomicfoundation/hardhat-network-helpers": "^1.0.0",
+    "@nomicfoundation/hardhat-toolbox": "^4.0.0",
+    "@nomicfoundation/hardhat-verify": "^2.0.0",
+    "@typechain/ethers-v6": "^0.5.0",
+    "@typechain/hardhat": "^9.0.0",
+    "@types/chai": "^4.2.0",
+    "@types/mocha": ">=9.1.0",
+    "@types/node": ">=16.0.0",
+    "chai": "^4.2.0",
+    "eslint": "^8.56.0",
+    "eslint-graph-config": "workspace:^0.0.1",
+    "ethers": "^6.4.0",
+    "hardhat": "^2.20.1",
+    "hardhat-gas-reporter": "^1.0.8",
+    "lint-staged": "^15.2.2",
+    "solidity-coverage": "^0.8.0",
+    "ts-node": ">=8.0.0",
+    "typechain": "^8.3.0",
+    "typescript": "^5.3.3"
+  },
+  "lint-staged": {
+    "contracts/**/*.sol": [
+      "yarn lint:sol"
+    ],
+    "**/*.ts": [
+      "yarn lint:ts"
+    ],
+    "**/*.js": [
+      "yarn lint:ts"
+    ],
+    "**/*.json": [
+      "yarn lint:ts"
+    ]
+  }
+}

packages/subgraph-service/remappings.txt

@@ -0,0 +1,5 @@
+@graphprotocol/contracts/=node_modules/@graphprotocol/contracts/
+forge-std/=lib/forge-std/src/
+ds-test/=lib/forge-std/lib/ds-test/src/
+eth-gas-reporter/=node_modules/eth-gas-reporter/
+hardhat/=node_modules/hardhat/

packages/subgraph-service/scripts/deploy.ts

@@ -0,0 +1,28 @@
+import { ethers } from 'hardhat'
+
+async function main() {
+  const currentTimestampInSeconds = Math.round(Date.now() / 1000)
+  const unlockTime = currentTimestampInSeconds + 60
+
+  const lockedAmount = ethers.parseEther('0.001')
+  const a = 1
+  console.log(a)
+  const lock = await ethers.deployContract('Lock', [unlockTime], {
+    value: lockedAmount,
+  })
+
+  await lock.waitForDeployment()
+
+  console.log(
+    `Lock with ${ethers.formatEther(
+      lockedAmount,
+    )}ETH and unlock timestamp ${unlockTime} deployed to ${typeof lock.target == 'string' ? lock.target : ''}`,
+  )
+}
+
+// We recommend this pattern to be able to use async/await everywhere
+// and properly handle errors.
+main().catch((error) => {
+  console.error(error)
+  process.exitCode = 1
+})