Skip to content

Commit f9c477f

Browse files
tnulltnull
committed
Prefix BLIP-50/LSPS0 message types to avoid naming collisions
1 parent 095194f commit f9c477f

File tree

4 files changed

+22
-19
lines changed

4 files changed

+22
-19
lines changed

‎lightning-liquidity/src/lsps0/client.rs

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,8 @@
77
use crate::events::EventQueue;
88
use crate::lsps0::event::LSPS0ClientEvent;
99
use crate::lsps0::msgs::{
10-
LSPS0Message, LSPS0Request, LSPS0Response, ListProtocolsRequest, ListProtocolsResponse,
10+
LSPS0ListProtocolsRequest, LSPS0ListProtocolsResponse, LSPS0Message, LSPS0Request,
11+
LSPS0Response,
1112
};
1213
use crate::lsps0::ser::{ProtocolMessageHandler, ResponseError};
1314
use crate::message_queue::MessageQueue;
@@ -51,7 +52,7 @@ where
5152
pub fn list_protocols(&self, counterparty_node_id: &PublicKey) {
5253
let msg = LSPS0Message::Request(
5354
utils::generate_request_id(&self.entropy_source),
54-
LSPS0Request::ListProtocols(ListProtocolsRequest {}),
55+
LSPS0Request::ListProtocols(LSPS0ListProtocolsRequest {}),
5556
);
5657

5758
self.pending_messages.enqueue(counterparty_node_id, msg.into());
@@ -61,7 +62,7 @@ where
6162
&self, response: LSPS0Response, counterparty_node_id: &PublicKey,
6263
) -> Result<(), LightningError> {
6364
match response {
64-
LSPS0Response::ListProtocols(ListProtocolsResponse { protocols }) => {
65+
LSPS0Response::ListProtocols(LSPS0ListProtocolsResponse { protocols }) => {
6566
self.pending_events.enqueue(LSPS0ClientEvent::ListProtocolsResponse {
6667
counterparty_node_id: *counterparty_node_id,
6768
protocols,
@@ -146,7 +147,7 @@ mod tests {
146147
*message,
147148
LSPSMessage::LSPS0(LSPS0Message::Request(
148149
RequestId("00000000000000000000000000000000".to_string()),
149-
LSPS0Request::ListProtocols(ListProtocolsRequest {})
150+
LSPS0Request::ListProtocols(LSPS0ListProtocolsRequest {})
150151
))
151152
);
152153
}

‎lightning-liquidity/src/lsps0/msgs.rs

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -15,15 +15,15 @@ pub(crate) const LSPS0_LISTPROTOCOLS_METHOD_NAME: &str = "lsps0.list_protocols";
1515
/// specification](https://github.com/lightning/blips/blob/master/blip-0050.md#lsps-specification-support-query)
1616
/// for more information.
1717
#[derive(Clone, Debug, PartialEq, Eq, Deserialize, Serialize, Default)]
18-
pub struct ListProtocolsRequest {}
18+
pub struct LSPS0ListProtocolsRequest {}
1919

2020
/// A response to a `list_protocols` request.
2121
///
2222
/// Please refer to the [bLIP-50 / LSPS0
2323
/// specification](https://github.com/lightning/blips/blob/master/blip-0050.md#lsps-specification-support-query)
2424
/// for more information.
2525
#[derive(Clone, Debug, PartialEq, Eq, Deserialize, Serialize)]
26-
pub struct ListProtocolsResponse {
26+
pub struct LSPS0ListProtocolsResponse {
2727
/// A list of supported protocols.
2828
pub protocols: Vec<u16>,
2929
}
@@ -36,7 +36,7 @@ pub struct ListProtocolsResponse {
3636
#[derive(Clone, Debug, PartialEq, Eq)]
3737
pub enum LSPS0Request {
3838
/// A request calling `list_protocols`.
39-
ListProtocols(ListProtocolsRequest),
39+
ListProtocols(LSPS0ListProtocolsRequest),
4040
}
4141

4242
impl LSPS0Request {
@@ -56,7 +56,7 @@ impl LSPS0Request {
5656
#[derive(Clone, Debug, PartialEq, Eq)]
5757
pub enum LSPS0Response {
5858
/// A response to a `list_protocols` request.
59-
ListProtocols(ListProtocolsResponse),
59+
ListProtocols(LSPS0ListProtocolsResponse),
6060
/// An error response to a `list_protocols` request.
6161
ListProtocolsError(ResponseError),
6262
}
@@ -118,7 +118,7 @@ mod tests {
118118
msg,
119119
LSPSMessage::LSPS0(LSPS0Message::Request(
120120
RequestId("request:id:xyz123".to_string()),
121-
LSPS0Request::ListProtocols(ListProtocolsRequest {})
121+
LSPS0Request::ListProtocols(LSPS0ListProtocolsRequest {})
122122
))
123123
);
124124
}
@@ -127,7 +127,7 @@ mod tests {
127127
fn serializes_request() {
128128
let request = LSPSMessage::LSPS0(LSPS0Message::Request(
129129
RequestId("request:id:xyz123".to_string()),
130-
LSPS0Request::ListProtocols(ListProtocolsRequest {}),
130+
LSPS0Request::ListProtocols(LSPS0ListProtocolsRequest {}),
131131
));
132132
let json = serde_json::to_string(&request).unwrap();
133133
assert_eq!(
@@ -156,7 +156,9 @@ mod tests {
156156
response,
157157
LSPSMessage::LSPS0(LSPS0Message::Response(
158158
RequestId("request:id:xyz123".to_string()),
159-
LSPS0Response::ListProtocols(ListProtocolsResponse { protocols: vec![1, 2, 3] })
159+
LSPS0Response::ListProtocols(LSPS0ListProtocolsResponse {
160+
protocols: vec![1, 2, 3]
161+
})
160162
))
161163
);
162164
}
@@ -212,7 +214,7 @@ mod tests {
212214
fn serializes_response() {
213215
let response = LSPSMessage::LSPS0(LSPS0Message::Response(
214216
RequestId("request:id:xyz123".to_string()),
215-
LSPS0Response::ListProtocols(ListProtocolsResponse { protocols: vec![1, 2, 3] }),
217+
LSPS0Response::ListProtocols(LSPS0ListProtocolsResponse { protocols: vec![1, 2, 3] }),
216218
));
217219
let json = serde_json::to_string(&response).unwrap();
218220
assert_eq!(

‎lightning-liquidity/src/lsps0/ser.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
//! information.
66
77
use crate::lsps0::msgs::{
8-
LSPS0Message, LSPS0Request, LSPS0Response, ListProtocolsRequest,
8+
LSPS0ListProtocolsRequest, LSPS0Message, LSPS0Request, LSPS0Response,
99
LSPS0_LISTPROTOCOLS_METHOD_NAME,
1010
};
1111

@@ -428,7 +428,7 @@ impl<'de, 'a> Visitor<'de> for LSPSMessageVisitor<'a> {
428428
Some(method) => match method {
429429
LSPSMethod::LSPS0ListProtocols => Ok(LSPSMessage::LSPS0(LSPS0Message::Request(
430430
id,
431-
LSPS0Request::ListProtocols(ListProtocolsRequest {}),
431+
LSPS0Request::ListProtocols(LSPS0ListProtocolsRequest {}),
432432
))),
433433
LSPSMethod::LSPS1GetInfo => {
434434
let request = serde_json::from_value(params.unwrap_or(json!({})))

‎lightning-liquidity/src/lsps0/service.rs

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
//! specifcation](https://github.com/lightning/blips/blob/master/blip-0050.md) for more
1414
//! information.
1515
16-
use crate::lsps0::msgs::{LSPS0Message, LSPS0Request, LSPS0Response, ListProtocolsResponse};
16+
use crate::lsps0::msgs::{LSPS0ListProtocolsResponse, LSPS0Message, LSPS0Request, LSPS0Response};
1717
use crate::lsps0::ser::{ProtocolMessageHandler, RequestId};
1818
use crate::message_queue::MessageQueue;
1919
use crate::prelude::Vec;
@@ -43,7 +43,7 @@ impl LSPS0ServiceHandler {
4343
LSPS0Request::ListProtocols(_) => {
4444
let msg = LSPS0Message::Response(
4545
request_id,
46-
LSPS0Response::ListProtocols(ListProtocolsResponse {
46+
LSPS0Response::ListProtocols(LSPS0ListProtocolsResponse {
4747
protocols: self.protocols.clone(),
4848
}),
4949
);
@@ -79,7 +79,7 @@ impl ProtocolMessageHandler for LSPS0ServiceHandler {
7979
#[cfg(test)]
8080
mod tests {
8181

82-
use crate::lsps0::msgs::ListProtocolsRequest;
82+
use crate::lsps0::msgs::LSPS0ListProtocolsRequest;
8383
use crate::lsps0::ser::LSPSMessage;
8484
use crate::tests::utils;
8585
use alloc::string::ToString;
@@ -96,7 +96,7 @@ mod tests {
9696

9797
let list_protocols_request = LSPS0Message::Request(
9898
RequestId("xyz123".to_string()),
99-
LSPS0Request::ListProtocols(ListProtocolsRequest {}),
99+
LSPS0Request::ListProtocols(LSPS0ListProtocolsRequest {}),
100100
);
101101
let counterparty_node_id = utils::parse_pubkey(
102102
"027100442c3b79f606f80f322d98d499eefcb060599efc5d4ecb00209c2cb54190",
@@ -115,7 +115,7 @@ mod tests {
115115
*message,
116116
LSPSMessage::LSPS0(LSPS0Message::Response(
117117
RequestId("xyz123".to_string()),
118-
LSPS0Response::ListProtocols(ListProtocolsResponse { protocols: vec![] })
118+
LSPS0Response::ListProtocols(LSPS0ListProtocolsResponse { protocols: vec![] })
119119
))
120120
);
121121
}

0 commit comments

Comments
 (0)