mirrors/core-lightning
1
0
Fork 0
mirror of https://github.com/ElementsProject/lightning.git synced 2024-11-19 09:54:16 +01:00
Code Issues Projects Releases Wiki Activity
3c689cdaff
core-lightning/contrib/msggen
History
Christian Decker 53b37ca1c1 cln-rpc: Allow access to deprecated fields in conversions 
This silences a compilation warning about accessing a deprecated
field. This was triggering on each build and we'll notice when they go
away, so why upset users with it?
2023-07-10 18:22:11 +02:00
..
examples msggen: adding example and fixes typo 2022-05-07 11:11:51 +02:00
msggen cln-rpc: Allow access to deprecated fields in conversions 2023-07-10 18:22:11 +02: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: Move overrides into the model itself 2023-05-05 11:54:41 +09:30

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";
}

msggen will load the schemas in doc/schemas into memory, and then use Patches to enrich the model before using it to generate the bindings for the various languages as well as the converters from one format to another. These patches can be found in msggen/patch.py and perform a variety of operations:

  • Annotate the model with additional data from external sources, such as the .msggen.json file at the repository root to track details that can be derived but should remain constant (grpc field numbering and versioning information)
  • Aggregate common types with type overrides and omit fields that we can't map currently.
  • Infer optionality based on the versions a field was added or deprecated, and the currently supported range of versions.

If there is a field that is currently missing in the model, that is in the schemas it is most likely because it has been marked as omitted in the patch.