fluencelabs/tendermint
1
0
Fork 0
mirror of https://github.com/fluencelabs/tendermint synced 2025-06-15 14:21:22 +00:00
Code Issues Projects Releases Wiki Activity

add warnings about new spec

Browse Source
This commit is contained in:
Ethan Buchman
2018-01-19 17:51:09 -05:00
parent f2d19162d2
commit ae27e85bf7
2 changed files with 22 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
docs/specification/new-spec/README.md
View File

@ -1,14 +1,24 @@
# Tendermint Specification # Tendermint Specification
This is a markdown specification of the Tendermint blockchain. This is a markdown specification of the Tendermint blockchain.
It defines the base data structures used in the blockchain and how they are validated. It defines the base data structures used in the blockchain and how they are validated.
It contains the following components: XXX: this spec is a work in progress and not yet complete - see github
[isses](https://github.com/tendermint/tendermint/issues) and
[pull requests](https://github.com/tendermint/tendermint/pulls)
for more details.
If you find discrepancies between the spec and the code that
do not have an associated issue or pull request on github,
please submit them to our [bug bounty](https://tendermint.com/security)!
## Contents
- [Overview](#overview)
- [Encoding and Digests](encoding.md) - [Encoding and Digests](encoding.md)
- [Blockchain](blockchain.md) - [Blockchain](blockchain.md)
- [State](state.md) - [State](state.md)
- [Consensus](consensus.md)
- [P2P](p2p/node.md) - [P2P](p2p/node.md)
## Overview ## Overview
@ -56,3 +66,4 @@ We call this the `State`. Block verification also requires access to the previou
- Light Client - Light Client
- P2P - P2P
- Reactor protocols (consensus, mempool, blockchain, pex) - Reactor protocols (consensus, mempool, blockchain, pex)

3
docs/specification/new-spec/encoding.md
View File

@ -6,6 +6,9 @@ Tendermint aims to encode data structures in a manner similar to how the corresp
Variable length items are length-prefixed. Variable length items are length-prefixed.
While the encoding was inspired by Go, it is easily implemented in other languages as well given its intuitive design. While the encoding was inspired by Go, it is easily implemented in other languages as well given its intuitive design.
XXX: This is changing to use real varints and 4-byte-prefixes.
See https://github.com/tendermint/go-wire/tree/sdk2.
### Fixed Length Integers ### Fixed Length Integers
Fixed length integers are encoded in Big-Endian using the specified number of bytes. Fixed length integers are encoded in Big-Endian using the specified number of bytes.