Skip to content

Commit 05f0100

Browse files
daywalker90endothermicdev
authored andcommitted
msggen: comply with grpc and rust naming conventions
Changelog-Changed: Some enums, structs, functions in pyln-grpc-proto/cln-grpc/cln-rpc have been slightly renamed so they follow grpc and rust's naming convention
1 parent 3e46103 commit 05f0100

File tree

12 files changed

+1957
-1877
lines changed

12 files changed

+1957
-1877
lines changed

.msggen.json

Lines changed: 68 additions & 75 deletions
Large diffs are not rendered by default.

cln-grpc/proto/node.proto

Lines changed: 97 additions & 97 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

cln-grpc/src/convert.rs

Lines changed: 123 additions & 123 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

cln-grpc/src/server.rs

Lines changed: 55 additions & 55 deletions
Large diffs are not rendered by default.

cln-rpc/src/model.rs

Lines changed: 330 additions & 243 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

cln-rpc/src/notifications.rs

Lines changed: 21 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
#![allow(non_camel_case_types)]
21
// This file is autogenerated by `msggen`
32
// Do not edit it manually, your changes will be overwritten
43

@@ -44,6 +43,7 @@ pub struct ChannelOpenedNotification {
4443

4544
/// ['Direction of the connection']
4645
#[derive(Copy, Clone, Debug, Deserialize, Serialize, PartialEq, Eq)]
46+
#[allow(non_camel_case_types)]
4747
pub enum ConnectDirection {
4848
#[serde(rename = "in")]
4949
IN = 0,
@@ -73,6 +73,7 @@ impl ToString for ConnectDirection {
7373

7474
/// ['Type of connection (*torv2*/*torv3* only if **direction** is *out*)']
7575
#[derive(Copy, Clone, Debug, Deserialize, Serialize, PartialEq, Eq)]
76+
#[allow(non_camel_case_types)]
7677
pub enum ConnectAddressType {
7778
#[serde(rename = "local socket")]
7879
LOCAL_SOCKET = 0,
@@ -141,7 +142,8 @@ pub struct CustomMsgNotification {
141142

142143
/// ['The cause of the state change.']
143144
#[derive(Copy, Clone, Debug, Deserialize, Serialize, PartialEq, Eq)]
144-
pub enum Channel_state_changedCause {
145+
#[allow(non_camel_case_types)]
146+
pub enum ChannelStateChangedCause {
145147
#[serde(rename = "unknown")]
146148
UNKNOWN = 0,
147149
#[serde(rename = "local")]
@@ -156,38 +158,38 @@ pub enum Channel_state_changedCause {
156158
ONCHAIN = 5,
157159
}
158160

159-
impl TryFrom<i32> for Channel_state_changedCause {
161+
impl TryFrom<i32> for ChannelStateChangedCause {
160162
type Error = anyhow::Error;
161-
fn try_from(c: i32) -> Result<Channel_state_changedCause, anyhow::Error> {
163+
fn try_from(c: i32) -> Result<ChannelStateChangedCause, anyhow::Error> {
162164
match c {
163-
0 => Ok(Channel_state_changedCause::UNKNOWN),
164-
1 => Ok(Channel_state_changedCause::LOCAL),
165-
2 => Ok(Channel_state_changedCause::USER),
166-
3 => Ok(Channel_state_changedCause::REMOTE),
167-
4 => Ok(Channel_state_changedCause::PROTOCOL),
168-
5 => Ok(Channel_state_changedCause::ONCHAIN),
169-
o => Err(anyhow::anyhow!("Unknown variant {} for enum Channel_state_changedCause", o)),
165+
0 => Ok(ChannelStateChangedCause::UNKNOWN),
166+
1 => Ok(ChannelStateChangedCause::LOCAL),
167+
2 => Ok(ChannelStateChangedCause::USER),
168+
3 => Ok(ChannelStateChangedCause::REMOTE),
169+
4 => Ok(ChannelStateChangedCause::PROTOCOL),
170+
5 => Ok(ChannelStateChangedCause::ONCHAIN),
171+
o => Err(anyhow::anyhow!("Unknown variant {} for enum ChannelStateChangedCause", o)),
170172
}
171173
}
172174
}
173175

174-
impl ToString for Channel_state_changedCause {
176+
impl ToString for ChannelStateChangedCause {
175177
fn to_string(&self) -> String {
176178
match self {
177-
Channel_state_changedCause::UNKNOWN => "UNKNOWN",
178-
Channel_state_changedCause::LOCAL => "LOCAL",
179-
Channel_state_changedCause::USER => "USER",
180-
Channel_state_changedCause::REMOTE => "REMOTE",
181-
Channel_state_changedCause::PROTOCOL => "PROTOCOL",
182-
Channel_state_changedCause::ONCHAIN => "ONCHAIN",
179+
ChannelStateChangedCause::UNKNOWN => "UNKNOWN",
180+
ChannelStateChangedCause::LOCAL => "LOCAL",
181+
ChannelStateChangedCause::USER => "USER",
182+
ChannelStateChangedCause::REMOTE => "REMOTE",
183+
ChannelStateChangedCause::PROTOCOL => "PROTOCOL",
184+
ChannelStateChangedCause::ONCHAIN => "ONCHAIN",
183185
}.to_string()
184186
}
185187
}
186188

187189
#[derive(Clone, Debug, Deserialize, Serialize)]
188190
pub struct ChannelStateChangedNotification {
189191
// Path `channel_state_changed.cause`
190-
pub cause: Channel_state_changedCause,
192+
pub cause: ChannelStateChangedCause,
191193
// Path `channel_state_changed.new_state`
192194
pub new_state: ChannelState,
193195
// Path `channel_state_changed.old_state`

cln-rpc/src/primitives.rs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ use std::string::ToString;
1212
pub use bitcoin::hashes::sha256::Hash as Sha256;
1313
pub use bitcoin::secp256k1::PublicKey;
1414

15-
#[derive(Copy, Clone, Serialize, Deserialize, Debug, PartialEq)]
15+
#[derive(Copy, Clone, Serialize, Deserialize, Debug, PartialEq, Eq)]
1616
#[allow(non_camel_case_types)]
1717
pub enum ChannelState {
1818
OPENINGD = 0,
@@ -31,7 +31,7 @@ pub enum ChannelState {
3131
DUALOPEND_OPEN_COMMIT_READY = 13,
3232
}
3333

34-
#[derive(Copy, Clone, Serialize, Deserialize, Debug)]
34+
#[derive(Copy, Clone, Serialize, Deserialize, Debug, PartialEq, Eq)]
3535
#[allow(non_camel_case_types)]
3636
pub enum HtlcState {
3737
SENT_ADD_HTLC = 0,
@@ -402,7 +402,7 @@ impl<'de> Deserialize<'de> for Outpoint {
402402
}
403403
}
404404

405-
#[derive(Copy, Clone, Serialize, Deserialize, Debug, PartialEq)]
405+
#[derive(Copy, Clone, Serialize, Deserialize, Debug, PartialEq, Eq)]
406406
#[serde(rename_all = "lowercase")]
407407
pub enum ChannelSide {
408408
LOCAL,

contrib/msggen/msggen/gen/rpc/notification.py

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,6 @@ def generate_enum(self, service: Service):
3333
self.write("}\n")
3434

3535
def generate(self, service: Service) -> None:
36-
self.write("#![allow(non_camel_case_types)]\n")
3736
self.write("// This file is autogenerated by `msggen`\n")
3837
self.write("// Do not edit it manually, your changes will be overwritten\n\n\n")
3938
self.write("\n")

contrib/msggen/msggen/gen/rpc/rust.py

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -48,8 +48,7 @@
4848
"integer": "i64",
4949
}
5050

51-
header = f"""#![allow(non_camel_case_types)]
52-
//
51+
header = f"""
5352
// This file was automatically generated using the following command:
5453
//
5554
// ```bash
@@ -98,7 +97,7 @@ def gen_enum(e, meta):
9897

9998
if e.deprecated:
10099
decl += "#[deprecated]\n"
101-
decl += f"#[derive(Copy, Clone, Debug, Deserialize, Serialize, PartialEq, Eq)]\npub enum {e.typename} {{\n"
100+
decl += f"#[derive(Copy, Clone, Debug, Deserialize, Serialize, PartialEq, Eq)]\n#[allow(non_camel_case_types)]\npub enum {e.typename} {{\n"
102101

103102
m = meta["grpc-field-map"]
104103
m2 = meta["grpc-enum-map"]
@@ -395,7 +394,7 @@ def generate_enums(self, service: Service):
395394
)
396395

397396
for method in service.methods:
398-
if "-" in method.name_raw:
397+
if "-" in method.name_raw or "_" in method.name_raw:
399398
self.write(
400399
f'#[serde(rename = "{method.name_raw.lower()}")]\n', numindent=1
401400
)
@@ -415,7 +414,7 @@ def generate_enums(self, service: Service):
415414
)
416415

417416
for method in service.methods:
418-
if "-" in method.name_raw:
417+
if "-" in method.name_raw or "_" in method.name_raw:
419418
self.write(
420419
f'#[serde(rename = "{method.name_raw.lower()}")]\n', numindent=1
421420
)

contrib/msggen/msggen/model.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,13 @@
11
from typing import List, Union, Optional
22
import logging
3+
import re
34
from copy import copy
45

56
logger = logging.getLogger(__name__)
67

78

89
def path2type(path):
9-
typename = "".join([s.capitalize() for s in path.replace("[]", "").split(".")])
10+
typename = "".join([s.capitalize() for s in re.split(r'_|\.', path.replace("[]", ""))])
1011
return typename
1112

1213

@@ -18,7 +19,6 @@ def normalized(self):
1819
name = {
1920
"type": "item_type"
2021
}.get(self.name, self.name)
21-
2222
name = name.replace(' ', '_').replace('-', '_').replace('[]', '').replace("/", "_")
2323
return name
2424

@@ -188,7 +188,7 @@ def __init__(self, name: str, typename: str, request: Field, response: Field):
188188

189189
class Method:
190190
def __init__(self, name: str, request: Field, response: Field):
191-
self.name = name
191+
self.name = name.replace('_', '')
192192
self.name_raw = name
193193
self.request = request
194194
self.response = response

0 commit comments

Comments
 (0)