mirror of https://github.com/ElementsProject/lightning.git synced 2024-11-20 02:27:51 +01:00

History

Christian Decker bb4946a6e6 msggen: Support renaming methods in GRPC There is at least one clash with a built-in for the grpc server trait, namely `connect` so we add support for renaming a method when generating the scaffolding		2022-02-28 23:25:37 +00:00
..
msggen	msggen: Support renaming methods in GRPC	2022-02-28 23:25:37 +00:00
pyproject.toml	msggen: Parse JSON-RPC schemas and build the in-memory model	2022-02-11 16:02:25 +01:00
README.md	msggen: Parse JSON-RPC schemas and build the in-memory model	2022-02-11 16:02:25 +01:00

README.md

MsgGen - Generating language bindings and docs from schemas and wire descriptions

MsgGen is a collection of tools that are used to parse schemas and (eventually) protocol wire CSVs into an intermediate representation in memory, and then generate language specific bindings and documentation from it.

The dependency graph looks like this:

digraph {
  "JSON-RPC Schemas" -> "msggen model";
  "msggen model" -> "grpc proto file";
  "msggen model" -> "Rust From<JsonRpc> Converters";
  "grpc proto file" -> "Rust grpc bindings"
  "Rust grpc bindings" -> "cln-grpc";
  "Rust From<JsonRpc> Converters" -> "cln-grpc";
  "msggen model" -> "Rust JSON-RPC structs";
  "Rust JSON-RPC structs" -> "cln-rpc";
}