Skip to content

Commit cfe49d3

Browse files
dr-orlovskydr-orlovsky
committed
Standartize Opts processing
1 parent 6474457 commit cfe49d3

30 files changed

+356
-280
lines changed

‎Cargo.lock

+5-4
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎Cargo.toml

+2-2
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ lnpbp = "0.7.0"
5151
lnp-core = { version = "0.8.0-alpha.1", git = "https://github.com/LNP-WG/lnp-core" }
5252
lnp_rpc = { version = "0.8.0-alpha.1", path = "./rpc" }
5353
internet2 = { version = "0.8.0-beta.1", features = ["keygen"] }
54-
microservices = { version = "0.8.0-rc.6", default-features = false, features = ["node", "peer"], git = "https://github.com/Internet2-WG/rust-microservices" }
54+
microservices = { version = "0.8.0-rc.8", default-features = false, features = ["node", "peer"], git = "https://github.com/Internet2-WG/rust-microservices" }
5555
# Bitcoin
5656
bitcoin = { version = "0.28.1", features = ["rand"] }
5757
miniscript = "7.0.0"
@@ -83,7 +83,7 @@ lightning-invoice = "0.14.0"
8383
lnp-core = { version = "0.8.0-alpha.1", git = "https://github.com/LNP-WG/lnp-core" }
8484
lnp_rpc = { version = "0.8.0-alpha.1", path = "./rpc" }
8585
internet2 = "0.8.0-beta.1"
86-
microservices = { version = "0.8.0-rc.6", default-features = false, features = ["peer"], git = "https://github.com/Internet2-WG/rust-microservices" }
86+
microservices = { version = "0.8.0-rc.8", default-features = false, features = ["peer"], git = "https://github.com/Internet2-WG/rust-microservices" }
8787
clap = { version = "~3.1.18", features = ["env"] }
8888
clap_complete = "~3.1.4"
8989
log = { version = "0.4", features = ["max_level_trace", "release_max_level_debug"] }

‎cli/src/opts.rs

+4-4
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ use std::str::FromStr;
1818
use internet2::addr::{PartialNodeAddr, ServiceAddr};
1919
use lightning_invoice::Invoice;
2020
use lnp::p2p::bolt::{ChannelId, ChannelType};
21-
use lnp_rpc::LNP_NODE_RPC_SOCKET;
21+
use lnp_rpc::LNP_NODE_RPC_ENDPOINT;
2222

2323
/// Command-line tool for working with LNP node
2424
#[derive(Parser, Clone, PartialEq, Eq, Debug)]
@@ -31,11 +31,11 @@ pub struct Opts {
3131
///
3232
/// Defaults to `127.0.0.1:62962`.
3333
#[clap(
34-
short,
34+
short = 'R',
3535
long,
3636
global = true,
37-
default_value = LNP_NODE_RPC_SOCKET,
38-
env = "LNP_NODE_RPC_SOCKET"
37+
default_value = LNP_NODE_RPC_ENDPOINT,
38+
env = "LNP_NODE_RPC_ENDPOINT"
3939
)]
4040
pub connect: ServiceAddr,
4141

‎rpc/src/lib.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -53,4 +53,4 @@ pub use error::{Error, FailureCode};
5353
pub use messages::*;
5454
pub use service_id::{ClientId, ServiceId, ServiceName};
5555

56-
pub const LNP_NODE_RPC_SOCKET: &str = "127.0.0.1:62962";
56+
pub const LNP_NODE_RPC_ENDPOINT: &str = "0.0.0.0:62962";

‎shell/_channeld

+11-8
Original file line numberDiff line numberDiff line change
@@ -17,16 +17,18 @@ _channeld() {
1717
_arguments "${_arguments_options[@]}" \
1818
'-k+[Node key file]:KEY_FILE:_files' \
1919
'--key-file=[Node key file]:KEY_FILE:_files' \
20-
'-d+[<\[_\]<\[_\]>::into_vec(box \[$($x),+\]).into_iter().flatten() are located]:DATA_DIR:_files -/' \
21-
'--data-dir=[<\[_\]<\[_\]>::into_vec(box \[$($x),+\]).into_iter().flatten() are located]:DATA_DIR:_files -/' \
20+
'-d+[Data directory path]:DATA_DIR:_files -/' \
21+
'--data-dir=[Data directory path]:DATA_DIR:_files -/' \
2222
'-c+[Path for the configuration file]:CONFIG:_files' \
2323
'--config=[Path for the configuration file]:CONFIG:_files' \
2424
'-T+[Use Tor]:TOR_PROXY:_hosts' \
2525
'--tor-proxy=[Use Tor]:TOR_PROXY:_hosts' \
26-
'--msg=[ZMQ socket for internal message bus]:MSG_SOCKET:_files' \
27-
'--ctl=[ZMQ socket for internal service bus]:CTL_SOCKET:_files' \
28-
'-r+[ZMQ socket for connecting daemon RPC interface]:RPC_SOCKET: ' \
29-
'--rpc=[ZMQ socket for connecting daemon RPC interface]:RPC_SOCKET: ' \
26+
'-M+[ZMQ socket for peer message bus used to communicate with LNP node peerd service]:MSG_ENDPOINT:_files' \
27+
'--msg=[ZMQ socket for peer message bus used to communicate with LNP node peerd service]:MSG_ENDPOINT:_files' \
28+
'-X+[ZMQ socket for internal service control bus]:CTL_ENDPOINT:_files' \
29+
'--ctl=[ZMQ socket for internal service control bus]:CTL_ENDPOINT:_files' \
30+
'-R+[ZMQ socket for LNP Node client-server RPC API]:RPC_ENDPOINT: ' \
31+
'--rpc=[ZMQ socket for LNP Node client-server RPC API]:RPC_ENDPOINT: ' \
3032
'-n+[Blockchain to use]:CHAIN: ' \
3133
'--chain=[Blockchain to use]:CHAIN: ' \
3234
'--electrum-server=[Electrum server to use]:ELECTRUM_SERVER:_hosts' \
@@ -35,11 +37,12 @@ _channeld() {
3537
'--help[Print help information]' \
3638
'-V[Print version information]' \
3739
'--version[Print version information]' \
38-
'-R[Flag indicating that we are re-establishing a channel with the provided `channel_id`]' \
40+
'-r[Flag indicating that we are re-establishing a channel with the provided `channel_id`]' \
3941
'--reestablish[Flag indicating that we are re-establishing a channel with the provided `channel_id`]' \
4042
'*-v[Set verbosity level]' \
4143
'*--verbose[Set verbosity level]' \
42-
'--threaded-daemons[Spawn daemons as threads and not processes]' \
44+
'-t[Spawn daemons as threads and not processes]' \
45+
'--threaded[Spawn daemons as threads and not processes]' \
4346
':channel-id -- Channel id:' \
4447
&& ret=0
4548
}

‎shell/_channeld.ps1

+11-8
Original file line numberDiff line numberDiff line change
@@ -23,16 +23,18 @@ Register-ArgumentCompleter -Native -CommandName 'channeld' -ScriptBlock {
2323
'channeld' {
2424
[CompletionResult]::new('-k', 'k', [CompletionResultType]::ParameterName, 'Node key file')
2525
[CompletionResult]::new('--key-file', 'key-file', [CompletionResultType]::ParameterName, 'Node key file')
26-
[CompletionResult]::new('-d', 'd', [CompletionResultType]::ParameterName, '<[_]<[_]>::into_vec(box [$($x),+]).into_iter().flatten() are located')
27-
[CompletionResult]::new('--data-dir', 'data-dir', [CompletionResultType]::ParameterName, '<[_]<[_]>::into_vec(box [$($x),+]).into_iter().flatten() are located')
26+
[CompletionResult]::new('-d', 'd', [CompletionResultType]::ParameterName, 'Data directory path')
27+
[CompletionResult]::new('--data-dir', 'data-dir', [CompletionResultType]::ParameterName, 'Data directory path')
2828
[CompletionResult]::new('-c', 'c', [CompletionResultType]::ParameterName, 'Path for the configuration file')
2929
[CompletionResult]::new('--config', 'config', [CompletionResultType]::ParameterName, 'Path for the configuration file')
3030
[CompletionResult]::new('-T', 'T', [CompletionResultType]::ParameterName, 'Use Tor')
3131
[CompletionResult]::new('--tor-proxy', 'tor-proxy', [CompletionResultType]::ParameterName, 'Use Tor')
32-
[CompletionResult]::new('--msg', 'msg', [CompletionResultType]::ParameterName, 'ZMQ socket for internal message bus')
33-
[CompletionResult]::new('--ctl', 'ctl', [CompletionResultType]::ParameterName, 'ZMQ socket for internal service bus')
34-
[CompletionResult]::new('-r', 'r', [CompletionResultType]::ParameterName, 'ZMQ socket for connecting daemon RPC interface')
35-
[CompletionResult]::new('--rpc', 'rpc', [CompletionResultType]::ParameterName, 'ZMQ socket for connecting daemon RPC interface')
32+
[CompletionResult]::new('-M', 'M', [CompletionResultType]::ParameterName, 'ZMQ socket for peer message bus used to communicate with LNP node peerd service')
33+
[CompletionResult]::new('--msg', 'msg', [CompletionResultType]::ParameterName, 'ZMQ socket for peer message bus used to communicate with LNP node peerd service')
34+
[CompletionResult]::new('-X', 'X', [CompletionResultType]::ParameterName, 'ZMQ socket for internal service control bus')
35+
[CompletionResult]::new('--ctl', 'ctl', [CompletionResultType]::ParameterName, 'ZMQ socket for internal service control bus')
36+
[CompletionResult]::new('-R', 'R', [CompletionResultType]::ParameterName, 'ZMQ socket for LNP Node client-server RPC API')
37+
[CompletionResult]::new('--rpc', 'rpc', [CompletionResultType]::ParameterName, 'ZMQ socket for LNP Node client-server RPC API')
3638
[CompletionResult]::new('-n', 'n', [CompletionResultType]::ParameterName, 'Blockchain to use')
3739
[CompletionResult]::new('--chain', 'chain', [CompletionResultType]::ParameterName, 'Blockchain to use')
3840
[CompletionResult]::new('--electrum-server', 'electrum-server', [CompletionResultType]::ParameterName, 'Electrum server to use')
@@ -41,11 +43,12 @@ Register-ArgumentCompleter -Native -CommandName 'channeld' -ScriptBlock {
4143
[CompletionResult]::new('--help', 'help', [CompletionResultType]::ParameterName, 'Print help information')
4244
[CompletionResult]::new('-V', 'V', [CompletionResultType]::ParameterName, 'Print version information')
4345
[CompletionResult]::new('--version', 'version', [CompletionResultType]::ParameterName, 'Print version information')
44-
[CompletionResult]::new('-R', 'R', [CompletionResultType]::ParameterName, 'Flag indicating that we are re-establishing a channel with the provided `channel_id`')
46+
[CompletionResult]::new('-r', 'r', [CompletionResultType]::ParameterName, 'Flag indicating that we are re-establishing a channel with the provided `channel_id`')
4547
[CompletionResult]::new('--reestablish', 'reestablish', [CompletionResultType]::ParameterName, 'Flag indicating that we are re-establishing a channel with the provided `channel_id`')
4648
[CompletionResult]::new('-v', 'v', [CompletionResultType]::ParameterName, 'Set verbosity level')
4749
[CompletionResult]::new('--verbose', 'verbose', [CompletionResultType]::ParameterName, 'Set verbosity level')
48-
[CompletionResult]::new('--threaded-daemons', 'threaded-daemons', [CompletionResultType]::ParameterName, 'Spawn daemons as threads and not processes')
50+
[CompletionResult]::new('-t', 't', [CompletionResultType]::ParameterName, 'Spawn daemons as threads and not processes')
51+
[CompletionResult]::new('--threaded', 'threaded', [CompletionResultType]::ParameterName, 'Spawn daemons as threads and not processes')
4952
break
5053
}
5154
})

‎shell/_lnp-cli

+12-12
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ _lnp-cli() {
1515

1616
local context curcontext="$curcontext" state line
1717
_arguments "${_arguments_options[@]}" \
18-
'-c+[ZMQ socket for connecting daemon RPC interface]:CONNECT: ' \
18+
'-R+[ZMQ socket for connecting daemon RPC interface]:CONNECT: ' \
1919
'--connect=[ZMQ socket for connecting daemon RPC interface]:CONNECT: ' \
2020
'-h[Print help information]' \
2121
'--help[Print help information]' \
@@ -38,7 +38,7 @@ _arguments "${_arguments_options[@]}" \
3838
'--ip=[IPv4 or IPv6 address to bind to]:IP_ADDR: ' \
3939
'-p+[Port to use; defaults to the native LN port]:PORT: ' \
4040
'--port=[Port to use; defaults to the native LN port]:PORT: ' \
41-
'-c+[ZMQ socket for connecting daemon RPC interface]:CONNECT: ' \
41+
'-R+[ZMQ socket for connecting daemon RPC interface]:CONNECT: ' \
4242
'--connect=[ZMQ socket for connecting daemon RPC interface]:CONNECT: ' \
4343
'-h[Print help information]' \
4444
'--help[Print help information]' \
@@ -48,7 +48,7 @@ _arguments "${_arguments_options[@]}" \
4848
;;
4949
(connect)
5050
_arguments "${_arguments_options[@]}" \
51-
'-c+[ZMQ socket for connecting daemon RPC interface]:CONNECT: ' \
51+
'-R+[ZMQ socket for connecting daemon RPC interface]:CONNECT: ' \
5252
'--connect=[ZMQ socket for connecting daemon RPC interface]:CONNECT: ' \
5353
'-h[Print help information]' \
5454
'--help[Print help information]' \
@@ -59,7 +59,7 @@ _arguments "${_arguments_options[@]}" \
5959
;;
6060
(ping)
6161
_arguments "${_arguments_options[@]}" \
62-
'-c+[ZMQ socket for connecting daemon RPC interface]:CONNECT: ' \
62+
'-R+[ZMQ socket for connecting daemon RPC interface]:CONNECT: ' \
6363
'--connect=[ZMQ socket for connecting daemon RPC interface]:CONNECT: ' \
6464
'-h[Print help information]' \
6565
'--help[Print help information]' \
@@ -70,7 +70,7 @@ _arguments "${_arguments_options[@]}" \
7070
;;
7171
(info)
7272
_arguments "${_arguments_options[@]}" \
73-
'-c+[ZMQ socket for connecting daemon RPC interface]:CONNECT: ' \
73+
'-R+[ZMQ socket for connecting daemon RPC interface]:CONNECT: ' \
7474
'--connect=[ZMQ socket for connecting daemon RPC interface]:CONNECT: ' \
7575
'-h[Print help information]' \
7676
'--help[Print help information]' \
@@ -81,7 +81,7 @@ _arguments "${_arguments_options[@]}" \
8181
;;
8282
(funds)
8383
_arguments "${_arguments_options[@]}" \
84-
'-c+[ZMQ socket for connecting daemon RPC interface]:CONNECT: ' \
84+
'-R+[ZMQ socket for connecting daemon RPC interface]:CONNECT: ' \
8585
'--connect=[ZMQ socket for connecting daemon RPC interface]:CONNECT: ' \
8686
'-h[Print help information]' \
8787
'--help[Print help information]' \
@@ -91,7 +91,7 @@ _arguments "${_arguments_options[@]}" \
9191
;;
9292
(peers)
9393
_arguments "${_arguments_options[@]}" \
94-
'-c+[ZMQ socket for connecting daemon RPC interface]:CONNECT: ' \
94+
'-R+[ZMQ socket for connecting daemon RPC interface]:CONNECT: ' \
9595
'--connect=[ZMQ socket for connecting daemon RPC interface]:CONNECT: ' \
9696
'-h[Print help information]' \
9797
'--help[Print help information]' \
@@ -101,7 +101,7 @@ _arguments "${_arguments_options[@]}" \
101101
;;
102102
(channels)
103103
_arguments "${_arguments_options[@]}" \
104-
'-c+[ZMQ socket for connecting daemon RPC interface]:CONNECT: ' \
104+
'-R+[ZMQ socket for connecting daemon RPC interface]:CONNECT: ' \
105105
'--connect=[ZMQ socket for connecting daemon RPC interface]:CONNECT: ' \
106106
'-h[Print help information]' \
107107
'--help[Print help information]' \
@@ -121,7 +121,7 @@ _arguments "${_arguments_options[@]}" \
121121
'--htlc-min-value=[Indicates the smallest value of an HTLC this node will accept, in milli-satoshi]:HTLC_MIN_VALUE: ' \
122122
'--htlc-max-total-value=[The maximum inbound HTLC value in flight towards this node, in milli-satoshi]:HTLC_MAX_TOTAL_VALUE: ' \
123123
'--channel-reserve=[The minimum value unencumbered by HTLCs for the counterparty to keep in the channel, in satoshis]:CHANNEL_RESERVE: ' \
124-
'-c+[ZMQ socket for connecting daemon RPC interface]:CONNECT: ' \
124+
'-R+[ZMQ socket for connecting daemon RPC interface]:CONNECT: ' \
125125
'--connect=[ZMQ socket for connecting daemon RPC interface]:CONNECT: ' \
126126
'-h[Print help information]' \
127127
'--help[Print help information]' \
@@ -133,7 +133,7 @@ _arguments "${_arguments_options[@]}" \
133133
;;
134134
(invoice)
135135
_arguments "${_arguments_options[@]}" \
136-
'-c+[ZMQ socket for connecting daemon RPC interface]:CONNECT: ' \
136+
'-R+[ZMQ socket for connecting daemon RPC interface]:CONNECT: ' \
137137
'--connect=[ZMQ socket for connecting daemon RPC interface]:CONNECT: ' \
138138
'-h[Print help information]' \
139139
'--help[Print help information]' \
@@ -145,7 +145,7 @@ _arguments "${_arguments_options[@]}" \
145145
;;
146146
(pay)
147147
_arguments "${_arguments_options[@]}" \
148-
'-c+[ZMQ socket for connecting daemon RPC interface]:CONNECT: ' \
148+
'-R+[ZMQ socket for connecting daemon RPC interface]:CONNECT: ' \
149149
'--connect=[ZMQ socket for connecting daemon RPC interface]:CONNECT: ' \
150150
'-h[Print help information]' \
151151
'--help[Print help information]' \
@@ -158,7 +158,7 @@ _arguments "${_arguments_options[@]}" \
158158
;;
159159
(help)
160160
_arguments "${_arguments_options[@]}" \
161-
'-c+[ZMQ socket for connecting daemon RPC interface]:CONNECT: ' \
161+
'-R+[ZMQ socket for connecting daemon RPC interface]:CONNECT: ' \
162162
'--connect=[ZMQ socket for connecting daemon RPC interface]:CONNECT: ' \
163163
'*-v[Set verbosity level]' \
164164
'*--verbose[Set verbosity level]' \

0 commit comments

Comments
 (0)