decdn-common 0.1.0

Shared types for deCDN binaries: config schema, identity, CLI args
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

//! Arguments for the `decdn setup` onboarding wizard (ADR 019 Phases 1–2).
//!
//! `setup` is thin orchestration over the existing primitives — `key-gen`,
//! `node bond`, `node register` — gated by pre-flight checks that catch the
//! mis-ordered-step / under-funded-wallet failure class ADR 019 § Context
//! calls out, *before* any transaction is submitted. It introduces no new
//! on-chain logic of its own (#933).

use clap::Args;

use super::node::ChainArgs;

/// `decdn setup --mbps <N> --region <CC>` — run the operator through Phase 1
/// pre-flight checks and Phase 2 on-chain setup, then print a go/no-go
/// readiness summary. The flattened [`ChainArgs`] supplies the same
/// `--rpc-url` / `--capacity-bond-address` / `--keystore` / `--dry-run` /
/// `--json` flags as `node bond` / `node register`.
#[derive(Args, Debug)]
pub struct SetupArgs {
    /// Declared serving capacity in Mbps. The TOKEN bond is read on-chain as
    /// `max(minBond, bondRequired(mbps))` (same as `decdn node bond`); you do
    /// not pass a token amount. Must fall within the governable
    /// `[minCapacityMbps, maxCapacityMbps]` band.
    #[arg(long, value_name = "MBPS")]
    pub mbps: u64,

    /// ISO 3166-1 alpha-2 country code submitted as the on-chain `regionHint`
    /// (ADR 030) at registration — e.g. `US`, `DE`. Self-reported.
    #[arg(long, value_name = "CODE")]
    pub region: String,

    /// QUIC multiaddr to register, e.g. `/ip4/203.0.113.10/udp/4433/quic-v1`.
    /// Repeatable. The node listens on the same port over IPv4 and IPv6, so a
    /// dual-stack host also registers `/ip6/2001:db8::10/udp/4433/quic-v1`.
    /// Omitted, it defaults to the host's public address on
    /// `network.bind_port` when the default route has one. A host behind NAT
    /// registers none, and peers reach it through the relay; pass the
    /// forwarded address here if UDP `network.bind_port` is forwarded.
    #[arg(long = "multiaddr", value_name = "MA")]
    pub multiaddrs: Vec<String>,

    /// Skip the interactive confirmation of the bond amount and submit without
    /// prompting (for non-interactive / CI use). The keystore password still
    /// comes from `DECDN_KEYSTORE_PASSWORD` / `--keystore-password-file`.
    #[arg(long)]
    pub yes: bool,

    /// Accept the network's current operator terms non-interactively (ADR 019
    /// § Terms Acceptance). Separate from `--yes` (which only skips the bond
    /// confirmation): terms acceptance is always its own explicit act. On a
    /// terminal the terms are shown and confirmed interactively instead.
    #[arg(long = "accept-terms")]
    pub accept_terms: bool,

    /// Chain coordinates: RPC endpoint, contract addresses, and keystore.
    #[command(flatten)]
    pub chain: ChainArgs,
}