ledger-models
| Crates.io | ledger-models |
| lib.rs | ledger-models |
| version | 0.1.92 |
| source | src |
| created_at | 2022-12-02 01:54:07.830601 |
| updated_at | 2024-08-29 19:26:47.779905 |
| description | A comprehensive model library for financial products (securities, prices, transactions, etc). Protobuf used for serialization, with language-specific implementations |
| homepage | |
| repository | https://github.com/fintekkers/ledger-models |
| max_upload_size | |
| id | 728056 |
| size | 463,475 |
(samiam376)
documentation
README
Rust Types Derived from Proto Files
Context
This project contains protobuf models of financial objects & request/response formats for APIs; as well as language specific bindings.
Generating Types
To generate the types run cargo run --bin gen. This will overwrite the files in ledger-models-rust. Any new file must be exported in lib.rs.
This is included in the compile.sh script which creates types across all languages.
Project structure
Tonic/Prost is used to generate language bindings in Rust. Auto-generated files
are created in the format fintekkers.
Hand-written wrappers are included in the folder fintekkers/wrappers/file.rs. The purpose of this code is to make it easier to use the Rust implementation of fintekkers without having gitto understand all the nuance of protobufs, or nuances of performance optimizations made in the proto schema.
DevOps
Preparing Rust to publish
to publish a new version do the following
- generate the new protobus using the compile script
- export any new models in lib.rs
- bump the package version in
Cargo.toml - merge your pr then create a release tagged with the version, if the version = 0.1.1, set the tag to v0.1.1