Skip to content

directory_server.cli

directory_server.cli

CLI commands for directory server management.

Functions:

format_status_output(stats: dict) -> str

Source code in directory_server/src/directory_server/cli.py 
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
def format_status_output(stats: dict) -> str:
    lines = [
        "=== Directory Server Status ===",
        f"Network: {stats['network']}",
        f"Uptime: {stats['uptime_seconds']:.0f}s ({stats['uptime_seconds'] / 3600:.1f}h)",
        f"Status: {stats['server_status']}",
        f"Connected peers: {stats['connected_peers']['total']}/{stats['max_peers']}",
    ]

    if stats["connected_peers"]["nicks"]:
        lines.append(f"  Nicks: {', '.join(stats['connected_peers']['nicks'][:20])}")
        if len(stats["connected_peers"]["nicks"]) > 20:
            remaining = len(stats["connected_peers"]["nicks"]) - 20
            lines.append(f"  ... and {remaining} more")

    lines.extend(
        [
            f"Passive peers (orderbook watchers): {stats['passive_peers']['total']}",
        ]
    )

    if stats["passive_peers"]["nicks"]:
        lines.append(f"  Nicks: {', '.join(stats['passive_peers']['nicks'][:20])}")
        if len(stats["passive_peers"]["nicks"]) > 20:
            remaining = len(stats["passive_peers"]["nicks"]) - 20
            lines.append(f"  ... and {remaining} more")

    lines.extend(
        [
            f"Active peers (makers): {stats['active_peers']['total']}",
        ]
    )

    if stats["active_peers"]["nicks"]:
        lines.append(f"  Nicks: {', '.join(stats['active_peers']['nicks'][:20])}")
        if len(stats["active_peers"]["nicks"]) > 20:
            remaining = len(stats["active_peers"]["nicks"]) - 20
            lines.append(f"  ... and {remaining} more")

    lines.extend(
        [
            f"Active connections: {stats['active_connections']}",
        ]
    )

    # Add offer stats if available
    if "offers" in stats:
        offer_stats = stats["offers"]
        lines.extend(
            [
                "",
                "Offers:",
                f"  Total offers: {offer_stats['total_offers']}",
                f"  Peers with offers: {offer_stats['peers_with_offers']}",
            ]
        )

        # Show peers with more than 2 offers
        if offer_stats.get("peers_many_offers"):
            peers_many = offer_stats["peers_many_offers"]
            if peers_many:
                lines.append("  Peers with >2 offers:")
                for nick, count in peers_many:
                    lines.append(f"    {nick}: {count} offers")

    # Add rate limiter stats if available
    if "rate_limiter" in stats:
        rl_stats = stats["rate_limiter"]
        lines.extend(
            [
                "",
                "Rate Limiting:",
                f"  Tracked connections: {rl_stats['tracked_peers']}",
                f"  Total violations: {rl_stats['total_violations']}",
            ]
        )

        # Show top violators if any
        if rl_stats.get("top_violators"):
            top_violators = rl_stats["top_violators"][:5]  # Show top 5
            if top_violators:
                lines.append("  Top violators (by connection):")
                for conn_id, count in top_violators:
                    # Connection IDs are IP:port format - display as-is
                    lines.append(f"    {conn_id}: {count} violations")

    lines.append("===============================")

    return "\n".join(lines)

health_command(args: argparse.Namespace) -> int

Source code in directory_server/src/directory_server/cli.py 
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
def health_command(args: argparse.Namespace) -> int:
    url = f"http://{args.host}:{args.port}/health"

    try:
        with urlopen(url, timeout=5) as response:
            data = json.loads(response.read().decode())

            if args.json:
                print(json.dumps(data, indent=2))
            else:
                status = data.get("status", "unknown")
                print(f"Server status: {status}")

            return 0 if data.get("status") == "healthy" else 1

    except URLError:
        print("Error: Server unhealthy or unreachable", file=sys.stderr)
        return 1
    except Exception as e:
        print(f"Error: {e}", file=sys.stderr)
        return 1

main() -> None

Source code in directory_server/src/directory_server/cli.py 
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
def main() -> None:
    exit_if_version_requested(sys.argv[1:])

    from jmcore.process_hardening import harden_current_process

    # Disable core dumps and ptrace before loading directory-node keys.
    harden_current_process()

    # Load settings to get defaults from config
    settings = get_settings()

    parser = argparse.ArgumentParser(
        description="JoinMarket Directory Server CLI",
        formatter_class=SortedHelpFormatter,
    )
    parser.add_argument(
        "--version",
        action="version",
        version=f"JoinMarket NG {get_version()}",
        help="Show the installed JoinMarket NG version and exit.",
    )
    parser.add_argument(
        "--host",
        default=settings.directory_server.health_check_host,
        help=f"Health check server host (default: {settings.directory_server.health_check_host})",
    )
    parser.add_argument(
        "--port",
        type=int,
        default=settings.directory_server.health_check_port,
        help=f"Health check server port (default: {settings.directory_server.health_check_port})",
    )
    parser.add_argument(
        "--log-level",
        "-l",
        default=settings.logging.level,
        help=f"Log level (default: {settings.logging.level})",
    )

    subparsers = parser.add_subparsers(dest="command", help="Available commands")

    # Register subcommands alphabetically so the usage metavar is sorted too.
    health_parser = subparsers.add_parser(
        "health", help="Check server health", formatter_class=SortedHelpFormatter
    )
    health_parser.add_argument("--json", action="store_true", help="Output as JSON")
    health_parser.set_defaults(func=health_command)

    status_parser = subparsers.add_parser(
        "status", help="Get server status", formatter_class=SortedHelpFormatter
    )
    status_parser.add_argument("--json", action="store_true", help="Output as JSON")
    status_parser.set_defaults(func=status_command)

    args = parser.parse_args()

    # Configure logging
    setup_logging(args.log_level)

    if not args.command:
        parser.print_help()
        sys.exit(1)

    sys.exit(args.func(args))

status_command(args: argparse.Namespace) -> int

Source code in directory_server/src/directory_server/cli.py 
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
def status_command(args: argparse.Namespace) -> int:
    url = f"http://{args.host}:{args.port}/status"

    try:
        with urlopen(url, timeout=5) as response:
            data = json.loads(response.read().decode())

            if args.json:
                print(json.dumps(data, indent=2))
            else:
                print(format_status_output(data))

            return 0

    except URLError as e:
        print(f"Error: Could not connect to server at {url}", file=sys.stderr)
        print(f"Details: {e}", file=sys.stderr)
        return 1
    except json.JSONDecodeError as e:
        print("Error: Invalid JSON response from server", file=sys.stderr)
        print(f"Details: {e}", file=sys.stderr)
        return 1
    except Exception as e:
        print(f"Error: {e}", file=sys.stderr)
        return 1