Skip to main content

Node Commands (modal node)

Manage network nodes — create, run, and monitor.

Create

modal node create [OPTIONS]

Create a new node directory with configuration.

Options:

OptionDescription
--path <PATH>Node directory (default: ./node)
--network <NET>Network (mainnet/testnet)
--name <NAME>Node name

Creates:

node/
├── config.json # Node configuration
├── node.passfile # Node identity
├── data/ # Chain data
└── logs/ # Log files

Lifecycle Commands

Start

modal node start [OPTIONS]

Start a node in the background.

Options:

OptionDescription
--path <PATH>Node directory
--detachRun in background (default)

Stop

modal node stop [OPTIONS]

Gracefully stop a running node.

Restart

modal node restart [OPTIONS]

Restart a running node.

Kill

modal node kill [OPTIONS]

Forcefully kill a node process.

PID

modal node pid [OPTIONS]

Display the PID of a running node.

Run Commands (Foreground)

Run nodes in the foreground (useful for debugging).

Run Miner

modal node run-miner [OPTIONS]

Run a mining node that participates in block production.

Options:

OptionDescription
--path <PATH>Node directory
--threads <N>Mining threads

Run Validator

modal node run-validator [OPTIONS]

Run a validator node (observes and validates, doesn't mine).

Run Observer

modal node run-observer [OPTIONS]

Run an observer node (read-only, syncs chain).

Run Noop

modal node run-noop [OPTIONS]

Run a minimal node (only auto-upgrade, no network).

Information Commands

Info

modal node info [OPTIONS]

Display information about a node.

Example output:

NODE: my-node
Status: running
PID: 12345
Network: mainnet
Chain height: 1,234,567
Peers: 12
Uptime: 3d 4h 12m

Address

modal node address [OPTIONS]

Display the listening addresses of a node.

Example output:

/ip4/192.168.1.100/tcp/9000/p2p/12D3KooWExample...
/ip4/127.0.0.1/tcp/9000/p2p/12D3KooWExample...

Inspect

modal node inspect [OPTIONS]

Inspect a node's state (works for running or offline nodes).

Options:

OptionDescription
--path <PATH>Node directory
--chainShow chain info
--peersShow peer info
--configShow configuration

Compare

modal node compare <PEER> [OPTIONS]

Compare local chain with a remote peer.

Options:

OptionDescription
--path <PATH>Local node directory
--verboseShow block-by-block comparison

Logs

modal node logs [OPTIONS]

Tail the logs of a running node.

Options:

OptionDescription
--path <PATH>Node directory
--follow, -fFollow log output
--lines <N>Number of lines to show

Stats

modal node stats [OPTIONS]

Display summary statistics from recent blocks.

Network Operations

Ping

modal node ping <PEER> [OPTIONS]

Ping a remote Modality node.

Example:

modal node ping /ip4/peer.modality.network/tcp/9000/p2p/12D3Koo...

Sync

modal node sync [OPTIONS]

Sync blockchain from network peers.

Options:

OptionDescription
--path <PATH>Node directory
--peer <ADDR>Specific peer to sync from
--from <HEIGHT>Start height

Maintenance

Config

modal node config [OPTIONS]

View or modify node configuration.

Options:

OptionDescription
--path <PATH>Node directory
--get <KEY>Get config value
--set <KEY=VALUE>Set config value

Clear

modal node clear [OPTIONS]

Clear both storage and logs from a node.

Options:

OptionDescription
--path <PATH>Node directory
--confirmSkip confirmation prompt

Clear Storage

modal node clear-storage [OPTIONS]

Clear only storage (keep logs).

Hub Commands

The contract hub is a collaborative server for multi-party contracts.

Start Hub

modal hub start [OPTIONS]

Start the contract hub server.

Options:

OptionDescription
--detachRun in background
--port <PORT>Listen port (default: 8080)
--data <PATH>Data directory

Stop Hub

modal hub stop

Hub Status

modal hub status

Register Identity

modal hub register [OPTIONS]

Register your identity with the hub.

Options:

OptionDescription
--passfile <PATH>Identity passfile
--hub <URL>Hub URL

Create Hub Contract

modal hub create <NAME> [OPTIONS]

Create a new contract on the hub.

Options:

OptionDescription
--description <DESC>Contract description
--passfile <PATH>Creator identity

Grant Access

modal hub grant <CONTRACT_ID> [OPTIONS]

Grant access to a contract.

Options:

OptionDescription
--identity <ID>Identity to grant
--role <ROLE>Role (reader/writer/admin)