Tendermint Streaming Protocol (TMSP)

TMSP is a socket protocol, which means applications can be written in any programming language. TMSP is an asynchronous streaming protocol: message responses are written back asynchronously to the platform.

Applications must be deterministic.

Message types

AppendTx

• Arguments:
  • TxBytes ([]byte)
• Returns:
  • RetCode (int8)
• Usage:
  Append and run a transaction. The transaction may or may not be final.

GetHash

• Returns:
  • RetCode (int8)
  • Hash ([]byte)
• Usage:
  Return a Merkle root hash of the application state

Commit

• Returns:
  • RetCode (int8)
• Usage:
  Finalize all appended transactions

Rollback

• Returns:
  • RetCode (int8)
• Usage:
  Roll back to the last commit

SetEventsMode

• Arguments:
  • EventsMode (int8):
    • EventsModeOff (0): Events are not reported. Used for mempool.
    • EventsModeCached (1): Events are cached.
    • EventsModeOn (2): Flush cache and report events.
• Returns:
  • RetCode (int8)
• Usage:
  Set event reporting mode for future transactions

AddListener

• Arguments:
  • EventKey (string)
• Returns:
  • RetCode (int8)
• Usage:
  Add event listener callback for events with given key.

RemoveListener

• Arguments:
  • EventKey (string)
• Returns:
  • RetCode (int8)
• Usage:
  Remove event listener callback for events with given key.