# @eth-optimism/balance-monitor

> [Optimism] Forta Agent that reports whether certain accounts have fallen below some balance

Latest version **0.0.4** (published 2023-01-11) · MIT license · 0 weekly downloads

## Install

```sh
npm install @eth-optimism/balance-monitor
pnpm add @eth-optimism/balance-monitor
yarn add @eth-optimism/balance-monitor
bun add @eth-optimism/balance-monitor
```

## Health

**Score 40/100 (D)** — status: abandoned.

Positive: has types; no vulnerabilities; high maintenance score; high quality score.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 0.0.4 |
| Published | 2023-01-11 |
| First published | 2023-01-10 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 23.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 6476 |
| Author | Optimism PBC |
| Maintainers | optibot, kelvinfichter |
| Keywords | optimism, ethereum, forta, monitoring |

## Links

- npm: https://www.npmjs.com/package/@eth-optimism/balance-monitor
- Repository: https://github.com/ethereum-optimism/optimism
- Homepage: https://github.com/ethereum-optimism/optimism/tree/develop/packages/balance-monitor#readme
- Issues: https://github.com/ethereum-optimism/optimism/issues
- npm.io page: https://npm.io/package/@eth-optimism/balance-monitor

## Dependencies (3)

- [ethers](https://npm.io/package/ethers.md) ^5.7.2
- [node-fetch](https://npm.io/package/node-fetch.md) ^2.6.1
- [forta-agent](https://npm.io/package/forta-agent.md) ^0.1.1

## Recent versions

- 0.0.4 (latest) — 2023-01-11
- 0.0.3 — 2023-01-11
- 0.0.2 — 2023-01-10

## README

# Minimum Balance Agent

## Description

A forta agent which detects when a specified account balance is below the
specified threshold.

## Installing and building

`yarn && yarn build`

## Running

1. Copy `.env.example` into `.env` and set the appropriate values.
2. Copy `forta.config.example.json` into `forta.config.json`, and set the RPC endpoint (yes, this is
   duplicated in the .env file).
2. `yarn run start:prod`

## Alerts

- `OPTIMISM-BALANCE-DANGER-[ACCOUNT_NAME]`
  - Fired when the specified account balance is below the configured DANGER threshold
  - Severity is always set to "high"
  - Type is always set to "info"
  - Metadata "balance" field contains amount of wei in account

---
_Source: https://npm.io/package/@eth-optimism/balance-monitor · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._