John ShuttandGitHub
f8572441af
* feat(scripts): update transfer scripts and monitors readme and index Signed-off-by: John Shutt <[email protected]> * feat(scripts): add more args to DeployEMP Signed-off-by: John Shutt <[email protected]> * fix(scripts): convert string to number for expiry Signed-off-by: John Shutt <[email protected]> * fix(scripts): convert string to number properly Signed-off-by: John Shutt <[email protected]> * improve(scripts): fix typo in MultiVersionTestHelpers comment Signed-off-by: John Shutt <[email protected]> * improve(scripts): minor improvements Signed-off-by: John Shutt <[email protected]> * improve(docs): monitor config is optional * fix: add some collateral and synthetic defaults and fix an arg in the synthetic script Signed-off-by: John Shutt <[email protected]> * fix(scripts): add collateral back to arg list Signed-off-by: John Shutt <[email protected]> * fix(scripts): clarify variable names Signed-off-by: John Shutt <[email protected]> * fix(scripts): expiry name change in deploy emp script Signed-off-by: John Shutt <[email protected]>
1.5 KiB
@uma/monitors
This package contains four UMA monitor bot implementations: BalanceMonitor, ContractMonitor, CRMonitor, and SyntheticPegMonitor. The monitor bots are used to monitor the UMA ecosystem for key events. They have a number of monitor modules built into them that enable real time reporting on key events for a given Financial Contract.
For more information about running a monitor bot, see the docs.
Installing the package
yarn add @uma/monitors
Running the monitors
The simplest way to run the monitors is:
EMP_ADDRESS=0x1234 CUSTOM_NODE_URL=https://your.node.url.io MNEMONIC="your mnemonic (12-word seed phrase) here" MONITOR_CONFIG="{optional monitor config object}" monitors --network mainnet_mnemonic
Monitors
The four monitors available are:
-
The
BalanceMonitortakes a specified list of addresses to monitor and sends alerts if their collateral, synthetic or Ether balance drops below defined thresholds. -
The
ContractMonitorsends alerts when financial contract events occur, such as liquidations and disputes. -
The
CRMonitor, or collateralization ratio monitor, monitors a given position's CR and sends alerts if it drops below a given threshold. -
The
SyntheticPegMonitormonitors a Financial Contract's synthetic and reports when the synthetic is trading off peg and there is high volatility in the synthetic price or there is high volatility in the reference price.