Browse Source

Update README.md

pull/1780/head
Jae Kwon 9 years ago
parent
commit
9a8d40b87c
1 changed files with 13 additions and 7 deletions
  1. +13
    -7
      README.md

+ 13
- 7
README.md View File

@ -10,6 +10,12 @@ Other implementations:
* [cpp-tmsp](https://github.com/mdyring/cpp-tmsp) by Martin Dyring-Andersen * [cpp-tmsp](https://github.com/mdyring/cpp-tmsp) by Martin Dyring-Andersen
* [js-tmsp](https://github.com/tendermint/js-tmsp) * [js-tmsp](https://github.com/tendermint/js-tmsp)
## Message format
Since this is a streaming protocol, all messages are encoded with a length-prefix followed by the message encoded in Protobuf3. Protobuf3 doesn't have an official length-prefix standard, so we use our own. The first byte represents the length of the big-endian encoded length.
For example, if the Protobuf3 encoded TMSP message is `0xDEADBEEF` (4 bytes), the length-prefixed message is `0x0104DEADBEEF`. If the Protobuf3 encoded TMSP message is 65535 bytes long, the length-prefixed message would be like `0x02FFFF...`.
## Message types ## Message types
TMSP requests/responses are simple Protobuf messages. Check out the [schema file](https://github.com/tendermint/tmsp/blob/master/types/types.proto). TMSP requests/responses are simple Protobuf messages. Check out the [schema file](https://github.com/tendermint/tmsp/blob/master/types/types.proto).
@ -92,21 +98,21 @@ TMSP requests/responses are simple Protobuf messages. Check out the [schema fil
* __Usage__:<br/> * __Usage__:<br/>
Signals the end of a block. Called prior to each Commit after all transactions Signals the end of a block. Called prior to each Commit after all transactions
### Changelog
## Changelog
#### Mar 26h, 2016
##### Mar 26h, 2016
* Introduce BeginBlock * Introduce BeginBlock
#### Mar 6th, 2016
##### Mar 6th, 2016
* Added InitChain, EndBlock * Added InitChain, EndBlock
#### Feb 14th, 2016
##### Feb 14th, 2016
* s/GetHash/Commit/g * s/GetHash/Commit/g
* Document Protobuf request/response fields * Document Protobuf request/response fields
#### Jan 23th, 2016
##### Jan 23th, 2016
* Added CheckTx/Query TMSP message types * Added CheckTx/Query TMSP message types
* Added Result/Log fields to AppendTx/CheckTx/SetOption * Added Result/Log fields to AppendTx/CheckTx/SetOption
@ -114,10 +120,10 @@ TMSP requests/responses are simple Protobuf messages. Check out the [schema fil
* Removed Code from ResponseSetOption and ResponseGetHash * Removed Code from ResponseSetOption and ResponseGetHash
* Made examples BigEndian * Made examples BigEndian
#### Jan 12th, 2016
##### Jan 12th, 2016
* Added "RetCodeBadNonce = 0x06" return code * Added "RetCodeBadNonce = 0x06" return code
#### Jan 8th, 2016
##### Jan 8th, 2016
* Tendermint/TMSP now comes to consensus on the order first before AppendTx. * Tendermint/TMSP now comes to consensus on the order first before AppendTx.

Loading…
Cancel
Save