Skip to content

bcdevtools/node-setup-check

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

49 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Node setup check

  • Validator node
  • RPC node
  • Snapshot node
  • Archival node
nodesc check ~/.node_home --type validator/rpc/snapshot/archival

Nginx config generator

nodesc gen-nginx \
  --rpc rpc.mychain.testnet.example.com \
  --rest rest.mychain.testnet.example.com \
  --jsonrpc jsonrpc.mychain.testnet.example.com \
  [--rpc-port 26657] \
  [--rest-port 1317] \
  [--jsonrpc-port 8545]

Install

cd ~ && go install github.com/bcdevtools/node-setup-check/cmd/nodesc@latest

Spec

  • Check permission of all files
  • Check pruning settings
    • Validator node
    • RPC node
    • Snapshot node
    • Archival node
  • Check snapshot settings
    • Validator node: should disable
    • Non-validator: should enable
  • Check keyring settings
    • Validator node: should have keyring file
    • Non-validator: should not have keyring
  • Double sign check
    • Validator node: 10
    • Non-validator node: 0
  • P2P port check
    • Should not be default port 26656
  • API & Json-RPC settings
    • Validator node
      • Disable API
      • Disable Json-RPC
    • RPC node
      • Enable API
      • Enable Json-RPC
  • Check peers config:
    • Maximum inbound & outbound peers, should greater than default
    • Seeds should be set
    • Persistent peers should be set
  • Suggest firewall
    • Validator: allow P2P, close other ports
    • RPC: allow P2P, RPC, Rest API, Json-RPC
    • Snapshot: allow P2P, close other ports
    • Archival: allow P2P, RPC, Rest API, Json-RPC
  • Check tx index config:
    • Validator: should disable
    • RPC: should enable
    • Archival: should enable
  • Check service
    • Do not auto restart
    • Do not enable on boot