leapdao / eth-node-healthcheck

Geth/Parity node healthcheck endpoint. Check the node is in sync with the network

eth-node-healthcheck

Little http node.js server to run along the ethereum node. Node needs to have JSONRPC enabled. Returns 503 Service Unavailable if the last block number on the local node is off by 3 or more blocks from the last block number from Infura node. Otherwise returns 200 OK.

Supported networks:

Installation

npm install -g eth-node-healthcheck

Run

Configuration parameters (set as ENV variables):

• RPC_HOST — hostname where your node JSON RPC is running. Default: localhost

• NETWORK — network name. Supported networks:

  • homestead
  • rinkeby
  • ropsten
  • kovan
  • goerli

• PORT — port to run this service on

Example for mainnet:

RPC_HOST=127.0.0.1 NETWORK=homestead PORT=50336 eth-node-healthcheck

Make sure the process is detached from the terminal. Make sure the port is open for incoming connections.

License

MIT

eth-node-healthcheck's Issues

Ropsten support

Any particual reason why this healthcheck only supports rinkeby and mainnet?
I'm trying to set this up for my ropsten nodes too (it works great on mainnet nodes) but it doesn't work (returned values are always as if the node is on mainnet)

Is there any simple way to bypass this and use ropsten provider?

etherscan api key not used

Hey,

thanks for this module. While reviewing the code I noticed that there seems to be no usage of the etherscan api key. So it won't be used at all, is that right? I assume it still works, because etherscan is kind of lazy about api key usage, though.

Best,

Caspar.