diff --git a/docs/glossary.rst b/docs/glossary.rst index bef1b7cdc..e67f7a095 100644 --- a/docs/glossary.rst +++ b/docs/glossary.rst @@ -32,7 +32,7 @@ users (or apps) to inspect the chain. Note how we can wrap any other transaction, add a fee level, and not worry about the encoding in our module any more? -.. code:: golang +:: type Fee struct { Fee coin.Coin `json:"fee"` @@ -118,7 +118,7 @@ structures into an internal format that is more convenient, but unable to travel over the wire. The basic interface for any code that modifies state is the ``Handler`` interface, which provides four methods: -.. code:: golang +:: Name() string CheckTx(ctx Context, store state.KVStore, tx Tx) (Result, error) @@ -154,7 +154,7 @@ extra ``next`` parameter, and a ``Stack`` that can wire all the levels together (which also gives us a place to perform seperation of each step). -.. code:: golang +:: Name() string CheckTx(ctx Context, store state.KVStore, tx Tx, next Checker) (Result, error) @@ -198,7 +198,7 @@ go-wire magic that we are already using, rather than add another layer. For all the transactions to be properly routed, the only thing you need to remember is to use the following pattern: -.. code:: golang +:: const ( NameCoin = "coin" @@ -217,7 +217,7 @@ permissions than simple public key signatures. Rather than just use an address to identify who is performing an action, we can use a more complex structure: -.. code:: golang +:: type Actor struct { ChainID string `json:"chain"` // this is empty unless it comes from a different chain diff --git a/docs/ibc.rst b/docs/ibc.rst index ab6539fa5..f2392aaaa 100644 --- a/docs/ibc.rst +++ b/docs/ibc.rst @@ -69,7 +69,7 @@ The ``IBCRegisterChainTx`` is used to register one chain on another. It contains the chain ID and genesis configuration of the chain to register: -.. code:: golang +:: type IBCRegisterChainTx struct { BlockchainGenesis } @@ -85,7 +85,7 @@ The ``IBCUpdateChainTx`` is used to update the state of one chain on another. It contains the header and commit signatures for some block in the chain: -.. code:: golang +:: type IBCUpdateChainTx struct { Header tm.Header @@ -106,7 +106,7 @@ a sequence number (i.e. an integer that increments with every message sent between this pair of chains), a packet type (e.g. coin, data, etc.), and a payload. -.. code:: golang +:: type IBCPacketCreateTx struct { Packet @@ -137,7 +137,7 @@ The ``IBCPacketPostTx`` is used to post an outgoing packet from one chain to another. It contains the packet and a proof that the packet was committed into the state of the sending chain: -.. code:: golang +:: type IBCPacketPostTx struct { FromChainID string // The immediate source of the packet, not always Packet.SrcChainID diff --git a/docs/sdk/overview.rst b/docs/sdk/overview.rst index 5cac2ffcd..32d777dbb 100644 --- a/docs/sdk/overview.rst +++ b/docs/sdk/overview.rst @@ -322,6 +322,7 @@ TODO: * IAVLStore: Fast balanced dynamic Merkle store. * supports iteration. + * MultiStore: multiple Merkle tree backends in a single store * allows using Ethereum Patricia Trie and Tendermint IAVL in same app