@uma/liquidator

UMA Liquidator

Usage no npm install needed!

<script type="module">
  import umaLiquidator from 'https://cdn.skypack.dev/@uma/liquidator';
</script>

README

@uma/liquidator

This package contains the UMA Liquidation bot reference implementation. This executable will watch an ExpiringMultiParty contract for undercollateralized positions and liquidate them.

For more information about running a liquidator bot, see the docs.

Installing the package

yarn add @uma/liquidator

Note: this is a local installation, meaning it instructs yarn to install into the current package/directory. It can be installed globally if you'd like the executable to be accessible everywhere.

Running the liquidator

The simplest way to run the liquidator (with default parameters and price feeds) is:

EMP_ADDRESS=0x1234 CUSTOM_NODE_URL=https://your.node.url.io MNEMONIC="your mnemonic (12-word seed phrase) here" yarn liquidator --network mainnet_mnemonic

Other networks and private keys

Check out the docs for more options on how to plug in your private keys in different ways or use different networks.

More customization options

See here for a full list of environment variables that can be provided to customize the disputer.