discv5-cli 0.7.1

Simple CLI utility for creating and debugging discovery v5 servers
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
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
105
106
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
132
133
134
135
136
137
138
139
140
141
142
143
144

use clap::{Args, Subcommand as ClapSubcommand};

/// Server Subcommand
#[derive(ClapSubcommand, Clone, Debug, PartialEq, Eq, PartialOrd, Ord, Default)]
pub enum ServerSubcommand {
    /// Queries random node ids.
    #[default]
    Query,
    /// Prints the event stream.
    Events,
}

/// Server Command
#[derive(Args, Default, Debug, Clone, PartialEq, Eq, PartialOrd, Ord)]
pub struct Server {
    /// The service to run once the server is started.
    #[clap(subcommand)]
    pub service: ServerSubcommand,
    /// Specifies the listening address of the server.
    #[clap(
        short = 'l',
        long = "listen-addresses",
        help = "Specifies the listening address(es) of the server. A comma separated string can specify ipv4 and ipv6 addresses for dual stack.",
        default_value = "0.0.0.0"
    )]
    pub listen_addresses: String,
    /// Specifies the listening UDP port of the server.
    #[clap(
        short = 'p',
        long = "listen-port",
        help = "Specifies the listening UDP port of the server.",
        default_value = "9000"
    )]
    pub listen_port: u16,
    /// Optionally specify the listening ipv6 port.
    #[clap(
        short = 'p',
        long = "listen-port-v6",
        help = "Specifies the listening UDP port of the server if an ipv6 address is specified as a listening address."
    )]
    pub listen_port_v6: Option<u16>,
    /// Specifies the IP address of the ENR record. Not specifying this results in an ENR with no IP field, unless the -w switch is used.
    #[clap(
        short = 'i',
        long = "enr-addresses",
        help = "Specifies the IP address(es) of the ENR record. Not specifying this results in an ENR with no IP field, unless the -w switch is used. These can be a comma separated addresses of ipv4,ipv6. Only the last two are used."
    )]
    pub enr_addresses: Option<String>,
    /// Specifies the UDP port of the ENR record. Not specifying this results in an ENR with no UDP field, unless the -w switch is used.
    #[clap(
        short = 'u',
        long = "enr-v4-port",
        help = "Specifies the UDP port of the ENR record corresponding to ipv4 address. Not specifying this results in an ENR with no UDP field, unless the -w switch is used."
    )]
    pub enr_v4_port: Option<u16>,
    /// The port associated with an ipv6 address.
    #[clap(
        short = 'u',
        long = "enr-v6-port",
        help = "Specifies the UDP port of the ENR record corresponding to ipv6 address. Not specifying this results in an ENR with no UDP field, unless the -w switch is used."
    )]
    pub enr_v6_port: Option<u16>,
    /// Specifies the ENR sequence number when creating the ENR.
    #[clap(
        short = 'q',
        long = "enr-seq-no",
        help = "Specifies the ENR sequence number when creating the ENR."
    )]
    pub enr_seq_no: Option<String>,
    /// Specifies the Eth2 field as ssz encoded hex bytes.
    #[clap(
        short = 'd',
        long = "enr-eth2",
        help = "Specifies the Eth2 field as ssz encoded hex bytes."
    )]
    pub enr_eth2: Option<String>,
    /// The Enr IP address and port will be the same as the specified listening address and port.
    #[clap(
        short = 'w',
        long = "enr-default",
        help = "The Enr IP address and port will be the same as the specified listening address and port."
    )]
    pub enr_default: bool,
    /// Use a fixed static key (hard-coded). This is primarily for debugging.
    #[clap(
        short = 'k',
        long = "static-key",
        help = "Use a fixed static key (hard-coded). This is primarily for debugging."
    )]
    pub static_key: bool,
    /// Specify a secp256k1 private key (hex encoded) to use for the nodes identity.
    #[clap(
        short = 't',
        long = "secp256k1-key",
        help = "Specify a secp256k1 private key (hex encoded) to use for the nodes identity."
    )]
    pub secp256k1_key: Option<String>,
    /// A base64 ENR that this node will initially connect to.
    #[clap(
        short = 'e',
        long = "enr",
        allow_hyphen_values = true,
        help = "A base64 ENR that this node will initially connect to."
    )]
    pub enr: Option<String>,
    /// The minimum number of peers required to update the IP address. Cannot be less than 2.
    #[clap(
        short = 'n',
        long = "peer-update-min",
        help = "The minimum number of peers required to update the IP address. Cannot be less than 2.",
        default_value = "2"
    )]
    pub peer_update_min: u64,
    /// The time to wait between successive searches. Default is 10 seconds.
    #[clap(
        short = 'b',
        long = "break-time",
        help = "The time to wait between successive searches. Default is 10 seconds.",
        default_value = "10"
    )]
    pub break_time: u64,
    /// Displays statistics on the local routing table.
    #[clap(
        short = 's',
        long = "stats",
        help = "Displays statistics on the local routing table.",
        default_value = "10"
    )]
    pub stats: u64,
    /// Prevents the server from doing any peer searches.
    #[clap(
        short = 'x',
        long = "no-search",
        help = "Prevents the server from doing any peer searches."
    )]
    pub no_search: bool,
    /// Bootstraps the server peers
    #[clap(
        short = 'o',
        long = "bootstrap",
        help = "Bootstraps the server peers from a specified file."
    )]
    pub bootstrap: Option<String>,
}