update some docs

CHANGELOG.md

@@ -12,7 +12,7 @@ BREAKING CHANGES:
     * Integers are encoded as strings
 - [crypto] Update go-crypto to v0.10.0 and merge into `crypto`
     * privKey.Sign returns error.
-    * ed25519 address is the first 20-bytes of the SHA256 of the pubkey
+    * ed25519 address changed to the first 20-bytes of the SHA256 of the raw pubkey bytes
     * `tmlibs/merkle` -> `crypto/merkle`. Uses SHA256 instead of RIPEMD160
 - [rpc] `syncing` is now called `catching_up`.
 

README.md

@@ -50,11 +50,11 @@ Go version | Go1.9 or higher
 
 ## Install
 
-See the [install instructions](/docs/install.rst)
+See the [install instructions](/docs/install.md)
 
 ## Quick Start
 
-- [Single node](/docs/using-tendermint.rst)
+- [Single node](/docs/using-tendermint.md)
 - [Local cluster using docker-compose](/networks/local)
 - [Remote cluster using terraform and ansible](/docs/terraform-and-ansible.md)
 - [Join the public testnet](https://cosmos.network/testnet)
@@ -72,10 +72,7 @@ Additional information about some - and eventually all - of the sub-projects bel
 
 ### Sub-projects
 
-* [ABCI](http://github.com/tendermint/abci), the Application Blockchain Interface
+* [Amino](http://github.com/tendermint/go-amino), a reflection-based improvement on proto3
-* [Go-Wire](http://github.com/tendermint/go-wire), a deterministic serialization library
-* [Go-Crypto](http://github.com/tendermint/tendermint/crypto), an elliptic curve cryptography library
-* [TmLibs](http://github.com/tendermint/tmlibs), an assortment of Go libraries used internally
 * [IAVL](http://github.com/tendermint/iavl), Merkleized IAVL+ Tree implementation
 
 ### Tools
@@ -119,8 +116,8 @@ CHANGELOG even if they don't lead to MINOR version bumps:
 - node
 
 Exported objects in these packages that are not covered by the versioning scheme
-are explicitly marked by `// UNSTABLE` in their go doc comment and may change at any time.
+are explicitly marked by `// UNSTABLE` in their go doc comment and may change at any
-Functions, types, and values in any other package may also change at any time.
+time without notice. Functions, types, and values in any other package may also change at any time.
 
 ### Upgrades
 

docs/spec/blockchain/encoding.md

@@ -54,17 +54,15 @@ familiar with amino encoding.
 You can simply use below table and concatenate Prefix || Length (of raw bytes) || raw bytes
 ( while || stands for byte concatenation here).
 
-| Type | Name | Prefix | Length |
+| Type | Name | Prefix | Length | Notes |
-| ---- | ---- | ------ | ----- |
+| ---- | ---- | ------ | ----- | ------ |
-| PubKeyEd25519 | tendermint/PubKeyEd25519 | 0x1624DE62 | 0x20 |
+| PubKeyEd25519 | tendermint/PubKeyEd25519 | 0x1624DE64 | 0x20 |  |
-| PubKeyLedgerEd25519 | tendermint/PubKeyLedgerEd25519 | 0x5C3453B2 | 0x20 |
+| PubKeySecp256k1 | tendermint/PubKeySecp256k1 | 0xEB5AE987 | 0x21 |  |
-| PubKeySecp256k1 | tendermint/PubKeySecp256k1 | 0xEB5AE982 | 0x21 |
+| PrivKeyEd25519 | tendermint/PrivKeyEd25519 | 0xA3288910 | 0x40 |  |
-| PrivKeyEd25519 | tendermint/PrivKeyEd25519 | 0xA3288912 | 0x40 |
+| PrivKeySecp256k1 | tendermint/PrivKeySecp256k1 | 0xE1B0F79B | 0x20 |  |
-| PrivKeySecp256k1 | tendermint/PrivKeySecp256k1 | 0xE1B0F79A | 0x20 |
+| SignatureEd25519 | tendermint/SignatureEd25519 | 0x2031EA53 | 0x40 |  |
-| PrivKeyLedgerSecp256k1 | tendermint/PrivKeyLedgerSecp256k1 | 0x10CAB393 | variable |
+| SignatureSecp256k1 | tendermint/SignatureSecp256k1 | 0x7FC4A495 | variable |
-| PrivKeyLedgerEd25519 | tendermint/PrivKeyLedgerEd25519 | 0x0CFEEF9B | variable |
+|
-| SignatureEd25519 | tendermint/SignatureKeyEd25519 | 0x3DA1DB2A | 0x40 |
-| SignatureSecp256k1 | tendermint/SignatureKeySecp256k1 | 0x16E1FEEA | variable |
 
 ### Examples
 

docs/spec/scripts/crypto.go

@@ -2,132 +2,15 @@ package main
 
 import (
 	"fmt"
+	"os"
 
-	"github.com/tendermint/tendermint/crypto"
+	amino "github.com/tendermint/go-amino"
+	crypto "github.com/tendermint/tendermint/crypto"
 )
 
-// SECRET
-var SECRET = []byte("some secret")
-
-func printEd() {
-	priv := crypto.GenPrivKeyEd25519FromSecret(SECRET)
-	pub := priv.PubKey().(crypto.PubKeyEd25519)
-	sigV, err := priv.Sign([]byte("hello"))
-	if err != nil {
-		fmt.Println("Unexpected error:", err)
-	}
-	sig := sigV.(crypto.SignatureEd25519)
-
-	name := "tendermint/PubKeyEd25519"
-	length := len(pub[:])
-
-	fmt.Println("### PubKeyEd25519")
-	fmt.Println("")
-	fmt.Println("```")
-	fmt.Printf("// Name: %s\n", name)
-	fmt.Printf("// PrefixBytes: 0x%X \n", pub.Bytes()[:4])
-	fmt.Printf("// Length: 0x%X \n", length)
-	fmt.Println("// Notes: raw 32-byte Ed25519 pubkey")
-	fmt.Println("type PubKeyEd25519 [32]byte")
-	fmt.Println("")
-	fmt.Println(`func (pubkey PubKeyEd25519) Address() []byte {
-  // NOTE: hash of the Amino encoded bytes!
-  return RIPEMD160(AminoEncode(pubkey))
-}`)
-	fmt.Println("```")
-	fmt.Println("")
-	fmt.Printf("For example, the 32-byte Ed25519 pubkey `%X` would be encoded as `%X`.\n\n", pub[:], pub.Bytes())
-	fmt.Printf("The address would then be `RIPEMD160(0x%X)` or `%X`\n", pub.Bytes(), pub.Address())
-	fmt.Println("")
-
-	name = "tendermint/SignatureKeyEd25519"
-	length = len(sig[:])
-
-	fmt.Println("### SignatureEd25519")
-	fmt.Println("")
-	fmt.Println("```")
-	fmt.Printf("// Name: %s\n", name)
-	fmt.Printf("// PrefixBytes: 0x%X \n", sig.Bytes()[:4])
-	fmt.Printf("// Length: 0x%X \n", length)
-	fmt.Println("// Notes: raw 64-byte Ed25519 signature")
-	fmt.Println("type SignatureEd25519 [64]byte")
-	fmt.Println("```")
-	fmt.Println("")
-	fmt.Printf("For example, the 64-byte Ed25519 signature `%X` would be encoded as `%X`\n", sig[:], sig.Bytes())
-	fmt.Println("")
-
-	name = "tendermint/PrivKeyEd25519"
-
-	fmt.Println("### PrivKeyEd25519")
-	fmt.Println("")
-	fmt.Println("```")
-	fmt.Println("// Name:", name)
-	fmt.Println("// Notes: raw 32-byte priv key concatenated to raw 32-byte pub key")
-	fmt.Println("type PrivKeyEd25519 [64]byte")
-	fmt.Println("```")
-}
-
-func printSecp() {
-	priv := crypto.GenPrivKeySecp256k1FromSecret(SECRET)
-	pub := priv.PubKey().(crypto.PubKeySecp256k1)
-	sigV, err := priv.Sign([]byte("hello"))
-	if err != nil {
-		fmt.Println("Unexpected error:", err)
-	}
-	sig := sigV.(crypto.SignatureSecp256k1)
-
-	name := "tendermint/PubKeySecp256k1"
-	length := len(pub[:])
-
-	fmt.Println("### PubKeySecp256k1")
-	fmt.Println("")
-	fmt.Println("```")
-	fmt.Printf("// Name: %s\n", name)
-	fmt.Printf("// PrefixBytes: 0x%X \n", pub.Bytes()[:4])
-	fmt.Printf("// Length: 0x%X \n", length)
-	fmt.Println("// Notes: OpenSSL compressed pubkey prefixed with 0x02 or 0x03")
-	fmt.Println("type PubKeySecp256k1 [33]byte")
-	fmt.Println("")
-	fmt.Println(`func (pubkey PubKeySecp256k1) Address() []byte {
-  // NOTE: hash of the raw pubkey bytes (not Amino encoded!).
-  // Compatible with Bitcoin addresses.
-  return RIPEMD160(SHA256(pubkey[:]))
-}`)
-	fmt.Println("```")
-	fmt.Println("")
-	fmt.Printf("For example, the 33-byte Secp256k1 pubkey `%X` would be encoded as `%X`\n\n", pub[:], pub.Bytes())
-	fmt.Printf("The address would then be `RIPEMD160(SHA256(0x%X))` or `%X`\n", pub[:], pub.Address())
-	fmt.Println("")
-
-	name = "tendermint/SignatureKeySecp256k1"
-
-	fmt.Println("### SignatureSecp256k1")
-	fmt.Println("")
-	fmt.Println("```")
-	fmt.Printf("// Name: %s\n", name)
-	fmt.Printf("// PrefixBytes: 0x%X \n", sig.Bytes()[:4])
-	fmt.Printf("// Length: Variable\n")
-	fmt.Printf("// Encoding prefix: Variable\n")
-	fmt.Println("// Notes: raw bytes of the Secp256k1 signature")
-	fmt.Println("type SignatureSecp256k1 []byte")
-	fmt.Println("```")
-	fmt.Println("")
-	fmt.Printf("For example, the Secp256k1 signature `%X` would be encoded as `%X`\n", []byte(sig[:]), sig.Bytes())
-	fmt.Println("")
-
-	name = "tendermint/PrivKeySecp256k1"
-
-	fmt.Println("### PrivKeySecp256k1")
-	fmt.Println("")
-	fmt.Println("```")
-	fmt.Println("// Name:", name)
-	fmt.Println("// Notes: raw 32-byte priv key")
-	fmt.Println("type PrivKeySecp256k1 [32]byte")
-	fmt.Println("```")
-}
-
 func main() {
-	printEd()
+	cdc := amino.NewCodec()
+	crypto.RegisterAmino(cdc)
+	cdc.PrintTypes(os.Stdout)
 	fmt.Println("")
-	printSecp()
 }

networks/local/README.md

@@ -2,7 +2,7 @@
 
 ## Requirements
 
-- [Install tendermint](/docs/install.rst)
+- [Install tendermint](/docs/install.md)
 - [Install docker](https://docs.docker.com/engine/installation/)
 - [Install docker-compose](https://docs.docker.com/compose/install/)