diff --git a/docs/spec/ibc/mvp1.md b/docs/spec/ibc/mvp1.md index cadc745dd5..3cfaf88ce8 100644 --- a/docs/spec/ibc/mvp1.md +++ b/docs/spec/ibc/mvp1.md @@ -11,7 +11,7 @@ The initial implementation of IBC will include just enough for simple coin trans ```golang // User facing API -type IBCTransferPacket struct { +type IBCPacket struct { DestAddr sdk.Address Coins sdk.Coins SrcChain string @@ -20,19 +20,20 @@ type IBCTransferPacket struct { // Implements sdk.Msg type IBCTransferMsg struct { - IBCTransferPacket + IBCPacket } // Implements sdk.Msg type IBCReceiveMsg struct { - IBCTransferPacket + IBCPacket } // Internal API type IBCMapper struct { - ingressKey sdk.StoreKey // Source Chain ID => last income msg's sequence - egressKey sdk.StoreKey // (Dest chain ID, Msg index) => length / indexed msg + ibcKey sdk.StoreKey // IngressKey / EgressKey => Value + // Ingress: Source Chain ID => last income msg's sequence + // Egress: (Dest chain ID, Msg index) => length / indexed msg } type IngressKey struct { diff --git a/docs/spec/ibc/mvp2.md b/docs/spec/ibc/mvp2.md index deee209527..acfd45e22f 100644 --- a/docs/spec/ibc/mvp2.md +++ b/docs/spec/ibc/mvp2.md @@ -11,7 +11,7 @@ IBC module will store its own router for handling custom incoming msgs. `IBCPush ```golang // User facing API -type IBCTransferPacket struct { +type IBCPacket struct { DestAddr sdk.Address Coins sdk.Coins SrcChain string @@ -20,12 +20,12 @@ type IBCTransferPacket struct { // Implements sdk.Msg type IBCTransferMsg struct { - IBCTransferPacket + IBCPacket } // Implements sdk.Msg type IBCReceiveMsg struct { - IBCTransferPacket + IBCPacket } // Internal API @@ -33,12 +33,13 @@ type IBCReceiveMsg struct { func NewHandler(dispatcher Dispatcher, ibcm IBCMapper) sdk.Handler type IBCMapper struct { - ingressKey sdk.StoreKey // Source Chain ID => last income msg's sequence - egressKey sdk.StoreKey // (Dest chain ID, Msg index) => length / indexed msg + ibcKey sdk.StoreKey // IngressKey / EgressKey => Value + // Ingress: Source Chain ID => last income msg's sequence + // Egress: (Dest chain ID, Msg index) => length / indexed msg } type IngressKey struct { - SourceChain string + SrcChain string } type EgressKey struct { diff --git a/docs/spec/ibc/mvp3.md b/docs/spec/ibc/mvp3.md index d53e2c00e3..1f12b3bfee 100644 --- a/docs/spec/ibc/mvp3.md +++ b/docs/spec/ibc/mvp3.md @@ -16,13 +16,13 @@ type IBCTransferData struct { } // Implements ibc.PacketData -type IBCTransferPacket struct { - IBCTransferData +type IBCPacket struct { + IBCData } // Implements ibc.PacketData type IBCReceivePacket struct { - IBCTransferData + IBCData } type Packet struct { @@ -52,9 +52,10 @@ type IBCUpdateMsg struct { func NewHandler(dispatcher Dispatcher, ibcm IBCMapper) sdk.Handler type IBCMapper struct { - ingressKey sdk.StoreKey // ChannelID => last income msg's sequence - egressKey sdk.StoreKey // (ChannelID, Msg index) => length / indexed msg - headerKey sdk.StoreKey // ChannelID => last known header + ibcKey sdk.StoreKey // IngressKey / EgressKey / HeaderKey => Value + // ChannelID => last income msg's sequence + // (ChannelID, Msg index) => length / indexed msg + // ChannelID => last known header } type IngressKey struct {