tokenbridge/monitor
2019-06-03 09:47:12 -03:00
..
responses Update bridge monitor (#38) 2019-05-14 09:17:03 +02:00
utils Expose stuckTransfer endpoint only if v1 bridge 2019-06-03 09:47:12 -03:00
.env.example Configurable port (#76) 2019-05-30 13:18:48 +02:00
.eslintrc Oracle & Monitor - Compiled ABI's (#71) 2019-05-27 09:22:08 +02:00
alerts.js Fix error handling on monitor workers 2019-05-30 15:05:36 -03:00
checkWorker2.js Fix error handling on monitor workers 2019-05-30 15:05:36 -03:00
checkWorker3.js Add support v1 legacy contracts on monitor 2019-05-31 15:35:50 -03:00
checkWorker.js Add support v1 legacy contracts on monitor 2019-05-31 15:35:50 -03:00
crontab.example Update bridge monitor (#38) 2019-05-14 09:17:03 +02:00
eventsStats.js Fix error handling on monitor workers 2019-05-30 15:05:36 -03:00
getBalances.js Add support v1 legacy contracts on monitor 2019-05-31 15:35:50 -03:00
getShortEventStats.js Add support v1 legacy contracts on monitor 2019-05-31 15:35:50 -03:00
index.js Expose stuckTransfer endpoint only if v1 bridge 2019-06-03 09:47:12 -03:00
logger.js Update bridge monitor (#38) 2019-05-14 09:17:03 +02:00
package.json Update dependencies (#72) 2019-05-25 13:27:52 +02:00
README.md Updates after deployment test (#75) 2019-05-31 14:54:32 +02:00
stuckTransfers.js Add support v1 legacy contracts on monitor 2019-05-31 15:35:50 -03:00
test-srv.js Update bridge monitor (#38) 2019-05-14 09:17:03 +02:00
validators.js Fix error handling on monitor workers 2019-05-30 15:05:36 -03:00

POA Token Bridge / Monitor

Tool for checking balances and unprocessed events in bridged networks.

Overview

Please refer to the POA Token Bridge overview first of all.

This tool allows you to spin up a NODE.JS server to monitor for health of the Token Bridge contracts: check for the balance difference, discover inconsistency in the validators list, catch unhandled transactions.

Examples

Example of an API

  • GET / - check contract balances & tx numbers

{
    "home": {
        "balance": "3710077.6896438415780044",
        "deposits": 481,
        "withdrawals": 221
    },
    "foreign": {
        "totalSupply": "3710077.6896438415780044",
        "deposits": 481,
        "withdrawals": 221
    },
    "balanceDiff": 0,
    "lastChecked": 1529511982,
    "depositsDiff": 0,
    "withdrawalDiff": 0
}
  • GET /validators - check validators balances
{
    "home": {
        "validators": {
            "0x35DC13c72A9C09C8AEEBD0490C7228C43Ccc38Cd": {
                "balance": "19.994900374",
                "leftTx": 66649667913333,
                "gasPrice": 1
            },
            "0x5D44BC8642947685F45004c936245B969F9709a6": {
                "balance": "19.993736069",
                "leftTx": 66645786896666,
                "gasPrice": 1
            },
            "0x284877074B986A78F01D7Eb1f34B6043b1719002": {
                "balance": "19.995139875",
                "leftTx": 66650466250000,
                "gasPrice": 1
            }
        },
        "requiredSignatures": 2
    },
    "foreign": {
        "validators": {
            "0x35DC13c72A9C09C8AEEBD0490C7228C43Ccc38Cd": {
                "balance": "19.084023268196",
                "leftTx": 28915,
                "gasPrice": 2.2
            },
            "0x5D44BC8642947685F45004c936245B969F9709a6": {
                "balance": "19.086724777075",
                "leftTx": 28919,
                "gasPrice": 2.2
            },
            "0x284877074B986A78F01D7Eb1f34B6043b1719002": {
                "balance": "19.050074813935",
                "leftTx": 28863,
                "gasPrice": 2.2
            }
        },
        "requiredSignatures": 2
    },
    "requiredSignaturesMatch": true,
    "validatorsMatch": true,
    "lastChecked": 1529512164
}
  • GET /eventsStats - check unprocessed events
{
    "onlyInHomeDeposits": [],
    "onlyInForeignDeposits": [],
    "onlyInHomeWithdrawals": [],
    "onlyInForeignWithdrawals": [],
    "lastChecked": 1529512436
}

How to run

Setup

  1. Initialize the monorepository.

  2. Go to the monitor sub-repository:

cd monitor
  1. Create .env file:
cp .env.example .env

Example:

HOME_RPC_URL=https://sokol.poa.network
FOREIGN_RPC_URL=https://kovan.infura.io/mew
HOME_BRIDGE_ADDRESS=0xABb4C1399DcC28FBa3Beb76CAE2b50Be3e087353
FOREIGN_BRIDGE_ADDRESS=0xE405F6872cE38a7a4Ff63DcF946236D458c2ca3a
GAS_PRICE_SPEED_TYPE=standard
GAS_LIMIT=300000
GAS_PRICE_FALLBACK=21
LEFT_TX_THRESHOLD=100

Check balances of contracts and validators

node checkWorker.js

Check unprocessed events

node checkWorker2.js

Run web interface

yarn start

To enabled debug logging, set DEBUG=1 env variable.

You can create cron job to run workers (see crontab.example for reference):

#crontab -e
*/4 * * * * cd $HOME/bridge-monitor; node checkWorker.js >>cronWorker.out 2>>cronWorker.err
*/5 * * * * cd $HOME/bridge-monitor; node checkWorker2.js >>cronWorker2.out 2>>cronWorker2.err

You can run web interface via pm2 or similar supervisor program.

Linting

Running linter:

yarn lint

Contributing

See the CONTRIBUTING document for contribution, testing and pull request protocol.

License

License: LGPL v3.0

This project is licensed under the GNU Lesser General Public License v3.0. See the LICENSE file for details.