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
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
use std::collections::{BTreeMap, HashSet};
use std::fmt::{self, Debug, Display, Formatter};
use std::io;
use std::iter::FromIterator;
use std::str::FromStr;
use std::time::Duration;
use amplify::{Slice32, ToYamlString, Wrapper};
use bitcoin::Address;
use internet2::addr::{InetSocketAddr, NodeAddr, NodeId};
use lightning_invoice::Invoice;
use lnp::addr::LnpAddr;
use lnp::channel::bolt::{AssetsBalance, ChannelState, CommonParams, PeerParams};
use lnp::p2p::bolt::{ChannelId, ChannelType};
use lnpbp::chain::AssetId;
use microservices::esb::ClientId;
use microservices::rpc;
use microservices::util::OptionDetails;
#[cfg(feature = "serde")]
use serde_with::{DisplayFromStr, DurationSeconds, Same};
use strict_encoding::{StrictDecode, StrictEncode};
use wallet::address::AddressCompat;
use crate::error::FailureCode;
use crate::{ListenAddr, ServiceId};
#[derive(Clone, Debug, Display, From, Api)]
#[api(encoding = "strict")]
#[non_exhaustive]
pub(crate) enum BusMsg {
#[api(type = 4)]
#[display(inner)]
#[from]
Rpc(RpcMsg),
}
impl rpc::Request for BusMsg {}
#[derive(Clone, Debug, Display, From)]
#[derive(NetworkEncode, NetworkDecode)]
#[non_exhaustive]
pub enum RpcMsg {
#[display("get_info()")]
GetInfo,
#[display("list_peers()")]
ListPeers,
#[display("list_channels()")]
ListChannels,
#[display("list_funds()")]
ListFunds,
#[display("listen({0})")]
Listen(ListenAddr),
#[display("connect({0})")]
ConnectPeer(LnpAddr),
#[display("disconnect({0})")]
DisconnectPeer(LnpAddr),
#[display("ping_peer()")]
PingPeer,
#[display("create_channel({0})")]
CreateChannel(CreateChannel),
#[display("send({0})")]
Send(Send),
#[display("pay_invoice({0})")]
PayInvoice(PayInvoice),
#[display("progress(\"{0}\")")]
#[from]
Progress(String),
#[display("success({0})")]
Success(OptionDetails),
#[display("failure({0:#})")]
#[from]
Failure(Failure),
#[display("node_info({0})", alt = "{0:#}")]
#[from]
NodeInfo(NodeInfo),
#[display("node_info({0})", alt = "{0:#}")]
#[from]
PeerInfo(PeerInfo),
#[display("channel_info({0})", alt = "{0:#}")]
#[from]
ChannelInfo(ChannelInfo),
#[display("peer_list({0})", alt = "{0:#}")]
#[from]
PeerList(List<NodeId>),
#[display("channel_list({0})", alt = "{0:#}")]
#[from]
ChannelList(List<ChannelId>),
#[display("funds_info({0})", alt = "{0:#}")]
#[from]
FundsInfo(FundsInfo),
}
impl RpcMsg {
pub fn success() -> Self { RpcMsg::Success(OptionDetails::new()) }
}
#[derive(Clone, PartialEq, Eq, Debug, Display, NetworkEncode, NetworkDecode)]
#[display("{remote_peer}, {funding_sat}, ...")]
pub struct CreateChannel {
pub remote_peer: NodeAddr,
pub report_to: Option<ClientId>,
pub funding_sat: u64,
pub push_msat: u64,
pub fee_rate: Option<u32>,
pub announce_channel: Option<bool>,
pub channel_type: Option<ChannelType>,
pub dust_limit: Option<u64>,
pub to_self_delay: Option<u16>,
pub htlc_max_count: Option<u16>,
pub htlc_min_value: Option<u64>,
pub htlc_max_total_value: Option<u64>,
pub channel_reserve: Option<u64>,
}
impl CreateChannel {
pub fn apply_params(&self, common: &mut CommonParams, local: &mut PeerParams) {
if let Some(fee_rate) = self.fee_rate {
common.feerate_per_kw = fee_rate;
}
if let Some(announce_channel) = self.announce_channel {
common.announce_channel = announce_channel;
}
if let Some(channel_type) = self.channel_type {
common.channel_type = channel_type;
}
if let Some(dust_limit) = self.dust_limit {
local.dust_limit_satoshis = dust_limit;
}
if let Some(to_self_delay) = self.to_self_delay {
local.to_self_delay = to_self_delay
}
if let Some(htlc_max_count) = self.htlc_max_count {
local.max_accepted_htlcs = htlc_max_count
}
if let Some(htlc_min_value) = self.htlc_min_value {
local.htlc_minimum_msat = htlc_min_value
}
if let Some(htlc_max_total_value) = self.htlc_max_total_value {
local.max_htlc_value_in_flight_msat = htlc_max_total_value
}
if let Some(channel_reserve) = self.channel_reserve {
local.channel_reserve_satoshis = channel_reserve
}
}
}
#[derive(Clone, PartialEq, Eq, Debug, Display)]
#[display("{invoice}, {channel_id}")]
pub struct PayInvoice {
pub channel_id: ChannelId,
pub invoice: Invoice,
pub amount_msat: Option<u64>,
}
impl StrictEncode for PayInvoice {
fn strict_encode<E: io::Write>(&self, mut e: E) -> Result<usize, strict_encoding::Error> {
Ok(strict_encode_list!(e; self.channel_id, self.invoice.to_string(), self.amount_msat))
}
}
impl StrictDecode for PayInvoice {
fn strict_decode<D: io::Read>(mut d: D) -> Result<Self, strict_encoding::Error> {
Ok(PayInvoice {
channel_id: ChannelId::strict_decode(&mut d)?,
invoice: Invoice::from_str(&String::strict_decode(&mut d)?).map_err(|err| {
strict_encoding::Error::DataIntegrityError(format!(
"invalid bech32 lightning invoice: {}",
err
))
})?,
amount_msat: StrictDecode::strict_decode(&mut d)?,
})
}
}
#[derive(Clone, PartialEq, Eq, Debug, Display, NetworkEncode, NetworkDecode)]
#[display("{amount} {asset:?} to {channeld}")]
pub struct Send {
pub channeld: ServiceId,
pub amount: u64,
pub asset: Option<AssetId>,
}
#[cfg_attr(feature = "serde", serde_as)]
#[derive(Clone, PartialEq, Eq, Debug, Display, NetworkEncode, NetworkDecode)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize), serde(crate = "serde_crate"))]
#[display(NodeInfo::to_yaml_string)]
pub struct NodeInfo {
pub node_id: NodeId,
#[serde_as(as = "Vec<DisplayFromStr>")]
pub listens: Vec<ListenAddr>,
#[serde_as(as = "DurationSeconds")]
pub uptime: Duration,
pub since: u64,
#[serde_as(as = "Vec<DisplayFromStr>")]
pub peers: Vec<NodeId>,
#[serde_as(as = "Vec<DisplayFromStr>")]
pub channels: Vec<ChannelId>,
}
#[cfg_attr(feature = "serde", serde_as)]
#[derive(Clone, PartialEq, Eq, Debug, Display, NetworkEncode, NetworkDecode)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize), serde(crate = "serde_crate"))]
#[display(PeerInfo::to_yaml_string)]
pub struct PeerInfo {
pub local_id: NodeId,
pub remote_id: Vec<NodeId>,
#[serde_as(as = "Option<DisplayFromStr>")]
pub local_socket: Option<InetSocketAddr>,
#[serde_as(as = "Vec<DisplayFromStr>")]
pub remote_socket: Vec<InetSocketAddr>,
#[serde_as(as = "DurationSeconds")]
pub uptime: Duration,
pub since: u64,
pub messages_sent: usize,
pub messages_received: usize,
#[serde_as(as = "HashSet<DisplayFromStr>")]
pub channels: HashSet<Slice32>,
pub connected: bool,
pub awaits_pong: bool,
}
pub type RemotePeerMap<T> = BTreeMap<NodeAddr, T>;
#[cfg_attr(feature = "serde", serde_as)]
#[derive(Clone, Debug, Display, NetworkEncode, NetworkDecode)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize), serde(crate = "serde_crate"))]
#[display(ChannelInfo::to_yaml_string)]
pub struct ChannelInfo {
pub state: ChannelState,
pub remote_id: Option<NodeId>,
}
#[cfg_attr(feature = "serde", serde_as)]
#[derive(Clone, PartialEq, Eq, Debug, Display, NetworkEncode, NetworkDecode)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize), serde(crate = "serde_crate"))]
#[display(FundsInfo::to_yaml_string)]
pub struct FundsInfo {
#[serde_as(as = "BTreeMap<DisplayFromStr, Same>")]
pub bitcoin_funds: BTreeMap<AddressCompat, u64>,
pub asset_funds: AssetsBalance,
pub next_address: Address,
}
#[cfg(feature = "serde")]
impl ToYamlString for NodeInfo {}
#[cfg(feature = "serde")]
impl ToYamlString for PeerInfo {}
#[cfg(feature = "serde")]
impl ToYamlString for ChannelInfo {}
#[cfg(feature = "serde")]
impl ToYamlString for FundsInfo {}
#[derive(Wrapper, Clone, PartialEq, Eq, Debug, From, NetworkEncode, NetworkDecode)]
#[wrapper(IndexRange)]
pub struct List<T>(Vec<T>)
where
T: Clone + PartialEq + Eq + Debug + Display + StrictEncode + StrictDecode;
#[cfg(feature = "serde")]
impl<'a, T> Display for List<T>
where
T: Clone + PartialEq + Eq + Debug + Display + serde::Serialize + StrictEncode + StrictDecode,
{
fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
f.write_str(&serde_yaml::to_string(self).expect("internal YAML serialization error"))
}
}
impl<T> FromIterator<T> for List<T>
where
T: Clone + PartialEq + Eq + Debug + Display + serde::Serialize + StrictEncode + StrictDecode,
{
fn from_iter<I: IntoIterator<Item = T>>(iter: I) -> Self {
Self::from_inner(iter.into_iter().collect())
}
}
#[cfg(feature = "serde")]
impl<T> serde::Serialize for List<T>
where
T: Clone + PartialEq + Eq + Debug + Display + serde::Serialize + StrictEncode + StrictDecode,
{
fn serialize<S>(
&self,
serializer: S,
) -> Result<<S as serde::Serializer>::Ok, <S as serde::Serializer>::Error>
where
S: serde::Serializer,
{
self.as_inner().serialize(serializer)
}
}
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize), serde(crate = "serde_crate"))]
#[derive(Clone, PartialEq, Eq, PartialOrd, Ord, Hash, Debug, Display)]
#[derive(NetworkEncode, NetworkDecode)]
#[display("{info}", alt = "Server returned failure #{code}: {info}")]
pub struct Failure {
pub code: FailureCode,
pub info: String,
}
impl Failure {
pub fn into_microservice_failure(self) -> rpc::Failure<FailureCode> {
rpc::Failure { code: self.code.into(), info: self.info }
}
}
impl From<&str> for RpcMsg {
fn from(s: &str) -> Self { RpcMsg::Progress(s.to_owned()) }
}