@graphprotocol/toolshed/src/deployments/contract.ts

A collection of tools and utilities for the Graph Protocol Typescript components

import { getInterface } from '@graphprotocol/interfaces'
import { Contract, Provider, Signer } from 'ethers'

import { wrapTransactionCalls } from './tx-logging'

export type ContractList<T extends string = string> = Partial<Record<T, unknown>>

/**
 * Loads a contract from an address book
 *
 * @param name Name of the contract
 * @param address Contract address
 * @param signerOrProvider Signer or provider to use
 * @param enableTxLogging Enable transaction logging to console and output file. Defaults to false.
 * @returns the loaded contract
 *
 * @throws Error if the contract could not be loaded
 */
export function loadContract<ContractName extends string = string>(
  name: ContractName,
  address: string,
  signerOrProvider?: Signer | Provider,
  enableTxLogging?: boolean,
): Contract {
  try {
    let contract = new Contract(address, getInterface(name), signerOrProvider)

    if (signerOrProvider) {
      contract = contract.connect(signerOrProvider) as Contract
    }

    if (enableTxLogging) {
      contract = wrapTransactionCalls(contract, name)
    }

    return contract
  } catch (err: unknown) {
    if (err instanceof Error) {
      throw new Error(`Could not load contract ${name} - ${err.message}`)
    } else {
      throw new Error(`Could not load contract ${name}`)
    }
  }
}