cuprate-hinto-janai/helper/README.md
hinto-janai 80bfe0a34c
types: JSON representation types (#300)
* add `cuprate_types::json`

* docs

* `Option` -> flattened enums + prefix structs

* output enum

* docs

* todo!() epee impl

* cuprate-rpc-types: add comments

* cuprate-rpc-types: common `TxEntry` fields into prefix struct

* remove epee

* docs

* add `hex` module

* `From` serai types

* cleanup

* proofs

* tx from impls

* fix tx timelock

* add block value tests

* add ringct types

* add tx_v1, tx_rct_3 test

* clsag bulletproofs tx test

* clsag bulletproofs plus tx test

* docs

* fix hex bytes

* typo

* docs
2024-10-05 01:47:44 +01:00

22 lines
No EOL
851 B
Markdown

## Helper
`helper/` is the kitchen-sink crate for very generic, not necessarily Cuprate specific functions, types, etc.
This allows all workspace crates to share, and aids compile times.
If a 3rd party's crate/functions/types are small enough, it could be moved here to trim dependencies and allow easy modifications.
## Features
Modules can be selectively used/compiled with cargo's `--feature` or `features = ["..."]`.
All features are off by default.
See [`Cargo.toml`](Cargo.toml)'s `[features]` table to see what features there are and what they enable.
Special non-module related features:
- `serde`: Enables serde implementations on applicable types
- `std`: Enables usage of `std`
## `#[no_std]`
Each modules documents whether it requires `std` or not.
If a module that requires `std` is enabled, `helper` will automatically use `std`.