dusk-rusk 1.6.0

Rusk is the Dusk Network node implementation
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

// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at http://mozilla.org/MPL/2.0/.
//
// Copyright (c) DUSK NETWORK. All rights reserved.

pub(crate) mod command;
#[cfg(feature = "recovery-state")]
mod state;

use std::path::PathBuf;

use clap::Parser;
use clap::builder::PossibleValuesParser;

#[derive(Parser, Debug)]
#[command(
    author="Dusk Network B.V. All Rights Reserved.",
    version = &rusk::VERSION_BUILD[..],
    about = "Rusk server node",
)]
pub struct Args {
    /// Sets the profile path
    #[clap(long, short, env = "RUSK_CONFIG_TOML", value_parser)]
    pub config: Option<PathBuf>,

    /// Output log level
    #[clap(long)]
    pub log_level: Option<tracing::Level>,

    // Change the log format accordingly
    #[clap(long, value_parser = PossibleValuesParser::new(["coloured", "plain", "json"]))]
    pub log_type: Option<String>,

    /// Add log filter(s)
    #[clap(long)]
    pub log_filter: Option<String>,

    /// Sets the profile path
    #[clap(long, value_parser)]
    pub profile: Option<PathBuf>,

    #[cfg(feature = "ephemeral")]
    /// Ephemeral state file (archive)
    #[clap(short, long = "state", value_parser)]
    pub state_path: Option<PathBuf>,

    #[clap(long, value_parser)]
    /// path to blockchain database
    pub db_path: Option<PathBuf>,

    #[clap(long, value_parser)]
    /// path to encrypted BLS keys
    pub consensus_keys_path: Option<PathBuf>,

    #[clap(long)]
    /// height at which migration will be performed
    pub migration_height: Option<u64>,

    #[clap(long)]
    /// Delay in milliseconds to mitigate UDP drops for DataBroker service in
    /// localnet
    pub delay_on_resp_msg: Option<u64>,

    #[clap(long)]
    /// Address http server should listen on
    pub http_listen_addr: Option<String>,

    #[clap(long)]
    /// Address telemetry server should listen on
    pub telemetry_listen_addr: Option<String>,

    #[clap(long, env = "KADCAST_BOOTSTRAP", verbatim_doc_comment)]
    /// Kadcast list of bootstrapping server addresses
    pub kadcast_bootstrap: Option<Vec<String>>,

    #[clap(long, env = "KADCAST_PUBLIC_ADDRESS", verbatim_doc_comment)]
    /// Public address you want to be identified with. Eg: 193.xxx.xxx.198:9999
    ///
    /// This is the address where other peer can contact you.
    /// This address MUST be accessible from any peer of the network"
    pub kadcast_public_address: Option<String>,

    #[clap(long, env = "KADCAST_LISTEN_ADDRESS", verbatim_doc_comment)]
    /// Optional internal address to listen incoming connections. Eg:
    /// 127.0.0.1:9999
    ///
    /// This address is the one bound for the incoming connections.
    /// Use this argument if your host is not publicly reachable from other
    /// peer in the network (Eg: if you are behind a NAT)
    /// If this is not specified, the public address is used for binding
    /// incoming connection
    pub kadcast_listen_address: Option<String>,

    #[clap(short = 'n', long = "network-id")]
    /// Kadcast network id
    pub kadcast_network_id: Option<u8>,

    /// Utility commands
    #[clap(subcommand)]
    pub command: Option<command::Command>,
}