hardhat-graph-protocol/src/config.ts

A hardhat plugin that extends the runtime environment to inject additional functionality related to the usage of the Graph Protocol.

import type { GraphDeploymentName } from '@graphprotocol/toolshed/deployments'
import fs from 'fs'
import type { HardhatRuntimeEnvironment } from 'hardhat/types'
import path from 'path'

import { GraphPluginError } from './error'
import { logDebug } from './logger'
import type { GraphRuntimeEnvironmentOptions } from './types'

export function getAddressBookPath(
  deployment: GraphDeploymentName,
  hre: HardhatRuntimeEnvironment,
  opts: GraphRuntimeEnvironmentOptions,
): string | undefined {
  const optsPath = getPath(opts.deployments?.[deployment])
  const networkPath = getPath(hre.network.config.deployments?.[deployment])
  const globalPath = getPath(hre.config.graph?.deployments?.[deployment])

  logDebug(`Getting address book path...`)
  logDebug(`Graph base dir: ${hre.config.paths.graph}`)
  logDebug(`1) opts: ${optsPath}`)
  logDebug(`2) network: ${networkPath}`)
  logDebug(`3) global: ${globalPath}`)

  const addressBookPath = optsPath ?? networkPath ?? globalPath
  if (addressBookPath === undefined) {
    return undefined
  }

  const normalizedAddressBookPath = normalizePath(addressBookPath, hre.config.paths.graph)
  logDebug(`Address book path: ${normalizedAddressBookPath}`)

  if (!fs.existsSync(normalizedAddressBookPath)) {
    if (opts.createAddressBook) {
      logDebug(`Creating address book: ${normalizedAddressBookPath}`)
      fs.writeFileSync(normalizedAddressBookPath, '{}')
    } else {
      throw new GraphPluginError(`Address book not found: ${normalizedAddressBookPath}`)
    }
  }

  return normalizedAddressBookPath
}

function normalizePath(_path: string, graphPath?: string): string {
  if (!path.isAbsolute(_path) && graphPath !== undefined) {
    _path = path.join(graphPath, _path)
  }
  return _path
}

function getPath(
  value:
    | string
    | {
        addressBook: string
      }
    | undefined,
): string | undefined {
  if (typeof value === 'string') {
    return value
  } else if (value && typeof value == 'object') {
    return value.addressBook
  }
  return
}