@eth-optimism/common-ts/src/base-service/validators.ts

[Optimism] Advanced typescript tooling used by various services

import {
  str,
  bool,
  num,
  email,
  host,
  port,
  url,
  json,
  makeValidator,
} from 'envalid'
import { Provider } from '@ethersproject/abstract-provider'
import { Signer } from '@ethersproject/abstract-signer'
import { ethers } from 'ethers'

import { LogLevel, logLevels } from '../common'

const provider = makeValidator<Provider>((input) => {
  const parsed = url()._parse(input)
  return new ethers.providers.JsonRpcProvider(parsed)
})

const jsonRpcProvider = makeValidator<ethers.providers.JsonRpcProvider>(
  (input) => {
    const parsed = url()._parse(input)
    return new ethers.providers.JsonRpcProvider(parsed)
  }
)

const staticJsonRpcProvider =
  makeValidator<ethers.providers.StaticJsonRpcProvider>((input) => {
    const parsed = url()._parse(input)
    return new ethers.providers.StaticJsonRpcProvider(parsed)
  })

const wallet = makeValidator<Signer>((input) => {
  if (!ethers.utils.isHexString(input)) {
    throw new Error(`expected wallet to be a hex string`)
  } else {
    return new ethers.Wallet(input)
  }
})

const logLevel = makeValidator<LogLevel>((input) => {
  if (!logLevels.includes(input as LogLevel)) {
    throw new Error(`expected log level to be one of ${logLevels.join(', ')}`)
  } else {
    return input as LogLevel
  }
})

const address = makeValidator<string>((input) => {
  if (!ethers.utils.isHexString(input, 20)) {
    throw new Error(`expected input to be an address: ${input}`)
  } else {
    return input as `0x${string}`
  }
})

export const validators = {
  str,
  bool,
  num,
  email,
  host,
  port,
  url,
  json,
  wallet,
  provider,
  jsonRpcProvider,
  staticJsonRpcProvider,
  logLevel,
  address,
}