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 <[email protected]>

* 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 <[email protected]>

rpc/types/Cargo.toml

@@ -16,10 +16,12 @@ epee    = ["dep:cuprate-epee-encoding"]
 [dependencies]
 cuprate-epee-encoding = { path = "../../net/epee-encoding", optional = true }
 cuprate-fixed-bytes   = { path = "../../net/fixed-bytes" }
+cuprate-types         = { path = "../../types" }
 
 monero-serai = { workspace = true }
 paste        = { workspace = true }
 serde        = { workspace = true, optional = true }
 
 [dev-dependencies]
-serde_json = { workspace = true }
+serde_json        = { workspace = true }
+pretty_assertions = { workspace = true }

rpc/types/README.md

@@ -78,6 +78,22 @@ will be used instead of a more typical [`String`] for optimization reasons.
 
 -->
 
+# (De)serialization invariants
+Due to how types are defined in this library internally (all through a single macro),
+most types implement both `serde` and `epee`.
+
+However, some of the types will panic with [`unimplemented`]
+or will otherwise have undefined implementation in the incorrect context.
+
+In other words:
+- The epee (de)serialization of [`json`] & [`other`] types should **not** be relied upon
+- The JSON (de)serialization of [`bin`] types should **not** be relied upon
+
+The invariants that can be relied upon:
+- Types in [`json`] & [`other`] will implement `serde` correctly
+- Types in [`bin`] will implement `epee` correctly
+- Misc types will implement `serde/epee` correctly as needed
+
 # Feature flags
 List of feature flags for `cuprate-rpc-types`.
 

rpc/types/src/base.rs

@@ -46,7 +46,7 @@ epee_object! {
 //---------------------------------------------------------------------------------------------------- Responses
 #[doc = monero_definition_link!(cc73fe71162d564ffda8e549b79a350bca53c454, "rpc/core_rpc_server_commands_defs.h", 101..=112)]
 /// The most common base for responses.
-#[derive(Copy, Clone, Debug, Default, PartialEq, Eq, PartialOrd, Ord, Hash)]
+#[derive(Clone, Debug, Default, PartialEq, Eq, PartialOrd, Ord, Hash)]
 #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
 pub struct ResponseBase {
     /// General RPC error code. [`Status::Ok`] means everything looks good.