Health Check: Endpoints

[adamantmm]

See also: Health Check: Algorithm, General Description

For the health check, we receive the current node height or the update timestamp for a service.
Receiving the node version is optional and is done only if no additional requests are required.

Node and Service Health Check Endpoints

Node or Service	Health Check Endpoint	Comments
adm-node (no service/indexer)	https://endless.adamant.im/api/node/status	Includes node version
Currencyinfo service	https://info.adamant.im/status	Includes software version
btc-node	Single RPC request combining getblockchaininfo and getnetworkinfo Example: curl --data-binary '[{"jsonrpc":"1.0","id":"curltext1","method":"getblockchaininfo","params":[]}, {"jsonrpc":"1.0","id":"curltext2","method":"getnetworkinfo","params":[]}]' -H 'content-type:text/plain;' https://dogenode1.adamant.im	Includes node version
btc-indexer	https://btcnode2.adamant.im/blocks/tip/height	No endpoint to get Indexer’s version
eth-node	Single RPC request combining eth_blockNumber and web3_clientVersion Example: curl --data '[{"method":"eth_blockNumber","params":[],"id":1,"jsonrpc":"2.0"}, {"method":"web3_clientVersion","params":[],"id":2,"jsonrpc":"2.0"}]' -H "Content-Type: application/json" -X POST localhost:8545 Response: [{"id":1,"result":"0x120802f"}, {"id":2,"result":"Geth/v1.13.5-stable-916d6a44/linux-amd64/go1.21.4"}] Client names look like: Geth/v1.13.5, Nethermind/v1.22.0	Includes node version
eth-indexer	https://ethnode3.adamant.im/max_block	Includes software version
doge-node	Single RPC request combining getblockchaininfo and getnetworkinfo Example: curl --data-binary '[{"jsonrpc":"1.0","id":"curltext1","method":"getblockchaininfo","params":[]}, {"jsonrpc":"1.0","id":"curltext2","method":"getnetworkinfo","params":[]}]' -H 'content-type:text/plain;' https://btcnode1.adamant.im/bitcoind	Includes node version
doge-indexer	https://dogenode1.adamant.im/api/status	Includes node (not service/indexer) version
dash-node (no service/indexer)	getStatus RPC (combine getnetworkinfo for version + getblockchaininfo for height)	Includes node version
lsk-node (kly-node)	system_getNodeInfo RPC	Includes node version
lsk-service (kly-service)	https://klyservice2.adamant.im/api/v3/network/status	Includes node (not service/indexer) version
ipfs-node	https://ipfs4.adm.im/api/node/info	Includes node version In process: add more IPFS info for Health check

[al-onyxprotocol]

Hi,

I think this structure makes sense:

• Height/timestamp is the baseline metric for liveness and sync
• Version info is optional — good to have when it comes “for free” from the same endpoint, but not worth extra network calls

I like that you’re distinguishing between node endpoints and indexer/service endpoints.

Future improvements

• IPFS: adding peer count, swarm connect, or repo stats would make the health check more informative
• Rate limiting: important to make sure these checks don’t overload nodes (especially public ones)