@hyperlane-xyz/core/dependencies/@eth-optimism-contracts-0.6.0/packages/chain-mon/src/balance-mon/service.ts

Core solidity contracts for Hyperlane

import {
  BaseServiceV2,
  StandardOptions,
  Gauge,
  Counter,
  validators,
} from '@eth-optimism/common-ts'
import { Provider } from '@ethersproject/abstract-provider'
import { ethers } from 'ethers'

import { version } from '../../package.json'

type BalanceMonOptions = {
  rpc: Provider
  accounts: string
}

type BalanceMonMetrics = {
  balances: Gauge
  unexpectedRpcErrors: Counter
}

type BalanceMonState = {
  accounts: Array<{ address: string; nickname: string }>
}

export class BalanceMonService extends BaseServiceV2<
  BalanceMonOptions,
  BalanceMonMetrics,
  BalanceMonState
> {
  constructor(options?: Partial<BalanceMonOptions & StandardOptions>) {
    super({
      version,
      name: 'balance-mon',
      loop: true,
      options: {
        loopIntervalMs: 60_000,
        ...options,
      },
      optionsSpec: {
        rpc: {
          validator: validators.provider,
          desc: 'Provider for network to monitor balances on',
        },
        accounts: {
          validator: validators.str,
          desc: 'JSON array of [{ address, nickname }] to monitor balances of',
          public: true,
        },
      },
      metricsSpec: {
        balances: {
          type: Gauge,
          desc: 'Balances of addresses',
          labels: ['address', 'nickname'],
        },
        unexpectedRpcErrors: {
          type: Counter,
          desc: 'Number of unexpected RPC errors',
          labels: ['section', 'name'],
        },
      },
    })
  }

  protected async init(): Promise<void> {
    this.state.accounts = JSON.parse(this.options.accounts)
  }

  protected async main(): Promise<void> {
    for (const account of this.state.accounts) {
      let balance: ethers.BigNumber
      try {
        balance = await this.options.rpc.getBalance(account.address)
      } catch (err) {
        this.logger.info(`got unexpected RPC error`, {
          section: 'balances',
          name: 'getBalance',
          err,
        })
        this.metrics.unexpectedRpcErrors.inc({
          section: 'balances',
          name: 'getBalance',
        })
        continue
      }

      this.logger.info(`got balance`, {
        address: account.address,
        nickname: account.nickname,
        balance: balance.toString(),
      })

      // Parse the balance as an integer instead of via toNumber() to avoid ethers throwing an
      // an error. We might get rounding errors but we don't need perfect precision here, just a
      // generally accurate sense for what the current balance is.
      this.metrics.balances.set(
        { address: account.address, nickname: account.nickname },
        parseInt(balance.toString(), 10)
      )
    }
  }
}

if (require.main === module) {
  const service = new BalanceMonService()
  service.run()
}