tendermint / go-amino

Protobuf3 with Interface support - Designed for blockchains (deterministic, upgradeable, fast, and compact)
Other
259 stars 78 forks source link

Write specification #133

Open melekes opened 6 years ago

melekes commented 6 years ago

Example: https://github.com/msgpack/msgpack/blob/master/spec.md

jaekwon commented 6 years ago

Maybe we need to break this into smaller tasks.

ebuchman commented 6 years ago

It would be amazing to split this up into a section for each type (like we had with the old wire spec of : https://github.com/tendermint/tendermint/blob/v0.19.0/docs/specification/new-spec/encoding.md)

For types that are the same as protobuf, we just state that and link to the corresponding protobuf spec. For types that aren't we explain how it works and ideally why its different. I think most of that information is already in the README.

But I did notice we don't define there how we encode time!