mirror of
https://github.com/fluencelabs/tendermint
synced 2025-05-19 01:51:19 +00:00
Merge pull request #1500 from tendermint/bucky/spec-updates
Bucky/spec updates
This commit is contained in:
commit
389a6ffa16
66
docs/specification/new-spec/abci.md
Normal file
66
docs/specification/new-spec/abci.md
Normal file
@ -0,0 +1,66 @@
|
|||||||
|
# Application Blockchain Interface (ABCI)
|
||||||
|
|
||||||
|
ABCI is the interface between Tendermint (a state-machine replication engine)
|
||||||
|
and an application (the actual state machine).
|
||||||
|
|
||||||
|
The ABCI message types are defined in a [protobuf
|
||||||
|
file](https://github.com/tendermint/abci/blob/master/types/types.proto).
|
||||||
|
For full details on the ABCI message types and protocol, see the [ABCI
|
||||||
|
specificaiton](https://github.com/tendermint/abci/blob/master/specification.rst).
|
||||||
|
For additional details on server implementation, see the [ABCI
|
||||||
|
readme](https://github.com/tendermint/abci#implementation).
|
||||||
|
|
||||||
|
Here we provide some more details around the use of ABCI by Tendermint and
|
||||||
|
clarify common "gotchas".
|
||||||
|
|
||||||
|
## Validator Updates
|
||||||
|
|
||||||
|
Updates to the Tendermint validator set can be made by returning `Validator`
|
||||||
|
objects in the `ResponseBeginBlock`:
|
||||||
|
|
||||||
|
```
|
||||||
|
message Validator {
|
||||||
|
bytes pub_key = 1;
|
||||||
|
int64 power = 2;
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
The `pub_key` is the Amino encoded public key for the validator. For details on
|
||||||
|
Amino encoded public keys, see the [section of the encoding spec](./encoding.md#public-key-cryptography).
|
||||||
|
|
||||||
|
For Ed25519 pubkeys, the Amino prefix is always "1624DE6220". For example, the 32-byte Ed25519 pubkey
|
||||||
|
`76852933A4686A721442E931A8415F62F5F1AEDF4910F1F252FB393F74C40C85` would be
|
||||||
|
Amino encoded as
|
||||||
|
`1624DE622076852933A4686A721442E931A8415F62F5F1AEDF4910F1F252FB393F74C40C85`
|
||||||
|
|
||||||
|
The `power` is the new voting power for the validator, with the
|
||||||
|
following rules:
|
||||||
|
|
||||||
|
- power must be non-negative
|
||||||
|
- if power is 0, the validator must already exist, and will be removed from the
|
||||||
|
validator set
|
||||||
|
- if power is non-0:
|
||||||
|
- if the validator does not already exist, it will be added to the validator
|
||||||
|
set with the given power
|
||||||
|
- if the validator does already exist, its power will be adjusted to the given power
|
||||||
|
|
||||||
|
## Query
|
||||||
|
|
||||||
|
Query is a generic message type with lots of flexibility to enable diverse sets
|
||||||
|
of queries from applications. Tendermint has no requirements from the Query
|
||||||
|
message for normal operation - that is, the ABCI app developer need not implement Query functionality if they do not wish too.
|
||||||
|
That said, Tendermint makes a number of queries to support some optional
|
||||||
|
features. These are:
|
||||||
|
|
||||||
|
### Peer Filtering
|
||||||
|
|
||||||
|
When Tendermint connects to a peer, it sends two queries to the ABCI application
|
||||||
|
using the following paths, with no additional data:
|
||||||
|
|
||||||
|
- `/p2p/filter/addr/<IP:PORT>`, where `<IP:PORT>` denote the IP address and
|
||||||
|
the port of the connection
|
||||||
|
- `p2p/filter/pubkey/<ID>`, where `<ID>` is the peer node ID (ie. the
|
||||||
|
pubkey.Address() for the peer's PubKey)
|
||||||
|
|
||||||
|
If either of these queries return a non-zero ABCI code, Tendermint will refuse
|
||||||
|
to connect to the peer.
|
@ -1,106 +1,163 @@
|
|||||||
# Tendermint Encoding
|
# Tendermint Encoding
|
||||||
|
|
||||||
## Binary Serialization (TMBIN)
|
## Amino
|
||||||
|
|
||||||
Tendermint aims to encode data structures in a manner similar to how the corresponding Go structs
|
Tendermint uses the Protobuf3 derrivative [Amino]() for all data structures.
|
||||||
are laid out in memory.
|
Think of Amino as an object-oriented Protobuf3 with native JSON support.
|
||||||
Variable length items are length-prefixed.
|
The goal of the Amino encoding protocol is to bring parity between application
|
||||||
While the encoding was inspired by Go, it is easily implemented in other languages as well, given its intuitive design.
|
logic objects and persistence objects.
|
||||||
|
|
||||||
XXX: This is changing to use real varints and 4-byte-prefixes.
|
Please see the [Amino
|
||||||
See https://github.com/tendermint/go-wire/tree/sdk2.
|
specification](https://github.com/tendermint/go-amino#amino-encoding-for-go) for
|
||||||
|
more details.
|
||||||
|
|
||||||
### Fixed Length Integers
|
Notably, every object that satisfies an interface (eg. a particular kind of p2p message,
|
||||||
|
or a particular kind of pubkey) is registered with a global name, the hash of
|
||||||
|
which is included in the object's encoding as the so-called "prefix bytes".
|
||||||
|
|
||||||
Fixed length integers are encoded in Big-Endian using the specified number of bytes.
|
We define the `func AminoEncode(obj interface{}) []byte` function to take an
|
||||||
So `uint8` and `int8` use one byte, `uint16` and `int16` use two bytes,
|
arbitrary object and return the Amino encoded bytes.
|
||||||
`uint32` and `int32` use 3 bytes, and `uint64` and `int64` use 4 bytes.
|
|
||||||
|
|
||||||
Negative integers are encoded via twos-complement.
|
## Byte Arrays
|
||||||
|
|
||||||
Examples:
|
The encoding of a byte array is simply the raw-bytes prefixed with the length of
|
||||||
|
the array as a `UVarint` (what Protobuf calls a `Varint`).
|
||||||
|
|
||||||
```go
|
For details on varints, see the [protobuf
|
||||||
encode(uint8(6)) == [0x06]
|
spec](https://developers.google.com/protocol-buffers/docs/encoding#varints).
|
||||||
encode(uint32(6)) == [0x00, 0x00, 0x00, 0x06]
|
|
||||||
|
|
||||||
encode(int8(-6)) == [0xFA]
|
For example, the byte-array `[0xA, 0xB]` would be encoded as `0x020A0B`,
|
||||||
encode(int32(-6)) == [0xFF, 0xFF, 0xFF, 0xFA]
|
while a byte-array containing 300 entires beginning with `[0xA, 0xB, ...]` would
|
||||||
|
be encoded as `0xAC020A0B...` where `0xAC02` is the UVarint encoding of 300.
|
||||||
|
|
||||||
|
## Public Key Cryptography
|
||||||
|
|
||||||
|
Tendermint uses Amino to distinguish between different types of private keys,
|
||||||
|
public keys, and signatures. Additionally, for each public key, Tendermint
|
||||||
|
defines an Address function that can be used as a more compact identifier in
|
||||||
|
place of the public key. Here we list the concrete types, their names,
|
||||||
|
and prefix bytes for public keys and signatures, as well as the address schemes
|
||||||
|
for each PubKey. Note for brevity we don't
|
||||||
|
include details of the private keys beyond their type and name, as they can be
|
||||||
|
derrived the same way as the others using Amino.
|
||||||
|
|
||||||
|
All registered objects are encoded by Amino using a 4-byte PrefixBytes that
|
||||||
|
uniquely identifies the object and includes information about its underlying
|
||||||
|
type. For details on how PrefixBytes are computed, see the [Amino
|
||||||
|
spec](https://github.com/tendermint/go-amino#computing-the-prefix-and-disambiguation-bytes).
|
||||||
|
|
||||||
|
In what follows, we provide the type names and prefix bytes directly.
|
||||||
|
Notice that when encoding byte-arrays, the length of the byte-array is appended
|
||||||
|
to the PrefixBytes. Thus the encoding of a byte array becomes `<PrefixBytes>
|
||||||
|
<Length> <ByteArray>`
|
||||||
|
|
||||||
|
(NOTE: the remainder of this section on Public Key Cryptography can be generated
|
||||||
|
from [this script](./scripts/crypto.go))
|
||||||
|
|
||||||
|
### PubKeyEd25519
|
||||||
|
|
||||||
|
```
|
||||||
|
// Name: tendermint/PubKeyEd25519
|
||||||
|
// PrefixBytes: 0x1624DE62
|
||||||
|
// Length: 0x20
|
||||||
|
// Notes: raw 32-byte Ed25519 pubkey
|
||||||
|
type PubKeyEd25519 [32]byte
|
||||||
|
|
||||||
|
func (pubkey PubKeyEd25519) Address() []byte {
|
||||||
|
// NOTE: hash of the Amino encoded bytes!
|
||||||
|
return RIPEMD160(AminoEncode(pubkey))
|
||||||
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
### Variable Length Integers
|
For example, the 32-byte Ed25519 pubkey
|
||||||
|
`CCACD52F9B29D04393F01CD9AF6535455668115641F3D8BAEFD2295F24BAF60E` would be
|
||||||
|
encoded as
|
||||||
|
`1624DE6220CCACD52F9B29D04393F01CD9AF6535455668115641F3D8BAEFD2295F24BAF60E`.
|
||||||
|
|
||||||
Variable length integers are encoded as length-prefixed Big-Endian integers.
|
The address would then be
|
||||||
The length-prefix consists of a single byte and corresponds to the length of the encoded integer.
|
`RIPEMD160(0x1624DE6220CCACD52F9B29D04393F01CD9AF6535455668115641F3D8BAEFD2295F24BAF60E)`
|
||||||
|
or `430FF75BAF1EC4B0D51BB3EEC2955479D0071605`
|
||||||
|
|
||||||
Negative integers are encoded by flipping the leading bit of the length-prefix to a `1`.
|
### SignatureEd25519
|
||||||
|
|
||||||
Zero is encoded as `0x00`. It is not length-prefixed.
|
```
|
||||||
|
// Name: tendermint/SignatureKeyEd25519
|
||||||
Examples:
|
// PrefixBytes: 0x3DA1DB2A
|
||||||
|
// Length: 0x40
|
||||||
```go
|
// Notes: raw 64-byte Ed25519 signature
|
||||||
encode(uint(6)) == [0x01, 0x06]
|
type SignatureEd25519 [64]byte
|
||||||
encode(uint(70000)) == [0x03, 0x01, 0x11, 0x70]
|
|
||||||
|
|
||||||
encode(int(-6)) == [0xF1, 0x06]
|
|
||||||
encode(int(-70000)) == [0xF3, 0x01, 0x11, 0x70]
|
|
||||||
|
|
||||||
encode(int(0)) == [0x00]
|
|
||||||
```
|
```
|
||||||
|
|
||||||
### Strings
|
For example, the 64-byte Ed25519 signature
|
||||||
|
`1B6034A8ED149D3C94FDA13EC03B26CC0FB264D9B0E47D3FA3DEF9FCDE658E49C80B35F9BE74949356401B15B18FB817D6E54495AD1C4A8401B248466CB0DB0B`
|
||||||
|
would be encoded as
|
||||||
|
`3DA1DB2A401B6034A8ED149D3C94FDA13EC03B26CC0FB264D9B0E47D3FA3DEF9FCDE658E49C80B35F9BE74949356401B15B18FB817D6E54495AD1C4A8401B248466CB0DB0B`
|
||||||
|
|
||||||
An encoded string is length-prefixed followed by the underlying bytes of the string.
|
### PrivKeyEd25519
|
||||||
The length-prefix is itself encoded as an `int`.
|
|
||||||
|
|
||||||
The empty string is encoded as `0x00`. It is not length-prefixed.
|
```
|
||||||
|
// Name: tendermint/PrivKeyEd25519
|
||||||
Examples:
|
// Notes: raw 32-byte priv key concatenated to raw 32-byte pub key
|
||||||
|
type PrivKeyEd25519 [64]byte
|
||||||
```go
|
|
||||||
encode("") == [0x00]
|
|
||||||
encode("a") == [0x01, 0x01, 0x61]
|
|
||||||
encode("hello") == [0x01, 0x05, 0x68, 0x65, 0x6C, 0x6C, 0x6F]
|
|
||||||
encode("¥") == [0x01, 0x02, 0xC2, 0xA5]
|
|
||||||
```
|
```
|
||||||
|
|
||||||
### Arrays (fixed length)
|
### PubKeySecp256k1
|
||||||
|
|
||||||
An encoded fix-lengthed array is the concatenation of the encoding of its elements.
|
```
|
||||||
There is no length-prefix.
|
// Name: tendermint/PubKeySecp256k1
|
||||||
|
// PrefixBytes: 0xEB5AE982
|
||||||
|
// Length: 0x21
|
||||||
|
// Notes: OpenSSL compressed pubkey prefixed with 0x02 or 0x03
|
||||||
|
type PubKeySecp256k1 [33]byte
|
||||||
|
|
||||||
Examples:
|
func (pubkey PubKeySecp256k1) Address() []byte {
|
||||||
|
// NOTE: hash of the raw pubkey bytes (not Amino encoded!).
|
||||||
```go
|
// Compatible with Bitcoin addresses.
|
||||||
encode([4]int8{1, 2, 3, 4}) == [0x01, 0x02, 0x03, 0x04]
|
return RIPEMD160(SHA256(pubkey[:]))
|
||||||
encode([4]int16{1, 2, 3, 4}) == [0x00, 0x01, 0x00, 0x02, 0x00, 0x03, 0x00, 0x04]
|
}
|
||||||
encode([4]int{1, 2, 3, 4}) == [0x01, 0x01, 0x01, 0x02, 0x01, 0x03, 0x01, 0x04]
|
|
||||||
encode([2]string{"abc", "efg"}) == [0x01, 0x03, 0x61, 0x62, 0x63, 0x01, 0x03, 0x65, 0x66, 0x67]
|
|
||||||
```
|
```
|
||||||
|
|
||||||
### Slices (variable length)
|
For example, the 33-byte Secp256k1 pubkey
|
||||||
|
`020BD40F225A57ED383B440CF073BC5539D0341F5767D2BF2D78406D00475A2EE9` would be
|
||||||
|
encoded as
|
||||||
|
`EB5AE98221020BD40F225A57ED383B440CF073BC5539D0341F5767D2BF2D78406D00475A2EE9`
|
||||||
|
|
||||||
An encoded variable-length array is length-prefixed followed by the concatenation of the encoding of
|
The address would then be
|
||||||
its elements.
|
`RIPEMD160(SHA256(0x020BD40F225A57ED383B440CF073BC5539D0341F5767D2BF2D78406D00475A2EE9))`
|
||||||
The length-prefix is itself encoded as an `int`.
|
or `0AE5BEE929ABE51BAD345DB925EEA652680783FC`
|
||||||
|
|
||||||
An empty slice is encoded as `0x00`. It is not length-prefixed.
|
### SignatureSecp256k1
|
||||||
|
|
||||||
Examples:
|
|
||||||
|
|
||||||
```go
|
|
||||||
encode([]int8{}) == [0x00]
|
|
||||||
encode([]int8{1, 2, 3, 4}) == [0x01, 0x04, 0x01, 0x02, 0x03, 0x04]
|
|
||||||
encode([]int16{1, 2, 3, 4}) == [0x01, 0x04, 0x00, 0x01, 0x00, 0x02, 0x00, 0x03, 0x00, 0x04]
|
|
||||||
encode([]int{1, 2, 3, 4}) == [0x01, 0x04, 0x01, 0x01, 0x01, 0x02, 0x01, 0x03, 0x01, 0x4]
|
|
||||||
encode([]string{"abc", "efg"}) == [0x01, 0x02, 0x01, 0x03, 0x61, 0x62, 0x63, 0x01, 0x03, 0x65, 0x66, 0x67]
|
|
||||||
```
|
```
|
||||||
|
// Name: tendermint/SignatureKeySecp256k1
|
||||||
|
// PrefixBytes: 0x16E1FEEA
|
||||||
|
// Length: Variable
|
||||||
|
// Encoding prefix: Variable
|
||||||
|
// Notes: raw bytes of the Secp256k1 signature
|
||||||
|
type SignatureSecp256k1 []byte
|
||||||
|
```
|
||||||
|
|
||||||
|
For example, the Secp256k1 signature
|
||||||
|
`304402201CD4B8C764D2FD8AF23ECFE6666CA8A53886D47754D951295D2D311E1FEA33BF02201E0F906BB1CF2C30EAACFFB032A7129358AFF96B9F79B06ACFFB18AC90C2ADD7`
|
||||||
|
would be encoded as
|
||||||
|
`16E1FEEA46304402201CD4B8C764D2FD8AF23ECFE6666CA8A53886D47754D951295D2D311E1FEA33BF02201E0F906BB1CF2C30EAACFFB032A7129358AFF96B9F79B06ACFFB18AC90C2ADD7`
|
||||||
|
|
||||||
|
### PrivKeySecp256k1
|
||||||
|
|
||||||
|
```
|
||||||
|
// Name: tendermint/PrivKeySecp256k1
|
||||||
|
// Notes: raw 32-byte priv key
|
||||||
|
type PrivKeySecp256k1 [32]byte
|
||||||
|
```
|
||||||
|
|
||||||
|
## Other Common Types
|
||||||
|
|
||||||
### BitArray
|
### BitArray
|
||||||
|
|
||||||
BitArray is encoded as an `int` of the number of bits, and with an array of `uint64` to encode
|
The BitArray is used in block headers and some consensus messages to signal
|
||||||
value of each array element.
|
whether or not something was done by each validator. BitArray is represented
|
||||||
|
with a struct containing the number of bits (`Bits`) and the bit-array itself
|
||||||
|
encoded in base64 (`Elems`).
|
||||||
|
|
||||||
```go
|
```go
|
||||||
type BitArray struct {
|
type BitArray struct {
|
||||||
@ -109,36 +166,35 @@ type BitArray struct {
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
### Time
|
This type is easily encoded directly by Amino.
|
||||||
|
|
||||||
Time is encoded as an `int64` of the number of nanoseconds since January 1, 1970,
|
Note BitArray receives a special JSON encoding in the form of `x` and `_`
|
||||||
rounded to the nearest millisecond.
|
representing `1` and `0`. Ie. the BitArray `10110` would be JSON encoded as
|
||||||
|
`"x_xx_"`
|
||||||
|
|
||||||
Times before then are invalid.
|
### Part
|
||||||
|
|
||||||
Examples:
|
Part is used to break up blocks into pieces that can be gossiped in parallel
|
||||||
|
and securely verified using a Merkle tree of the parts.
|
||||||
|
|
||||||
|
Part contains the index of the part in the larger set (`Index`), the actual
|
||||||
|
underlying data of the part (`Bytes`), and a simple Merkle proof that the part is contained in
|
||||||
|
the larger set (`Proof`).
|
||||||
|
|
||||||
```go
|
```go
|
||||||
encode(time.Time("Jan 1 00:00:00 UTC 1970")) == [0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00]
|
type Part struct {
|
||||||
encode(time.Time("Jan 1 00:00:01 UTC 1970")) == [0x00, 0x00, 0x00, 0x00, 0x3B, 0x9A, 0xCA, 0x00] // 1,000,000,000 ns
|
Index int
|
||||||
encode(time.Time("Mon Jan 2 15:04:05 -0700 MST 2006")) == [0x0F, 0xC4, 0xBB, 0xC1, 0x53, 0x03, 0x12, 0x00]
|
Bytes byte[]
|
||||||
|
Proof byte[]
|
||||||
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
### Structs
|
### MakeParts
|
||||||
|
|
||||||
An encoded struct is the concatenation of the encoding of its elements.
|
Encode an object using Amino and slice it into parts.
|
||||||
There is no length-prefix.
|
|
||||||
|
|
||||||
Examples:
|
|
||||||
|
|
||||||
```go
|
```go
|
||||||
type MyStruct struct{
|
func MakeParts(obj interface{}, partSize int) []Part
|
||||||
A int
|
|
||||||
B string
|
|
||||||
C time.Time
|
|
||||||
}
|
|
||||||
encode(MyStruct{4, "hello", time.Time("Mon Jan 2 15:04:05 -0700 MST 2006")}) ==
|
|
||||||
[0x01, 0x04, 0x01, 0x05, 0x68, 0x65, 0x6C, 0x6C, 0x6F, 0x0F, 0xC4, 0xBB, 0xC1, 0x53, 0x03, 0x12, 0x00]
|
|
||||||
```
|
```
|
||||||
|
|
||||||
## Merkle Trees
|
## Merkle Trees
|
||||||
@ -147,6 +203,8 @@ Simple Merkle trees are used in numerous places in Tendermint to compute a crypt
|
|||||||
|
|
||||||
RIPEMD160 is always used as the hashing function.
|
RIPEMD160 is always used as the hashing function.
|
||||||
|
|
||||||
|
### Simple Merkle Root
|
||||||
|
|
||||||
The function `SimpleMerkleRoot` is a simple recursive function defined as follows:
|
The function `SimpleMerkleRoot` is a simple recursive function defined as follows:
|
||||||
|
|
||||||
```go
|
```go
|
||||||
@ -159,20 +217,69 @@ func SimpleMerkleRoot(hashes [][]byte) []byte{
|
|||||||
default:
|
default:
|
||||||
left := SimpleMerkleRoot(hashes[:(len(hashes)+1)/2])
|
left := SimpleMerkleRoot(hashes[:(len(hashes)+1)/2])
|
||||||
right := SimpleMerkleRoot(hashes[(len(hashes)+1)/2:])
|
right := SimpleMerkleRoot(hashes[(len(hashes)+1)/2:])
|
||||||
return RIPEMD160(append(left, right))
|
return SimpleConcatHash(left, right)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func SimpleConcatHash(left, right []byte) []byte{
|
||||||
|
left = encodeByteSlice(left)
|
||||||
|
right = encodeByteSlice(right)
|
||||||
|
return RIPEMD160 (append(left, right))
|
||||||
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
Note: we abuse notion and call `SimpleMerkleRoot` with arguments of type `struct` or type `[]struct`.
|
Note that the leaves are Amino encoded as byte-arrays (ie. simple Uvarint length
|
||||||
|
prefix) before being concatenated together and hashed.
|
||||||
|
|
||||||
|
Note: we will abuse notion and invoke `SimpleMerkleRoot` with arguments of type `struct` or type `[]struct`.
|
||||||
For `struct` arguments, we compute a `[][]byte` by sorting elements of the `struct` according to
|
For `struct` arguments, we compute a `[][]byte` by sorting elements of the `struct` according to
|
||||||
field name and then hashing them.
|
field name and then hashing them.
|
||||||
For `[]struct` arguments, we compute a `[][]byte` by hashing the individual `struct` elements.
|
For `[]struct` arguments, we compute a `[][]byte` by hashing the individual `struct` elements.
|
||||||
|
|
||||||
## JSON (TMJSON)
|
### Simple Merkle Proof
|
||||||
|
|
||||||
Signed messages (eg. votes, proposals) in the consensus are encoded in TMJSON, rather than TMBIN.
|
Proof that a leaf is in a Merkle tree consists of a simple structure:
|
||||||
TMJSON is JSON where `[]byte` are encoded as uppercase hex, rather than base64.
|
|
||||||
|
|
||||||
|
```
|
||||||
|
type SimpleProof struct {
|
||||||
|
Aunts [][]byte
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
Which is verified using the following:
|
||||||
|
|
||||||
|
```
|
||||||
|
func (proof SimpleProof) Verify(index, total int, leafHash, rootHash []byte) bool {
|
||||||
|
computedHash := computeHashFromAunts(index, total, leafHash, proof.Aunts)
|
||||||
|
return computedHash == rootHash
|
||||||
|
}
|
||||||
|
|
||||||
|
func computeHashFromAunts(index, total int, leafHash []byte, innerHashes [][]byte) []byte{
|
||||||
|
assert(index < total && index >= 0 && total > 0)
|
||||||
|
|
||||||
|
if total == 1{
|
||||||
|
assert(len(proof.Aunts) == 0)
|
||||||
|
return leafHash
|
||||||
|
}
|
||||||
|
|
||||||
|
assert(len(innerHashes) > 0)
|
||||||
|
|
||||||
|
numLeft := (total + 1) / 2
|
||||||
|
if index < numLeft {
|
||||||
|
leftHash := computeHashFromAunts(index, numLeft, leafHash, innerHashes[:len(innerHashes)-1])
|
||||||
|
assert(leftHash != nil)
|
||||||
|
return SimpleHashFromTwoHashes(leftHash, innerHashes[len(innerHashes)-1])
|
||||||
|
}
|
||||||
|
rightHash := computeHashFromAunts(index-numLeft, total-numLeft, leafHash, innerHashes[:len(innerHashes)-1])
|
||||||
|
assert(rightHash != nil)
|
||||||
|
return SimpleHashFromTwoHashes(innerHashes[len(innerHashes)-1], rightHash)
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
## AminoJSON
|
||||||
|
|
||||||
|
Signed messages (eg. votes, proposals) in the consensus are encoded in AminoJSON, rather than binary Amino.
|
||||||
|
|
||||||
When signing, the elements of a message are sorted by key and the sorted message is embedded in an
|
When signing, the elements of a message are sorted by key and the sorted message is embedded in an
|
||||||
outer JSON that includes a `chain_id` field.
|
outer JSON that includes a `chain_id` field.
|
||||||
@ -185,22 +292,5 @@ like:
|
|||||||
|
|
||||||
Note how the fields within each level are sorted.
|
Note how the fields within each level are sorted.
|
||||||
|
|
||||||
## Other
|
|
||||||
|
|
||||||
### MakeParts
|
|
||||||
|
|
||||||
Encode an object using TMBIN and slice it into parts.
|
|
||||||
|
|
||||||
```go
|
|
||||||
MakeParts(object, partSize)
|
|
||||||
```
|
|
||||||
|
|
||||||
### Part
|
|
||||||
|
|
||||||
```go
|
|
||||||
type Part struct {
|
|
||||||
Index int
|
|
||||||
Bytes byte[]
|
|
||||||
Proof byte[]
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
125
docs/specification/new-spec/scripts/crypto.go
Normal file
125
docs/specification/new-spec/scripts/crypto.go
Normal file
@ -0,0 +1,125 @@
|
|||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
|
||||||
|
crypto "github.com/tendermint/go-crypto"
|
||||||
|
)
|
||||||
|
|
||||||
|
// SECRET
|
||||||
|
var SECRET = []byte("some secret")
|
||||||
|
|
||||||
|
func printEd() {
|
||||||
|
priv := crypto.GenPrivKeyEd25519FromSecret(SECRET)
|
||||||
|
pub := priv.PubKey().(crypto.PubKeyEd25519)
|
||||||
|
sig := priv.Sign([]byte("hello")).(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)
|
||||||
|
sig := priv.Sign([]byte("hello")).(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()
|
||||||
|
fmt.Println("")
|
||||||
|
printSecp()
|
||||||
|
}
|
@ -1,80 +0,0 @@
|
|||||||
package main
|
|
||||||
|
|
||||||
import (
|
|
||||||
"fmt"
|
|
||||||
"time"
|
|
||||||
|
|
||||||
wire "github.com/tendermint/go-wire"
|
|
||||||
)
|
|
||||||
|
|
||||||
func main() {
|
|
||||||
|
|
||||||
encode(uint8(6))
|
|
||||||
encode(uint32(6))
|
|
||||||
encode(int8(-6))
|
|
||||||
encode(int32(-6))
|
|
||||||
Break()
|
|
||||||
encode(uint(6))
|
|
||||||
encode(uint(70000))
|
|
||||||
encode(int(0))
|
|
||||||
encode(int(-6))
|
|
||||||
encode(int(-70000))
|
|
||||||
Break()
|
|
||||||
encode("")
|
|
||||||
encode("a")
|
|
||||||
encode("hello")
|
|
||||||
encode("¥")
|
|
||||||
Break()
|
|
||||||
encode([4]int8{1, 2, 3, 4})
|
|
||||||
encode([4]int16{1, 2, 3, 4})
|
|
||||||
encode([4]int{1, 2, 3, 4})
|
|
||||||
encode([2]string{"abc", "efg"})
|
|
||||||
Break()
|
|
||||||
encode([]int8{})
|
|
||||||
encode([]int8{1, 2, 3, 4})
|
|
||||||
encode([]int16{1, 2, 3, 4})
|
|
||||||
encode([]int{1, 2, 3, 4})
|
|
||||||
encode([]string{"abc", "efg"})
|
|
||||||
Break()
|
|
||||||
|
|
||||||
timeFmt := "Mon Jan 2 15:04:05 -0700 MST 2006"
|
|
||||||
t1, _ := time.Parse(timeFmt, timeFmt)
|
|
||||||
n := (t1.UnixNano() / 1000000.) * 1000000
|
|
||||||
encode(n)
|
|
||||||
encode(t1)
|
|
||||||
|
|
||||||
t2, _ := time.Parse(timeFmt, "Thu Jan 1 00:00:00 -0000 UTC 1970")
|
|
||||||
encode(t2)
|
|
||||||
|
|
||||||
t2, _ = time.Parse(timeFmt, "Thu Jan 1 00:00:01 -0000 UTC 1970")
|
|
||||||
fmt.Println("N", t2.UnixNano())
|
|
||||||
encode(t2)
|
|
||||||
Break()
|
|
||||||
encode(struct {
|
|
||||||
A int
|
|
||||||
B string
|
|
||||||
C time.Time
|
|
||||||
}{
|
|
||||||
4,
|
|
||||||
"hello",
|
|
||||||
t1,
|
|
||||||
})
|
|
||||||
}
|
|
||||||
|
|
||||||
func encode(i interface{}) {
|
|
||||||
Println(wire.BinaryBytes(i))
|
|
||||||
|
|
||||||
}
|
|
||||||
|
|
||||||
func Println(b []byte) {
|
|
||||||
s := "["
|
|
||||||
for _, x := range b {
|
|
||||||
s += fmt.Sprintf("0x%.2X, ", x)
|
|
||||||
}
|
|
||||||
s = s[:len(s)-2] + "]"
|
|
||||||
fmt.Println(s)
|
|
||||||
}
|
|
||||||
|
|
||||||
func Break() {
|
|
||||||
fmt.Println("------")
|
|
||||||
}
|
|
Loading…
x
Reference in New Issue
Block a user