noosphere-ns 0.9.3

A P2P name system for Noosphere
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

#![cfg(not(target_arch = "wasm32"))]

use crate::cli::address::{
    deserialize_multiaddr, deserialize_socket_addr, deserialize_url, parse_cli_address,
};
use clap::{Parser, Subcommand};
use noosphere_core::data::{Did, LinkRecord};
use noosphere_ns::{DhtConfig, Multiaddr};
use serde::Deserialize;
use std::net::SocketAddr;
use std::path::PathBuf;
use url::Url;

#[derive(Parser)]
#[command(author, version, about, long_about=None, name = "orb-ns")]
pub struct CLI {
    #[command(subcommand)]
    pub command: CLICommand,
}

#[derive(Subcommand)]
pub enum CLICommand {
    /// Run a node in the Noosphere Name System.
    Run {
        /// The path to the bootstrap configuration, a TOML file, containing
        /// entries for keyname/port pairs.
        #[arg(short, long)]
        config: Option<PathBuf>,

        /// If no configuration path provided, the name of the Noosphere keypair to use
        /// stored in `~/.noosphere/keys/`.
        #[arg(short, long)]
        key: Option<String>,

        /// If no configuration path provided, the listening address of this DHT node.
        #[arg(
            short,
            long,
            value_parser = parse_cli_address::<Multiaddr>
        )]
        listening_address: Option<Multiaddr>,

        /// If no configuration path provided, the HTTP listening port of the
        /// API web server associated with this DHT node.
        #[arg(
            long,
            value_parser = parse_cli_address::<SocketAddr>
        )]
        api_address: Option<SocketAddr>,

        /// If no configuration path provided, a list of bootstrap peers
        /// to connect to in addition to the default bootstrap peers.
        #[arg(short, long)]
        peers: Option<Vec<Multiaddr>>,

        /// If no configuration path provided, disables the usage of
        /// the default bootstrap peers.
        #[arg(long, default_value_t = false)]
        no_default_peers: bool,

        /// If no configuration path provided, the URL to a Kubo HTTP RPC
        /// service to resolve content-addressable content.
        #[arg(
            long,
            value_parser = parse_cli_address::<Url>
        )]
        ipfs_api_url: Option<Url>,
    },

    /// Utility to create keys compatible with Noosphere.
    KeyGen {
        /// The name of the key to be stored in `~/.noosphere/keys/`.
        #[arg(short, long)]
        key: String,
    },

    Status {
        #[arg(short, long, value_parser = parse_cli_address::<Url>)]
        api_url: Url,
    },

    #[command(subcommand)]
    Records(CLIRecords),

    #[command(subcommand)]
    Peers(CLIPeers),
}

#[derive(Subcommand)]
pub enum CLIRecords {
    Get {
        identity: Did,
        #[arg(short, long, value_parser = parse_cli_address::<Url>)]
        api_url: Url,
    },
    Put {
        record: LinkRecord,
        #[arg(short, long, value_parser = parse_cli_address::<Url>)]
        api_url: Url,
    },
}

#[derive(Subcommand)]
pub enum CLIPeers {
    Ls {
        #[arg(short, long, value_parser = parse_cli_address::<Url>)]
        api_url: Url,
    },
    Add {
        peer: Multiaddr,
        #[arg(short, long, value_parser = parse_cli_address::<Url>)]
        api_url: Url,
    },
}

#[derive(Debug, Deserialize)]
pub struct CLIConfigFile {
    pub key: String,
    #[serde(default, deserialize_with = "deserialize_multiaddr")]
    pub listening_address: Option<Multiaddr>,
    #[serde(default, deserialize_with = "deserialize_socket_addr")]
    pub api_address: Option<SocketAddr>,
    #[serde(default)]
    pub peers: Vec<Multiaddr>,
    #[serde(default)]
    pub no_default_peers: bool,
    #[serde(default)]
    pub dht_config: DhtConfig,
    #[serde(default, deserialize_with = "deserialize_url")]
    pub ipfs_api_url: Option<Url>,
}