Skip to content

Commit

Permalink
msggen: comply with grpc and rust naming conventions
Browse files Browse the repository at this point in the history
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
  • Loading branch information
daywalker90 authored and endothermicdev committed Feb 27, 2025
1 parent 3e46103 commit 05f0100
Show file tree
Hide file tree
Showing 12 changed files with 1,957 additions and 1,877 deletions.
143 changes: 68 additions & 75 deletions .msggen.json

Large diffs are not rendered by default.

194 changes: 97 additions & 97 deletions cln-grpc/proto/node.proto

Large diffs are not rendered by default.

246 changes: 123 additions & 123 deletions cln-grpc/src/convert.rs

Large diffs are not rendered by default.

110 changes: 55 additions & 55 deletions cln-grpc/src/server.rs

Large diffs are not rendered by default.

573 changes: 330 additions & 243 deletions cln-rpc/src/model.rs

Large diffs are not rendered by default.

40 changes: 21 additions & 19 deletions cln-rpc/src/notifications.rs
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
#![allow(non_camel_case_types)]
// This file is autogenerated by `msggen`
// Do not edit it manually, your changes will be overwritten

Expand Down Expand Up @@ -44,6 +43,7 @@ pub struct ChannelOpenedNotification {

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

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

/// ['The cause of the state change.']
#[derive(Copy, Clone, Debug, Deserialize, Serialize, PartialEq, Eq)]
pub enum Channel_state_changedCause {
#[allow(non_camel_case_types)]
pub enum ChannelStateChangedCause {
#[serde(rename = "unknown")]
UNKNOWN = 0,
#[serde(rename = "local")]
Expand All @@ -156,38 +158,38 @@ pub enum Channel_state_changedCause {
ONCHAIN = 5,
}

impl TryFrom<i32> for Channel_state_changedCause {
impl TryFrom<i32> for ChannelStateChangedCause {
type Error = anyhow::Error;
fn try_from(c: i32) -> Result<Channel_state_changedCause, anyhow::Error> {
fn try_from(c: i32) -> Result<ChannelStateChangedCause, anyhow::Error> {
match c {
0 => Ok(Channel_state_changedCause::UNKNOWN),
1 => Ok(Channel_state_changedCause::LOCAL),
2 => Ok(Channel_state_changedCause::USER),
3 => Ok(Channel_state_changedCause::REMOTE),
4 => Ok(Channel_state_changedCause::PROTOCOL),
5 => Ok(Channel_state_changedCause::ONCHAIN),
o => Err(anyhow::anyhow!("Unknown variant {} for enum Channel_state_changedCause", o)),
0 => Ok(ChannelStateChangedCause::UNKNOWN),
1 => Ok(ChannelStateChangedCause::LOCAL),
2 => Ok(ChannelStateChangedCause::USER),
3 => Ok(ChannelStateChangedCause::REMOTE),
4 => Ok(ChannelStateChangedCause::PROTOCOL),
5 => Ok(ChannelStateChangedCause::ONCHAIN),
o => Err(anyhow::anyhow!("Unknown variant {} for enum ChannelStateChangedCause", o)),
}
}
}

impl ToString for Channel_state_changedCause {
impl ToString for ChannelStateChangedCause {
fn to_string(&self) -> String {
match self {
Channel_state_changedCause::UNKNOWN => "UNKNOWN",
Channel_state_changedCause::LOCAL => "LOCAL",
Channel_state_changedCause::USER => "USER",
Channel_state_changedCause::REMOTE => "REMOTE",
Channel_state_changedCause::PROTOCOL => "PROTOCOL",
Channel_state_changedCause::ONCHAIN => "ONCHAIN",
ChannelStateChangedCause::UNKNOWN => "UNKNOWN",
ChannelStateChangedCause::LOCAL => "LOCAL",
ChannelStateChangedCause::USER => "USER",
ChannelStateChangedCause::REMOTE => "REMOTE",
ChannelStateChangedCause::PROTOCOL => "PROTOCOL",
ChannelStateChangedCause::ONCHAIN => "ONCHAIN",
}.to_string()
}
}

#[derive(Clone, Debug, Deserialize, Serialize)]
pub struct ChannelStateChangedNotification {
// Path `channel_state_changed.cause`
pub cause: Channel_state_changedCause,
pub cause: ChannelStateChangedCause,
// Path `channel_state_changed.new_state`
pub new_state: ChannelState,
// Path `channel_state_changed.old_state`
Expand Down
6 changes: 3 additions & 3 deletions cln-rpc/src/primitives.rs
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ use std::string::ToString;
pub use bitcoin::hashes::sha256::Hash as Sha256;
pub use bitcoin::secp256k1::PublicKey;

#[derive(Copy, Clone, Serialize, Deserialize, Debug, PartialEq)]
#[derive(Copy, Clone, Serialize, Deserialize, Debug, PartialEq, Eq)]
#[allow(non_camel_case_types)]
pub enum ChannelState {
OPENINGD = 0,
Expand All @@ -31,7 +31,7 @@ pub enum ChannelState {
DUALOPEND_OPEN_COMMIT_READY = 13,
}

#[derive(Copy, Clone, Serialize, Deserialize, Debug)]
#[derive(Copy, Clone, Serialize, Deserialize, Debug, PartialEq, Eq)]
#[allow(non_camel_case_types)]
pub enum HtlcState {
SENT_ADD_HTLC = 0,
Expand Down Expand Up @@ -402,7 +402,7 @@ impl<'de> Deserialize<'de> for Outpoint {
}
}

#[derive(Copy, Clone, Serialize, Deserialize, Debug, PartialEq)]
#[derive(Copy, Clone, Serialize, Deserialize, Debug, PartialEq, Eq)]
#[serde(rename_all = "lowercase")]
pub enum ChannelSide {
LOCAL,
Expand Down
1 change: 0 additions & 1 deletion contrib/msggen/msggen/gen/rpc/notification.py
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,6 @@ def generate_enum(self, service: Service):
self.write("}\n")

def generate(self, service: Service) -> None:
self.write("#![allow(non_camel_case_types)]\n")
self.write("// This file is autogenerated by `msggen`\n")
self.write("// Do not edit it manually, your changes will be overwritten\n\n\n")
self.write("\n")
Expand Down
9 changes: 4 additions & 5 deletions contrib/msggen/msggen/gen/rpc/rust.py
Original file line number Diff line number Diff line change
Expand Up @@ -48,8 +48,7 @@
"integer": "i64",
}

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

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

m = meta["grpc-field-map"]
m2 = meta["grpc-enum-map"]
Expand Down Expand Up @@ -395,7 +394,7 @@ def generate_enums(self, service: Service):
)

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

for method in service.methods:
if "-" in method.name_raw:
if "-" in method.name_raw or "_" in method.name_raw:
self.write(
f'#[serde(rename = "{method.name_raw.lower()}")]\n', numindent=1
)
Expand Down
6 changes: 3 additions & 3 deletions contrib/msggen/msggen/model.py
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
from typing import List, Union, Optional
import logging
import re
from copy import copy

logger = logging.getLogger(__name__)


def path2type(path):
typename = "".join([s.capitalize() for s in path.replace("[]", "").split(".")])
typename = "".join([s.capitalize() for s in re.split(r'_|\.', path.replace("[]", ""))])
return typename


Expand All @@ -18,7 +19,6 @@ def normalized(self):
name = {
"type": "item_type"
}.get(self.name, self.name)

name = name.replace(' ', '_').replace('-', '_').replace('[]', '').replace("/", "_")
return name

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

class Method:
def __init__(self, name: str, request: Field, response: Field):
self.name = name
self.name = name.replace('_', '')
self.name_raw = name
self.request = request
self.response = response
Expand Down
2,220 changes: 1,110 additions & 1,110 deletions contrib/pyln-grpc-proto/pyln/grpc/node_pb2.py

Large diffs are not rendered by default.

Loading

0 comments on commit 05f0100

Please sign in to comment.