remmenet¶
The remmenet
command is used to interact with an entire
network of Sawtooth nodes.
usage: remmenet [-h] [-v] [-V] {compare-chains,list-blocks,peers} ...
Inspect status of a sawtooth network
optional arguments:
-h, --help show this help message and exit
-v, --verbose enable more verbose output
-V, --version display version information
subcommands:
{compare-chains,list-blocks,peers}
compare-chains Compare chains from different nodes.
list-blocks List blocks from different nodes.
peers Shows the peering arrangment of a network
remmenet compare-chains¶
The remmenet compare-chains
subcommand compares chains across the specified
nodes.
usage: remmenet compare-chains [-h] [-v] [-V] [--users USERNAME[:PASSWORD]]
[-l LIMIT] [--table] [--tree]
urls [urls ...]
Compute and display information about how the chains at different nodes differ.
positional arguments:
urls The URLs of the validator's REST APIs of interest,
separated by commas or spaces. (no default)
optional arguments:
-h, --help show this help message and exit
-v, --verbose enable more verbose output
-V, --version display version information
--users USERNAME[:PASSWORD]
Specify the users to authorize requests, in the same
order as the URLs, separate by commas. Passing empty
strings between commas is supported.
-l LIMIT, --limit LIMIT
the number of blocks to request at a time
--table Print out a fork table for all nodes since the common
ancestor.
--tree Print out a fork tree for all nodes since the common
ancestor.
By default, prints a table of summary data and a table of per-node data with
the following fields. Pass --tree for a fork graph.
COMMON ANCESTOR
The most recent block that all chains have in common.
COMMON HEIGHT
Let min_height := the minimum height of any chain across all nodes passed
in. COMMON HEIGHT = min_height.
HEAD
The block id of the most recent block on a given chain.
HEIGHT
The block number of the most recent block on a given chain.
LAG
Let max_height := the maximum height of any chain across all nodes passed
in. LAG = max_height - HEIGHT for a given chain.
DIVERG
Let common_ancestor_height := the height of the COMMON ANCESTOR.
DIVERG = HEIGHT - common_ancestor_height
remmenet peers¶
usage: remmenet peers [-h] {list,graph} ...
Shows the peering arrangment of a network.
optional arguments:
-h, --help show this help message and exit
subcommands:
{list,graph}
list Lists peers for validators with given URLs
graph Generates a file to graph a network's peering arrangement
remmenet peers list¶
The remmenet peers list
subcommand displays the peers of the specified nodes.
usage: remmenet peers list [-h] [-v] [-V] [--users USERNAME[:PASSWORD]]
[--pretty]
urls [urls ...]
Lists peers for validators with given URLs.
positional arguments:
urls The URLs of the validator's REST APIs of interest,
separated by commas or spaces. (no default)
optional arguments:
-h, --help show this help message and exit
-v, --verbose enable more verbose output
-V, --version display version information
--users USERNAME[:PASSWORD]
Specify the users to authorize requests, in the same
order as the URLs, separate by commas. Passing empty
strings between commas is supported.
--pretty, -p Pretty-print the results
remmenet peers graph¶
The remmenet peers graph
subcommand displays a file called peers.dot
that describes the peering arrangement of the specified nodes.
usage: remmenet peers graph [-h] [-v] [-V] [--users USERNAME[:PASSWORD]]
[-o OUTPUT] [--force]
urls [urls ...]
Generates a file to graph a network's peering arrangement.
positional arguments:
urls The URLs of the validator's REST APIs of interest,
separated by commas or spaces. (no default)
optional arguments:
-h, --help show this help message and exit
-v, --verbose enable more verbose output
-V, --version display version information
--users USERNAME[:PASSWORD]
Specify the users to authorize requests, in the same
order as the URLs, separate by commas. Passing empty
strings between commas is supported.
-o OUTPUT, --output OUTPUT
The path of the dot file to be produced (defaults to
peers.dot)
--force TODO