cuprate/types/README.md

# `cuprate-types`
Shared data types within Cuprate.

This crate is a kitchen-sink for data types that are shared across Cuprate.

# Features flags
| Feature flag | Does what |
|--------------|-----------|
| `blockchain` | Enables the `blockchain` module, containing the blockchain database request/response types
| `serde`      | Enables `serde` on types where applicable
| `epee`       | Enables `cuprate-epee-encoding` on types where applicable
| `proptest`   | Enables `proptest::arbitrary::Arbitrary` on some types
| `json`       | Enables the `json` module, containing JSON representations of common Monero types
| `hex`        | Enables the `hex` module, containing the `HexBytes` type
Implement `types/` (#94) * workspace: add `bytemuck` to workspace * add `types/` * workspace: add `cuprate-types` to members * copy `consensus/` types to `types/` * remove `hard_fork/` * extended_block_header: impl `Pod`, fix layout * update `Request/Response` * impl types * fix `Response/Request` * impl `borsh` * workspace: add `strum` * service: add `strum` traits * remove `paste`, `serde_json`, `thiserror` * remove `strum` * VerifiedBlockInformation: remove `hf_vote` * Update Cargo.toml Co-authored-by: Boog900 <boog900@tutanota.com> --------- Co-authored-by: Boog900 <boog900@tutanota.com> 2024-03-27 00:46:32 +00:00			# `cuprate-types`
types: add `BlockCompleteEntry` (#230) * types: add `block_complete_entry.rs` * net: fix imports * p2p: fix imports * turn off default-features * p2p: fix imports * Update net/wire/Cargo.toml Co-authored-by: Boog900 <boog900@tutanota.com> * wire: re-export types --------- Co-authored-by: Boog900 <boog900@tutanota.com> 2024-07-16 21:47:50 +00:00			`Shared data types within Cuprate.`
Implement `types/` (#94) * workspace: add `bytemuck` to workspace * add `types/` * workspace: add `cuprate-types` to members * copy `consensus/` types to `types/` * remove `hard_fork/` * extended_block_header: impl `Pod`, fix layout * update `Request/Response` * impl types * fix `Response/Request` * impl `borsh` * workspace: add `strum` * service: add `strum` traits * remove `paste`, `serde_json`, `thiserror` * remove `strum` * VerifiedBlockInformation: remove `hf_vote` * Update Cargo.toml Co-authored-by: Boog900 <boog900@tutanota.com> --------- Co-authored-by: Boog900 <boog900@tutanota.com> 2024-03-27 00:46:32 +00:00
types: add `BlockCompleteEntry` (#230) * types: add `block_complete_entry.rs` * net: fix imports * p2p: fix imports * turn off default-features * p2p: fix imports * Update net/wire/Cargo.toml Co-authored-by: Boog900 <boog900@tutanota.com> * wire: re-export types --------- Co-authored-by: Boog900 <boog900@tutanota.com> 2024-07-16 21:47:50 +00:00			`This crate is a kitchen-sink for data types that are shared across Cuprate.`
Implement `types/` (#94) * workspace: add `bytemuck` to workspace * add `types/` * workspace: add `cuprate-types` to members * copy `consensus/` types to `types/` * remove `hard_fork/` * extended_block_header: impl `Pod`, fix layout * update `Request/Response` * impl types * fix `Response/Request` * impl `borsh` * workspace: add `strum` * service: add `strum` traits * remove `paste`, `serde_json`, `thiserror` * remove `strum` * VerifiedBlockInformation: remove `hf_vote` * Update Cargo.toml Co-authored-by: Boog900 <boog900@tutanota.com> --------- Co-authored-by: Boog900 <boog900@tutanota.com> 2024-03-27 00:46:32 +00:00
types: add `BlockCompleteEntry` (#230) * types: add `block_complete_entry.rs` * net: fix imports * p2p: fix imports * turn off default-features * p2p: fix imports * Update net/wire/Cargo.toml Co-authored-by: Boog900 <boog900@tutanota.com> * wire: re-export types --------- Co-authored-by: Boog900 <boog900@tutanota.com> 2024-07-16 21:47:50 +00:00			`# Features flags`
			`\| Feature flag \| Does what \|`
			`\|--------------\|-----------\|`
			\| `blockchain` \| Enables the `blockchain` module, containing the blockchain database request/response types
			\| `serde` \| Enables `serde` on types where applicable
rpc: custom epee for misc/bin types (#229) * fixed-bytes: add `serde`, document feature flags * fixed-bytes: add derives * rpc: add `as _` syntax to macro * rpc: use `ByteArrayVec` and `ContainerAsBlob` for binary types * fixed-bytes: re-add derives * rpc-types: dedup default value within macro * readme: fixed bytes section * types: custom epee - `BlockCompleteEntry` * types: custom epee - `KeyImageSpentStatus` * types: custom epee - `PoolInfoExtent` * types: add `Status::Other(String)` variant * types: custom epee - `TxEntry`, add `read_epee_field` macro * bin: custom epee - `GetBlocks` * types: add `serde.rs` * misc: make `TxEntry` an `enum`, impl serde * misc: `unimplemented!()` for `TxEntry`'s epee * types: add `BlockCompleteEntry` * rpc: replace `BlockCompleteEntry` with `cuprate-types` * types: document `BlockCompleteEntry` * bin: fix `number_of_fields` for `GetBlocksResponse` * misc: add `Distribution` * distribution: add todo * misc fixes * readme: add `(De)serialization invariants` * distribution: compress variants * types: add `block_complete_entry.rs` * net: fix imports * p2p: fix imports * turn off default-features * p2p: fix imports * misc fixes * Update net/wire/Cargo.toml Co-authored-by: Boog900 <boog900@tutanota.com> * distribution: module doc * wire: re-export types * bin: use enum for `GetBlocksResponse` * misc: use lowercase for stringify * remove duplicated fields for custom epee * types: remove `should_write()` for custom epee * bin: split `GetBlocksResponse` variant fields into structs * misc: split `Distribution` variant fields into structs * small fixes * put all fields in `read_epee_field!` * distribution: (de)compress during epee/serde (de)serialization * distribution: leave (de)compression functions as `todo!()` --------- Co-authored-by: Boog900 <boog900@tutanota.com> 2024-07-25 15:46:41 +00:00			\| `epee` \| Enables `cuprate-epee-encoding` on types where applicable
Consensus: move more types to `types` (#250) * move `HardFork` to `types` * fmt * fix tests & doc * fmt * fix clippy * move transaction verification data * misc fixes * doc fixes * update README.md * review fixes 2024-08-08 23:56:13 +00:00			\| `proptest` \| Enables `proptest::arbitrary::Arbitrary` on some types
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 00:47:44 +00:00			\| `json` \| Enables the `json` module, containing JSON representations of common Monero types
			\| `hex` \| Enables the `hex` module, containing the `HexBytes` type