Monero EPEE
epee is a bespoke serialization format seen within the Monero project without any official
documentation. The best specification is available here.
This library implements the epee 'portable storage' encoding, with the following exceptions:
- We don't support the
Arraytype (type 13) as it's unused and lacking documentation - We may accept a wider class of inputs than the
epeelibrary itself due to slight differences in depth limits on nested objects
We do not support:
- Encoding objects
- Decoding objects into typed data structures
Instead, we support iterating through epee-encoded values and finding all instances of a
field. This lets the caller jump to the binary blob representing an encoded value, and decode
it themselves, without us actually deserializing the entire object. If we were to do that, we'd
presumably require something akin to serde_json::Value or a proc macro. This is sufficient
for basic needs, much simpler, and should be trivial to verify it won't panic/face various
exhaustion attacks. This library is implemented without recursion.
Because of this, we are also able to support no-std and no-alloc, without any dependencies other
than core, while only consuming approximately a kibibyte of memory on the stack.
For a more functional library, please check out to
cuprate-epee-encoding.