From 7e9859d3889a7dedfddb09d97e0f8ec01965958e Mon Sep 17 00:00:00 2001 From: Zaki Manian Date: Thu, 21 Jun 2018 22:38:40 -0700 Subject: [PATCH] Added a bech32 spec doc --- docs/spec/other/bech32.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 docs/spec/other/bech32.md diff --git a/docs/spec/other/bech32.md b/docs/spec/other/bech32.md new file mode 100644 index 000000000..1d337ef6c --- /dev/null +++ b/docs/spec/other/bech32.md @@ -0,0 +1,25 @@ +# Bech32 on Cosmos + +The Cosmos network prefers to use the Bech32 address format whereever users must handle binary data. Bech32 encoding provides robust integrity checks on data and the human readable part(HRP) provides contextual hints that can assist UI developers with providing informative error messages. + +In the Cosmos network, keys and addresses may refer to a number of different roles in the network like accounts, validators etc. + + +## HRP table + +| HRP | Definition | +| ------------- |:-------------:| +| `cosmosaccaddr` | Cosmos Account Address | +| `cosmosaccpub` | Cosmos Account Public Key | +| `cosmosvaladdr` | Cosmos Consensus Address | +| `cosmosvalpub` | Cosmos Consensus Public Key| + +## Encoding + +While all user facing interfaces to Cosmos software should exposed bech32 interfaces, many internal interfaces encode binary value in hex or base64 encoded form. + +To covert between other binary reprsentation of addresses and keys, it is important to first apply the Amino enocoding process before bech32 encoding. + +A complete implementation of the Amino serialization format is unncessary in most cases. Simply prepending bytes from this [table](https://github.com/tendermint/tendermint/blob/master/docs/spec/blockchain/encoding.md#public-key-cryptography) to the bytestring payload before bech32 encoding will sufficient for compatible representation. + +  \ No newline at end of file