tendermint / go-crypto

DEPRECATED: Merged into https://github.com/tendermint/tendermint under `crypto`
Other
44 stars 32 forks source link

SignatureKey -> Signature #110

Closed ebuchman closed 6 years ago

ebuchman commented 6 years ago

Ref https://github.com/tendermint/go-crypto/issues/84

@Liamsi can you add https://github.com/tendermint/go-crypto/issues/88 so we can get the updated info for the docs: https://github.com/tendermint/tendermint/blob/master/docs/spec/blockchain/encoding.md#pubkeyed25519

We can probably simplify those docs a bunch by just using a table instead of all the verbosity I have there now ...

liamsi commented 6 years ago

Yes, will add something that prints a table in markdown. This can be copy & pasted to update the documentation. Be aware that this also requires changes in amino though. (everything related to the type info is currently not exported). Also, you only need the concrete types (not the interfaces), I assume?

liamsi commented 6 years ago

How does this look to you:

Type Name Prefix Length Notes
PubKeyEd25519 tendermint/PubKeyEd25519 0x1624DE62 0x20
PubKeyLedgerEd25519 tendermint/PubKeyLedgerEd25519 0x5C3453B2 0x20
PubKeySecp256k1 tendermint/PubKeySecp256k1 0xEB5AE982 0x21
PrivKeyEd25519 tendermint/PrivKeyEd25519 0xA3288912 0x40
PrivKeySecp256k1 tendermint/PrivKeySecp256k1 0xE1B0F79A 0x20
PrivKeyLedgerSecp256k1 tendermint/PrivKeyLedgerSecp256k1 0x10CAB393 variable
PrivKeyLedgerEd25519 tendermint/PrivKeyLedgerEd25519 0x0CFEEF9B variable
SignatureEd25519 tendermint/SignatureKeyEd25519 0x3DA1DB2A 0x40
SignatureSecp256k1 tendermint/SignatureKeySecp256k1 0x16E1FEEA variable
liamsi commented 6 years ago

updated the docs here: https://github.com/Liamsi/tendermint-1/blob/978277a4c18258a8aaa1a829c4924a31e96d9270/docs/spec/blockchain/encoding.md

I'm wondering if we even need the "Notes" column?

/cc @ebuchman

ebuchman commented 6 years ago

I'm wondering if we even need the "Notes" column?

Seems not, at least for now

liamsi commented 6 years ago

Seems not, at least for now

OK, (manually) removed it in https://github.com/tendermint/tendermint/pull/1662

xla commented 6 years ago

@Liamsi Let's fix for 0.8.0.

liamsi commented 6 years ago

PTAL @xla