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

History

Christian Decker 2d35c9a929 msggen: Do not override method names when loading Schema We were overriding the name right when loading, which is bad since in some languages we use the method name as tag in the requests, thus renaming causes us to call something that isn't defined. Changelog-Fixed: cln-rpc: Fixed a naming mismatch for `ConnectPeer` causing `connectpeer` to be called on the JSON-RPC		2022-07-21 14:19:06 +09:30
..
examples	msggen: adding example and fixes typo	2022-05-07 11:11:51 +02:00
msggen	msggen: Do not override method names when loading Schema	2022-07-21 14:19:06 +09:30
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";
}