diff --git a/CHANGELOG.md b/CHANGELOG.md index 2da253f0bed..c019d979934 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -48,7 +48,7 @@ Ref: https://keepachangelog.com/en/1.0.0/ ### Features -* (apps/transfer) [\#2305](https://github.com/cosmos/ibc-go/pull/2305) Added optional metadata field to `FungibleTokenPacketData` and `MsgTransfer`. +* (apps/transfer) [\#2595](https://github.com/cosmos/ibc-go/pull/2595) Adding optional memo field to `FungibleTokenPacketData` and `MsgTransfer`. ### Bug Fixes diff --git a/docs/ibc/proto-docs.md b/docs/ibc/proto-docs.md index 881a5e4bc07..5b2a220281b 100644 --- a/docs/ibc/proto-docs.md +++ b/docs/ibc/proto-docs.md @@ -699,7 +699,7 @@ https://github.com/cosmos/ibc/tree/master/spec/app/ics-020-fungible-token-transf | `receiver` | [string](#string) | | the recipient address on the destination chain | | `timeout_height` | [ibc.core.client.v1.Height](#ibc.core.client.v1.Height) | | Timeout height relative to the current block height. The timeout is disabled when set to 0. | | `timeout_timestamp` | [uint64](#uint64) | | Timeout timestamp (in nanoseconds) relative to the current block timestamp. The timeout is disabled when set to 0. | -| `metadata` | [bytes](#bytes) | | optional metadata | +| `memo` | [string](#string) | | optional memo | @@ -761,7 +761,7 @@ https://github.com/cosmos/ibc/tree/master/spec/app/ics-020-fungible-token-transf | `amount` | [string](#string) | | the token amount to be transferred | | `sender` | [string](#string) | | the sender address | | `receiver` | [string](#string) | | the recipient address on the destination chain | -| `metadata` | [bytes](#bytes) | | optional metadata | +| `memo` | [string](#string) | | optional memo | diff --git a/modules/apps/transfer/client/cli/tx.go b/modules/apps/transfer/client/cli/tx.go index 85c012da865..a7fa344d7ca 100644 --- a/modules/apps/transfer/client/cli/tx.go +++ b/modules/apps/transfer/client/cli/tx.go @@ -22,7 +22,7 @@ const ( flagPacketTimeoutHeight = "packet-timeout-height" flagPacketTimeoutTimestamp = "packet-timeout-timestamp" flagAbsoluteTimeouts = "absolute-timeouts" - flagMetadata = "metadata" + flagMemo = "memo" ) // NewTransferTxCmd returns the command to create a NewMsgTransfer transaction @@ -77,7 +77,7 @@ corresponding to the counterparty channel. Any timeout set to 0 is disabled.`), return err } - metadataStr, err := cmd.Flags().GetString(flagMetadata) + memo, err := cmd.Flags().GetString(flagMemo) if err != nil { return err } @@ -119,7 +119,7 @@ corresponding to the counterparty channel. Any timeout set to 0 is disabled.`), msg := types.NewMsgTransfer( srcPort, srcChannel, coin, sender, receiver, timeoutHeight, timeoutTimestamp, ) - msg.Metadata = []byte(metadataStr) + msg.Memo = memo return tx.GenerateOrBroadcastTxCLI(clientCtx, cmd.Flags(), msg) }, @@ -128,7 +128,7 @@ corresponding to the counterparty channel. Any timeout set to 0 is disabled.`), cmd.Flags().String(flagPacketTimeoutHeight, types.DefaultRelativePacketTimeoutHeight, "Packet timeout block height. The timeout is disabled when set to 0-0.") cmd.Flags().Uint64(flagPacketTimeoutTimestamp, types.DefaultRelativePacketTimeoutTimestamp, "Packet timeout timestamp in nanoseconds. Default is 10 minutes. The timeout is disabled when set to 0.") cmd.Flags().Bool(flagAbsoluteTimeouts, false, "Timeout flags are used as absolute timeouts.") - cmd.Flags().String(flagMetadata, "", "Metadata to be sent along with the packet. The CLI accepts only strings here but you can construct a packet with arbitrary bytes via code.") + cmd.Flags().String(flagMemo, "", "Memo to be sent along with the packet.") flags.AddTxFlagsToCmd(cmd) return cmd diff --git a/modules/apps/transfer/keeper/msg_server.go b/modules/apps/transfer/keeper/msg_server.go index 77c83a2f3e5..7b720146c7a 100644 --- a/modules/apps/transfer/keeper/msg_server.go +++ b/modules/apps/transfer/keeper/msg_server.go @@ -20,7 +20,7 @@ func (k Keeper) Transfer(goCtx context.Context, msg *types.MsgTransfer) (*types. sequence, err := k.sendTransfer( ctx, msg.SourcePort, msg.SourceChannel, msg.Token, sender, msg.Receiver, msg.TimeoutHeight, msg.TimeoutTimestamp, - msg.Metadata) + msg.Memo) if err != nil { return nil, err } diff --git a/modules/apps/transfer/keeper/msg_server_test.go b/modules/apps/transfer/keeper/msg_server_test.go index e09d326aa84..541f5fd3dcc 100644 --- a/modules/apps/transfer/keeper/msg_server_test.go +++ b/modules/apps/transfer/keeper/msg_server_test.go @@ -55,7 +55,7 @@ func (suite *KeeperTestSuite) TestMsgTransfer() { coin, suite.chainA.SenderAccount.GetAddress().String(), suite.chainB.SenderAccount.GetAddress().String(), suite.chainB.GetTimeoutHeight(), 0, // only use timeout height ) - msg.Metadata = []byte("custom metadata") + msg.Memo = "memo" tc.malleate() diff --git a/modules/apps/transfer/keeper/relay.go b/modules/apps/transfer/keeper/relay.go index 96527af63dc..fc7f5074c81 100644 --- a/modules/apps/transfer/keeper/relay.go +++ b/modules/apps/transfer/keeper/relay.go @@ -69,7 +69,7 @@ func (k Keeper) SendTransfer( receiver, timeoutHeight, timeoutTimestamp, - nil, + "", ) return err } @@ -84,7 +84,7 @@ func (k Keeper) sendTransfer( receiver string, timeoutHeight clienttypes.Height, timeoutTimestamp uint64, - metadata []byte, + memo string, ) (uint64, error) { if !k.GetSendEnabled(ctx) { return 0, types.ErrSendDisabled @@ -177,7 +177,7 @@ func (k Keeper) sendTransfer( packetData := types.NewFungibleTokenPacketData( fullDenomPath, token.Amount.String(), sender.String(), receiver, ) - packetData.Metadata = metadata + packetData.Memo = memo packet := channeltypes.NewPacket( packetData.GetBytes(), diff --git a/modules/apps/transfer/keeper/relay_test.go b/modules/apps/transfer/keeper/relay_test.go index 1bac750a713..acb8a792913 100644 --- a/modules/apps/transfer/keeper/relay_test.go +++ b/modules/apps/transfer/keeper/relay_test.go @@ -149,7 +149,7 @@ func (suite *KeeperTestSuite) TestOnRecvPacket() { trace types.DenomTrace amount sdk.Int receiver string - metadata []byte + memo string ) testCases := []struct { @@ -159,12 +159,12 @@ func (suite *KeeperTestSuite) TestOnRecvPacket() { expPass bool }{ {"success receive on source chain", func() {}, true, true}, - {"success receive on source chain with metadata", func() { - metadata = []byte("metadata") + {"success receive on source chain with memo", func() { + memo = "memo" }, true, true}, {"success receive with coin from another chain as source", func() {}, false, true}, - {"success receive with coin from another chain as source with metadata", func() { - metadata = []byte("metadata") + {"success receive with coin from another chain as source with memo", func() { + memo = "memo" }, false, true}, {"empty coin", func() { trace = types.DenomTrace{} @@ -206,7 +206,7 @@ func (suite *KeeperTestSuite) TestOnRecvPacket() { suite.coordinator.Setup(path) receiver = suite.chainB.SenderAccount.GetAddress().String() // must be explicitly changed in malleate - metadata = []byte{} // can be explicitly changed in malleate + memo = "" // can be explicitly changed in malleate amount = sdk.NewInt(100) // must be explicitly changed in malleate seq := uint64(1) @@ -234,14 +234,14 @@ func (suite *KeeperTestSuite) TestOnRecvPacket() { // send coin from chainA to chainB transferMsg := types.NewMsgTransfer(path.EndpointA.ChannelConfig.PortID, path.EndpointA.ChannelID, sdk.NewCoin(trace.IBCDenom(), amount), suite.chainA.SenderAccount.GetAddress().String(), receiver, clienttypes.NewHeight(0, 110), 0) - transferMsg.Metadata = metadata + transferMsg.Memo = memo _, err := suite.chainA.SendMsgs(transferMsg) suite.Require().NoError(err) // message committed tc.malleate() data := types.NewFungibleTokenPacketData(trace.GetFullDenomPath(), amount.String(), suite.chainA.SenderAccount.GetAddress().String(), receiver) - data.Metadata = metadata + data.Memo = memo packet := channeltypes.NewPacket(data.GetBytes(), seq, path.EndpointA.ChannelConfig.PortID, path.EndpointA.ChannelID, path.EndpointB.ChannelConfig.PortID, path.EndpointB.ChannelID, clienttypes.NewHeight(0, 100), 0) err = suite.chainB.GetSimApp().TransferKeeper.OnRecvPacket(suite.chainB.GetContext(), packet, data) diff --git a/modules/apps/transfer/module.go b/modules/apps/transfer/module.go index 4cf8bb65db4..58e29b2a8a8 100644 --- a/modules/apps/transfer/module.go +++ b/modules/apps/transfer/module.go @@ -2,7 +2,6 @@ package transfer import ( "context" - "encoding/hex" "encoding/json" "fmt" "math" @@ -355,7 +354,7 @@ func (am AppModule) OnRecvPacket( sdk.NewAttribute(types.AttributeKeyReceiver, data.Receiver), sdk.NewAttribute(types.AttributeKeyDenom, data.Denom), sdk.NewAttribute(types.AttributeKeyAmount, data.Amount), - sdk.NewAttribute(types.AttributeKeyMetadata, hex.EncodeToString(data.Metadata)), + sdk.NewAttribute(types.AttributeKeyMemo, data.Memo), sdk.NewAttribute(types.AttributeKeyAckSuccess, fmt.Sprintf("%t", ack.Success())), ), ) @@ -392,7 +391,7 @@ func (am AppModule) OnAcknowledgementPacket( sdk.NewAttribute(types.AttributeKeyReceiver, data.Receiver), sdk.NewAttribute(types.AttributeKeyDenom, data.Denom), sdk.NewAttribute(types.AttributeKeyAmount, data.Amount), - sdk.NewAttribute(types.AttributeKeyMetadata, hex.EncodeToString(data.Metadata)), + sdk.NewAttribute(types.AttributeKeyMemo, data.Memo), sdk.NewAttribute(types.AttributeKeyAck, ack.String()), ), ) @@ -439,7 +438,7 @@ func (am AppModule) OnTimeoutPacket( sdk.NewAttribute(types.AttributeKeyRefundReceiver, data.Sender), sdk.NewAttribute(types.AttributeKeyRefundDenom, data.Denom), sdk.NewAttribute(types.AttributeKeyRefundAmount, data.Amount), - sdk.NewAttribute(types.AttributeKeyMetadata, hex.EncodeToString(data.Metadata)), + sdk.NewAttribute(types.AttributeKeyMemo, data.Memo), ), ) diff --git a/modules/apps/transfer/spec/04_messages.md b/modules/apps/transfer/spec/04_messages.md index b3808054353..143c9c7f037 100644 --- a/modules/apps/transfer/spec/04_messages.md +++ b/modules/apps/transfer/spec/04_messages.md @@ -17,7 +17,7 @@ type MsgTransfer struct { Receiver string TimeoutHeight ibcexported.Height TimeoutTimestamp uint64 - Metadata []byte + Memo string } ``` diff --git a/modules/apps/transfer/spec/05_events.md b/modules/apps/transfer/spec/05_events.md index 46343198bc6..f5cfc443a81 100644 --- a/modules/apps/transfer/spec/05_events.md +++ b/modules/apps/transfer/spec/05_events.md @@ -22,7 +22,7 @@ order: 5 | fungible_token_packet | denom | {denom} | | fungible_token_packet | amount | {amount} | | fungible_token_packet | success | {ackSuccess} | -| fungible_token_packet | metadata | {metadata} | +| fungible_token_packet | memo | {memo} | | denomination_trace | trace_hash | {hex_hash} | ## OnAcknowledgePacket callback @@ -33,7 +33,7 @@ order: 5 | fungible_token_packet | receiver | {receiver} | | fungible_token_packet | denom | {denom} | | fungible_token_packet | amount | {amount} | -| fungible_token_packet | metadata | {metadata} | +| fungible_token_packet | memo | {memo} | | fungible_token_packet | acknowledgement | {ack.String()} | | fungible_token_packet | success | error | {ack.Response} | @@ -45,4 +45,4 @@ order: 5 | fungible_token_packet | refund_receiver | {receiver} | | fungible_token_packet | denom | {denom} | | fungible_token_packet | amount | {amount} | -| fungible_token_packet | metadata | {metadata} | +| fungible_token_packet | memo | {memo} | diff --git a/modules/apps/transfer/types/events.go b/modules/apps/transfer/types/events.go index 5cc87f11797..89964a8a9a4 100644 --- a/modules/apps/transfer/types/events.go +++ b/modules/apps/transfer/types/events.go @@ -18,5 +18,5 @@ const ( AttributeKeyAck = "acknowledgement" AttributeKeyAckError = "error" AttributeKeyTraceHash = "trace_hash" - AttributeKeyMetadata = "metadata" + AttributeKeyMemo = "memo" ) diff --git a/modules/apps/transfer/types/packet.pb.go b/modules/apps/transfer/types/packet.pb.go index 8ff01154f9c..4d0ba72e4d7 100644 --- a/modules/apps/transfer/types/packet.pb.go +++ b/modules/apps/transfer/types/packet.pb.go @@ -34,8 +34,8 @@ type FungibleTokenPacketData struct { Sender string `protobuf:"bytes,3,opt,name=sender,proto3" json:"sender,omitempty"` // the recipient address on the destination chain Receiver string `protobuf:"bytes,4,opt,name=receiver,proto3" json:"receiver,omitempty"` - // optional metadata - Metadata []byte `protobuf:"bytes,5,opt,name=metadata,proto3" json:"metadata,omitempty"` + // optional memo + Memo string `protobuf:"bytes,5,opt,name=memo,proto3" json:"memo,omitempty"` } func (m *FungibleTokenPacketData) Reset() { *m = FungibleTokenPacketData{} } @@ -99,11 +99,11 @@ func (m *FungibleTokenPacketData) GetReceiver() string { return "" } -func (m *FungibleTokenPacketData) GetMetadata() []byte { +func (m *FungibleTokenPacketData) GetMemo() string { if m != nil { - return m.Metadata + return m.Memo } - return nil + return "" } func init() { @@ -115,24 +115,23 @@ func init() { } var fileDescriptor_653ca2ce9a5ca313 = []byte{ - // 258 bytes of a gzipped FileDescriptorProto - 0x1f, 0x8b, 0x08, 0x00, 0x00, 0x00, 0x00, 0x00, 0x02, 0xff, 0x4c, 0x90, 0xb1, 0x4e, 0xc3, 0x30, - 0x10, 0x86, 0x6b, 0xa0, 0x15, 0x44, 0x4c, 0x11, 0x82, 0x08, 0x21, 0xab, 0x62, 0x2a, 0x03, 0xb1, - 0x54, 0x06, 0x76, 0x84, 0x98, 0xa1, 0x62, 0x62, 0xb3, 0x9d, 0x23, 0x58, 0x8d, 0x7d, 0x96, 0x7d, - 0x89, 0xc4, 0x5b, 0xb0, 0xf1, 0x4a, 0x8c, 0x1d, 0x19, 0x51, 0xf2, 0x22, 0x28, 0x09, 0x54, 0x1d, - 0xbf, 0xff, 0xff, 0x6f, 0xb8, 0x2f, 0xb9, 0x32, 0x4a, 0x0b, 0xe9, 0x7d, 0x65, 0xb4, 0x24, 0x83, - 0x2e, 0x0a, 0x0a, 0xd2, 0xc5, 0x57, 0x08, 0xa2, 0x59, 0x0a, 0x2f, 0xf5, 0x1a, 0x28, 0xf7, 0x01, - 0x09, 0xd3, 0x0b, 0xa3, 0x74, 0xbe, 0x3b, 0xcd, 0xff, 0xa7, 0x79, 0xb3, 0xbc, 0xfc, 0x64, 0xc9, - 0xd9, 0x43, 0xed, 0x4a, 0xa3, 0x2a, 0x78, 0xc6, 0x35, 0xb8, 0xc7, 0xe1, 0xf6, 0x5e, 0x92, 0x4c, - 0x4f, 0x92, 0x69, 0x01, 0x0e, 0x6d, 0xc6, 0xe6, 0x6c, 0x71, 0xb4, 0x1a, 0x21, 0x3d, 0x4d, 0x66, - 0xd2, 0x62, 0xed, 0x28, 0xdb, 0x1b, 0xe2, 0x3f, 0xea, 0xf3, 0x08, 0xae, 0x80, 0x90, 0xed, 0x8f, - 0xf9, 0x48, 0xe9, 0x79, 0x72, 0x18, 0x40, 0x83, 0x69, 0x20, 0x64, 0x07, 0x43, 0xb3, 0xe5, 0xbe, - 0xb3, 0x40, 0xb2, 0x90, 0x24, 0xb3, 0xe9, 0x9c, 0x2d, 0x8e, 0x57, 0x5b, 0xbe, 0x7b, 0xfa, 0x6a, - 0x39, 0xdb, 0xb4, 0x9c, 0xfd, 0xb4, 0x9c, 0x7d, 0x74, 0x7c, 0xb2, 0xe9, 0xf8, 0xe4, 0xbb, 0xe3, - 0x93, 0x97, 0xdb, 0xd2, 0xd0, 0x5b, 0xad, 0x72, 0x8d, 0x56, 0x68, 0x8c, 0x16, 0xa3, 0x30, 0x4a, - 0x5f, 0x97, 0xd8, 0xff, 0x6e, 0xb1, 0xa8, 0x2b, 0x88, 0xbd, 0x9c, 0x1d, 0x29, 0xf4, 0xee, 0x21, - 0xaa, 0xd9, 0x60, 0xe4, 0xe6, 0x37, 0x00, 0x00, 0xff, 0xff, 0x5d, 0x3d, 0x15, 0x2a, 0x3e, 0x01, - 0x00, 0x00, + // 252 bytes of a gzipped FileDescriptorProto + 0x1f, 0x8b, 0x08, 0x00, 0x00, 0x00, 0x00, 0x00, 0x02, 0xff, 0x4c, 0x90, 0xb1, 0x4a, 0x04, 0x31, + 0x10, 0x86, 0x2f, 0x7a, 0x77, 0x68, 0xca, 0x20, 0xba, 0x88, 0x04, 0xb1, 0xd2, 0xc2, 0x0d, 0x9c, + 0x85, 0xbd, 0x88, 0xb5, 0x8a, 0x95, 0x5d, 0x92, 0x1d, 0xd7, 0x70, 0x9b, 0x4c, 0x48, 0xb2, 0x0b, + 0x3e, 0x85, 0x3e, 0x96, 0xe5, 0x95, 0x96, 0xb2, 0xfb, 0x22, 0xb2, 0x59, 0x95, 0xeb, 0xe6, 0xfb, + 0xe6, 0x9f, 0x62, 0x7e, 0x7a, 0x61, 0x94, 0x16, 0xd2, 0xfb, 0xc6, 0x68, 0x99, 0x0c, 0xba, 0x28, + 0x52, 0x90, 0x2e, 0xbe, 0x40, 0x10, 0xdd, 0x4a, 0x78, 0xa9, 0xd7, 0x90, 0x4a, 0x1f, 0x30, 0x21, + 0x3b, 0x31, 0x4a, 0x97, 0xdb, 0xd1, 0xf2, 0x2f, 0x5a, 0x76, 0xab, 0xb3, 0x77, 0x42, 0x8f, 0xee, + 0x5a, 0x57, 0x1b, 0xd5, 0xc0, 0x13, 0xae, 0xc1, 0xdd, 0xe7, 0xdb, 0x5b, 0x99, 0x24, 0x3b, 0xa0, + 0x8b, 0x0a, 0x1c, 0xda, 0x82, 0x9c, 0x92, 0xf3, 0xfd, 0xc7, 0x09, 0xd8, 0x21, 0x5d, 0x4a, 0x8b, + 0xad, 0x4b, 0xc5, 0x4e, 0xd6, 0xbf, 0x34, 0xfa, 0x08, 0xae, 0x82, 0x50, 0xec, 0x4e, 0x7e, 0x22, + 0x76, 0x4c, 0xf7, 0x02, 0x68, 0x30, 0x1d, 0x84, 0x62, 0x9e, 0x37, 0xff, 0xcc, 0x18, 0x9d, 0x5b, + 0xb0, 0x58, 0x2c, 0xb2, 0xcf, 0xf3, 0xcd, 0xc3, 0x67, 0xcf, 0xc9, 0xa6, 0xe7, 0xe4, 0xbb, 0xe7, + 0xe4, 0x63, 0xe0, 0xb3, 0xcd, 0xc0, 0x67, 0x5f, 0x03, 0x9f, 0x3d, 0x5f, 0xd7, 0x26, 0xbd, 0xb6, + 0xaa, 0xd4, 0x68, 0x85, 0xc6, 0x68, 0x31, 0x0a, 0xa3, 0xf4, 0x65, 0x8d, 0xe3, 0xcf, 0x16, 0xab, + 0xb6, 0x81, 0x38, 0x96, 0xb2, 0x55, 0x46, 0x7a, 0xf3, 0x10, 0xd5, 0x32, 0x37, 0x71, 0xf5, 0x13, + 0x00, 0x00, 0xff, 0xff, 0x92, 0xb8, 0xf1, 0x30, 0x36, 0x01, 0x00, 0x00, } func (m *FungibleTokenPacketData) Marshal() (dAtA []byte, err error) { @@ -155,10 +154,10 @@ func (m *FungibleTokenPacketData) MarshalToSizedBuffer(dAtA []byte) (int, error) _ = i var l int _ = l - if len(m.Metadata) > 0 { - i -= len(m.Metadata) - copy(dAtA[i:], m.Metadata) - i = encodeVarintPacket(dAtA, i, uint64(len(m.Metadata))) + if len(m.Memo) > 0 { + i -= len(m.Memo) + copy(dAtA[i:], m.Memo) + i = encodeVarintPacket(dAtA, i, uint64(len(m.Memo))) i-- dAtA[i] = 0x2a } @@ -226,7 +225,7 @@ func (m *FungibleTokenPacketData) Size() (n int) { if l > 0 { n += 1 + l + sovPacket(uint64(l)) } - l = len(m.Metadata) + l = len(m.Memo) if l > 0 { n += 1 + l + sovPacket(uint64(l)) } @@ -398,9 +397,9 @@ func (m *FungibleTokenPacketData) Unmarshal(dAtA []byte) error { iNdEx = postIndex case 5: if wireType != 2 { - return fmt.Errorf("proto: wrong wireType = %d for field Metadata", wireType) + return fmt.Errorf("proto: wrong wireType = %d for field Memo", wireType) } - var byteLen int + var stringLen uint64 for shift := uint(0); ; shift += 7 { if shift >= 64 { return ErrIntOverflowPacket @@ -410,25 +409,23 @@ func (m *FungibleTokenPacketData) Unmarshal(dAtA []byte) error { } b := dAtA[iNdEx] iNdEx++ - byteLen |= int(b&0x7F) << shift + stringLen |= uint64(b&0x7F) << shift if b < 0x80 { break } } - if byteLen < 0 { + intStringLen := int(stringLen) + if intStringLen < 0 { return ErrInvalidLengthPacket } - postIndex := iNdEx + byteLen + postIndex := iNdEx + intStringLen if postIndex < 0 { return ErrInvalidLengthPacket } if postIndex > l { return io.ErrUnexpectedEOF } - m.Metadata = append(m.Metadata[:0], dAtA[iNdEx:postIndex]...) - if m.Metadata == nil { - m.Metadata = []byte{} - } + m.Memo = string(dAtA[iNdEx:postIndex]) iNdEx = postIndex default: iNdEx = preIndex diff --git a/modules/apps/transfer/types/tx.pb.go b/modules/apps/transfer/types/tx.pb.go index b2cacf0fab6..57cca2b80eb 100644 --- a/modules/apps/transfer/types/tx.pb.go +++ b/modules/apps/transfer/types/tx.pb.go @@ -50,8 +50,8 @@ type MsgTransfer struct { // Timeout timestamp (in nanoseconds) relative to the current block timestamp. // The timeout is disabled when set to 0. TimeoutTimestamp uint64 `protobuf:"varint,7,opt,name=timeout_timestamp,json=timeoutTimestamp,proto3" json:"timeout_timestamp,omitempty" yaml:"timeout_timestamp"` - // optional metadata - Metadata []byte `protobuf:"bytes,8,opt,name=metadata,proto3" json:"metadata,omitempty"` + // optional memo + Memo string `protobuf:"bytes,8,opt,name=memo,proto3" json:"memo,omitempty"` } func (m *MsgTransfer) Reset() { *m = MsgTransfer{} } @@ -143,40 +143,40 @@ func init() { } var fileDescriptor_7401ed9bed2f8e09 = []byte{ - // 520 bytes of a gzipped FileDescriptorProto - 0x1f, 0x8b, 0x08, 0x00, 0x00, 0x00, 0x00, 0x00, 0x02, 0xff, 0x8c, 0x93, 0x31, 0x6f, 0xd3, 0x40, - 0x14, 0xc7, 0x6d, 0x92, 0x86, 0x70, 0xa1, 0x15, 0x18, 0xa8, 0xdc, 0xa8, 0xd8, 0x91, 0x25, 0xa4, - 0x30, 0x70, 0x27, 0x07, 0xa1, 0x4a, 0x9d, 0x50, 0xba, 0xc0, 0x50, 0x09, 0xac, 0x4e, 0x2c, 0xe5, - 0x7c, 0x79, 0x38, 0x27, 0xe2, 0x3b, 0xe3, 0xbb, 0x58, 0xf4, 0x1b, 0x30, 0xf2, 0x11, 0xfa, 0x69, - 0x50, 0xc7, 0x8e, 0x4c, 0x11, 0x4a, 0x16, 0xe6, 0x7c, 0x02, 0x74, 0xb6, 0x13, 0x9c, 0x05, 0x31, - 0xe5, 0xfe, 0xef, 0xfd, 0x5e, 0xfe, 0x7e, 0xf7, 0xde, 0xa1, 0x67, 0x3c, 0x66, 0x84, 0x66, 0xd9, - 0x8c, 0x33, 0xaa, 0xb9, 0x14, 0x8a, 0xe8, 0x9c, 0x0a, 0xf5, 0x09, 0x72, 0x52, 0x84, 0x44, 0x7f, - 0xc5, 0x59, 0x2e, 0xb5, 0x74, 0x8e, 0x79, 0xcc, 0x70, 0x13, 0xc3, 0x1b, 0x0c, 0x17, 0x61, 0xff, - 0x71, 0x22, 0x13, 0x59, 0x82, 0xc4, 0x9c, 0xaa, 0x9a, 0xbe, 0xc7, 0xa4, 0x4a, 0xa5, 0x22, 0x31, - 0x55, 0x40, 0x8a, 0x30, 0x06, 0x4d, 0x43, 0xc2, 0x24, 0x17, 0x75, 0xde, 0x37, 0xd6, 0x4c, 0xe6, - 0x40, 0xd8, 0x8c, 0x83, 0xd0, 0xc6, 0xb0, 0x3a, 0x55, 0x40, 0xf0, 0xa3, 0x85, 0x7a, 0xe7, 0x2a, - 0xb9, 0xa8, 0x9d, 0x9c, 0x13, 0xd4, 0x53, 0x72, 0x9e, 0x33, 0xb8, 0xcc, 0x64, 0xae, 0x5d, 0x7b, - 0x60, 0x0f, 0xef, 0x8d, 0x0f, 0xd7, 0x0b, 0xdf, 0xb9, 0xa2, 0xe9, 0xec, 0x34, 0x68, 0x24, 0x83, - 0x08, 0x55, 0xea, 0x9d, 0xcc, 0xb5, 0xf3, 0x1a, 0x1d, 0xd4, 0x39, 0x36, 0xa5, 0x42, 0xc0, 0xcc, - 0xbd, 0x53, 0xd6, 0x1e, 0xad, 0x17, 0xfe, 0x93, 0x9d, 0xda, 0x3a, 0x1f, 0x44, 0xfb, 0x55, 0xe0, - 0xac, 0xd2, 0xce, 0x2b, 0xb4, 0xa7, 0xe5, 0x67, 0x10, 0x6e, 0x6b, 0x60, 0x0f, 0x7b, 0xa3, 0x23, - 0x5c, 0xf5, 0x86, 0x4d, 0x6f, 0xb8, 0xee, 0x0d, 0x9f, 0x49, 0x2e, 0xc6, 0xed, 0x9b, 0x85, 0x6f, - 0x45, 0x15, 0xed, 0x1c, 0xa2, 0x8e, 0x02, 0x31, 0x81, 0xdc, 0x6d, 0x1b, 0xc3, 0xa8, 0x56, 0x4e, - 0x1f, 0x75, 0x73, 0x60, 0xc0, 0x0b, 0xc8, 0xdd, 0xbd, 0x32, 0xb3, 0xd5, 0xce, 0x47, 0x74, 0xa0, - 0x79, 0x0a, 0x72, 0xae, 0x2f, 0xa7, 0xc0, 0x93, 0xa9, 0x76, 0x3b, 0xa5, 0x67, 0x1f, 0x9b, 0x19, - 0x98, 0xfb, 0xc2, 0xf5, 0x2d, 0x15, 0x21, 0x7e, 0x53, 0x12, 0xe3, 0xa7, 0xc6, 0xf4, 0x6f, 0x33, - 0xbb, 0xf5, 0x41, 0xb4, 0x5f, 0x07, 0x2a, 0xda, 0x79, 0x8b, 0x1e, 0x6e, 0x08, 0xf3, 0xab, 0x34, - 0x4d, 0x33, 0xf7, 0xee, 0xc0, 0x1e, 0xb6, 0xc7, 0xc7, 0xeb, 0x85, 0xef, 0xee, 0xfe, 0xc9, 0x16, - 0x09, 0xa2, 0x07, 0x75, 0xec, 0x62, 0x13, 0x32, 0x8d, 0xa4, 0xa0, 0xe9, 0x84, 0x6a, 0xea, 0x76, - 0x07, 0xf6, 0xf0, 0x7e, 0xb4, 0xd5, 0xa7, 0xdd, 0x6f, 0xd7, 0xbe, 0xf5, 0xfb, 0xda, 0xb7, 0x82, - 0x10, 0x3d, 0x6a, 0xcc, 0x31, 0x02, 0x95, 0x49, 0xa1, 0xc0, 0x14, 0x2b, 0xf8, 0x32, 0x07, 0xc1, - 0xa0, 0x1c, 0x66, 0x3b, 0xda, 0xea, 0x91, 0x44, 0xad, 0x73, 0x95, 0x38, 0x53, 0xd4, 0xdd, 0x8e, - 0xff, 0x39, 0xfe, 0xd7, 0x12, 0xe2, 0x86, 0x43, 0x3f, 0xfc, 0x6f, 0x74, 0xf3, 0x31, 0xe3, 0xf7, - 0x37, 0x4b, 0xcf, 0xbe, 0x5d, 0x7a, 0xf6, 0xaf, 0xa5, 0x67, 0x7f, 0x5f, 0x79, 0xd6, 0xed, 0xca, - 0xb3, 0x7e, 0xae, 0x3c, 0xeb, 0xc3, 0x49, 0xc2, 0xf5, 0x74, 0x1e, 0x63, 0x26, 0x53, 0x52, 0xaf, - 0x34, 0x8f, 0xd9, 0x8b, 0x44, 0x92, 0x62, 0x44, 0x52, 0x39, 0x99, 0xcf, 0x40, 0x99, 0x27, 0xd4, - 0x78, 0x3a, 0xfa, 0x2a, 0x03, 0x15, 0x77, 0xca, 0x35, 0x7e, 0xf9, 0x27, 0x00, 0x00, 0xff, 0xff, - 0x7f, 0x1a, 0xac, 0x9b, 0x64, 0x03, 0x00, 0x00, + // 517 bytes of a gzipped FileDescriptorProto + 0x1f, 0x8b, 0x08, 0x00, 0x00, 0x00, 0x00, 0x00, 0x02, 0xff, 0x8c, 0x53, 0xc1, 0x6e, 0xd3, 0x4c, + 0x10, 0xb6, 0xff, 0xa4, 0xf9, 0xc3, 0x46, 0xad, 0x60, 0x81, 0xca, 0x8d, 0x8a, 0x1d, 0x59, 0x42, + 0x0a, 0x07, 0x76, 0xe5, 0x20, 0x54, 0xa9, 0x27, 0x94, 0x5e, 0xe0, 0x50, 0x09, 0xac, 0x9e, 0xb8, + 0x14, 0x7b, 0x3b, 0x38, 0x2b, 0x62, 0x8f, 0xf1, 0x6e, 0x2c, 0xfa, 0x06, 0x1c, 0x79, 0x84, 0x3e, + 0x09, 0xe7, 0x1e, 0x7b, 0xe4, 0x14, 0xa1, 0xe4, 0xc2, 0x39, 0x4f, 0x80, 0xd6, 0x76, 0x42, 0x72, + 0x41, 0x9c, 0x3c, 0x33, 0xdf, 0x37, 0xfe, 0xf6, 0xdb, 0x99, 0x25, 0x4f, 0x65, 0x2c, 0x78, 0x94, + 0xe7, 0x53, 0x29, 0x22, 0x2d, 0x31, 0x53, 0x5c, 0x17, 0x51, 0xa6, 0x3e, 0x42, 0xc1, 0xcb, 0x80, + 0xeb, 0x2f, 0x2c, 0x2f, 0x50, 0x23, 0x3d, 0x96, 0xb1, 0x60, 0xdb, 0x34, 0xb6, 0xa6, 0xb1, 0x32, + 0xe8, 0x3f, 0x4a, 0x30, 0xc1, 0x8a, 0xc8, 0x4d, 0x54, 0xf7, 0xf4, 0x5d, 0x81, 0x2a, 0x45, 0xc5, + 0xe3, 0x48, 0x01, 0x2f, 0x83, 0x18, 0x74, 0x14, 0x70, 0x81, 0x32, 0x6b, 0x70, 0xcf, 0x48, 0x0b, + 0x2c, 0x80, 0x8b, 0xa9, 0x84, 0x4c, 0x1b, 0xc1, 0x3a, 0xaa, 0x09, 0xfe, 0xf7, 0x16, 0xe9, 0x9d, + 0xab, 0xe4, 0xa2, 0x51, 0xa2, 0x27, 0xa4, 0xa7, 0x70, 0x56, 0x08, 0xb8, 0xcc, 0xb1, 0xd0, 0x8e, + 0x3d, 0xb0, 0x87, 0xf7, 0xc6, 0x87, 0xab, 0xb9, 0x47, 0xaf, 0xa3, 0x74, 0x7a, 0xea, 0x6f, 0x81, + 0x7e, 0x48, 0xea, 0xec, 0x2d, 0x16, 0x9a, 0xbe, 0x22, 0x07, 0x0d, 0x26, 0x26, 0x51, 0x96, 0xc1, + 0xd4, 0xf9, 0xaf, 0xea, 0x3d, 0x5a, 0xcd, 0xbd, 0xc7, 0x3b, 0xbd, 0x0d, 0xee, 0x87, 0xfb, 0x75, + 0xe1, 0xac, 0xce, 0xe9, 0x4b, 0xb2, 0xa7, 0xf1, 0x13, 0x64, 0x4e, 0x6b, 0x60, 0x0f, 0x7b, 0xa3, + 0x23, 0x56, 0x7b, 0x63, 0xc6, 0x1b, 0x6b, 0xbc, 0xb1, 0x33, 0x94, 0xd9, 0xb8, 0x7d, 0x3b, 0xf7, + 0xac, 0xb0, 0x66, 0xd3, 0x43, 0xd2, 0x51, 0x90, 0x5d, 0x41, 0xe1, 0xb4, 0x8d, 0x60, 0xd8, 0x64, + 0xb4, 0x4f, 0xba, 0x05, 0x08, 0x90, 0x25, 0x14, 0xce, 0x5e, 0x85, 0x6c, 0x72, 0xfa, 0x81, 0x1c, + 0x68, 0x99, 0x02, 0xce, 0xf4, 0xe5, 0x04, 0x64, 0x32, 0xd1, 0x4e, 0xa7, 0xd2, 0xec, 0x33, 0x33, + 0x03, 0x73, 0x5f, 0xac, 0xb9, 0xa5, 0x32, 0x60, 0xaf, 0x2b, 0xc6, 0xf8, 0x89, 0x11, 0xfd, 0x63, + 0x66, 0xb7, 0xdf, 0x0f, 0xf7, 0x9b, 0x42, 0xcd, 0xa6, 0x6f, 0xc8, 0x83, 0x35, 0xc3, 0x7c, 0x95, + 0x8e, 0xd2, 0xdc, 0xf9, 0x7f, 0x60, 0x0f, 0xdb, 0xe3, 0xe3, 0xd5, 0xdc, 0x73, 0x76, 0x7f, 0xb2, + 0xa1, 0xf8, 0xe1, 0xfd, 0xa6, 0x76, 0xb1, 0x2e, 0x51, 0x4a, 0xda, 0x29, 0xa4, 0xe8, 0x74, 0x2b, + 0x13, 0x55, 0x7c, 0xda, 0xfd, 0x7a, 0xe3, 0x59, 0xbf, 0x6e, 0x3c, 0xcb, 0x0f, 0xc8, 0xc3, 0xad, + 0xf9, 0x85, 0xa0, 0x72, 0xcc, 0x14, 0x18, 0xf7, 0x0a, 0x3e, 0xcf, 0x20, 0x13, 0x50, 0x0d, 0xb1, + 0x1d, 0x6e, 0xf2, 0x11, 0x92, 0xd6, 0xb9, 0x4a, 0xe8, 0x84, 0x74, 0x37, 0x63, 0x7f, 0xc6, 0xfe, + 0xb6, 0x7c, 0x6c, 0x4b, 0xa1, 0x1f, 0xfc, 0x33, 0x75, 0x7d, 0x98, 0xf1, 0xbb, 0xdb, 0x85, 0x6b, + 0xdf, 0x2d, 0x5c, 0xfb, 0xe7, 0xc2, 0xb5, 0xbf, 0x2d, 0x5d, 0xeb, 0x6e, 0xe9, 0x5a, 0x3f, 0x96, + 0xae, 0xf5, 0xfe, 0x24, 0x91, 0x7a, 0x32, 0x8b, 0x99, 0xc0, 0x94, 0x37, 0xab, 0x2c, 0x63, 0xf1, + 0x3c, 0x41, 0x5e, 0x8e, 0x78, 0x8a, 0x57, 0xb3, 0x29, 0x28, 0xf3, 0x74, 0xb6, 0x9e, 0x8c, 0xbe, + 0xce, 0x41, 0xc5, 0x9d, 0x6a, 0x7d, 0x5f, 0xfc, 0x0e, 0x00, 0x00, 0xff, 0xff, 0x7e, 0x7c, 0x61, + 0xf8, 0x5c, 0x03, 0x00, 0x00, } // Reference imports to suppress errors if they are not otherwise used. @@ -281,10 +281,10 @@ func (m *MsgTransfer) MarshalToSizedBuffer(dAtA []byte) (int, error) { _ = i var l int _ = l - if len(m.Metadata) > 0 { - i -= len(m.Metadata) - copy(dAtA[i:], m.Metadata) - i = encodeVarintTx(dAtA, i, uint64(len(m.Metadata))) + if len(m.Memo) > 0 { + i -= len(m.Memo) + copy(dAtA[i:], m.Memo) + i = encodeVarintTx(dAtA, i, uint64(len(m.Memo))) i-- dAtA[i] = 0x42 } @@ -412,7 +412,7 @@ func (m *MsgTransfer) Size() (n int) { if m.TimeoutTimestamp != 0 { n += 1 + sovTx(uint64(m.TimeoutTimestamp)) } - l = len(m.Metadata) + l = len(m.Memo) if l > 0 { n += 1 + l + sovTx(uint64(l)) } @@ -681,9 +681,9 @@ func (m *MsgTransfer) Unmarshal(dAtA []byte) error { } case 8: if wireType != 2 { - return fmt.Errorf("proto: wrong wireType = %d for field Metadata", wireType) + return fmt.Errorf("proto: wrong wireType = %d for field Memo", wireType) } - var byteLen int + var stringLen uint64 for shift := uint(0); ; shift += 7 { if shift >= 64 { return ErrIntOverflowTx @@ -693,25 +693,23 @@ func (m *MsgTransfer) Unmarshal(dAtA []byte) error { } b := dAtA[iNdEx] iNdEx++ - byteLen |= int(b&0x7F) << shift + stringLen |= uint64(b&0x7F) << shift if b < 0x80 { break } } - if byteLen < 0 { + intStringLen := int(stringLen) + if intStringLen < 0 { return ErrInvalidLengthTx } - postIndex := iNdEx + byteLen + postIndex := iNdEx + intStringLen if postIndex < 0 { return ErrInvalidLengthTx } if postIndex > l { return io.ErrUnexpectedEOF } - m.Metadata = append(m.Metadata[:0], dAtA[iNdEx:postIndex]...) - if m.Metadata == nil { - m.Metadata = []byte{} - } + m.Memo = string(dAtA[iNdEx:postIndex]) iNdEx = postIndex default: iNdEx = preIndex diff --git a/proto/ibc/applications/transfer/v1/tx.proto b/proto/ibc/applications/transfer/v1/tx.proto index d7396fa4bd5..31a23f6834f 100644 --- a/proto/ibc/applications/transfer/v1/tx.proto +++ b/proto/ibc/applications/transfer/v1/tx.proto @@ -38,8 +38,8 @@ message MsgTransfer { // Timeout timestamp (in nanoseconds) relative to the current block timestamp. // The timeout is disabled when set to 0. uint64 timeout_timestamp = 7 [(gogoproto.moretags) = "yaml:\"timeout_timestamp\""]; - // optional metadata - bytes metadata = 8; + // optional memo + string memo = 8; } // MsgTransferResponse defines the Msg/Transfer response type. diff --git a/proto/ibc/applications/transfer/v2/packet.proto b/proto/ibc/applications/transfer/v2/packet.proto index 953f67128a2..d2626d36798 100644 --- a/proto/ibc/applications/transfer/v2/packet.proto +++ b/proto/ibc/applications/transfer/v2/packet.proto @@ -16,6 +16,6 @@ message FungibleTokenPacketData { string sender = 3; // the recipient address on the destination chain string receiver = 4; - // optional metadata - bytes metadata = 5; + // optional memo + string memo = 5; }