From 6e6570740a4e379f2ecd77ad8fe3293298b99361 Mon Sep 17 00:00:00 2001 From: Damian Nolan Date: Wed, 8 Jun 2022 18:17:41 +0200 Subject: [PATCH 1/9] renaming counterparty address rpc to counterparty payee --- docs/ibc/proto-docs.md | 22 +- modules/apps/29-fee/client/cli/tx.go | 50 +-- modules/apps/29-fee/ibc_middleware.go | 2 +- modules/apps/29-fee/ibc_middleware_test.go | 6 +- modules/apps/29-fee/ica_test.go | 2 +- modules/apps/29-fee/keeper/genesis.go | 2 +- modules/apps/29-fee/keeper/genesis_test.go | 4 +- modules/apps/29-fee/keeper/grpc_query.go | 2 +- modules/apps/29-fee/keeper/grpc_query_test.go | 2 +- modules/apps/29-fee/keeper/keeper.go | 8 +- modules/apps/29-fee/keeper/keeper_test.go | 2 +- modules/apps/29-fee/keeper/msg_server.go | 18 +- modules/apps/29-fee/keeper/msg_server_test.go | 48 +-- modules/apps/29-fee/keeper/relay.go | 2 +- modules/apps/29-fee/keeper/relay_test.go | 2 +- modules/apps/29-fee/transfer_test.go | 2 +- modules/apps/29-fee/types/codec.go | 6 +- modules/apps/29-fee/types/errors.go | 2 +- modules/apps/29-fee/types/genesis.go | 2 +- modules/apps/29-fee/types/msgs.go | 41 ++- modules/apps/29-fee/types/msgs_test.go | 28 +- modules/apps/29-fee/types/tx.pb.go | 290 +++++++++--------- proto/ibc/applications/fee/v1/tx.proto | 26 +- 23 files changed, 291 insertions(+), 278 deletions(-) diff --git a/docs/ibc/proto-docs.md b/docs/ibc/proto-docs.md index fe55e9c32be..57604569cc6 100644 --- a/docs/ibc/proto-docs.md +++ b/docs/ibc/proto-docs.md @@ -71,8 +71,8 @@ - [MsgPayPacketFeeAsync](#ibc.applications.fee.v1.MsgPayPacketFeeAsync) - [MsgPayPacketFeeAsyncResponse](#ibc.applications.fee.v1.MsgPayPacketFeeAsyncResponse) - [MsgPayPacketFeeResponse](#ibc.applications.fee.v1.MsgPayPacketFeeResponse) - - [MsgRegisterCounterpartyAddress](#ibc.applications.fee.v1.MsgRegisterCounterpartyAddress) - - [MsgRegisterCounterpartyAddressResponse](#ibc.applications.fee.v1.MsgRegisterCounterpartyAddressResponse) + - [MsgRegisterCounterpartyPayee](#ibc.applications.fee.v1.MsgRegisterCounterpartyPayee) + - [MsgRegisterCounterpartyPayeeResponse](#ibc.applications.fee.v1.MsgRegisterCounterpartyPayeeResponse) - [MsgRegisterPayee](#ibc.applications.fee.v1.MsgRegisterPayee) - [MsgRegisterPayeeResponse](#ibc.applications.fee.v1.MsgRegisterPayeeResponse) @@ -1308,28 +1308,28 @@ MsgPayPacketFeeResponse defines the response type for the PayPacketFee rpc - + -### MsgRegisterCounterpartyAddress -MsgRegisterCounterpartyAddress defines the request type for the RegisterCounterpartyAddress rpc +### MsgRegisterCounterpartyPayee +MsgRegisterCounterpartyPayee defines the request type for the RegisterCounterpartyPayee rpc | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | -| `address` | [string](#string) | | the relayer address | -| `counterparty_address` | [string](#string) | | the counterparty relayer address | | `port_id` | [string](#string) | | unique port identifier | | `channel_id` | [string](#string) | | unique channel identifier | +| `relayer_address` | [string](#string) | | the relayer address | +| `counterparty_payee` | [string](#string) | | the counterparty relayer address | - + -### MsgRegisterCounterpartyAddressResponse -MsgRegisterCounterpartyAddressResponse defines the response type for the RegisterCounterpartyAddress rpc +### MsgRegisterCounterpartyPayeeResponse +MsgRegisterCounterpartyPayeeResponse defines the response type for the RegisterCounterpartyPayee rpc @@ -1378,7 +1378,7 @@ Msg defines the ICS29 Msg service. | Method Name | Request Type | Response Type | Description | HTTP Verb | Endpoint | | ----------- | ------------ | ------------- | ------------| ------- | -------- | | `RegisterPayee` | [MsgRegisterPayee](#ibc.applications.fee.v1.MsgRegisterPayee) | [MsgRegisterPayeeResponse](#ibc.applications.fee.v1.MsgRegisterPayeeResponse) | RegisterPayee defines a rpc handler method for MsgRegisterPayee RegisterPayee is called by the relayer on each channelEnd and allows them to set an optional payee to which escrowed packet fees will be paid out. The payee should be registered on the source chain from which packets originate as this is where fee distribution takes place. This function may be called more than once by a relayer, in which case, the latest payee is always used. | | -| `RegisterCounterpartyAddress` | [MsgRegisterCounterpartyAddress](#ibc.applications.fee.v1.MsgRegisterCounterpartyAddress) | [MsgRegisterCounterpartyAddressResponse](#ibc.applications.fee.v1.MsgRegisterCounterpartyAddressResponse) | RegisterCounterpartyAddress defines a rpc handler method for MsgRegisterCounterpartyAddress RegisterCounterpartyAddress is called by the relayer on each channelEnd and allows them to specify their counterparty address before relaying. This ensures they will be properly compensated for forward relaying since destination chain must send back relayer's source address (counterparty address) in acknowledgement. This function may be called more than once by a relayer, in which case, the latest counterparty address is always used. | | +| `RegisterCounterpartyPayee` | [MsgRegisterCounterpartyPayee](#ibc.applications.fee.v1.MsgRegisterCounterpartyPayee) | [MsgRegisterCounterpartyPayeeResponse](#ibc.applications.fee.v1.MsgRegisterCounterpartyPayeeResponse) | RegisterCounterpartyPayee defines a rpc handler method for MsgRegisterCounterpartyPayee RegisterCounterpartyPayee is called by the relayer on each channelEnd and allows them to specify their counterparty address before relaying. This ensures they will be properly compensated for forward relaying since destination chain must send back relayer's source address (counterparty address) in acknowledgement. This function may be called more than once by a relayer, in which case, the latest counterparty address is always used. | | | `PayPacketFee` | [MsgPayPacketFee](#ibc.applications.fee.v1.MsgPayPacketFee) | [MsgPayPacketFeeResponse](#ibc.applications.fee.v1.MsgPayPacketFeeResponse) | PayPacketFee defines a rpc handler method for MsgPayPacketFee PayPacketFee is an open callback that may be called by any module/user that wishes to escrow funds in order to incentivize the relaying of the packet at the next sequence NOTE: This method is intended to be used within a multi msg transaction, where the subsequent msg that follows initiates the lifecycle of the incentivized packet | | | `PayPacketFeeAsync` | [MsgPayPacketFeeAsync](#ibc.applications.fee.v1.MsgPayPacketFeeAsync) | [MsgPayPacketFeeAsyncResponse](#ibc.applications.fee.v1.MsgPayPacketFeeAsyncResponse) | PayPacketFeeAsync defines a rpc handler method for MsgPayPacketFeeAsync PayPacketFeeAsync is an open callback that may be called by any module/user that wishes to escrow funds in order to incentivize the relaying of a known packet (i.e. at a particular sequence) | | diff --git a/modules/apps/29-fee/client/cli/tx.go b/modules/apps/29-fee/client/cli/tx.go index 24f84731d88..f4fe48f1dec 100644 --- a/modules/apps/29-fee/client/cli/tx.go +++ b/modules/apps/29-fee/client/cli/tx.go @@ -47,6 +47,31 @@ func NewRegisterPayeeCmd() *cobra.Command { return cmd } +// NewRegisterCounterpartyAddressCmd returns the command to create a MsgRegisterCounterpartyAddress +func NewRegisterCounterpartyAddressCmd() *cobra.Command { + cmd := &cobra.Command{ + Use: "register-counterparty [port-id] [channel-id] [address] [counterparty-payee-address] ", + Short: "Register a counterparty payee address on a given channel.", + Long: strings.TrimSpace(`Register a counterparty payee address on a given channel.`), + Example: fmt.Sprintf("%s tx ibc-fee register-counterparty transfer channel-0 cosmos1rsp837a4kvtgp2m4uqzdge0zzu6efqgucm0qdh osmo1v5y0tz01llxzf4c2afml8s3awue0ymju22wxx2", version.AppName), + Args: cobra.ExactArgs(4), + RunE: func(cmd *cobra.Command, args []string) error { + clientCtx, err := client.GetClientTxContext(cmd) + if err != nil { + return err + } + + msg := types.NewMsgRegisterCounterpartyPayee(args[0], args[1], args[2], args[3]) + + return tx.GenerateOrBroadcastTxCLI(clientCtx, cmd.Flags(), msg) + }, + } + + flags.AddTxFlagsToCmd(cmd) + + return cmd +} + // NewPayPacketFeeAsyncTxCmd returns the command to create a MsgPayPacketFeeAsync func NewPayPacketFeeAsyncTxCmd() *cobra.Command { cmd := &cobra.Command{ @@ -122,28 +147,3 @@ func NewPayPacketFeeAsyncTxCmd() *cobra.Command { return cmd } - -// NewRegisterCounterpartyAddressCmd returns the command to create a MsgRegisterCounterpartyAddress -func NewRegisterCounterpartyAddressCmd() *cobra.Command { - cmd := &cobra.Command{ - Use: "register-counterparty [port-id] [channel-id] [address] [counterparty-address] ", - Short: "Register a counterparty relayer address on a given channel.", - Long: strings.TrimSpace(`Register a counterparty relayer address on a given channel.`), - Example: fmt.Sprintf("%s tx ibc-fee register-counterparty transfer channel-0 cosmos1rsp837a4kvtgp2m4uqzdge0zzu6efqgucm0qdh osmo1v5y0tz01llxzf4c2afml8s3awue0ymju22wxx2", version.AppName), - Args: cobra.ExactArgs(4), - RunE: func(cmd *cobra.Command, args []string) error { - clientCtx, err := client.GetClientTxContext(cmd) - if err != nil { - return err - } - - msg := types.NewMsgRegisterCounterpartyAddress(args[0], args[1], args[2], args[3]) - - return tx.GenerateOrBroadcastTxCLI(clientCtx, cmd.Flags(), msg) - }, - } - - flags.AddTxFlagsToCmd(cmd) - - return cmd -} diff --git a/modules/apps/29-fee/ibc_middleware.go b/modules/apps/29-fee/ibc_middleware.go index d5cc6f4cfca..d9161d7caba 100644 --- a/modules/apps/29-fee/ibc_middleware.go +++ b/modules/apps/29-fee/ibc_middleware.go @@ -231,7 +231,7 @@ func (im IBCMiddleware) OnRecvPacket( } // if forwardRelayer is not found we refund recv_fee - forwardRelayer, _ := im.keeper.GetCounterpartyAddress(ctx, relayer.String(), packet.GetDestChannel()) + forwardRelayer, _ := im.keeper.GetCounterpartyPayeeAddress(ctx, relayer.String(), packet.GetDestChannel()) return types.NewIncentivizedAcknowledgement(forwardRelayer, ack.Acknowledgement(), ack.Success()) } diff --git a/modules/apps/29-fee/ibc_middleware_test.go b/modules/apps/29-fee/ibc_middleware_test.go index 17a961d0074..f949a3d7413 100644 --- a/modules/apps/29-fee/ibc_middleware_test.go +++ b/modules/apps/29-fee/ibc_middleware_test.go @@ -539,7 +539,7 @@ func (suite *FeeTestSuite) TestOnRecvPacket() { { "forward address is not found", func() { - suite.chainB.GetSimApp().IBCFeeKeeper.SetCounterpartyAddress(suite.chainB.GetContext(), suite.chainA.SenderAccount.GetAddress().String(), "", suite.path.EndpointB.ChannelID) + suite.chainB.GetSimApp().IBCFeeKeeper.SetCounterpartyPayeeAddress(suite.chainB.GetContext(), suite.chainA.SenderAccount.GetAddress().String(), "", suite.path.EndpointB.ChannelID) }, false, true, @@ -566,7 +566,7 @@ func (suite *FeeTestSuite) TestOnRecvPacket() { cbs, ok := suite.chainB.App.GetIBCKeeper().Router.GetRoute(module) suite.Require().True(ok) - suite.chainB.GetSimApp().IBCFeeKeeper.SetCounterpartyAddress(suite.chainB.GetContext(), suite.chainA.SenderAccount.GetAddress().String(), suite.chainB.SenderAccount.GetAddress().String(), suite.path.EndpointB.ChannelID) + suite.chainB.GetSimApp().IBCFeeKeeper.SetCounterpartyPayeeAddress(suite.chainB.GetContext(), suite.chainA.SenderAccount.GetAddress().String(), suite.chainB.SenderAccount.GetAddress().String(), suite.path.EndpointB.ChannelID) // malleate test case tc.malleate() @@ -575,7 +575,7 @@ func (suite *FeeTestSuite) TestOnRecvPacket() { switch { case tc.name == "success": - forwardAddr, _ := suite.chainB.GetSimApp().IBCFeeKeeper.GetCounterpartyAddress(suite.chainB.GetContext(), suite.chainA.SenderAccount.GetAddress().String(), suite.path.EndpointB.ChannelID) + forwardAddr, _ := suite.chainB.GetSimApp().IBCFeeKeeper.GetCounterpartyPayeeAddress(suite.chainB.GetContext(), suite.chainA.SenderAccount.GetAddress().String(), suite.path.EndpointB.ChannelID) expectedAck := types.IncentivizedAcknowledgement{ AppAcknowledgement: ibcmock.MockAcknowledgement.Acknowledgement(), diff --git a/modules/apps/29-fee/ica_test.go b/modules/apps/29-fee/ica_test.go index 88b3d088412..d8cd4e4ce05 100644 --- a/modules/apps/29-fee/ica_test.go +++ b/modules/apps/29-fee/ica_test.go @@ -102,7 +102,7 @@ func (suite *FeeTestSuite) TestFeeInterchainAccounts() { suite.Require().True(suite.chainB.GetSimApp().IBCFeeKeeper.IsFeeEnabled(suite.chainB.GetContext(), path.EndpointB.ChannelConfig.PortID, path.EndpointB.ChannelID)) // register counterparty address on destination chainB as chainA.SenderAccounts[1] for recv fee distribution - suite.chainB.GetSimApp().IBCFeeKeeper.SetCounterpartyAddress(suite.chainB.GetContext(), suite.chainB.SenderAccount.GetAddress().String(), suite.chainA.SenderAccounts[1].SenderAccount.GetAddress().String(), path.EndpointB.ChannelID) + suite.chainB.GetSimApp().IBCFeeKeeper.SetCounterpartyPayeeAddress(suite.chainB.GetContext(), suite.chainB.SenderAccount.GetAddress().String(), suite.chainA.SenderAccounts[1].SenderAccount.GetAddress().String(), path.EndpointB.ChannelID) // escrow a packet fee for the next send sequence expectedFee := types.NewFee(defaultRecvFee, defaultAckFee, defaultTimeoutFee) diff --git a/modules/apps/29-fee/keeper/genesis.go b/modules/apps/29-fee/keeper/genesis.go index c4be3a9d027..eb7b1fd7095 100644 --- a/modules/apps/29-fee/keeper/genesis.go +++ b/modules/apps/29-fee/keeper/genesis.go @@ -13,7 +13,7 @@ func (k Keeper) InitGenesis(ctx sdk.Context, state types.GenesisState) { } for _, relayer := range state.RegisteredRelayers { - k.SetCounterpartyAddress(ctx, relayer.Address, relayer.CounterpartyAddress, relayer.ChannelId) + k.SetCounterpartyPayeeAddress(ctx, relayer.Address, relayer.CounterpartyAddress, relayer.ChannelId) } for _, forwardAddr := range state.ForwardRelayers { diff --git a/modules/apps/29-fee/keeper/genesis_test.go b/modules/apps/29-fee/keeper/genesis_test.go index 7cd2e5bd1a6..05b8c907bb4 100644 --- a/modules/apps/29-fee/keeper/genesis_test.go +++ b/modules/apps/29-fee/keeper/genesis_test.go @@ -56,7 +56,7 @@ func (suite *KeeperTestSuite) TestInitGenesis() { suite.Require().True(isEnabled) // check relayers - addr, found := suite.chainA.GetSimApp().IBCFeeKeeper.GetCounterpartyAddress(suite.chainA.GetContext(), suite.chainA.SenderAccount.GetAddress().String(), ibctesting.FirstChannelID) + addr, found := suite.chainA.GetSimApp().IBCFeeKeeper.GetCounterpartyPayeeAddress(suite.chainA.GetContext(), suite.chainA.SenderAccount.GetAddress().String(), ibctesting.FirstChannelID) suite.Require().True(found) suite.Require().Equal(genesisState.RegisteredRelayers[0].CounterpartyAddress, addr) @@ -82,7 +82,7 @@ func (suite *KeeperTestSuite) TestExportGenesis() { sender := suite.chainA.SenderAccount.GetAddress().String() counterparty := suite.chainB.SenderAccount.GetAddress().String() // set counterparty address - suite.chainA.GetSimApp().IBCFeeKeeper.SetCounterpartyAddress(suite.chainA.GetContext(), sender, counterparty, ibctesting.FirstChannelID) + suite.chainA.GetSimApp().IBCFeeKeeper.SetCounterpartyPayeeAddress(suite.chainA.GetContext(), sender, counterparty, ibctesting.FirstChannelID) // set forward relayer address suite.chainA.GetSimApp().IBCFeeKeeper.SetRelayerAddressForAsyncAck(suite.chainA.GetContext(), packetID, sender) diff --git a/modules/apps/29-fee/keeper/grpc_query.go b/modules/apps/29-fee/keeper/grpc_query.go index 9b95753f25c..78f3c572702 100644 --- a/modules/apps/29-fee/keeper/grpc_query.go +++ b/modules/apps/29-fee/keeper/grpc_query.go @@ -179,7 +179,7 @@ func (k Keeper) CounterpartyAddress(goCtx context.Context, req *types.QueryCount ctx := sdk.UnwrapSDKContext(goCtx) - counterpartyAddr, found := k.GetCounterpartyAddress(ctx, req.RelayerAddress, req.ChannelId) + counterpartyAddr, found := k.GetCounterpartyPayeeAddress(ctx, req.RelayerAddress, req.ChannelId) if !found { return nil, status.Errorf(codes.NotFound, "counterparty address not found for address: %s on channel: %s", req.RelayerAddress, req.ChannelId) } diff --git a/modules/apps/29-fee/keeper/grpc_query_test.go b/modules/apps/29-fee/keeper/grpc_query_test.go index 5850a3be3ba..910b605d20c 100644 --- a/modules/apps/29-fee/keeper/grpc_query_test.go +++ b/modules/apps/29-fee/keeper/grpc_query_test.go @@ -445,7 +445,7 @@ func (suite *KeeperTestSuite) TestQueryCounterpartyAddress() { pk := secp256k1.GenPrivKey().PubKey() expectedCounterpartyAddr := sdk.AccAddress(pk.Address()) - suite.chainA.GetSimApp().IBCFeeKeeper.SetCounterpartyAddress( + suite.chainA.GetSimApp().IBCFeeKeeper.SetCounterpartyPayeeAddress( suite.chainA.GetContext(), suite.chainA.SenderAccount.GetAddress().String(), expectedCounterpartyAddr.String(), diff --git a/modules/apps/29-fee/keeper/keeper.go b/modules/apps/29-fee/keeper/keeper.go index 311bee5eb69..75a2ad3a0b9 100644 --- a/modules/apps/29-fee/keeper/keeper.go +++ b/modules/apps/29-fee/keeper/keeper.go @@ -190,15 +190,15 @@ func (k Keeper) GetAllPayeeAddresses(ctx sdk.Context) []types.RegisteredPayee { return registeredPayees } -// SetCounterpartyAddress maps the destination chain relayer address to the source relayer address +// SetCounterpartyPayeeAddress maps the destination chain relayer address to the source relayer address // The receiving chain must store the mapping from: address -> counterpartyAddress for the given channel -func (k Keeper) SetCounterpartyAddress(ctx sdk.Context, address, counterpartyAddress, channelID string) { +func (k Keeper) SetCounterpartyPayeeAddress(ctx sdk.Context, address, counterpartyAddress, channelID string) { store := ctx.KVStore(k.storeKey) store.Set(types.KeyCounterpartyRelayer(address, channelID), []byte(counterpartyAddress)) } -// GetCounterpartyAddress gets the relayer counterparty address given a destination relayer address -func (k Keeper) GetCounterpartyAddress(ctx sdk.Context, address, channelID string) (string, bool) { +// GetCounterpartyPayeeAddress gets the relayer counterparty address given a destination relayer address +func (k Keeper) GetCounterpartyPayeeAddress(ctx sdk.Context, address, channelID string) (string, bool) { store := ctx.KVStore(k.storeKey) key := types.KeyCounterpartyRelayer(address, channelID) diff --git a/modules/apps/29-fee/keeper/keeper_test.go b/modules/apps/29-fee/keeper/keeper_test.go index 1b26fe6ac5e..b322cb07c60 100644 --- a/modules/apps/29-fee/keeper/keeper_test.go +++ b/modules/apps/29-fee/keeper/keeper_test.go @@ -262,7 +262,7 @@ func (suite *KeeperTestSuite) TestGetAllRelayerAddresses() { sender := suite.chainA.SenderAccount.GetAddress().String() counterparty := suite.chainB.SenderAccount.GetAddress().String() - suite.chainA.GetSimApp().IBCFeeKeeper.SetCounterpartyAddress(suite.chainA.GetContext(), sender, counterparty, ibctesting.FirstChannelID) + suite.chainA.GetSimApp().IBCFeeKeeper.SetCounterpartyPayeeAddress(suite.chainA.GetContext(), sender, counterparty, ibctesting.FirstChannelID) expectedAddr := []types.RegisteredRelayerAddress{ { diff --git a/modules/apps/29-fee/keeper/msg_server.go b/modules/apps/29-fee/keeper/msg_server.go index 0dfc8cb9a10..d5398cdc706 100644 --- a/modules/apps/29-fee/keeper/msg_server.go +++ b/modules/apps/29-fee/keeper/msg_server.go @@ -36,13 +36,15 @@ func (k Keeper) RegisterPayee(goCtx context.Context, msg *types.MsgRegisterPayee return &types.MsgRegisterPayeeResponse{}, nil } -// RegisterCounterpartyAddress is called by the relayer on each channelEnd and allows them to specify their counterparty address before relaying -// This ensures they will be properly compensated for forward relaying on the source chain since the destination chain must send back relayer's source address (counterparty address) in acknowledgement -// This function may be called more than once by relayers, in which case, the previous counterparty address will be overwritten by the new counterparty address -func (k Keeper) RegisterCounterpartyAddress(goCtx context.Context, msg *types.MsgRegisterCounterpartyAddress) (*types.MsgRegisterCounterpartyAddressResponse, error) { +// RegisterCounterpartyPayee defines a rpc handler method for MsgRegisterCounterpartyPayee +// RegisterCounterpartyPayee is called by the relayer on each channelEnd and allows them to specify their +// counterparty address before relaying. This ensures they will be properly compensated for forward relaying since +// destination chain must send back relayer's source address (counterparty address) in acknowledgement. This function +// may be called more than once by a relayer, in which case, the latest counterparty address is always used. +func (k Keeper) RegisterCounterpartyPayee(goCtx context.Context, msg *types.MsgRegisterCounterpartyPayee) (*types.MsgRegisterCounterpartyPayeeResponse, error) { ctx := sdk.UnwrapSDKContext(goCtx) - // only register counterparty address if the channel exists and is fee enabled + // only register counterparty payee if the channel exists and is fee enabled if _, found := k.channelKeeper.GetChannel(ctx, msg.PortId, msg.ChannelId); !found { return nil, channeltypes.ErrChannelNotFound } @@ -51,11 +53,11 @@ func (k Keeper) RegisterCounterpartyAddress(goCtx context.Context, msg *types.Ms return nil, types.ErrFeeNotEnabled } - k.SetCounterpartyAddress(ctx, msg.Address, msg.CounterpartyAddress, msg.ChannelId) + k.SetCounterpartyPayeeAddress(ctx, msg.RelayerAddress, msg.CounterpartyPayee, msg.ChannelId) - k.Logger(ctx).Info("registering counterparty address for relayer", "address", msg.Address, "counterparty address", msg.CounterpartyAddress, "channel", msg.ChannelId) + k.Logger(ctx).Info("registering counterparty payee for relayer", "relayer address", msg.RelayerAddress, "counterparty payee address", msg.CounterpartyPayee, "channel", msg.ChannelId) - return &types.MsgRegisterCounterpartyAddressResponse{}, nil + return &types.MsgRegisterCounterpartyPayeeResponse{}, nil } // PayPacketFee defines a rpc handler method for MsgPayPacketFee diff --git a/modules/apps/29-fee/keeper/msg_server_test.go b/modules/apps/29-fee/keeper/msg_server_test.go index 76179514943..9a05f294c9d 100644 --- a/modules/apps/29-fee/keeper/msg_server_test.go +++ b/modules/apps/29-fee/keeper/msg_server_test.go @@ -73,12 +73,10 @@ func (suite *KeeperTestSuite) TestRegisterPayee() { } } -func (suite *KeeperTestSuite) TestRegisterCounterpartyAddress() { +func (suite *KeeperTestSuite) TestRegisterCounterpartyPayee() { var ( - sender string - counterparty string - channelID string - ctx sdk.Context + msg *types.MsgRegisterCounterpartyPayee + expCounterpartyPayee string ) testCases := []struct { @@ -92,43 +90,57 @@ func (suite *KeeperTestSuite) TestRegisterCounterpartyAddress() { func() {}, }, { - "counterparty is an arbitrary string", + "counterparty payee is an arbitrary string", true, - func() { counterparty = "arbitrary-string" }, + func() { + msg.CounterpartyPayee = "arbitrary-string" + expCounterpartyPayee = "arbitrary-string" + }, }, { "channel does not exist", false, - func() { channelID = "channel-22" }, + func() { + msg.ChannelId = "channel-100" + }, }, { "channel is not fee enabled", false, func() { - suite.chainA.GetSimApp().IBCFeeKeeper.DeleteFeeEnabled(ctx, suite.path.EndpointA.ChannelConfig.PortID, channelID) + suite.chainA.GetSimApp().IBCFeeKeeper.DeleteFeeEnabled(suite.chainA.GetContext(), suite.path.EndpointA.ChannelConfig.PortID, suite.path.EndpointA.ChannelID) }, }, } for _, tc := range testCases { suite.SetupTest() - ctx = suite.chainA.GetContext() suite.coordinator.Setup(suite.path) // setup channel - sender = suite.chainA.SenderAccount.GetAddress().String() - counterparty = suite.chainB.SenderAccount.GetAddress().String() - channelID = suite.path.EndpointA.ChannelID + expCounterpartyPayee = suite.chainA.SenderAccounts[1].SenderAccount.GetAddress().String() + msg = types.NewMsgRegisterCounterpartyPayee( + suite.path.EndpointA.ChannelConfig.PortID, + suite.path.EndpointA.ChannelID, + suite.chainA.SenderAccounts[0].SenderAccount.GetAddress().String(), + expCounterpartyPayee, + ) tc.malleate() - msg := types.NewMsgRegisterCounterpartyAddress(suite.path.EndpointA.ChannelConfig.PortID, channelID, sender, counterparty) - _, err := suite.chainA.GetSimApp().IBCFeeKeeper.RegisterCounterpartyAddress(sdk.WrapSDKContext(ctx), msg) + res, err := suite.chainA.GetSimApp().IBCFeeKeeper.RegisterCounterpartyPayee(sdk.WrapSDKContext(suite.chainA.GetContext()), msg) if tc.expPass { - suite.Require().NoError(err) // message committed + suite.Require().NoError(err) + suite.Require().NotNil(res) + + counterpartyPayee, found := suite.chainA.GetSimApp().IBCFeeKeeper.GetCounterpartyPayeeAddress( + suite.chainA.GetContext(), + suite.chainA.SenderAccount.GetAddress().String(), + ibctesting.FirstChannelID, + ) - counterpartyAddress, _ := suite.chainA.GetSimApp().IBCFeeKeeper.GetCounterpartyAddress(ctx, suite.chainA.SenderAccount.GetAddress().String(), ibctesting.FirstChannelID) - suite.Require().Equal(counterparty, counterpartyAddress) + suite.Require().True(found) + suite.Require().Equal(expCounterpartyPayee, counterpartyPayee) } else { suite.Require().Error(err) } diff --git a/modules/apps/29-fee/keeper/relay.go b/modules/apps/29-fee/keeper/relay.go index 476497bfbbb..0c14726c9ed 100644 --- a/modules/apps/29-fee/keeper/relay.go +++ b/modules/apps/29-fee/keeper/relay.go @@ -35,7 +35,7 @@ func (k Keeper) WriteAcknowledgement(ctx sdk.Context, chanCap *capabilitytypes.C // it is possible that a relayer has not registered a counterparty address. // if there is no registered counterparty address then write acknowledgement with empty relayer address and refund recv_fee. - forwardRelayer, _ := k.GetCounterpartyAddress(ctx, relayer, packet.GetDestChannel()) + forwardRelayer, _ := k.GetCounterpartyPayeeAddress(ctx, relayer, packet.GetDestChannel()) ack := types.NewIncentivizedAcknowledgement(forwardRelayer, acknowledgement.Acknowledgement(), acknowledgement.Success()) diff --git a/modules/apps/29-fee/keeper/relay_test.go b/modules/apps/29-fee/keeper/relay_test.go index d0a9e620f9d..5dd0aa15815 100644 --- a/modules/apps/29-fee/keeper/relay_test.go +++ b/modules/apps/29-fee/keeper/relay_test.go @@ -18,7 +18,7 @@ func (suite *KeeperTestSuite) TestWriteAcknowledgementAsync() { "success", func() { suite.chainB.GetSimApp().IBCFeeKeeper.SetRelayerAddressForAsyncAck(suite.chainB.GetContext(), channeltypes.NewPacketId(suite.path.EndpointB.ChannelConfig.PortID, suite.path.EndpointB.ChannelID, 1), suite.chainA.SenderAccount.GetAddress().String()) - suite.chainB.GetSimApp().IBCFeeKeeper.SetCounterpartyAddress(suite.chainB.GetContext(), suite.chainA.SenderAccount.GetAddress().String(), suite.chainB.SenderAccount.GetAddress().String(), suite.path.EndpointB.ChannelID) + suite.chainB.GetSimApp().IBCFeeKeeper.SetCounterpartyPayeeAddress(suite.chainB.GetContext(), suite.chainA.SenderAccount.GetAddress().String(), suite.chainB.SenderAccount.GetAddress().String(), suite.path.EndpointB.ChannelID) }, true, }, diff --git a/modules/apps/29-fee/transfer_test.go b/modules/apps/29-fee/transfer_test.go index 3f4545e9fdd..be91db917ed 100644 --- a/modules/apps/29-fee/transfer_test.go +++ b/modules/apps/29-fee/transfer_test.go @@ -46,7 +46,7 @@ func (suite *FeeTestSuite) TestFeeTransfer() { // to differentiate from the chainA.SenderAccount for checking successful relay payouts relayerAddress := suite.chainB.SenderAccount.GetAddress() - msgRegister := types.NewMsgRegisterCounterpartyAddress(path.EndpointB.ChannelConfig.PortID, path.EndpointB.ChannelID, suite.chainB.SenderAccount.GetAddress().String(), relayerAddress.String()) + msgRegister := types.NewMsgRegisterCounterpartyPayee(path.EndpointB.ChannelConfig.PortID, path.EndpointB.ChannelID, suite.chainB.SenderAccount.GetAddress().String(), relayerAddress.String()) _, err = suite.chainB.SendMsgs(msgRegister) suite.Require().NoError(err) // message committed diff --git a/modules/apps/29-fee/types/codec.go b/modules/apps/29-fee/types/codec.go index 871f148b043..272056d6f9f 100644 --- a/modules/apps/29-fee/types/codec.go +++ b/modules/apps/29-fee/types/codec.go @@ -10,9 +10,10 @@ import ( // RegisterLegacyAminoCodec registers the necessary x/ibc 29-fee interfaces and concrete types // on the provided LegacyAmino codec. These types are used for Amino JSON serialization. func RegisterLegacyAminoCodec(cdc *codec.LegacyAmino) { - cdc.RegisterConcrete(&MsgRegisterCounterpartyAddress{}, "cosmos-sdk/MsgRegisterCounterpartyAddress", nil) cdc.RegisterConcrete(&MsgPayPacketFee{}, "cosmos-sdk/MsgPayPacketFee", nil) cdc.RegisterConcrete(&MsgPayPacketFeeAsync{}, "cosmos-sdk/MsgPayPacketFeeAsync", nil) + cdc.RegisterConcrete(&MsgRegisterPayee{}, "cosmos-sdk/MsgRegisterPayee", nil) + cdc.RegisterConcrete(&MsgRegisterCounterpartyPayee{}, "cosmos-sdk/MsgRegisterCounterpartyPayee", nil) } // RegisterInterfaces register the 29-fee module interfaces to protobuf @@ -20,9 +21,10 @@ func RegisterLegacyAminoCodec(cdc *codec.LegacyAmino) { func RegisterInterfaces(registry codectypes.InterfaceRegistry) { registry.RegisterImplementations( (*sdk.Msg)(nil), - &MsgRegisterCounterpartyAddress{}, &MsgPayPacketFee{}, &MsgPayPacketFeeAsync{}, + &MsgRegisterPayee{}, + &MsgRegisterCounterpartyPayee{}, ) msgservice.RegisterMsgServiceDesc(registry, &_Msg_serviceDesc) diff --git a/modules/apps/29-fee/types/errors.go b/modules/apps/29-fee/types/errors.go index 812db0a43a4..0ac40e5f824 100644 --- a/modules/apps/29-fee/types/errors.go +++ b/modules/apps/29-fee/types/errors.go @@ -11,7 +11,7 @@ var ( ErrBalanceNotFound = sdkerrors.Register(ModuleName, 4, "balance not found for given account address") ErrFeeNotFound = sdkerrors.Register(ModuleName, 5, "there is no fee escrowed for the given packetID") ErrRelayersNotNil = sdkerrors.Register(ModuleName, 6, "relayers must be nil. This feature is not supported") - ErrCounterpartyAddressEmpty = sdkerrors.Register(ModuleName, 7, "counterparty address must not be empty") + ErrCounterpartyPayeeEmpty = sdkerrors.Register(ModuleName, 7, "counterparty payee must not be empty") ErrForwardRelayerAddressNotFound = sdkerrors.Register(ModuleName, 8, "forward relayer address not found") ErrFeeNotEnabled = sdkerrors.Register(ModuleName, 9, "fee module is not enabled for this channel. If this error occurs after channel setup, fee module may not be enabled") ErrRelayerNotFoundForAsyncAck = sdkerrors.Register(ModuleName, 10, "relayer address must be stored for async WriteAcknowledgement") diff --git a/modules/apps/29-fee/types/genesis.go b/modules/apps/29-fee/types/genesis.go index db406c3fefb..74660034041 100644 --- a/modules/apps/29-fee/types/genesis.go +++ b/modules/apps/29-fee/types/genesis.go @@ -89,7 +89,7 @@ func (gs GenesisState) Validate() error { } if strings.TrimSpace(rel.CounterpartyAddress) == "" { - return ErrCounterpartyAddressEmpty + return ErrCounterpartyPayeeEmpty } } diff --git a/modules/apps/29-fee/types/msgs.go b/modules/apps/29-fee/types/msgs.go index 3d5520f3ff2..639a324518c 100644 --- a/modules/apps/29-fee/types/msgs.go +++ b/modules/apps/29-fee/types/msgs.go @@ -63,46 +63,45 @@ func (msg MsgRegisterPayee) GetSigners() []sdk.AccAddress { return []sdk.AccAddress{signer} } -// NewMsgRegisterCounterpartyAddress creates a new instance of MsgRegisterCounterpartyAddress -func NewMsgRegisterCounterpartyAddress(portID, channelID, address, counterpartyAddress string) *MsgRegisterCounterpartyAddress { - return &MsgRegisterCounterpartyAddress{ - Address: address, - CounterpartyAddress: counterpartyAddress, - PortId: portID, - ChannelId: channelID, +// NewMsgRegisterCounterpartyPayee creates a new instance of MsgRegisterCounterpartyPayee +func NewMsgRegisterCounterpartyPayee(portID, channelID, relayerAddr, counterpartyPayeeAddr string) *MsgRegisterCounterpartyPayee { + return &MsgRegisterCounterpartyPayee{ + PortId: portID, + ChannelId: channelID, + RelayerAddress: relayerAddr, + CounterpartyPayee: counterpartyPayeeAddr, } } // ValidateBasic performs a basic check of the MsgRegisterCounterpartyAddress fields -func (msg MsgRegisterCounterpartyAddress) ValidateBasic() error { - _, err := sdk.AccAddressFromBech32(msg.Address) - if err != nil { - return sdkerrors.Wrap(err, "failed to convert msg.Address into sdk.AccAddress") - } - - if strings.TrimSpace(msg.CounterpartyAddress) == "" { - return ErrCounterpartyAddressEmpty - } - - // validate portId +func (msg MsgRegisterCounterpartyPayee) ValidateBasic() error { if err := host.PortIdentifierValidator(msg.PortId); err != nil { return err } - // validate channelId if err := host.ChannelIdentifierValidator(msg.ChannelId); err != nil { return err } + _, err := sdk.AccAddressFromBech32(msg.RelayerAddress) + if err != nil { + return sdkerrors.Wrap(err, "failed to create sdk.AccAddress from relayer address") + } + + if strings.TrimSpace(msg.CounterpartyPayee) == "" { + return ErrCounterpartyPayeeEmpty + } + return nil } // GetSigners implements sdk.Msg -func (msg MsgRegisterCounterpartyAddress) GetSigners() []sdk.AccAddress { - signer, err := sdk.AccAddressFromBech32(msg.Address) +func (msg MsgRegisterCounterpartyPayee) GetSigners() []sdk.AccAddress { + signer, err := sdk.AccAddressFromBech32(msg.RelayerAddress) if err != nil { panic(err) } + return []sdk.AccAddress{signer} } diff --git a/modules/apps/29-fee/types/msgs_test.go b/modules/apps/29-fee/types/msgs_test.go index 4ca23fea458..dfbe471c8fa 100644 --- a/modules/apps/29-fee/types/msgs_test.go +++ b/modules/apps/29-fee/types/msgs_test.go @@ -87,8 +87,8 @@ func TestRegisterPayeeGetSigners(t *testing.T) { require.Equal(t, []sdk.AccAddress{sdk.AccAddress(accAddress)}, msg.GetSigners()) } -func TestMsgRegisterCountepartyAddressValidation(t *testing.T) { - var msg *types.MsgRegisterCounterpartyAddress +func TestMsgRegisterCountepartyPayeeValidation(t *testing.T) { + var msg *types.MsgRegisterCounterpartyPayee testCases := []struct { name string @@ -101,44 +101,44 @@ func TestMsgRegisterCountepartyAddressValidation(t *testing.T) { true, }, { - "validate with incorrect destination relayer address", + "invalid portID", func() { - msg.Address = "invalid-address" + msg.PortId = "" }, false, }, { - "invalid counterparty address", + "invalid channelID", func() { - msg.CounterpartyAddress = "" + msg.ChannelId = "" }, false, }, { - "invalid counterparty address: whitespaced empty string", + "validate with incorrect destination relayer address", func() { - msg.CounterpartyAddress = " " + msg.RelayerAddress = "invalid-address" }, false, }, { - "invalid channelID", + "invalid counterparty payee address", func() { - msg.ChannelId = "" + msg.CounterpartyPayee = "" }, false, }, { - "invalid portID", + "invalid counterparty payee address: whitespaced empty string", func() { - msg.PortId = "" + msg.CounterpartyPayee = " " }, false, }, } for i, tc := range testCases { - msg = types.NewMsgRegisterCounterpartyAddress(ibctesting.MockPort, ibctesting.FirstChannelID, defaultAccAddress, defaultAccAddress) + msg = types.NewMsgRegisterCounterpartyPayee(ibctesting.MockPort, ibctesting.FirstChannelID, defaultAccAddress, defaultAccAddress) tc.malleate() @@ -154,7 +154,7 @@ func TestMsgRegisterCountepartyAddressValidation(t *testing.T) { func TestRegisterCountepartyAddressGetSigners(t *testing.T) { accAddress := sdk.AccAddress(secp256k1.GenPrivKey().PubKey().Address()) - msg := types.NewMsgRegisterCounterpartyAddress(ibctesting.MockPort, ibctesting.FirstChannelID, accAddress.String(), defaultAccAddress) + msg := types.NewMsgRegisterCounterpartyPayee(ibctesting.MockPort, ibctesting.FirstChannelID, accAddress.String(), defaultAccAddress) require.Equal(t, []sdk.AccAddress{sdk.AccAddress(accAddress)}, msg.GetSigners()) } diff --git a/modules/apps/29-fee/types/tx.pb.go b/modules/apps/29-fee/types/tx.pb.go index 7c941f44c9c..a748da63d47 100644 --- a/modules/apps/29-fee/types/tx.pb.go +++ b/modules/apps/29-fee/types/tx.pb.go @@ -111,30 +111,30 @@ func (m *MsgRegisterPayeeResponse) XXX_DiscardUnknown() { var xxx_messageInfo_MsgRegisterPayeeResponse proto.InternalMessageInfo -// MsgRegisterCounterpartyAddress defines the request type for the RegisterCounterpartyAddress rpc -type MsgRegisterCounterpartyAddress struct { - // the relayer address - Address string `protobuf:"bytes,1,opt,name=address,proto3" json:"address,omitempty"` - // the counterparty relayer address - CounterpartyAddress string `protobuf:"bytes,2,opt,name=counterparty_address,json=counterpartyAddress,proto3" json:"counterparty_address,omitempty" yaml:"counterparty_address"` +// MsgRegisterCounterpartyPayee defines the request type for the RegisterCounterpartyPayee rpc +type MsgRegisterCounterpartyPayee struct { // unique port identifier - PortId string `protobuf:"bytes,3,opt,name=port_id,json=portId,proto3" json:"port_id,omitempty" yaml:"port_id"` + PortId string `protobuf:"bytes,1,opt,name=port_id,json=portId,proto3" json:"port_id,omitempty" yaml:"port_id"` // unique channel identifier - ChannelId string `protobuf:"bytes,4,opt,name=channel_id,json=channelId,proto3" json:"channel_id,omitempty" yaml:"channel_id"` + ChannelId string `protobuf:"bytes,2,opt,name=channel_id,json=channelId,proto3" json:"channel_id,omitempty" yaml:"channel_id"` + // the relayer address + RelayerAddress string `protobuf:"bytes,3,opt,name=relayer_address,json=relayerAddress,proto3" json:"relayer_address,omitempty"` + // the counterparty relayer address + CounterpartyPayee string `protobuf:"bytes,4,opt,name=counterparty_payee,json=counterpartyPayee,proto3" json:"counterparty_payee,omitempty" yaml:"counterparty_payee"` } -func (m *MsgRegisterCounterpartyAddress) Reset() { *m = MsgRegisterCounterpartyAddress{} } -func (m *MsgRegisterCounterpartyAddress) String() string { return proto.CompactTextString(m) } -func (*MsgRegisterCounterpartyAddress) ProtoMessage() {} -func (*MsgRegisterCounterpartyAddress) Descriptor() ([]byte, []int) { +func (m *MsgRegisterCounterpartyPayee) Reset() { *m = MsgRegisterCounterpartyPayee{} } +func (m *MsgRegisterCounterpartyPayee) String() string { return proto.CompactTextString(m) } +func (*MsgRegisterCounterpartyPayee) ProtoMessage() {} +func (*MsgRegisterCounterpartyPayee) Descriptor() ([]byte, []int) { return fileDescriptor_05c93128649f1b96, []int{2} } -func (m *MsgRegisterCounterpartyAddress) XXX_Unmarshal(b []byte) error { +func (m *MsgRegisterCounterpartyPayee) XXX_Unmarshal(b []byte) error { return m.Unmarshal(b) } -func (m *MsgRegisterCounterpartyAddress) XXX_Marshal(b []byte, deterministic bool) ([]byte, error) { +func (m *MsgRegisterCounterpartyPayee) XXX_Marshal(b []byte, deterministic bool) ([]byte, error) { if deterministic { - return xxx_messageInfo_MsgRegisterCounterpartyAddress.Marshal(b, m, deterministic) + return xxx_messageInfo_MsgRegisterCounterpartyPayee.Marshal(b, m, deterministic) } else { b = b[:cap(b)] n, err := m.MarshalToSizedBuffer(b) @@ -144,36 +144,34 @@ func (m *MsgRegisterCounterpartyAddress) XXX_Marshal(b []byte, deterministic boo return b[:n], nil } } -func (m *MsgRegisterCounterpartyAddress) XXX_Merge(src proto.Message) { - xxx_messageInfo_MsgRegisterCounterpartyAddress.Merge(m, src) +func (m *MsgRegisterCounterpartyPayee) XXX_Merge(src proto.Message) { + xxx_messageInfo_MsgRegisterCounterpartyPayee.Merge(m, src) } -func (m *MsgRegisterCounterpartyAddress) XXX_Size() int { +func (m *MsgRegisterCounterpartyPayee) XXX_Size() int { return m.Size() } -func (m *MsgRegisterCounterpartyAddress) XXX_DiscardUnknown() { - xxx_messageInfo_MsgRegisterCounterpartyAddress.DiscardUnknown(m) +func (m *MsgRegisterCounterpartyPayee) XXX_DiscardUnknown() { + xxx_messageInfo_MsgRegisterCounterpartyPayee.DiscardUnknown(m) } -var xxx_messageInfo_MsgRegisterCounterpartyAddress proto.InternalMessageInfo +var xxx_messageInfo_MsgRegisterCounterpartyPayee proto.InternalMessageInfo -// MsgRegisterCounterpartyAddressResponse defines the response type for the RegisterCounterpartyAddress rpc -type MsgRegisterCounterpartyAddressResponse struct { +// MsgRegisterCounterpartyPayeeResponse defines the response type for the RegisterCounterpartyPayee rpc +type MsgRegisterCounterpartyPayeeResponse struct { } -func (m *MsgRegisterCounterpartyAddressResponse) Reset() { - *m = MsgRegisterCounterpartyAddressResponse{} -} -func (m *MsgRegisterCounterpartyAddressResponse) String() string { return proto.CompactTextString(m) } -func (*MsgRegisterCounterpartyAddressResponse) ProtoMessage() {} -func (*MsgRegisterCounterpartyAddressResponse) Descriptor() ([]byte, []int) { +func (m *MsgRegisterCounterpartyPayeeResponse) Reset() { *m = MsgRegisterCounterpartyPayeeResponse{} } +func (m *MsgRegisterCounterpartyPayeeResponse) String() string { return proto.CompactTextString(m) } +func (*MsgRegisterCounterpartyPayeeResponse) ProtoMessage() {} +func (*MsgRegisterCounterpartyPayeeResponse) Descriptor() ([]byte, []int) { return fileDescriptor_05c93128649f1b96, []int{3} } -func (m *MsgRegisterCounterpartyAddressResponse) XXX_Unmarshal(b []byte) error { +func (m *MsgRegisterCounterpartyPayeeResponse) XXX_Unmarshal(b []byte) error { return m.Unmarshal(b) } -func (m *MsgRegisterCounterpartyAddressResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error) { +func (m *MsgRegisterCounterpartyPayeeResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error) { if deterministic { - return xxx_messageInfo_MsgRegisterCounterpartyAddressResponse.Marshal(b, m, deterministic) + return xxx_messageInfo_MsgRegisterCounterpartyPayeeResponse.Marshal(b, m, deterministic) } else { b = b[:cap(b)] n, err := m.MarshalToSizedBuffer(b) @@ -183,17 +181,17 @@ func (m *MsgRegisterCounterpartyAddressResponse) XXX_Marshal(b []byte, determini return b[:n], nil } } -func (m *MsgRegisterCounterpartyAddressResponse) XXX_Merge(src proto.Message) { - xxx_messageInfo_MsgRegisterCounterpartyAddressResponse.Merge(m, src) +func (m *MsgRegisterCounterpartyPayeeResponse) XXX_Merge(src proto.Message) { + xxx_messageInfo_MsgRegisterCounterpartyPayeeResponse.Merge(m, src) } -func (m *MsgRegisterCounterpartyAddressResponse) XXX_Size() int { +func (m *MsgRegisterCounterpartyPayeeResponse) XXX_Size() int { return m.Size() } -func (m *MsgRegisterCounterpartyAddressResponse) XXX_DiscardUnknown() { - xxx_messageInfo_MsgRegisterCounterpartyAddressResponse.DiscardUnknown(m) +func (m *MsgRegisterCounterpartyPayeeResponse) XXX_DiscardUnknown() { + xxx_messageInfo_MsgRegisterCounterpartyPayeeResponse.DiscardUnknown(m) } -var xxx_messageInfo_MsgRegisterCounterpartyAddressResponse proto.InternalMessageInfo +var xxx_messageInfo_MsgRegisterCounterpartyPayeeResponse proto.InternalMessageInfo // MsgPayPacketFee defines the request type for the PayPacketFee rpc // This Msg can be used to pay for a packet at the next sequence send & should be combined with the Msg that will be @@ -363,8 +361,8 @@ var xxx_messageInfo_MsgPayPacketFeeAsyncResponse proto.InternalMessageInfo func init() { proto.RegisterType((*MsgRegisterPayee)(nil), "ibc.applications.fee.v1.MsgRegisterPayee") proto.RegisterType((*MsgRegisterPayeeResponse)(nil), "ibc.applications.fee.v1.MsgRegisterPayeeResponse") - proto.RegisterType((*MsgRegisterCounterpartyAddress)(nil), "ibc.applications.fee.v1.MsgRegisterCounterpartyAddress") - proto.RegisterType((*MsgRegisterCounterpartyAddressResponse)(nil), "ibc.applications.fee.v1.MsgRegisterCounterpartyAddressResponse") + proto.RegisterType((*MsgRegisterCounterpartyPayee)(nil), "ibc.applications.fee.v1.MsgRegisterCounterpartyPayee") + proto.RegisterType((*MsgRegisterCounterpartyPayeeResponse)(nil), "ibc.applications.fee.v1.MsgRegisterCounterpartyPayeeResponse") proto.RegisterType((*MsgPayPacketFee)(nil), "ibc.applications.fee.v1.MsgPayPacketFee") proto.RegisterType((*MsgPayPacketFeeResponse)(nil), "ibc.applications.fee.v1.MsgPayPacketFeeResponse") proto.RegisterType((*MsgPayPacketFeeAsync)(nil), "ibc.applications.fee.v1.MsgPayPacketFeeAsync") @@ -374,53 +372,53 @@ func init() { func init() { proto.RegisterFile("ibc/applications/fee/v1/tx.proto", fileDescriptor_05c93128649f1b96) } var fileDescriptor_05c93128649f1b96 = []byte{ - // 732 bytes of a gzipped FileDescriptorProto - 0x1f, 0x8b, 0x08, 0x00, 0x00, 0x00, 0x00, 0x00, 0x02, 0xff, 0x9c, 0x55, 0xcf, 0x4f, 0xdb, 0x58, - 0x10, 0x8e, 0x09, 0xbf, 0x32, 0xb0, 0x40, 0xbc, 0x01, 0x8c, 0x61, 0x6d, 0xd6, 0x87, 0x55, 0x56, - 0x2b, 0xec, 0x4d, 0x00, 0xad, 0x96, 0x0b, 0x22, 0x48, 0xa8, 0x1c, 0x50, 0x23, 0xab, 0xa7, 0xaa, - 0x12, 0x72, 0x9c, 0x89, 0x71, 0x9b, 0xe4, 0x59, 0x7e, 0x4e, 0x54, 0xff, 0x07, 0x3d, 0x72, 0xeb, - 0x95, 0x3f, 0x87, 0x23, 0x87, 0x1e, 0xaa, 0x1e, 0xac, 0x0a, 0x2e, 0x3d, 0x47, 0xea, 0xa9, 0x97, - 0xca, 0xf6, 0xb3, 0xeb, 0xa4, 0x09, 0x0a, 0xbd, 0xbd, 0x99, 0xf9, 0x66, 0xde, 0x7c, 0x9f, 0x67, - 0xfc, 0x60, 0xd7, 0x6e, 0x98, 0x9a, 0xe1, 0x38, 0x6d, 0xdb, 0x34, 0x3c, 0x9b, 0x74, 0xa9, 0xd6, - 0x42, 0xd4, 0xfa, 0x15, 0xcd, 0x7b, 0xab, 0x3a, 0x2e, 0xf1, 0x08, 0xbf, 0x69, 0x37, 0x4c, 0x35, - 0x8b, 0x50, 0x5b, 0x88, 0x6a, 0xbf, 0x22, 0x96, 0x2c, 0x62, 0x91, 0x08, 0xa3, 0x85, 0xa7, 0x18, - 0x2e, 0xfe, 0x39, 0xa9, 0x60, 0x98, 0x95, 0x81, 0x98, 0xc4, 0x45, 0xcd, 0xbc, 0x32, 0xba, 0x5d, - 0x6c, 0x87, 0x61, 0x76, 0x8c, 0x21, 0xca, 0x27, 0x0e, 0xd6, 0x2e, 0xa8, 0xa5, 0xa3, 0x65, 0x53, - 0x0f, 0xdd, 0xba, 0xe1, 0x23, 0xf2, 0xff, 0xc0, 0x82, 0x43, 0x5c, 0xef, 0xd2, 0x6e, 0x0a, 0xdc, - 0x2e, 0x57, 0x2e, 0xd4, 0xf8, 0x41, 0x20, 0xaf, 0xf8, 0x46, 0xa7, 0x7d, 0xa4, 0xb0, 0x80, 0xa2, - 0xcf, 0x87, 0xa7, 0xf3, 0x26, 0x7f, 0x00, 0xc0, 0x4a, 0x86, 0xf8, 0x99, 0x08, 0xbf, 0x3e, 0x08, - 0xe4, 0x62, 0x8c, 0xff, 0x11, 0x53, 0xf4, 0x02, 0x33, 0xce, 0x9b, 0xfc, 0x29, 0xac, 0xba, 0xd8, - 0x36, 0x7c, 0x74, 0x2f, 0x8d, 0x66, 0xd3, 0x45, 0x4a, 0x85, 0x7c, 0x94, 0x2a, 0x0e, 0x02, 0x79, - 0x23, 0x4e, 0x1d, 0x01, 0x28, 0xfa, 0x0a, 0xf3, 0x9c, 0xc4, 0x0e, 0xbe, 0x04, 0x73, 0x4e, 0xd8, - 0xb0, 0x30, 0x1b, 0xa6, 0xea, 0xb1, 0x71, 0xb4, 0xf8, 0xee, 0x46, 0xce, 0x7d, 0xb9, 0x91, 0x73, - 0x8a, 0x08, 0xc2, 0x28, 0x37, 0x1d, 0xa9, 0x43, 0xba, 0x14, 0x95, 0x6f, 0x1c, 0x48, 0x99, 0xe0, - 0x29, 0xe9, 0x75, 0x3d, 0x74, 0x1d, 0xc3, 0xf5, 0xfc, 0xa4, 0xbc, 0x00, 0x0b, 0x49, 0x6f, 0x91, - 0x0c, 0x7a, 0x62, 0xf2, 0x3a, 0x94, 0xcc, 0x4c, 0x42, 0x4a, 0x21, 0x66, 0x2f, 0x0f, 0x02, 0x79, - 0x9b, 0xb1, 0x1f, 0x83, 0x52, 0xf4, 0xdf, 0xcd, 0x31, 0xb7, 0x65, 0x44, 0xcf, 0x3f, 0x51, 0xf4, - 0xd9, 0xe9, 0x44, 0xcf, 0x28, 0x53, 0x86, 0xbf, 0x1e, 0x27, 0x9f, 0xea, 0x74, 0x3d, 0x03, 0xab, - 0x17, 0xd4, 0xaa, 0x1b, 0x7e, 0xdd, 0x30, 0xdf, 0xa0, 0x77, 0x86, 0xc8, 0x1f, 0x40, 0xbe, 0x85, - 0x18, 0x89, 0xb2, 0x54, 0xdd, 0x51, 0x27, 0xcc, 0xad, 0x7a, 0x86, 0x58, 0x9b, 0xbd, 0x0d, 0xe4, - 0x9c, 0x1e, 0xc2, 0xf9, 0x63, 0x58, 0xa1, 0xa4, 0xe7, 0x9a, 0x78, 0x99, 0xf0, 0x8c, 0xe5, 0xda, - 0x1a, 0x04, 0xf2, 0x7a, 0xdc, 0xf7, 0x70, 0x5c, 0xd1, 0x97, 0x63, 0x47, 0x3d, 0x26, 0xfd, 0x0c, - 0x8a, 0x0c, 0x90, 0xe1, 0x1e, 0x6b, 0xb5, 0x33, 0x08, 0x64, 0x61, 0xa8, 0x46, 0x56, 0x82, 0xd5, - 0xd8, 0x77, 0x9a, 0x4e, 0xdf, 0x06, 0xcc, 0x53, 0xdb, 0xea, 0xa2, 0xcb, 0x26, 0x87, 0x59, 0xbc, - 0x08, 0x8b, 0x6c, 0xc4, 0xa8, 0x30, 0xb7, 0x9b, 0x2f, 0x17, 0xf4, 0xd4, 0xce, 0x88, 0xb7, 0x05, - 0x9b, 0x23, 0x8a, 0xa4, 0x6a, 0x7d, 0xe0, 0xa0, 0x34, 0x12, 0x3b, 0xa1, 0x7e, 0xd7, 0xe4, 0x5f, - 0x40, 0xc1, 0x89, 0x3c, 0xc9, 0x52, 0x2d, 0x55, 0xff, 0x88, 0x84, 0x0b, 0xd7, 0x53, 0x4d, 0x76, - 0xb2, 0x5f, 0x51, 0xe3, 0xbc, 0xf3, 0x66, 0x4d, 0x08, 0x95, 0x1b, 0x04, 0xf2, 0x1a, 0x1b, 0x81, - 0x24, 0x5b, 0xd1, 0x17, 0x1d, 0x86, 0xe1, 0x5f, 0x01, 0x30, 0x7f, 0xf8, 0x3d, 0x66, 0xa2, 0xb2, - 0xca, 0xc4, 0xef, 0x91, 0xb6, 0x54, 0xdb, 0x62, 0xb5, 0x8b, 0x43, 0xb5, 0x5b, 0x88, 0x8a, 0xce, - 0xda, 0x3c, 0x1b, 0x5a, 0x24, 0x09, 0x76, 0xc6, 0xb1, 0x4a, 0x68, 0x57, 0xbf, 0xe6, 0x21, 0x7f, - 0x41, 0x2d, 0xbe, 0x03, 0xbf, 0x0d, 0xff, 0x49, 0xfe, 0x9e, 0xd8, 0xcc, 0xe8, 0x62, 0x8a, 0x95, - 0xa9, 0xa1, 0xc9, 0xb5, 0xfc, 0x7b, 0x0e, 0xb6, 0x1f, 0x5b, 0xe0, 0xff, 0xa6, 0x29, 0x39, 0x26, - 0x51, 0x3c, 0xfe, 0xc5, 0xc4, 0xb4, 0xb3, 0xd7, 0xb0, 0x3c, 0xb4, 0x31, 0xe5, 0xc7, 0x0a, 0x66, - 0x91, 0xe2, 0xbf, 0xd3, 0x22, 0xd3, 0xbb, 0x7c, 0x28, 0xfe, 0x3c, 0x6f, 0x7b, 0xd3, 0x96, 0x89, - 0xe0, 0xe2, 0xe1, 0x93, 0xe0, 0xc9, 0xd5, 0xb5, 0xe7, 0xb7, 0xf7, 0x12, 0x77, 0x77, 0x2f, 0x71, - 0x9f, 0xef, 0x25, 0xee, 0xfa, 0x41, 0xca, 0xdd, 0x3d, 0x48, 0xb9, 0x8f, 0x0f, 0x52, 0xee, 0xe5, - 0xa1, 0x65, 0x7b, 0x57, 0xbd, 0x86, 0x6a, 0x92, 0x8e, 0x66, 0x12, 0xda, 0x21, 0x54, 0xb3, 0x1b, - 0xe6, 0x9e, 0x45, 0xb4, 0xfe, 0xbe, 0xd6, 0x21, 0xcd, 0x5e, 0x1b, 0x69, 0xf8, 0x7a, 0x51, 0xad, - 0xfa, 0xff, 0x5e, 0xf8, 0x70, 0x79, 0xbe, 0x83, 0xb4, 0x31, 0x1f, 0xbd, 0x4a, 0xfb, 0xdf, 0x03, - 0x00, 0x00, 0xff, 0xff, 0x8c, 0x56, 0x8c, 0xfd, 0x2e, 0x07, 0x00, 0x00, + // 721 bytes of a gzipped FileDescriptorProto + 0x1f, 0x8b, 0x08, 0x00, 0x00, 0x00, 0x00, 0x00, 0x02, 0xff, 0xbc, 0x55, 0xcf, 0x6e, 0xd3, 0x4e, + 0x10, 0x8e, 0x93, 0xb6, 0xbf, 0x66, 0xdb, 0x5f, 0xdb, 0xac, 0xfa, 0xc7, 0xb1, 0x5a, 0xbb, 0x58, + 0x08, 0x8a, 0x50, 0x6d, 0x92, 0xb6, 0x07, 0x2a, 0x21, 0xd4, 0x54, 0xaa, 0xa8, 0x44, 0x45, 0x64, + 0x71, 0x42, 0x48, 0x91, 0x63, 0x6f, 0x5c, 0x43, 0xe2, 0xb5, 0xbc, 0x4e, 0x84, 0xaf, 0x9c, 0x38, + 0x96, 0x37, 0xe8, 0xe3, 0xf4, 0xd8, 0x03, 0x07, 0xc4, 0xc1, 0x42, 0xed, 0x85, 0x1b, 0x92, 0x9f, + 0x00, 0xad, 0xbd, 0x36, 0x4e, 0xa2, 0x54, 0x81, 0x03, 0xb7, 0xdd, 0x99, 0x6f, 0xbe, 0x99, 0xf9, + 0x3c, 0xe3, 0x05, 0xdb, 0x76, 0xdb, 0x50, 0x75, 0xd7, 0xed, 0xda, 0x86, 0xee, 0xdb, 0xd8, 0x21, + 0x6a, 0x07, 0x21, 0x75, 0x50, 0x53, 0xfd, 0x0f, 0x8a, 0xeb, 0x61, 0x1f, 0xc3, 0x0d, 0xbb, 0x6d, + 0x28, 0x79, 0x84, 0xd2, 0x41, 0x48, 0x19, 0xd4, 0x84, 0x55, 0x0b, 0x5b, 0x38, 0xc6, 0xa8, 0xf4, + 0x94, 0xc0, 0x85, 0x7b, 0x93, 0x08, 0x69, 0x54, 0x0e, 0x62, 0x60, 0x0f, 0xa9, 0xc6, 0xb9, 0xee, + 0x38, 0xa8, 0x4b, 0xdd, 0xec, 0x98, 0x40, 0xe4, 0x6f, 0x1c, 0x58, 0x39, 0x23, 0x96, 0x86, 0x2c, + 0x9b, 0xf8, 0xc8, 0x6b, 0xea, 0x01, 0x42, 0xf0, 0x31, 0xf8, 0xcf, 0xc5, 0x9e, 0xdf, 0xb2, 0x4d, + 0x9e, 0xdb, 0xe6, 0x76, 0xca, 0x0d, 0x18, 0x85, 0xd2, 0x52, 0xa0, 0xf7, 0xba, 0x87, 0x32, 0x73, + 0xc8, 0xda, 0x1c, 0x3d, 0x9d, 0x9a, 0x70, 0x1f, 0x00, 0x46, 0x49, 0xf1, 0xc5, 0x18, 0xbf, 0x16, + 0x85, 0x52, 0x25, 0xc1, 0xff, 0xf6, 0xc9, 0x5a, 0x99, 0x5d, 0x4e, 0x4d, 0x78, 0x0c, 0x96, 0x3d, + 0xd4, 0xd5, 0x03, 0xe4, 0xb5, 0x74, 0xd3, 0xf4, 0x10, 0x21, 0x7c, 0x29, 0x0e, 0x15, 0xa2, 0x50, + 0x5a, 0x4f, 0x42, 0x47, 0x00, 0xb2, 0xb6, 0xc4, 0x2c, 0x47, 0x89, 0x01, 0xae, 0x82, 0x59, 0x97, + 0x16, 0xcc, 0xcf, 0xd0, 0x50, 0x2d, 0xb9, 0x1c, 0xce, 0x7f, 0xba, 0x94, 0x0a, 0x3f, 0x2e, 0xa5, + 0x82, 0x2c, 0x00, 0x7e, 0xb4, 0x37, 0x0d, 0x11, 0x17, 0x3b, 0x04, 0xc9, 0x1f, 0x8b, 0x60, 0x33, + 0xe7, 0x3c, 0xc6, 0x7d, 0xc7, 0x47, 0x9e, 0xab, 0x7b, 0x7e, 0xf0, 0xcf, 0x44, 0x78, 0x38, 0x41, + 0x84, 0xb1, 0x46, 0x5f, 0x02, 0x68, 0xe4, 0x0a, 0x6c, 0xe5, 0xba, 0x6e, 0x6c, 0x45, 0xa1, 0x54, + 0x65, 0x69, 0xc6, 0x30, 0xb2, 0x56, 0x31, 0x46, 0x3b, 0xcb, 0x09, 0xf4, 0x00, 0xdc, 0xbf, 0x4b, + 0x83, 0x4c, 0xac, 0x8b, 0x22, 0x58, 0x3e, 0x23, 0x56, 0x53, 0x0f, 0x9a, 0xba, 0xf1, 0x1e, 0xf9, + 0x27, 0x08, 0xc1, 0x7d, 0x50, 0xea, 0x20, 0x14, 0x6b, 0xb3, 0x50, 0xdf, 0x54, 0x26, 0x0c, 0xaf, + 0x72, 0x82, 0x50, 0x63, 0xe6, 0x2a, 0x94, 0x0a, 0x1a, 0x85, 0xc3, 0xe7, 0x60, 0x89, 0xe0, 0xbe, + 0x67, 0xa0, 0x56, 0x2a, 0x6e, 0x22, 0x56, 0x35, 0x0a, 0xa5, 0xb5, 0xa4, 0x8b, 0x61, 0xbf, 0xac, + 0x2d, 0x26, 0x86, 0x66, 0xa2, 0xf4, 0x0b, 0x50, 0x61, 0x80, 0x9c, 0xe0, 0xc9, 0xe8, 0x6c, 0x46, + 0xa1, 0xc4, 0x0f, 0x71, 0xe4, 0x75, 0x5f, 0x4e, 0x6c, 0xc7, 0x99, 0xfa, 0xeb, 0x60, 0x8e, 0xd8, + 0x96, 0x83, 0x3c, 0x36, 0x3e, 0xec, 0x06, 0x05, 0x30, 0xcf, 0xe4, 0x27, 0xfc, 0xec, 0x76, 0x69, + 0xa7, 0xac, 0x65, 0xf7, 0x9c, 0x74, 0x55, 0xb0, 0x31, 0xa2, 0x48, 0xa6, 0xd6, 0x17, 0x0e, 0xac, + 0x8e, 0xf8, 0x8e, 0x48, 0xe0, 0x18, 0xf0, 0x35, 0x28, 0xbb, 0xb1, 0x25, 0x1d, 0xaa, 0x85, 0xfa, + 0x56, 0x2c, 0x1c, 0xdd, 0x51, 0x25, 0x5d, 0xcc, 0x41, 0x4d, 0x49, 0xe2, 0x4e, 0xcd, 0x06, 0x4f, + 0x95, 0x8b, 0x42, 0x69, 0x85, 0xcd, 0x5d, 0x1a, 0x2d, 0x6b, 0xf3, 0x2e, 0xc3, 0xc0, 0xb7, 0x00, + 0x30, 0x3b, 0xfd, 0x1e, 0xc5, 0x98, 0x56, 0x9e, 0xf8, 0x3d, 0xb2, 0x92, 0x1a, 0x55, 0xc6, 0x5d, + 0x19, 0xe2, 0xee, 0xd0, 0xa1, 0x61, 0x65, 0x9e, 0x0c, 0x0d, 0x8b, 0x18, 0x2f, 0xcc, 0x58, 0x57, + 0x69, 0xdb, 0xf5, 0x9f, 0x25, 0x50, 0x3a, 0x23, 0x16, 0xec, 0x81, 0xff, 0x87, 0x7f, 0x27, 0x8f, + 0x26, 0x16, 0x33, 0xba, 0x9d, 0x42, 0x6d, 0x6a, 0x68, 0x9a, 0x16, 0x7e, 0xe6, 0x40, 0x75, 0xf2, + 0x16, 0x1f, 0x4c, 0x43, 0x38, 0x16, 0x26, 0x3c, 0xfb, 0xab, 0xb0, 0xac, 0xa6, 0x77, 0x60, 0x71, + 0x68, 0x57, 0x76, 0xee, 0xa2, 0xcb, 0x23, 0x85, 0x27, 0xd3, 0x22, 0xb3, 0x5c, 0x01, 0xa8, 0x8c, + 0x4f, 0xda, 0xee, 0xb4, 0x34, 0x31, 0x5c, 0x38, 0xf8, 0x23, 0x78, 0x9a, 0xba, 0xf1, 0xea, 0xea, + 0x46, 0xe4, 0xae, 0x6f, 0x44, 0xee, 0xfb, 0x8d, 0xc8, 0x5d, 0xdc, 0x8a, 0x85, 0xeb, 0x5b, 0xb1, + 0xf0, 0xf5, 0x56, 0x2c, 0xbc, 0x39, 0xb0, 0x6c, 0xff, 0xbc, 0xdf, 0x56, 0x0c, 0xdc, 0x53, 0x0d, + 0x4c, 0x7a, 0x98, 0xa8, 0x76, 0xdb, 0xd8, 0xb5, 0xb0, 0x3a, 0xd8, 0x53, 0x7b, 0xd8, 0xec, 0x77, + 0x11, 0xa1, 0x8f, 0x17, 0x51, 0xeb, 0x4f, 0x77, 0xe9, 0xbb, 0xe5, 0x07, 0x2e, 0x22, 0xed, 0xb9, + 0xf8, 0x51, 0xda, 0xfb, 0x15, 0x00, 0x00, 0xff, 0xff, 0x06, 0xc3, 0x6e, 0xb1, 0x2d, 0x07, 0x00, + 0x00, } // Reference imports to suppress errors if they are not otherwise used. @@ -441,12 +439,12 @@ type MsgClient interface { // packets originate as this is where fee distribution takes place. This function may be called more than once by a // relayer, in which case, the latest payee is always used. RegisterPayee(ctx context.Context, in *MsgRegisterPayee, opts ...grpc.CallOption) (*MsgRegisterPayeeResponse, error) - // RegisterCounterpartyAddress defines a rpc handler method for MsgRegisterCounterpartyAddress - // RegisterCounterpartyAddress is called by the relayer on each channelEnd and allows them to specify their + // RegisterCounterpartyPayee defines a rpc handler method for MsgRegisterCounterpartyPayee + // RegisterCounterpartyPayee is called by the relayer on each channelEnd and allows them to specify their // counterparty address before relaying. This ensures they will be properly compensated for forward relaying since // destination chain must send back relayer's source address (counterparty address) in acknowledgement. This function // may be called more than once by a relayer, in which case, the latest counterparty address is always used. - RegisterCounterpartyAddress(ctx context.Context, in *MsgRegisterCounterpartyAddress, opts ...grpc.CallOption) (*MsgRegisterCounterpartyAddressResponse, error) + RegisterCounterpartyPayee(ctx context.Context, in *MsgRegisterCounterpartyPayee, opts ...grpc.CallOption) (*MsgRegisterCounterpartyPayeeResponse, error) // PayPacketFee defines a rpc handler method for MsgPayPacketFee // PayPacketFee is an open callback that may be called by any module/user that wishes to escrow funds in order to // incentivize the relaying of the packet at the next sequence @@ -476,9 +474,9 @@ func (c *msgClient) RegisterPayee(ctx context.Context, in *MsgRegisterPayee, opt return out, nil } -func (c *msgClient) RegisterCounterpartyAddress(ctx context.Context, in *MsgRegisterCounterpartyAddress, opts ...grpc.CallOption) (*MsgRegisterCounterpartyAddressResponse, error) { - out := new(MsgRegisterCounterpartyAddressResponse) - err := c.cc.Invoke(ctx, "/ibc.applications.fee.v1.Msg/RegisterCounterpartyAddress", in, out, opts...) +func (c *msgClient) RegisterCounterpartyPayee(ctx context.Context, in *MsgRegisterCounterpartyPayee, opts ...grpc.CallOption) (*MsgRegisterCounterpartyPayeeResponse, error) { + out := new(MsgRegisterCounterpartyPayeeResponse) + err := c.cc.Invoke(ctx, "/ibc.applications.fee.v1.Msg/RegisterCounterpartyPayee", in, out, opts...) if err != nil { return nil, err } @@ -511,12 +509,12 @@ type MsgServer interface { // packets originate as this is where fee distribution takes place. This function may be called more than once by a // relayer, in which case, the latest payee is always used. RegisterPayee(context.Context, *MsgRegisterPayee) (*MsgRegisterPayeeResponse, error) - // RegisterCounterpartyAddress defines a rpc handler method for MsgRegisterCounterpartyAddress - // RegisterCounterpartyAddress is called by the relayer on each channelEnd and allows them to specify their + // RegisterCounterpartyPayee defines a rpc handler method for MsgRegisterCounterpartyPayee + // RegisterCounterpartyPayee is called by the relayer on each channelEnd and allows them to specify their // counterparty address before relaying. This ensures they will be properly compensated for forward relaying since // destination chain must send back relayer's source address (counterparty address) in acknowledgement. This function // may be called more than once by a relayer, in which case, the latest counterparty address is always used. - RegisterCounterpartyAddress(context.Context, *MsgRegisterCounterpartyAddress) (*MsgRegisterCounterpartyAddressResponse, error) + RegisterCounterpartyPayee(context.Context, *MsgRegisterCounterpartyPayee) (*MsgRegisterCounterpartyPayeeResponse, error) // PayPacketFee defines a rpc handler method for MsgPayPacketFee // PayPacketFee is an open callback that may be called by any module/user that wishes to escrow funds in order to // incentivize the relaying of the packet at the next sequence @@ -536,8 +534,8 @@ type UnimplementedMsgServer struct { func (*UnimplementedMsgServer) RegisterPayee(ctx context.Context, req *MsgRegisterPayee) (*MsgRegisterPayeeResponse, error) { return nil, status.Errorf(codes.Unimplemented, "method RegisterPayee not implemented") } -func (*UnimplementedMsgServer) RegisterCounterpartyAddress(ctx context.Context, req *MsgRegisterCounterpartyAddress) (*MsgRegisterCounterpartyAddressResponse, error) { - return nil, status.Errorf(codes.Unimplemented, "method RegisterCounterpartyAddress not implemented") +func (*UnimplementedMsgServer) RegisterCounterpartyPayee(ctx context.Context, req *MsgRegisterCounterpartyPayee) (*MsgRegisterCounterpartyPayeeResponse, error) { + return nil, status.Errorf(codes.Unimplemented, "method RegisterCounterpartyPayee not implemented") } func (*UnimplementedMsgServer) PayPacketFee(ctx context.Context, req *MsgPayPacketFee) (*MsgPayPacketFeeResponse, error) { return nil, status.Errorf(codes.Unimplemented, "method PayPacketFee not implemented") @@ -568,20 +566,20 @@ func _Msg_RegisterPayee_Handler(srv interface{}, ctx context.Context, dec func(i return interceptor(ctx, in, info, handler) } -func _Msg_RegisterCounterpartyAddress_Handler(srv interface{}, ctx context.Context, dec func(interface{}) error, interceptor grpc.UnaryServerInterceptor) (interface{}, error) { - in := new(MsgRegisterCounterpartyAddress) +func _Msg_RegisterCounterpartyPayee_Handler(srv interface{}, ctx context.Context, dec func(interface{}) error, interceptor grpc.UnaryServerInterceptor) (interface{}, error) { + in := new(MsgRegisterCounterpartyPayee) if err := dec(in); err != nil { return nil, err } if interceptor == nil { - return srv.(MsgServer).RegisterCounterpartyAddress(ctx, in) + return srv.(MsgServer).RegisterCounterpartyPayee(ctx, in) } info := &grpc.UnaryServerInfo{ Server: srv, - FullMethod: "/ibc.applications.fee.v1.Msg/RegisterCounterpartyAddress", + FullMethod: "/ibc.applications.fee.v1.Msg/RegisterCounterpartyPayee", } handler := func(ctx context.Context, req interface{}) (interface{}, error) { - return srv.(MsgServer).RegisterCounterpartyAddress(ctx, req.(*MsgRegisterCounterpartyAddress)) + return srv.(MsgServer).RegisterCounterpartyPayee(ctx, req.(*MsgRegisterCounterpartyPayee)) } return interceptor(ctx, in, info, handler) } @@ -631,8 +629,8 @@ var _Msg_serviceDesc = grpc.ServiceDesc{ Handler: _Msg_RegisterPayee_Handler, }, { - MethodName: "RegisterCounterpartyAddress", - Handler: _Msg_RegisterCounterpartyAddress_Handler, + MethodName: "RegisterCounterpartyPayee", + Handler: _Msg_RegisterCounterpartyPayee_Handler, }, { MethodName: "PayPacketFee", @@ -721,7 +719,7 @@ func (m *MsgRegisterPayeeResponse) MarshalToSizedBuffer(dAtA []byte) (int, error return len(dAtA) - i, nil } -func (m *MsgRegisterCounterpartyAddress) Marshal() (dAtA []byte, err error) { +func (m *MsgRegisterCounterpartyPayee) Marshal() (dAtA []byte, err error) { size := m.Size() dAtA = make([]byte, size) n, err := m.MarshalToSizedBuffer(dAtA[:size]) @@ -731,48 +729,48 @@ func (m *MsgRegisterCounterpartyAddress) Marshal() (dAtA []byte, err error) { return dAtA[:n], nil } -func (m *MsgRegisterCounterpartyAddress) MarshalTo(dAtA []byte) (int, error) { +func (m *MsgRegisterCounterpartyPayee) MarshalTo(dAtA []byte) (int, error) { size := m.Size() return m.MarshalToSizedBuffer(dAtA[:size]) } -func (m *MsgRegisterCounterpartyAddress) MarshalToSizedBuffer(dAtA []byte) (int, error) { +func (m *MsgRegisterCounterpartyPayee) MarshalToSizedBuffer(dAtA []byte) (int, error) { i := len(dAtA) _ = i var l int _ = l + if len(m.CounterpartyPayee) > 0 { + i -= len(m.CounterpartyPayee) + copy(dAtA[i:], m.CounterpartyPayee) + i = encodeVarintTx(dAtA, i, uint64(len(m.CounterpartyPayee))) + i-- + dAtA[i] = 0x22 + } + if len(m.RelayerAddress) > 0 { + i -= len(m.RelayerAddress) + copy(dAtA[i:], m.RelayerAddress) + i = encodeVarintTx(dAtA, i, uint64(len(m.RelayerAddress))) + i-- + dAtA[i] = 0x1a + } if len(m.ChannelId) > 0 { i -= len(m.ChannelId) copy(dAtA[i:], m.ChannelId) i = encodeVarintTx(dAtA, i, uint64(len(m.ChannelId))) i-- - dAtA[i] = 0x22 + dAtA[i] = 0x12 } if len(m.PortId) > 0 { i -= len(m.PortId) copy(dAtA[i:], m.PortId) i = encodeVarintTx(dAtA, i, uint64(len(m.PortId))) i-- - dAtA[i] = 0x1a - } - if len(m.CounterpartyAddress) > 0 { - i -= len(m.CounterpartyAddress) - copy(dAtA[i:], m.CounterpartyAddress) - i = encodeVarintTx(dAtA, i, uint64(len(m.CounterpartyAddress))) - i-- - dAtA[i] = 0x12 - } - if len(m.Address) > 0 { - i -= len(m.Address) - copy(dAtA[i:], m.Address) - i = encodeVarintTx(dAtA, i, uint64(len(m.Address))) - i-- dAtA[i] = 0xa } return len(dAtA) - i, nil } -func (m *MsgRegisterCounterpartyAddressResponse) Marshal() (dAtA []byte, err error) { +func (m *MsgRegisterCounterpartyPayeeResponse) Marshal() (dAtA []byte, err error) { size := m.Size() dAtA = make([]byte, size) n, err := m.MarshalToSizedBuffer(dAtA[:size]) @@ -782,12 +780,12 @@ func (m *MsgRegisterCounterpartyAddressResponse) Marshal() (dAtA []byte, err err return dAtA[:n], nil } -func (m *MsgRegisterCounterpartyAddressResponse) MarshalTo(dAtA []byte) (int, error) { +func (m *MsgRegisterCounterpartyPayeeResponse) MarshalTo(dAtA []byte) (int, error) { size := m.Size() return m.MarshalToSizedBuffer(dAtA[:size]) } -func (m *MsgRegisterCounterpartyAddressResponse) MarshalToSizedBuffer(dAtA []byte) (int, error) { +func (m *MsgRegisterCounterpartyPayeeResponse) MarshalToSizedBuffer(dAtA []byte) (int, error) { i := len(dAtA) _ = i var l int @@ -992,32 +990,32 @@ func (m *MsgRegisterPayeeResponse) Size() (n int) { return n } -func (m *MsgRegisterCounterpartyAddress) Size() (n int) { +func (m *MsgRegisterCounterpartyPayee) Size() (n int) { if m == nil { return 0 } var l int _ = l - l = len(m.Address) + l = len(m.PortId) if l > 0 { n += 1 + l + sovTx(uint64(l)) } - l = len(m.CounterpartyAddress) + l = len(m.ChannelId) if l > 0 { n += 1 + l + sovTx(uint64(l)) } - l = len(m.PortId) + l = len(m.RelayerAddress) if l > 0 { n += 1 + l + sovTx(uint64(l)) } - l = len(m.ChannelId) + l = len(m.CounterpartyPayee) if l > 0 { n += 1 + l + sovTx(uint64(l)) } return n } -func (m *MsgRegisterCounterpartyAddressResponse) Size() (n int) { +func (m *MsgRegisterCounterpartyPayeeResponse) Size() (n int) { if m == nil { return 0 } @@ -1320,7 +1318,7 @@ func (m *MsgRegisterPayeeResponse) Unmarshal(dAtA []byte) error { } return nil } -func (m *MsgRegisterCounterpartyAddress) Unmarshal(dAtA []byte) error { +func (m *MsgRegisterCounterpartyPayee) Unmarshal(dAtA []byte) error { l := len(dAtA) iNdEx := 0 for iNdEx < l { @@ -1343,15 +1341,15 @@ func (m *MsgRegisterCounterpartyAddress) Unmarshal(dAtA []byte) error { fieldNum := int32(wire >> 3) wireType := int(wire & 0x7) if wireType == 4 { - return fmt.Errorf("proto: MsgRegisterCounterpartyAddress: wiretype end group for non-group") + return fmt.Errorf("proto: MsgRegisterCounterpartyPayee: wiretype end group for non-group") } if fieldNum <= 0 { - return fmt.Errorf("proto: MsgRegisterCounterpartyAddress: illegal tag %d (wire type %d)", fieldNum, wire) + return fmt.Errorf("proto: MsgRegisterCounterpartyPayee: illegal tag %d (wire type %d)", fieldNum, wire) } switch fieldNum { case 1: if wireType != 2 { - return fmt.Errorf("proto: wrong wireType = %d for field Address", wireType) + return fmt.Errorf("proto: wrong wireType = %d for field PortId", wireType) } var stringLen uint64 for shift := uint(0); ; shift += 7 { @@ -1379,11 +1377,11 @@ func (m *MsgRegisterCounterpartyAddress) Unmarshal(dAtA []byte) error { if postIndex > l { return io.ErrUnexpectedEOF } - m.Address = string(dAtA[iNdEx:postIndex]) + m.PortId = string(dAtA[iNdEx:postIndex]) iNdEx = postIndex case 2: if wireType != 2 { - return fmt.Errorf("proto: wrong wireType = %d for field CounterpartyAddress", wireType) + return fmt.Errorf("proto: wrong wireType = %d for field ChannelId", wireType) } var stringLen uint64 for shift := uint(0); ; shift += 7 { @@ -1411,11 +1409,11 @@ func (m *MsgRegisterCounterpartyAddress) Unmarshal(dAtA []byte) error { if postIndex > l { return io.ErrUnexpectedEOF } - m.CounterpartyAddress = string(dAtA[iNdEx:postIndex]) + m.ChannelId = string(dAtA[iNdEx:postIndex]) iNdEx = postIndex case 3: if wireType != 2 { - return fmt.Errorf("proto: wrong wireType = %d for field PortId", wireType) + return fmt.Errorf("proto: wrong wireType = %d for field RelayerAddress", wireType) } var stringLen uint64 for shift := uint(0); ; shift += 7 { @@ -1443,11 +1441,11 @@ func (m *MsgRegisterCounterpartyAddress) Unmarshal(dAtA []byte) error { if postIndex > l { return io.ErrUnexpectedEOF } - m.PortId = string(dAtA[iNdEx:postIndex]) + m.RelayerAddress = string(dAtA[iNdEx:postIndex]) iNdEx = postIndex case 4: if wireType != 2 { - return fmt.Errorf("proto: wrong wireType = %d for field ChannelId", wireType) + return fmt.Errorf("proto: wrong wireType = %d for field CounterpartyPayee", wireType) } var stringLen uint64 for shift := uint(0); ; shift += 7 { @@ -1475,7 +1473,7 @@ func (m *MsgRegisterCounterpartyAddress) Unmarshal(dAtA []byte) error { if postIndex > l { return io.ErrUnexpectedEOF } - m.ChannelId = string(dAtA[iNdEx:postIndex]) + m.CounterpartyPayee = string(dAtA[iNdEx:postIndex]) iNdEx = postIndex default: iNdEx = preIndex @@ -1498,7 +1496,7 @@ func (m *MsgRegisterCounterpartyAddress) Unmarshal(dAtA []byte) error { } return nil } -func (m *MsgRegisterCounterpartyAddressResponse) Unmarshal(dAtA []byte) error { +func (m *MsgRegisterCounterpartyPayeeResponse) Unmarshal(dAtA []byte) error { l := len(dAtA) iNdEx := 0 for iNdEx < l { @@ -1521,10 +1519,10 @@ func (m *MsgRegisterCounterpartyAddressResponse) Unmarshal(dAtA []byte) error { fieldNum := int32(wire >> 3) wireType := int(wire & 0x7) if wireType == 4 { - return fmt.Errorf("proto: MsgRegisterCounterpartyAddressResponse: wiretype end group for non-group") + return fmt.Errorf("proto: MsgRegisterCounterpartyPayeeResponse: wiretype end group for non-group") } if fieldNum <= 0 { - return fmt.Errorf("proto: MsgRegisterCounterpartyAddressResponse: illegal tag %d (wire type %d)", fieldNum, wire) + return fmt.Errorf("proto: MsgRegisterCounterpartyPayeeResponse: illegal tag %d (wire type %d)", fieldNum, wire) } switch fieldNum { default: diff --git a/proto/ibc/applications/fee/v1/tx.proto b/proto/ibc/applications/fee/v1/tx.proto index f7c4618f54c..f4992d0edb9 100644 --- a/proto/ibc/applications/fee/v1/tx.proto +++ b/proto/ibc/applications/fee/v1/tx.proto @@ -17,12 +17,12 @@ service Msg { // relayer, in which case, the latest payee is always used. rpc RegisterPayee(MsgRegisterPayee) returns (MsgRegisterPayeeResponse); - // RegisterCounterpartyAddress defines a rpc handler method for MsgRegisterCounterpartyAddress - // RegisterCounterpartyAddress is called by the relayer on each channelEnd and allows them to specify their + // RegisterCounterpartyPayee defines a rpc handler method for MsgRegisterCounterpartyPayee + // RegisterCounterpartyPayee is called by the relayer on each channelEnd and allows them to specify their // counterparty address before relaying. This ensures they will be properly compensated for forward relaying since // destination chain must send back relayer's source address (counterparty address) in acknowledgement. This function // may be called more than once by a relayer, in which case, the latest counterparty address is always used. - rpc RegisterCounterpartyAddress(MsgRegisterCounterpartyAddress) returns (MsgRegisterCounterpartyAddressResponse); + rpc RegisterCounterpartyPayee(MsgRegisterCounterpartyPayee) returns (MsgRegisterCounterpartyPayeeResponse); // PayPacketFee defines a rpc handler method for MsgPayPacketFee // PayPacketFee is an open callback that may be called by any module/user that wishes to escrow funds in order to @@ -55,23 +55,23 @@ message MsgRegisterPayee { // MsgRegisterPayeeResponse defines the response type for the RegisterPayee rpc message MsgRegisterPayeeResponse {} -// MsgRegisterCounterpartyAddress defines the request type for the RegisterCounterpartyAddress rpc -message MsgRegisterCounterpartyAddress { +// MsgRegisterCounterpartyPayee defines the request type for the RegisterCounterpartyPayee rpc +message MsgRegisterCounterpartyPayee { option (gogoproto.equal) = false; option (gogoproto.goproto_getters) = false; - // the relayer address - string address = 1; - // the counterparty relayer address - string counterparty_address = 2 [(gogoproto.moretags) = "yaml:\"counterparty_address\""]; // unique port identifier - string port_id = 3 [(gogoproto.moretags) = "yaml:\"port_id\""]; + string port_id = 1 [(gogoproto.moretags) = "yaml:\"port_id\""]; // unique channel identifier - string channel_id = 4 [(gogoproto.moretags) = "yaml:\"channel_id\""]; + string channel_id = 2 [(gogoproto.moretags) = "yaml:\"channel_id\""]; + // the relayer address + string relayer_address = 3; + // the counterparty relayer address + string counterparty_payee = 4 [(gogoproto.moretags) = "yaml:\"counterparty_payee\""]; } -// MsgRegisterCounterpartyAddressResponse defines the response type for the RegisterCounterpartyAddress rpc -message MsgRegisterCounterpartyAddressResponse {} +// MsgRegisterCounterpartyPayeeResponse defines the response type for the RegisterCounterpartyPayee rpc +message MsgRegisterCounterpartyPayeeResponse {} // MsgPayPacketFee defines the request type for the PayPacketFee rpc // This Msg can be used to pay for a packet at the next sequence send & should be combined with the Msg that will be From 6ef0b443aca6784a88da5230b2c17386d6cc4009 Mon Sep 17 00:00:00 2001 From: Damian Nolan Date: Thu, 9 Jun 2022 10:47:01 +0200 Subject: [PATCH 2/9] updating counterparty payee cli --- modules/apps/29-fee/client/cli/cli.go | 2 +- modules/apps/29-fee/client/cli/tx.go | 6 +++--- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/modules/apps/29-fee/client/cli/cli.go b/modules/apps/29-fee/client/cli/cli.go index 1306efa84b9..75651519a94 100644 --- a/modules/apps/29-fee/client/cli/cli.go +++ b/modules/apps/29-fee/client/cli/cli.go @@ -42,7 +42,7 @@ func NewTxCmd() *cobra.Command { txCmd.AddCommand( NewRegisterPayeeCmd(), NewPayPacketFeeAsyncTxCmd(), - NewRegisterCounterpartyAddressCmd(), + NewRegisterCounterpartyPayeeCmd(), ) return txCmd diff --git a/modules/apps/29-fee/client/cli/tx.go b/modules/apps/29-fee/client/cli/tx.go index f4fe48f1dec..467427b277b 100644 --- a/modules/apps/29-fee/client/cli/tx.go +++ b/modules/apps/29-fee/client/cli/tx.go @@ -47,10 +47,10 @@ func NewRegisterPayeeCmd() *cobra.Command { return cmd } -// NewRegisterCounterpartyAddressCmd returns the command to create a MsgRegisterCounterpartyAddress -func NewRegisterCounterpartyAddressCmd() *cobra.Command { +// NewRegisterCounterpartyPayeeCmd returns the command to create a MsgRegisterCounterpartyPayee +func NewRegisterCounterpartyPayeeCmd() *cobra.Command { cmd := &cobra.Command{ - Use: "register-counterparty [port-id] [channel-id] [address] [counterparty-payee-address] ", + Use: "register-counterparty-payee [port-id] [channel-id] [relayer-address] [payee-address] ", Short: "Register a counterparty payee address on a given channel.", Long: strings.TrimSpace(`Register a counterparty payee address on a given channel.`), Example: fmt.Sprintf("%s tx ibc-fee register-counterparty transfer channel-0 cosmos1rsp837a4kvtgp2m4uqzdge0zzu6efqgucm0qdh osmo1v5y0tz01llxzf4c2afml8s3awue0ymju22wxx2", version.AppName), From 679e0eea4b77519911b8be857ba35616778a5aa2 Mon Sep 17 00:00:00 2001 From: Damian Nolan Date: Thu, 9 Jun 2022 14:25:57 +0200 Subject: [PATCH 3/9] reorder cli cmd list --- modules/apps/29-fee/client/cli/cli.go | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/apps/29-fee/client/cli/cli.go b/modules/apps/29-fee/client/cli/cli.go index 87b894087dd..d609104ba67 100644 --- a/modules/apps/29-fee/client/cli/cli.go +++ b/modules/apps/29-fee/client/cli/cli.go @@ -42,8 +42,8 @@ func NewTxCmd() *cobra.Command { txCmd.AddCommand( NewRegisterPayeeCmd(), - NewPayPacketFeeAsyncTxCmd(), NewRegisterCounterpartyPayeeCmd(), + NewPayPacketFeeAsyncTxCmd(), ) return txCmd From 6121ec026240fcf96cd719dcc8c5a78cb7c8acab Mon Sep 17 00:00:00 2001 From: Damian Nolan Date: Thu, 9 Jun 2022 17:42:19 +0200 Subject: [PATCH 4/9] Apply suggestions from code review Co-authored-by: Charly --- modules/apps/29-fee/keeper/keeper.go | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/modules/apps/29-fee/keeper/keeper.go b/modules/apps/29-fee/keeper/keeper.go index 75a2ad3a0b9..4465aebbc81 100644 --- a/modules/apps/29-fee/keeper/keeper.go +++ b/modules/apps/29-fee/keeper/keeper.go @@ -190,14 +190,14 @@ func (k Keeper) GetAllPayeeAddresses(ctx sdk.Context) []types.RegisteredPayee { return registeredPayees } -// SetCounterpartyPayeeAddress maps the destination chain relayer address to the source relayer address -// The receiving chain must store the mapping from: address -> counterpartyAddress for the given channel +// SetCounterpartyPayeeAddress maps the destination chain counterparty payee address to the source relayer address +// The receiving chain must store the mapping from: address -> counterpartyPayeeAddress for the given channel func (k Keeper) SetCounterpartyPayeeAddress(ctx sdk.Context, address, counterpartyAddress, channelID string) { store := ctx.KVStore(k.storeKey) store.Set(types.KeyCounterpartyRelayer(address, channelID), []byte(counterpartyAddress)) } -// GetCounterpartyPayeeAddress gets the relayer counterparty address given a destination relayer address +// GetCounterpartyPayeeAddress gets the counterparty payee address given a destination relayer address func (k Keeper) GetCounterpartyPayeeAddress(ctx sdk.Context, address, channelID string) (string, bool) { store := ctx.KVStore(k.storeKey) key := types.KeyCounterpartyRelayer(address, channelID) From ac2dd48a0499eaaaca45861cd035153c45350053 Mon Sep 17 00:00:00 2001 From: Damian Nolan Date: Thu, 9 Jun 2022 18:09:52 +0200 Subject: [PATCH 5/9] removing address suffix from msg fields, updating protodoc and godoc --- docs/ibc/proto-docs.md | 10 +- modules/apps/29-fee/keeper/msg_server.go | 16 +-- modules/apps/29-fee/types/msgs.go | 20 ++-- modules/apps/29-fee/types/msgs_test.go | 6 +- modules/apps/29-fee/types/tx.pb.go | 144 +++++++++++------------ proto/ibc/applications/fee/v1/tx.proto | 16 +-- 6 files changed, 105 insertions(+), 107 deletions(-) diff --git a/docs/ibc/proto-docs.md b/docs/ibc/proto-docs.md index ecf4c9661de..b65d1704b57 100644 --- a/docs/ibc/proto-docs.md +++ b/docs/ibc/proto-docs.md @@ -1352,8 +1352,8 @@ MsgRegisterCounterpartyPayee defines the request type for the RegisterCounterpar | ----- | ---- | ----- | ----------- | | `port_id` | [string](#string) | | unique port identifier | | `channel_id` | [string](#string) | | unique channel identifier | -| `relayer_address` | [string](#string) | | the relayer address | -| `counterparty_payee` | [string](#string) | | the counterparty relayer address | +| `relayer` | [string](#string) | | the relayer address | +| `counterparty_payee` | [string](#string) | | the counterparty payee address | @@ -1380,8 +1380,8 @@ MsgRegisterPayee defines the request type for the RegisterPayee rpc | ----- | ---- | ----- | ----------- | | `port_id` | [string](#string) | | unique port identifier | | `channel_id` | [string](#string) | | unique channel identifier | -| `relayer_address` | [string](#string) | | the relayer address | -| `payee` | [string](#string) | | the fee payee address | +| `relayer` | [string](#string) | | the relayer address | +| `payee` | [string](#string) | | the payee address | @@ -1412,7 +1412,7 @@ Msg defines the ICS29 Msg service. | Method Name | Request Type | Response Type | Description | HTTP Verb | Endpoint | | ----------- | ------------ | ------------- | ------------| ------- | -------- | | `RegisterPayee` | [MsgRegisterPayee](#ibc.applications.fee.v1.MsgRegisterPayee) | [MsgRegisterPayeeResponse](#ibc.applications.fee.v1.MsgRegisterPayeeResponse) | RegisterPayee defines a rpc handler method for MsgRegisterPayee RegisterPayee is called by the relayer on each channelEnd and allows them to set an optional payee to which escrowed packet fees will be paid out. The payee should be registered on the source chain from which packets originate as this is where fee distribution takes place. This function may be called more than once by a relayer, in which case, the latest payee is always used. | | -| `RegisterCounterpartyPayee` | [MsgRegisterCounterpartyPayee](#ibc.applications.fee.v1.MsgRegisterCounterpartyPayee) | [MsgRegisterCounterpartyPayeeResponse](#ibc.applications.fee.v1.MsgRegisterCounterpartyPayeeResponse) | RegisterCounterpartyPayee defines a rpc handler method for MsgRegisterCounterpartyPayee RegisterCounterpartyPayee is called by the relayer on each channelEnd and allows them to specify their counterparty address before relaying. This ensures they will be properly compensated for forward relaying since destination chain must send back relayer's source address (counterparty address) in acknowledgement. This function may be called more than once by a relayer, in which case, the latest counterparty address is always used. | | +| `RegisterCounterpartyPayee` | [MsgRegisterCounterpartyPayee](#ibc.applications.fee.v1.MsgRegisterCounterpartyPayee) | [MsgRegisterCounterpartyPayeeResponse](#ibc.applications.fee.v1.MsgRegisterCounterpartyPayeeResponse) | RegisterCounterpartyPayee defines a rpc handler method for MsgRegisterCounterpartyPayee RegisterCounterpartyPayee is called by the relayer on each channelEnd and allows them to specify the counterparty payee address before relaying. This ensures they will be properly compensated for forward relaying since the destination chain must include the registered counterparty payee address in the acknowledgement. This function may be called more than once by a relayer, in which case, the latest counterparty payee address is always used. | | | `PayPacketFee` | [MsgPayPacketFee](#ibc.applications.fee.v1.MsgPayPacketFee) | [MsgPayPacketFeeResponse](#ibc.applications.fee.v1.MsgPayPacketFeeResponse) | PayPacketFee defines a rpc handler method for MsgPayPacketFee PayPacketFee is an open callback that may be called by any module/user that wishes to escrow funds in order to incentivize the relaying of the packet at the next sequence NOTE: This method is intended to be used within a multi msg transaction, where the subsequent msg that follows initiates the lifecycle of the incentivized packet | | | `PayPacketFeeAsync` | [MsgPayPacketFeeAsync](#ibc.applications.fee.v1.MsgPayPacketFeeAsync) | [MsgPayPacketFeeAsyncResponse](#ibc.applications.fee.v1.MsgPayPacketFeeAsyncResponse) | PayPacketFeeAsync defines a rpc handler method for MsgPayPacketFeeAsync PayPacketFeeAsync is an open callback that may be called by any module/user that wishes to escrow funds in order to incentivize the relaying of a known packet (i.e. at a particular sequence) | | diff --git a/modules/apps/29-fee/keeper/msg_server.go b/modules/apps/29-fee/keeper/msg_server.go index d5398cdc706..dc4d902e895 100644 --- a/modules/apps/29-fee/keeper/msg_server.go +++ b/modules/apps/29-fee/keeper/msg_server.go @@ -29,18 +29,18 @@ func (k Keeper) RegisterPayee(goCtx context.Context, msg *types.MsgRegisterPayee return nil, types.ErrFeeNotEnabled } - k.SetPayeeAddress(ctx, msg.RelayerAddress, msg.Payee, msg.ChannelId) + k.SetPayeeAddress(ctx, msg.Relayer, msg.Payee, msg.ChannelId) - k.Logger(ctx).Info("registering payee address for relayer", "relayer address", msg.RelayerAddress, "payee address", msg.Payee, "channel", msg.ChannelId) + k.Logger(ctx).Info("registering payee address for relayer", "relayer", msg.Relayer, "payee", msg.Payee, "channel", msg.ChannelId) return &types.MsgRegisterPayeeResponse{}, nil } // RegisterCounterpartyPayee defines a rpc handler method for MsgRegisterCounterpartyPayee -// RegisterCounterpartyPayee is called by the relayer on each channelEnd and allows them to specify their -// counterparty address before relaying. This ensures they will be properly compensated for forward relaying since -// destination chain must send back relayer's source address (counterparty address) in acknowledgement. This function -// may be called more than once by a relayer, in which case, the latest counterparty address is always used. +// RegisterCounterpartyPayee is called by the relayer on each channelEnd and allows them to specify the counterparty +// payee address before relaying. This ensures they will be properly compensated for forward relaying since +// the destination chain must include the registered counterparty payee address in the acknowledgement. This function +// may be called more than once by a relayer, in which case, the latest counterparty payee address is always used. func (k Keeper) RegisterCounterpartyPayee(goCtx context.Context, msg *types.MsgRegisterCounterpartyPayee) (*types.MsgRegisterCounterpartyPayeeResponse, error) { ctx := sdk.UnwrapSDKContext(goCtx) @@ -53,9 +53,9 @@ func (k Keeper) RegisterCounterpartyPayee(goCtx context.Context, msg *types.MsgR return nil, types.ErrFeeNotEnabled } - k.SetCounterpartyPayeeAddress(ctx, msg.RelayerAddress, msg.CounterpartyPayee, msg.ChannelId) + k.SetCounterpartyPayeeAddress(ctx, msg.Relayer, msg.CounterpartyPayee, msg.ChannelId) - k.Logger(ctx).Info("registering counterparty payee for relayer", "relayer address", msg.RelayerAddress, "counterparty payee address", msg.CounterpartyPayee, "channel", msg.ChannelId) + k.Logger(ctx).Info("registering counterparty payee for relayer", "relayer", msg.Relayer, "counterparty payee", msg.CounterpartyPayee, "channel", msg.ChannelId) return &types.MsgRegisterCounterpartyPayeeResponse{}, nil } diff --git a/modules/apps/29-fee/types/msgs.go b/modules/apps/29-fee/types/msgs.go index 639a324518c..81d22d50422 100644 --- a/modules/apps/29-fee/types/msgs.go +++ b/modules/apps/29-fee/types/msgs.go @@ -19,10 +19,10 @@ const ( // NewMsgRegisterPayee creates a new instance of MsgRegisterPayee func NewMsgRegisterPayee(portID, channelID, relayerAddr, payeeAddr string) *MsgRegisterPayee { return &MsgRegisterPayee{ - PortId: portID, - ChannelId: channelID, - RelayerAddress: relayerAddr, - Payee: payeeAddr, + PortId: portID, + ChannelId: channelID, + Relayer: relayerAddr, + Payee: payeeAddr, } } @@ -36,11 +36,11 @@ func (msg MsgRegisterPayee) ValidateBasic() error { return err } - if msg.RelayerAddress == msg.Payee { + if msg.Relayer == msg.Payee { return sdkerrors.Wrap(sdkerrors.ErrInvalidRequest, "relayer address and payee must not be equal") } - _, err := sdk.AccAddressFromBech32(msg.RelayerAddress) + _, err := sdk.AccAddressFromBech32(msg.Relayer) if err != nil { return sdkerrors.Wrap(err, "failed to create sdk.AccAddress from relayer address") } @@ -55,7 +55,7 @@ func (msg MsgRegisterPayee) ValidateBasic() error { // GetSigners implements sdk.Msg func (msg MsgRegisterPayee) GetSigners() []sdk.AccAddress { - signer, err := sdk.AccAddressFromBech32(msg.RelayerAddress) + signer, err := sdk.AccAddressFromBech32(msg.Relayer) if err != nil { panic(err) } @@ -68,7 +68,7 @@ func NewMsgRegisterCounterpartyPayee(portID, channelID, relayerAddr, counterpart return &MsgRegisterCounterpartyPayee{ PortId: portID, ChannelId: channelID, - RelayerAddress: relayerAddr, + Relayer: relayerAddr, CounterpartyPayee: counterpartyPayeeAddr, } } @@ -83,7 +83,7 @@ func (msg MsgRegisterCounterpartyPayee) ValidateBasic() error { return err } - _, err := sdk.AccAddressFromBech32(msg.RelayerAddress) + _, err := sdk.AccAddressFromBech32(msg.Relayer) if err != nil { return sdkerrors.Wrap(err, "failed to create sdk.AccAddress from relayer address") } @@ -97,7 +97,7 @@ func (msg MsgRegisterCounterpartyPayee) ValidateBasic() error { // GetSigners implements sdk.Msg func (msg MsgRegisterCounterpartyPayee) GetSigners() []sdk.AccAddress { - signer, err := sdk.AccAddressFromBech32(msg.RelayerAddress) + signer, err := sdk.AccAddressFromBech32(msg.Relayer) if err != nil { panic(err) } diff --git a/modules/apps/29-fee/types/msgs_test.go b/modules/apps/29-fee/types/msgs_test.go index dfbe471c8fa..5b6cbc8c033 100644 --- a/modules/apps/29-fee/types/msgs_test.go +++ b/modules/apps/29-fee/types/msgs_test.go @@ -42,7 +42,7 @@ func TestMsgRegisterPayeeValidation(t *testing.T) { { "invalid request relayer and payee are equal", func() { - msg.RelayerAddress = defaultAccAddress + msg.Relayer = defaultAccAddress msg.Payee = defaultAccAddress }, false, @@ -50,7 +50,7 @@ func TestMsgRegisterPayeeValidation(t *testing.T) { { "invalid relayer address", func() { - msg.RelayerAddress = "invalid-address" + msg.Relayer = "invalid-address" }, false, }, @@ -117,7 +117,7 @@ func TestMsgRegisterCountepartyPayeeValidation(t *testing.T) { { "validate with incorrect destination relayer address", func() { - msg.RelayerAddress = "invalid-address" + msg.Relayer = "invalid-address" }, false, }, diff --git a/modules/apps/29-fee/types/tx.pb.go b/modules/apps/29-fee/types/tx.pb.go index a748da63d47..e70398ccb28 100644 --- a/modules/apps/29-fee/types/tx.pb.go +++ b/modules/apps/29-fee/types/tx.pb.go @@ -36,8 +36,8 @@ type MsgRegisterPayee struct { // unique channel identifier ChannelId string `protobuf:"bytes,2,opt,name=channel_id,json=channelId,proto3" json:"channel_id,omitempty" yaml:"channel_id"` // the relayer address - RelayerAddress string `protobuf:"bytes,3,opt,name=relayer_address,json=relayerAddress,proto3" json:"relayer_address,omitempty" yaml:"relayer_address"` - // the fee payee address + Relayer string `protobuf:"bytes,3,opt,name=relayer,proto3" json:"relayer,omitempty"` + // the payee address Payee string `protobuf:"bytes,4,opt,name=payee,proto3" json:"payee,omitempty"` } @@ -118,8 +118,8 @@ type MsgRegisterCounterpartyPayee struct { // unique channel identifier ChannelId string `protobuf:"bytes,2,opt,name=channel_id,json=channelId,proto3" json:"channel_id,omitempty" yaml:"channel_id"` // the relayer address - RelayerAddress string `protobuf:"bytes,3,opt,name=relayer_address,json=relayerAddress,proto3" json:"relayer_address,omitempty"` - // the counterparty relayer address + Relayer string `protobuf:"bytes,3,opt,name=relayer,proto3" json:"relayer,omitempty"` + // the counterparty payee address CounterpartyPayee string `protobuf:"bytes,4,opt,name=counterparty_payee,json=counterpartyPayee,proto3" json:"counterparty_payee,omitempty" yaml:"counterparty_payee"` } @@ -372,53 +372,51 @@ func init() { func init() { proto.RegisterFile("ibc/applications/fee/v1/tx.proto", fileDescriptor_05c93128649f1b96) } var fileDescriptor_05c93128649f1b96 = []byte{ - // 721 bytes of a gzipped FileDescriptorProto - 0x1f, 0x8b, 0x08, 0x00, 0x00, 0x00, 0x00, 0x00, 0x02, 0xff, 0xbc, 0x55, 0xcf, 0x6e, 0xd3, 0x4e, - 0x10, 0x8e, 0x93, 0xb6, 0xbf, 0x66, 0xdb, 0x5f, 0xdb, 0xac, 0xfa, 0xc7, 0xb1, 0x5a, 0xbb, 0x58, - 0x08, 0x8a, 0x50, 0x6d, 0x92, 0xb6, 0x07, 0x2a, 0x21, 0xd4, 0x54, 0xaa, 0xa8, 0x44, 0x45, 0x64, - 0x71, 0x42, 0x48, 0x91, 0x63, 0x6f, 0x5c, 0x43, 0xe2, 0xb5, 0xbc, 0x4e, 0x84, 0xaf, 0x9c, 0x38, - 0x96, 0x37, 0xe8, 0xe3, 0xf4, 0xd8, 0x03, 0x07, 0xc4, 0xc1, 0x42, 0xed, 0x85, 0x1b, 0x92, 0x9f, - 0x00, 0xad, 0xbd, 0x36, 0x4e, 0xa2, 0x54, 0x81, 0x03, 0xb7, 0xdd, 0x99, 0x6f, 0xbe, 0x99, 0xf9, - 0x3c, 0xe3, 0x05, 0xdb, 0x76, 0xdb, 0x50, 0x75, 0xd7, 0xed, 0xda, 0x86, 0xee, 0xdb, 0xd8, 0x21, - 0x6a, 0x07, 0x21, 0x75, 0x50, 0x53, 0xfd, 0x0f, 0x8a, 0xeb, 0x61, 0x1f, 0xc3, 0x0d, 0xbb, 0x6d, - 0x28, 0x79, 0x84, 0xd2, 0x41, 0x48, 0x19, 0xd4, 0x84, 0x55, 0x0b, 0x5b, 0x38, 0xc6, 0xa8, 0xf4, - 0x94, 0xc0, 0x85, 0x7b, 0x93, 0x08, 0x69, 0x54, 0x0e, 0x62, 0x60, 0x0f, 0xa9, 0xc6, 0xb9, 0xee, - 0x38, 0xa8, 0x4b, 0xdd, 0xec, 0x98, 0x40, 0xe4, 0x6f, 0x1c, 0x58, 0x39, 0x23, 0x96, 0x86, 0x2c, - 0x9b, 0xf8, 0xc8, 0x6b, 0xea, 0x01, 0x42, 0xf0, 0x31, 0xf8, 0xcf, 0xc5, 0x9e, 0xdf, 0xb2, 0x4d, - 0x9e, 0xdb, 0xe6, 0x76, 0xca, 0x0d, 0x18, 0x85, 0xd2, 0x52, 0xa0, 0xf7, 0xba, 0x87, 0x32, 0x73, - 0xc8, 0xda, 0x1c, 0x3d, 0x9d, 0x9a, 0x70, 0x1f, 0x00, 0x46, 0x49, 0xf1, 0xc5, 0x18, 0xbf, 0x16, - 0x85, 0x52, 0x25, 0xc1, 0xff, 0xf6, 0xc9, 0x5a, 0x99, 0x5d, 0x4e, 0x4d, 0x78, 0x0c, 0x96, 0x3d, - 0xd4, 0xd5, 0x03, 0xe4, 0xb5, 0x74, 0xd3, 0xf4, 0x10, 0x21, 0x7c, 0x29, 0x0e, 0x15, 0xa2, 0x50, - 0x5a, 0x4f, 0x42, 0x47, 0x00, 0xb2, 0xb6, 0xc4, 0x2c, 0x47, 0x89, 0x01, 0xae, 0x82, 0x59, 0x97, - 0x16, 0xcc, 0xcf, 0xd0, 0x50, 0x2d, 0xb9, 0x1c, 0xce, 0x7f, 0xba, 0x94, 0x0a, 0x3f, 0x2e, 0xa5, - 0x82, 0x2c, 0x00, 0x7e, 0xb4, 0x37, 0x0d, 0x11, 0x17, 0x3b, 0x04, 0xc9, 0x1f, 0x8b, 0x60, 0x33, - 0xe7, 0x3c, 0xc6, 0x7d, 0xc7, 0x47, 0x9e, 0xab, 0x7b, 0x7e, 0xf0, 0xcf, 0x44, 0x78, 0x38, 0x41, - 0x84, 0xb1, 0x46, 0x5f, 0x02, 0x68, 0xe4, 0x0a, 0x6c, 0xe5, 0xba, 0x6e, 0x6c, 0x45, 0xa1, 0x54, - 0x65, 0x69, 0xc6, 0x30, 0xb2, 0x56, 0x31, 0x46, 0x3b, 0xcb, 0x09, 0xf4, 0x00, 0xdc, 0xbf, 0x4b, - 0x83, 0x4c, 0xac, 0x8b, 0x22, 0x58, 0x3e, 0x23, 0x56, 0x53, 0x0f, 0x9a, 0xba, 0xf1, 0x1e, 0xf9, - 0x27, 0x08, 0xc1, 0x7d, 0x50, 0xea, 0x20, 0x14, 0x6b, 0xb3, 0x50, 0xdf, 0x54, 0x26, 0x0c, 0xaf, - 0x72, 0x82, 0x50, 0x63, 0xe6, 0x2a, 0x94, 0x0a, 0x1a, 0x85, 0xc3, 0xe7, 0x60, 0x89, 0xe0, 0xbe, - 0x67, 0xa0, 0x56, 0x2a, 0x6e, 0x22, 0x56, 0x35, 0x0a, 0xa5, 0xb5, 0xa4, 0x8b, 0x61, 0xbf, 0xac, - 0x2d, 0x26, 0x86, 0x66, 0xa2, 0xf4, 0x0b, 0x50, 0x61, 0x80, 0x9c, 0xe0, 0xc9, 0xe8, 0x6c, 0x46, - 0xa1, 0xc4, 0x0f, 0x71, 0xe4, 0x75, 0x5f, 0x4e, 0x6c, 0xc7, 0x99, 0xfa, 0xeb, 0x60, 0x8e, 0xd8, - 0x96, 0x83, 0x3c, 0x36, 0x3e, 0xec, 0x06, 0x05, 0x30, 0xcf, 0xe4, 0x27, 0xfc, 0xec, 0x76, 0x69, - 0xa7, 0xac, 0x65, 0xf7, 0x9c, 0x74, 0x55, 0xb0, 0x31, 0xa2, 0x48, 0xa6, 0xd6, 0x17, 0x0e, 0xac, - 0x8e, 0xf8, 0x8e, 0x48, 0xe0, 0x18, 0xf0, 0x35, 0x28, 0xbb, 0xb1, 0x25, 0x1d, 0xaa, 0x85, 0xfa, - 0x56, 0x2c, 0x1c, 0xdd, 0x51, 0x25, 0x5d, 0xcc, 0x41, 0x4d, 0x49, 0xe2, 0x4e, 0xcd, 0x06, 0x4f, - 0x95, 0x8b, 0x42, 0x69, 0x85, 0xcd, 0x5d, 0x1a, 0x2d, 0x6b, 0xf3, 0x2e, 0xc3, 0xc0, 0xb7, 0x00, - 0x30, 0x3b, 0xfd, 0x1e, 0xc5, 0x98, 0x56, 0x9e, 0xf8, 0x3d, 0xb2, 0x92, 0x1a, 0x55, 0xc6, 0x5d, - 0x19, 0xe2, 0xee, 0xd0, 0xa1, 0x61, 0x65, 0x9e, 0x0c, 0x0d, 0x8b, 0x18, 0x2f, 0xcc, 0x58, 0x57, - 0x69, 0xdb, 0xf5, 0x9f, 0x25, 0x50, 0x3a, 0x23, 0x16, 0xec, 0x81, 0xff, 0x87, 0x7f, 0x27, 0x8f, - 0x26, 0x16, 0x33, 0xba, 0x9d, 0x42, 0x6d, 0x6a, 0x68, 0x9a, 0x16, 0x7e, 0xe6, 0x40, 0x75, 0xf2, - 0x16, 0x1f, 0x4c, 0x43, 0x38, 0x16, 0x26, 0x3c, 0xfb, 0xab, 0xb0, 0xac, 0xa6, 0x77, 0x60, 0x71, - 0x68, 0x57, 0x76, 0xee, 0xa2, 0xcb, 0x23, 0x85, 0x27, 0xd3, 0x22, 0xb3, 0x5c, 0x01, 0xa8, 0x8c, - 0x4f, 0xda, 0xee, 0xb4, 0x34, 0x31, 0x5c, 0x38, 0xf8, 0x23, 0x78, 0x9a, 0xba, 0xf1, 0xea, 0xea, - 0x46, 0xe4, 0xae, 0x6f, 0x44, 0xee, 0xfb, 0x8d, 0xc8, 0x5d, 0xdc, 0x8a, 0x85, 0xeb, 0x5b, 0xb1, - 0xf0, 0xf5, 0x56, 0x2c, 0xbc, 0x39, 0xb0, 0x6c, 0xff, 0xbc, 0xdf, 0x56, 0x0c, 0xdc, 0x53, 0x0d, - 0x4c, 0x7a, 0x98, 0xa8, 0x76, 0xdb, 0xd8, 0xb5, 0xb0, 0x3a, 0xd8, 0x53, 0x7b, 0xd8, 0xec, 0x77, - 0x11, 0xa1, 0x8f, 0x17, 0x51, 0xeb, 0x4f, 0x77, 0xe9, 0xbb, 0xe5, 0x07, 0x2e, 0x22, 0xed, 0xb9, - 0xf8, 0x51, 0xda, 0xfb, 0x15, 0x00, 0x00, 0xff, 0xff, 0x06, 0xc3, 0x6e, 0xb1, 0x2d, 0x07, 0x00, - 0x00, + // 699 bytes of a gzipped FileDescriptorProto + 0x1f, 0x8b, 0x08, 0x00, 0x00, 0x00, 0x00, 0x00, 0x02, 0xff, 0xcc, 0x55, 0x4f, 0x4f, 0xdb, 0x4a, + 0x10, 0x8f, 0x09, 0xff, 0x32, 0xf0, 0x80, 0xac, 0xe0, 0xe1, 0x58, 0x10, 0xf3, 0xac, 0xa7, 0x27, + 0x9e, 0x2a, 0xec, 0x26, 0xc0, 0xa1, 0x48, 0x55, 0x55, 0x23, 0xa1, 0x22, 0x15, 0x35, 0xb2, 0x7a, + 0xaa, 0x2a, 0x21, 0xc7, 0xd9, 0x18, 0xb7, 0x89, 0xd7, 0xf2, 0x3a, 0x51, 0xfd, 0x0d, 0x7a, 0xa4, + 0xdf, 0x80, 0x6f, 0xd0, 0xaf, 0xc1, 0x91, 0x43, 0x0f, 0x3d, 0x59, 0x15, 0x5c, 0x7a, 0xab, 0x94, + 0x7e, 0x81, 0x6a, 0xed, 0xb5, 0xeb, 0x24, 0x0a, 0x4a, 0x7b, 0xea, 0x6d, 0x67, 0xe6, 0x37, 0xbf, + 0x9d, 0xf9, 0x79, 0xc6, 0x0b, 0x3b, 0x4e, 0xd3, 0xd2, 0x4c, 0xcf, 0xeb, 0x38, 0x96, 0x19, 0x38, + 0xc4, 0xa5, 0x5a, 0x1b, 0x63, 0xad, 0x5f, 0xd3, 0x82, 0x77, 0xaa, 0xe7, 0x93, 0x80, 0xa0, 0x4d, + 0xa7, 0x69, 0xa9, 0x79, 0x84, 0xda, 0xc6, 0x58, 0xed, 0xd7, 0xa4, 0x75, 0x9b, 0xd8, 0x24, 0xc6, + 0x68, 0xec, 0x94, 0xc0, 0xa5, 0x7f, 0x26, 0x11, 0xb2, 0xac, 0x1c, 0xc4, 0x22, 0x3e, 0xd6, 0xac, + 0x0b, 0xd3, 0x75, 0x71, 0x87, 0x85, 0xf9, 0x31, 0x81, 0x28, 0x1f, 0x05, 0x58, 0x3b, 0xa3, 0xb6, + 0x81, 0x6d, 0x87, 0x06, 0xd8, 0x6f, 0x98, 0x21, 0xc6, 0xe8, 0x01, 0x2c, 0x78, 0xc4, 0x0f, 0xce, + 0x9d, 0x96, 0x28, 0xec, 0x08, 0xbb, 0x25, 0x1d, 0x0d, 0x22, 0x79, 0x25, 0x34, 0xbb, 0x9d, 0x23, + 0x85, 0x07, 0x14, 0x63, 0x9e, 0x9d, 0x4e, 0x5b, 0xe8, 0x00, 0x80, 0x53, 0x32, 0xfc, 0x4c, 0x8c, + 0xdf, 0x18, 0x44, 0x72, 0x39, 0xc1, 0xff, 0x8c, 0x29, 0x46, 0x89, 0x1b, 0xa7, 0x2d, 0x24, 0xc2, + 0x82, 0x8f, 0x3b, 0x66, 0x88, 0x7d, 0xb1, 0xc8, 0x52, 0x8c, 0xd4, 0x44, 0xeb, 0x30, 0xe7, 0xb1, + 0x2a, 0xc4, 0xd9, 0xd8, 0x9f, 0x18, 0x47, 0x8b, 0xef, 0xaf, 0xe4, 0xc2, 0xd7, 0x2b, 0xb9, 0xa0, + 0x48, 0x20, 0x8e, 0x16, 0x6c, 0x60, 0xea, 0x11, 0x97, 0x62, 0xe5, 0xbb, 0x00, 0x5b, 0xb9, 0xe0, + 0x31, 0xe9, 0xb9, 0x01, 0xf6, 0x3d, 0xd3, 0x0f, 0xc2, 0x3f, 0xa0, 0xb3, 0xe7, 0x80, 0xac, 0x5c, + 0x45, 0xe7, 0xb9, 0x36, 0xf5, 0xed, 0x41, 0x24, 0x57, 0x38, 0xef, 0x18, 0x46, 0x31, 0xca, 0xd6, + 0x68, 0x2b, 0x39, 0x45, 0xfe, 0x83, 0x7f, 0xef, 0x6b, 0x3a, 0x53, 0xe7, 0x72, 0x06, 0x56, 0xcf, + 0xa8, 0xdd, 0x30, 0xc3, 0x86, 0x69, 0xbd, 0xc5, 0xc1, 0x09, 0xc6, 0xe8, 0x00, 0x8a, 0x6d, 0x8c, + 0x63, 0x31, 0x96, 0xea, 0x5b, 0xea, 0x84, 0x11, 0x54, 0x4f, 0x30, 0xd6, 0x67, 0xaf, 0x23, 0xb9, + 0x60, 0x30, 0x38, 0x7a, 0x02, 0x2b, 0x94, 0xf4, 0x7c, 0x0b, 0x9f, 0xa7, 0x6a, 0x26, 0xea, 0x54, + 0x06, 0x91, 0xbc, 0x91, 0x74, 0x31, 0x1c, 0x57, 0x8c, 0xe5, 0xc4, 0xd1, 0x48, 0xa4, 0x7d, 0x06, + 0x65, 0x0e, 0xc8, 0x29, 0x1c, 0xcb, 0xa5, 0x6f, 0x0d, 0x22, 0x59, 0x1c, 0xe2, 0xc8, 0x0b, 0xbd, + 0x9a, 0xf8, 0x8e, 0x33, 0xb9, 0xff, 0x86, 0x79, 0xea, 0xd8, 0x2e, 0xf6, 0xf9, 0xbc, 0x70, 0x0b, + 0x49, 0xb0, 0xc8, 0x75, 0xa7, 0xe2, 0xdc, 0x4e, 0x71, 0xb7, 0x64, 0x64, 0x76, 0x4e, 0xba, 0x0a, + 0x6c, 0x8e, 0x28, 0x92, 0xa9, 0xf5, 0x49, 0x80, 0xf5, 0x91, 0xd8, 0x53, 0x1a, 0xba, 0x16, 0x7a, + 0x09, 0x25, 0x2f, 0xf6, 0xa4, 0x53, 0xb4, 0x54, 0xdf, 0x8e, 0x85, 0x63, 0x9b, 0xa6, 0xa6, 0xeb, + 0xd5, 0xaf, 0xa9, 0x49, 0xde, 0x69, 0x4b, 0x17, 0x99, 0x72, 0x83, 0x48, 0x5e, 0xe3, 0x83, 0x96, + 0x66, 0x2b, 0xc6, 0xa2, 0xc7, 0x31, 0xe8, 0x35, 0x00, 0xf7, 0xb3, 0xef, 0x31, 0x13, 0xd3, 0x2a, + 0x13, 0xbf, 0x47, 0x56, 0x92, 0x5e, 0xe1, 0xdc, 0xe5, 0x21, 0xee, 0x36, 0x1b, 0x1a, 0x5e, 0xe6, + 0xc9, 0xd0, 0xb0, 0x54, 0xe3, 0x0d, 0x19, 0xeb, 0x2a, 0x6d, 0xbb, 0xfe, 0xad, 0x08, 0xc5, 0x33, + 0x6a, 0xa3, 0x2e, 0xfc, 0x35, 0xfc, 0x53, 0xf8, 0x7f, 0x62, 0x31, 0xa3, 0xeb, 0x28, 0xd5, 0xa6, + 0x86, 0xa6, 0xd7, 0xa2, 0x0f, 0x02, 0x54, 0x26, 0xaf, 0xed, 0xe1, 0x34, 0x84, 0x63, 0x69, 0xd2, + 0xe3, 0xdf, 0x4a, 0xcb, 0x6a, 0x7a, 0x03, 0xcb, 0x43, 0xbb, 0xb2, 0x7b, 0x1f, 0x5d, 0x1e, 0x29, + 0x3d, 0x9c, 0x16, 0x99, 0xdd, 0x15, 0x42, 0x79, 0x7c, 0xd2, 0xf6, 0xa6, 0xa5, 0x89, 0xe1, 0xd2, + 0xe1, 0x2f, 0xc1, 0xd3, 0xab, 0xf5, 0x17, 0xd7, 0xb7, 0x55, 0xe1, 0xe6, 0xb6, 0x2a, 0x7c, 0xb9, + 0xad, 0x0a, 0x97, 0x77, 0xd5, 0xc2, 0xcd, 0x5d, 0xb5, 0xf0, 0xf9, 0xae, 0x5a, 0x78, 0x75, 0x68, + 0x3b, 0xc1, 0x45, 0xaf, 0xa9, 0x5a, 0xa4, 0xab, 0x59, 0x84, 0x76, 0x09, 0xd5, 0x9c, 0xa6, 0xb5, + 0x67, 0x13, 0xad, 0xbf, 0xaf, 0x75, 0x49, 0xab, 0xd7, 0xc1, 0x94, 0x3d, 0x41, 0x54, 0xab, 0x3f, + 0xda, 0x63, 0xaf, 0x4f, 0x10, 0x7a, 0x98, 0x36, 0xe7, 0xe3, 0xa7, 0x65, 0xff, 0x47, 0x00, 0x00, + 0x00, 0xff, 0xff, 0x59, 0xf9, 0x73, 0xbc, 0xf3, 0x06, 0x00, 0x00, } // Reference imports to suppress errors if they are not otherwise used. @@ -440,10 +438,10 @@ type MsgClient interface { // relayer, in which case, the latest payee is always used. RegisterPayee(ctx context.Context, in *MsgRegisterPayee, opts ...grpc.CallOption) (*MsgRegisterPayeeResponse, error) // RegisterCounterpartyPayee defines a rpc handler method for MsgRegisterCounterpartyPayee - // RegisterCounterpartyPayee is called by the relayer on each channelEnd and allows them to specify their - // counterparty address before relaying. This ensures they will be properly compensated for forward relaying since - // destination chain must send back relayer's source address (counterparty address) in acknowledgement. This function - // may be called more than once by a relayer, in which case, the latest counterparty address is always used. + // RegisterCounterpartyPayee is called by the relayer on each channelEnd and allows them to specify the counterparty + // payee address before relaying. This ensures they will be properly compensated for forward relaying since + // the destination chain must include the registered counterparty payee address in the acknowledgement. This function + // may be called more than once by a relayer, in which case, the latest counterparty payee address is always used. RegisterCounterpartyPayee(ctx context.Context, in *MsgRegisterCounterpartyPayee, opts ...grpc.CallOption) (*MsgRegisterCounterpartyPayeeResponse, error) // PayPacketFee defines a rpc handler method for MsgPayPacketFee // PayPacketFee is an open callback that may be called by any module/user that wishes to escrow funds in order to @@ -510,10 +508,10 @@ type MsgServer interface { // relayer, in which case, the latest payee is always used. RegisterPayee(context.Context, *MsgRegisterPayee) (*MsgRegisterPayeeResponse, error) // RegisterCounterpartyPayee defines a rpc handler method for MsgRegisterCounterpartyPayee - // RegisterCounterpartyPayee is called by the relayer on each channelEnd and allows them to specify their - // counterparty address before relaying. This ensures they will be properly compensated for forward relaying since - // destination chain must send back relayer's source address (counterparty address) in acknowledgement. This function - // may be called more than once by a relayer, in which case, the latest counterparty address is always used. + // RegisterCounterpartyPayee is called by the relayer on each channelEnd and allows them to specify the counterparty + // payee address before relaying. This ensures they will be properly compensated for forward relaying since + // the destination chain must include the registered counterparty payee address in the acknowledgement. This function + // may be called more than once by a relayer, in which case, the latest counterparty payee address is always used. RegisterCounterpartyPayee(context.Context, *MsgRegisterCounterpartyPayee) (*MsgRegisterCounterpartyPayeeResponse, error) // PayPacketFee defines a rpc handler method for MsgPayPacketFee // PayPacketFee is an open callback that may be called by any module/user that wishes to escrow funds in order to @@ -672,10 +670,10 @@ func (m *MsgRegisterPayee) MarshalToSizedBuffer(dAtA []byte) (int, error) { i-- dAtA[i] = 0x22 } - if len(m.RelayerAddress) > 0 { - i -= len(m.RelayerAddress) - copy(dAtA[i:], m.RelayerAddress) - i = encodeVarintTx(dAtA, i, uint64(len(m.RelayerAddress))) + if len(m.Relayer) > 0 { + i -= len(m.Relayer) + copy(dAtA[i:], m.Relayer) + i = encodeVarintTx(dAtA, i, uint64(len(m.Relayer))) i-- dAtA[i] = 0x1a } @@ -746,10 +744,10 @@ func (m *MsgRegisterCounterpartyPayee) MarshalToSizedBuffer(dAtA []byte) (int, e i-- dAtA[i] = 0x22 } - if len(m.RelayerAddress) > 0 { - i -= len(m.RelayerAddress) - copy(dAtA[i:], m.RelayerAddress) - i = encodeVarintTx(dAtA, i, uint64(len(m.RelayerAddress))) + if len(m.Relayer) > 0 { + i -= len(m.Relayer) + copy(dAtA[i:], m.Relayer) + i = encodeVarintTx(dAtA, i, uint64(len(m.Relayer))) i-- dAtA[i] = 0x1a } @@ -970,7 +968,7 @@ func (m *MsgRegisterPayee) Size() (n int) { if l > 0 { n += 1 + l + sovTx(uint64(l)) } - l = len(m.RelayerAddress) + l = len(m.Relayer) if l > 0 { n += 1 + l + sovTx(uint64(l)) } @@ -1004,7 +1002,7 @@ func (m *MsgRegisterCounterpartyPayee) Size() (n int) { if l > 0 { n += 1 + l + sovTx(uint64(l)) } - l = len(m.RelayerAddress) + l = len(m.Relayer) if l > 0 { n += 1 + l + sovTx(uint64(l)) } @@ -1185,7 +1183,7 @@ func (m *MsgRegisterPayee) Unmarshal(dAtA []byte) error { iNdEx = postIndex case 3: if wireType != 2 { - return fmt.Errorf("proto: wrong wireType = %d for field RelayerAddress", wireType) + return fmt.Errorf("proto: wrong wireType = %d for field Relayer", wireType) } var stringLen uint64 for shift := uint(0); ; shift += 7 { @@ -1213,7 +1211,7 @@ func (m *MsgRegisterPayee) Unmarshal(dAtA []byte) error { if postIndex > l { return io.ErrUnexpectedEOF } - m.RelayerAddress = string(dAtA[iNdEx:postIndex]) + m.Relayer = string(dAtA[iNdEx:postIndex]) iNdEx = postIndex case 4: if wireType != 2 { @@ -1413,7 +1411,7 @@ func (m *MsgRegisterCounterpartyPayee) Unmarshal(dAtA []byte) error { iNdEx = postIndex case 3: if wireType != 2 { - return fmt.Errorf("proto: wrong wireType = %d for field RelayerAddress", wireType) + return fmt.Errorf("proto: wrong wireType = %d for field Relayer", wireType) } var stringLen uint64 for shift := uint(0); ; shift += 7 { @@ -1441,7 +1439,7 @@ func (m *MsgRegisterCounterpartyPayee) Unmarshal(dAtA []byte) error { if postIndex > l { return io.ErrUnexpectedEOF } - m.RelayerAddress = string(dAtA[iNdEx:postIndex]) + m.Relayer = string(dAtA[iNdEx:postIndex]) iNdEx = postIndex case 4: if wireType != 2 { diff --git a/proto/ibc/applications/fee/v1/tx.proto b/proto/ibc/applications/fee/v1/tx.proto index f4992d0edb9..d8745f6d208 100644 --- a/proto/ibc/applications/fee/v1/tx.proto +++ b/proto/ibc/applications/fee/v1/tx.proto @@ -18,10 +18,10 @@ service Msg { rpc RegisterPayee(MsgRegisterPayee) returns (MsgRegisterPayeeResponse); // RegisterCounterpartyPayee defines a rpc handler method for MsgRegisterCounterpartyPayee - // RegisterCounterpartyPayee is called by the relayer on each channelEnd and allows them to specify their - // counterparty address before relaying. This ensures they will be properly compensated for forward relaying since - // destination chain must send back relayer's source address (counterparty address) in acknowledgement. This function - // may be called more than once by a relayer, in which case, the latest counterparty address is always used. + // RegisterCounterpartyPayee is called by the relayer on each channelEnd and allows them to specify the counterparty + // payee address before relaying. This ensures they will be properly compensated for forward relaying since + // the destination chain must include the registered counterparty payee address in the acknowledgement. This function + // may be called more than once by a relayer, in which case, the latest counterparty payee address is always used. rpc RegisterCounterpartyPayee(MsgRegisterCounterpartyPayee) returns (MsgRegisterCounterpartyPayeeResponse); // PayPacketFee defines a rpc handler method for MsgPayPacketFee @@ -47,8 +47,8 @@ message MsgRegisterPayee { // unique channel identifier string channel_id = 2 [(gogoproto.moretags) = "yaml:\"channel_id\""]; // the relayer address - string relayer_address = 3 [(gogoproto.moretags) = "yaml:\"relayer_address\""]; - // the fee payee address + string relayer = 3; + // the payee address string payee = 4; } @@ -65,8 +65,8 @@ message MsgRegisterCounterpartyPayee { // unique channel identifier string channel_id = 2 [(gogoproto.moretags) = "yaml:\"channel_id\""]; // the relayer address - string relayer_address = 3; - // the counterparty relayer address + string relayer = 3; + // the counterparty payee address string counterparty_payee = 4 [(gogoproto.moretags) = "yaml:\"counterparty_payee\""]; } From 473b1132120e96f9a2b0f452272ab3f3a8df6dc7 Mon Sep 17 00:00:00 2001 From: Damian Nolan Date: Thu, 9 Jun 2022 18:13:44 +0200 Subject: [PATCH 6/9] updating cli args naming convention to align --- modules/apps/29-fee/client/cli/tx.go | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/modules/apps/29-fee/client/cli/tx.go b/modules/apps/29-fee/client/cli/tx.go index 467427b277b..ef038ac7fd5 100644 --- a/modules/apps/29-fee/client/cli/tx.go +++ b/modules/apps/29-fee/client/cli/tx.go @@ -25,7 +25,7 @@ const ( // NewRegisterPayeeCmd returns the command to create a MsgRegisterPayee func NewRegisterPayeeCmd() *cobra.Command { cmd := &cobra.Command{ - Use: "register-payee [port-id] [channel-id] [relayer-address] [payee-address] ", + Use: "register-payee [port-id] [channel-id] [relayer] [payee] ", Short: "Register a payee on a given channel.", Long: strings.TrimSpace(`Register a payee address on a given channel.`), Example: fmt.Sprintf("%s tx ibc-fee register-payee transfer channel-0 cosmos1rsp837a4kvtgp2m4uqzdge0zzu6efqgucm0qdh cosmos153lf4zntqt33a4v0sm5cytrxyqn78q7kz8j8x5", version.AppName), @@ -50,10 +50,10 @@ func NewRegisterPayeeCmd() *cobra.Command { // NewRegisterCounterpartyPayeeCmd returns the command to create a MsgRegisterCounterpartyPayee func NewRegisterCounterpartyPayeeCmd() *cobra.Command { cmd := &cobra.Command{ - Use: "register-counterparty-payee [port-id] [channel-id] [relayer-address] [payee-address] ", + Use: "register-counterparty-payee [port-id] [channel-id] [relayer] [counterparty-payee] ", Short: "Register a counterparty payee address on a given channel.", Long: strings.TrimSpace(`Register a counterparty payee address on a given channel.`), - Example: fmt.Sprintf("%s tx ibc-fee register-counterparty transfer channel-0 cosmos1rsp837a4kvtgp2m4uqzdge0zzu6efqgucm0qdh osmo1v5y0tz01llxzf4c2afml8s3awue0ymju22wxx2", version.AppName), + Example: fmt.Sprintf("%s tx ibc-fee register-counterparty-payee transfer channel-0 cosmos1rsp837a4kvtgp2m4uqzdge0zzu6efqgucm0qdh osmo1v5y0tz01llxzf4c2afml8s3awue0ymju22wxx2", version.AppName), Args: cobra.ExactArgs(4), RunE: func(cmd *cobra.Command, args []string) error { clientCtx, err := client.GetClientTxContext(cmd) From 49ce2f67bbcf4b0604ac9a1c784470cb166a3e24 Mon Sep 17 00:00:00 2001 From: Damian Nolan Date: Mon, 13 Jun 2022 09:01:53 +0200 Subject: [PATCH 7/9] updating keys to reflect naming changes --- modules/apps/29-fee/keeper/keeper.go | 14 +++++++------- modules/apps/29-fee/types/keys.go | 24 ++++++++++++------------ modules/apps/29-fee/types/keys_test.go | 22 +++++++++++----------- 3 files changed, 30 insertions(+), 30 deletions(-) diff --git a/modules/apps/29-fee/keeper/keeper.go b/modules/apps/29-fee/keeper/keeper.go index 4465aebbc81..c8ccc9a0e6c 100644 --- a/modules/apps/29-fee/keeper/keeper.go +++ b/modules/apps/29-fee/keeper/keeper.go @@ -150,7 +150,7 @@ func (k Keeper) GetAllFeeEnabledChannels(ctx sdk.Context) []types.FeeEnabledChan // GetPayeeAddress retrieves the fee payee address stored in state given the provided channel identifier and relayer address func (k Keeper) GetPayeeAddress(ctx sdk.Context, relayerAddr, channelID string) (string, bool) { store := ctx.KVStore(k.storeKey) - key := types.KeyPayeeAddress(relayerAddr, channelID) + key := types.KeyPayee(relayerAddr, channelID) if !store.Has(key) { return "", false @@ -162,13 +162,13 @@ func (k Keeper) GetPayeeAddress(ctx sdk.Context, relayerAddr, channelID string) // SetPayeeAddress stores the fee payee address in state keyed by the provided channel identifier and relayer address func (k Keeper) SetPayeeAddress(ctx sdk.Context, relayerAddr, payeeAddr, channelID string) { store := ctx.KVStore(k.storeKey) - store.Set(types.KeyPayeeAddress(relayerAddr, channelID), []byte(payeeAddr)) + store.Set(types.KeyPayee(relayerAddr, channelID), []byte(payeeAddr)) } // GetAllPayeeAddresses returns all registered payees func (k Keeper) GetAllPayeeAddresses(ctx sdk.Context) []types.RegisteredPayee { store := ctx.KVStore(k.storeKey) - iterator := sdk.KVStorePrefixIterator(store, []byte(types.PayeeAddressKeyPrefix)) + iterator := sdk.KVStorePrefixIterator(store, []byte(types.PayeeKeyPrefix)) defer iterator.Close() var registeredPayees []types.RegisteredPayee @@ -194,13 +194,13 @@ func (k Keeper) GetAllPayeeAddresses(ctx sdk.Context) []types.RegisteredPayee { // The receiving chain must store the mapping from: address -> counterpartyPayeeAddress for the given channel func (k Keeper) SetCounterpartyPayeeAddress(ctx sdk.Context, address, counterpartyAddress, channelID string) { store := ctx.KVStore(k.storeKey) - store.Set(types.KeyCounterpartyRelayer(address, channelID), []byte(counterpartyAddress)) + store.Set(types.KeyCounterpartyPayee(address, channelID), []byte(counterpartyAddress)) } // GetCounterpartyPayeeAddress gets the counterparty payee address given a destination relayer address func (k Keeper) GetCounterpartyPayeeAddress(ctx sdk.Context, address, channelID string) (string, bool) { store := ctx.KVStore(k.storeKey) - key := types.KeyCounterpartyRelayer(address, channelID) + key := types.KeyCounterpartyPayee(address, channelID) if !store.Has(key) { return "", false @@ -213,12 +213,12 @@ func (k Keeper) GetCounterpartyPayeeAddress(ctx sdk.Context, address, channelID // GetAllRelayerAddresses returns all registered relayer addresses func (k Keeper) GetAllRelayerAddresses(ctx sdk.Context) []types.RegisteredRelayerAddress { store := ctx.KVStore(k.storeKey) - iterator := sdk.KVStorePrefixIterator(store, []byte(types.CounterpartyRelayerAddressKeyPrefix)) + iterator := sdk.KVStorePrefixIterator(store, []byte(types.CounterpartyPayeeKeyPrefix)) defer iterator.Close() var registeredAddrArr []types.RegisteredRelayerAddress for ; iterator.Valid(); iterator.Next() { - address, channelID, err := types.ParseKeyCounterpartyRelayer(string(iterator.Key())) + address, channelID, err := types.ParseKeyCounterpartyPayee(string(iterator.Key())) if err != nil { panic(err) } diff --git a/modules/apps/29-fee/types/keys.go b/modules/apps/29-fee/types/keys.go index 6cb6f53551c..7cbaffcd556 100644 --- a/modules/apps/29-fee/types/keys.go +++ b/modules/apps/29-fee/types/keys.go @@ -28,11 +28,11 @@ const ( // FeeEnabledPrefix is the key prefix for storing fee enabled flag FeeEnabledKeyPrefix = "feeEnabled" - // PayeeAddressKeyPrefix is the key prefix for the fee payee address stored in state - PayeeAddressKeyPrefix = "payeeAddress" + // PayeeKeyPrefix is the key prefix for the fee payee address stored in state + PayeeKeyPrefix = "payee" - // CounterpartyRelayerAddressKeyPrefix is the key prefix for relayer address mapping - CounterpartyRelayerAddressKeyPrefix = "relayerAddress" + // CounterpartyPayeeKeyPrefix is the key prefix for the counterparty payee address mapping + CounterpartyPayeeKeyPrefix = "counterpartyPayee" // FeesInEscrowPrefix is the key prefix for fee in escrow mapping FeesInEscrowPrefix = "feesInEscrow" @@ -73,9 +73,9 @@ func ParseKeyFeeEnabled(key string) (portID, channelID string, err error) { return portID, channelID, nil } -// KeyPayeeAddress returns the key for relayer address -> payee address mapping -func KeyPayeeAddress(relayerAddr, channelID string) []byte { - return []byte(fmt.Sprintf("%s/%s/%s", PayeeAddressKeyPrefix, relayerAddr, channelID)) +// KeyPayee returns the key for relayer address -> payee address mapping +func KeyPayee(relayerAddr, channelID string) []byte { + return []byte(fmt.Sprintf("%s/%s/%s", PayeeKeyPrefix, relayerAddr, channelID)) } // ParseKeyPayeeAddress returns the registered relayer addresss and channelID used to the store the fee payee address @@ -90,13 +90,13 @@ func ParseKeyPayeeAddress(key string) (relayerAddr, channelID string, err error) return keySplit[1], keySplit[2], nil } -// KeyCounterpartyRelayer returns the key for relayer address -> counterparty address mapping -func KeyCounterpartyRelayer(address, channelID string) []byte { - return []byte(fmt.Sprintf("%s/%s/%s", CounterpartyRelayerAddressKeyPrefix, address, channelID)) +// KeyCounterpartyPayee returns the key for relayer address -> counterparty payee address mapping +func KeyCounterpartyPayee(address, channelID string) []byte { + return []byte(fmt.Sprintf("%s/%s/%s", CounterpartyPayeeKeyPrefix, address, channelID)) } -// ParseKeyCounterpartyRelayer returns the registered relayer address and channelID used to store the counterpartyrelayer address -func ParseKeyCounterpartyRelayer(key string) (address string, channelID string, error error) { +// ParseKeyCounterpartyPayee returns the registered relayer address and channelID used to store the counterparty payee address +func ParseKeyCounterpartyPayee(key string) (address string, channelID string, error error) { keySplit := strings.Split(key, "/") if len(keySplit) != 3 { return "", "", sdkerrors.Wrapf( diff --git a/modules/apps/29-fee/types/keys_test.go b/modules/apps/29-fee/types/keys_test.go index 442c4a47634..94f2c4602b2 100644 --- a/modules/apps/29-fee/types/keys_test.go +++ b/modules/apps/29-fee/types/keys_test.go @@ -13,12 +13,12 @@ import ( var validPacketID = channeltypes.NewPacketId(ibctesting.MockFeePort, ibctesting.FirstChannelID, 1) -func TestKeyPayeeAddress(t *testing.T) { - key := types.KeyPayeeAddress("relayer-address", ibctesting.FirstChannelID) - require.Equal(t, string(key), fmt.Sprintf("%s/%s/%s", types.PayeeAddressKeyPrefix, "relayer-address", ibctesting.FirstChannelID)) +func TestKeyPayee(t *testing.T) { + key := types.KeyPayee("relayer-address", ibctesting.FirstChannelID) + require.Equal(t, string(key), fmt.Sprintf("%s/%s/%s", types.PayeeKeyPrefix, "relayer-address", ibctesting.FirstChannelID)) } -func TestParseKeyPayeeAddress(t *testing.T) { +func TestParseKeyPayee(t *testing.T) { testCases := []struct { name string key string @@ -26,7 +26,7 @@ func TestParseKeyPayeeAddress(t *testing.T) { }{ { "success", - string(types.KeyPayeeAddress("relayer-address", ibctesting.FirstChannelID)), + string(types.KeyPayee("relayer-address", ibctesting.FirstChannelID)), true, }, { @@ -49,14 +49,14 @@ func TestParseKeyPayeeAddress(t *testing.T) { } } -func TestKeyCounterpartyRelayer(t *testing.T) { +func TestKeyCounterpartyPayee(t *testing.T) { var ( relayerAddress = "relayer_address" channelID = "channel-0" ) - key := types.KeyCounterpartyRelayer(relayerAddress, channelID) - require.Equal(t, string(key), fmt.Sprintf("%s/%s/%s", types.CounterpartyRelayerAddressKeyPrefix, relayerAddress, channelID)) + key := types.KeyCounterpartyPayee(relayerAddress, channelID) + require.Equal(t, string(key), fmt.Sprintf("%s/%s/%s", types.CounterpartyPayeeKeyPrefix, relayerAddress, channelID)) } func TestKeyFeesInEscrow(t *testing.T) { @@ -172,7 +172,7 @@ func TestParseKeyForwardRelayerAddress(t *testing.T) { } } -func TestParseKeyCounterpartyRelayer(t *testing.T) { +func TestParseKeyCounterpartyPayee(t *testing.T) { relayerAddress := "relayer_address" testCases := []struct { @@ -182,7 +182,7 @@ func TestParseKeyCounterpartyRelayer(t *testing.T) { }{ { "success", - string(types.KeyCounterpartyRelayer(relayerAddress, ibctesting.FirstChannelID)), + string(types.KeyCounterpartyPayee(relayerAddress, ibctesting.FirstChannelID)), true, }, { @@ -193,7 +193,7 @@ func TestParseKeyCounterpartyRelayer(t *testing.T) { } for _, tc := range testCases { - address, channelID, err := types.ParseKeyCounterpartyRelayer(tc.key) + address, channelID, err := types.ParseKeyCounterpartyPayee(tc.key) if tc.expPass { require.NoError(t, err) From d8511e42da8dcc063b90a9668ea22fcd61c03356 Mon Sep 17 00:00:00 2001 From: Damian Nolan Date: Mon, 13 Jun 2022 10:04:48 +0200 Subject: [PATCH 8/9] updating docs --- docs/ibc/proto-docs.md | 2 +- modules/apps/29-fee/types/tx.pb.go | 6 +- .../07-tendermint/types/tendermint.pb.go | 130 +++++++++--------- proto/ibc/applications/fee/v1/tx.proto | 3 +- 4 files changed, 72 insertions(+), 69 deletions(-) diff --git a/docs/ibc/proto-docs.md b/docs/ibc/proto-docs.md index 7cd6982fc68..2b43f8262a4 100644 --- a/docs/ibc/proto-docs.md +++ b/docs/ibc/proto-docs.md @@ -1412,7 +1412,7 @@ Msg defines the ICS29 Msg service. | Method Name | Request Type | Response Type | Description | HTTP Verb | Endpoint | | ----------- | ------------ | ------------- | ------------| ------- | -------- | | `RegisterPayee` | [MsgRegisterPayee](#ibc.applications.fee.v1.MsgRegisterPayee) | [MsgRegisterPayeeResponse](#ibc.applications.fee.v1.MsgRegisterPayeeResponse) | RegisterPayee defines a rpc handler method for MsgRegisterPayee RegisterPayee is called by the relayer on each channelEnd and allows them to set an optional payee to which escrowed packet fees will be paid out. The payee should be registered on the source chain from which packets originate as this is where fee distribution takes place. This function may be called more than once by a relayer, in which case, the latest payee is always used. | | -| `RegisterCounterpartyPayee` | [MsgRegisterCounterpartyPayee](#ibc.applications.fee.v1.MsgRegisterCounterpartyPayee) | [MsgRegisterCounterpartyPayeeResponse](#ibc.applications.fee.v1.MsgRegisterCounterpartyPayeeResponse) | RegisterCounterpartyPayee defines a rpc handler method for MsgRegisterCounterpartyPayee RegisterCounterpartyPayee is called by the relayer on each channelEnd and allows them to specify the counterparty payee address before relaying. This ensures they will be properly compensated for forward relaying since the destination chain must include the registered counterparty payee address in the acknowledgement. This function may be called more than once by a relayer, in which case, the latest counterparty payee address is always used. | | +| `RegisterCounterpartyPayee` | [MsgRegisterCounterpartyPayee](#ibc.applications.fee.v1.MsgRegisterCounterpartyPayee) | [MsgRegisterCounterpartyPayeeResponse](#ibc.applications.fee.v1.MsgRegisterCounterpartyPayeeResponse) | RegisterCounterpartyPayee defines a rpc handler method for MsgRegisterCounterpartyPayee RegisterCounterpartyPayee is called by the relayer on each channelEnd and allows them to specify the counterparty payee address before relaying. This ensures they will be properly compensated for forward relaying since the destination chain may include the registered counterparty payee address in the acknowledgement. This function may be called more than once by a relayer, in which case, the latest counterparty payee address is always used. A registered payee on the source chain will always override a registered counterparty payee. | | | `PayPacketFee` | [MsgPayPacketFee](#ibc.applications.fee.v1.MsgPayPacketFee) | [MsgPayPacketFeeResponse](#ibc.applications.fee.v1.MsgPayPacketFeeResponse) | PayPacketFee defines a rpc handler method for MsgPayPacketFee PayPacketFee is an open callback that may be called by any module/user that wishes to escrow funds in order to incentivize the relaying of the packet at the next sequence NOTE: This method is intended to be used within a multi msg transaction, where the subsequent msg that follows initiates the lifecycle of the incentivized packet | | | `PayPacketFeeAsync` | [MsgPayPacketFeeAsync](#ibc.applications.fee.v1.MsgPayPacketFeeAsync) | [MsgPayPacketFeeAsyncResponse](#ibc.applications.fee.v1.MsgPayPacketFeeAsyncResponse) | PayPacketFeeAsync defines a rpc handler method for MsgPayPacketFeeAsync PayPacketFeeAsync is an open callback that may be called by any module/user that wishes to escrow funds in order to incentivize the relaying of a known packet (i.e. at a particular sequence) | | diff --git a/modules/apps/29-fee/types/tx.pb.go b/modules/apps/29-fee/types/tx.pb.go index e70398ccb28..1dccf3a8aed 100644 --- a/modules/apps/29-fee/types/tx.pb.go +++ b/modules/apps/29-fee/types/tx.pb.go @@ -440,8 +440,9 @@ type MsgClient interface { // RegisterCounterpartyPayee defines a rpc handler method for MsgRegisterCounterpartyPayee // RegisterCounterpartyPayee is called by the relayer on each channelEnd and allows them to specify the counterparty // payee address before relaying. This ensures they will be properly compensated for forward relaying since - // the destination chain must include the registered counterparty payee address in the acknowledgement. This function + // the destination chain may include the registered counterparty payee address in the acknowledgement. This function // may be called more than once by a relayer, in which case, the latest counterparty payee address is always used. + // A registered payee on the source chain will always override a registered counterparty payee. RegisterCounterpartyPayee(ctx context.Context, in *MsgRegisterCounterpartyPayee, opts ...grpc.CallOption) (*MsgRegisterCounterpartyPayeeResponse, error) // PayPacketFee defines a rpc handler method for MsgPayPacketFee // PayPacketFee is an open callback that may be called by any module/user that wishes to escrow funds in order to @@ -510,8 +511,9 @@ type MsgServer interface { // RegisterCounterpartyPayee defines a rpc handler method for MsgRegisterCounterpartyPayee // RegisterCounterpartyPayee is called by the relayer on each channelEnd and allows them to specify the counterparty // payee address before relaying. This ensures they will be properly compensated for forward relaying since - // the destination chain must include the registered counterparty payee address in the acknowledgement. This function + // the destination chain may include the registered counterparty payee address in the acknowledgement. This function // may be called more than once by a relayer, in which case, the latest counterparty payee address is always used. + // A registered payee on the source chain will always override a registered counterparty payee. RegisterCounterpartyPayee(context.Context, *MsgRegisterCounterpartyPayee) (*MsgRegisterCounterpartyPayeeResponse, error) // PayPacketFee defines a rpc handler method for MsgPayPacketFee // PayPacketFee is an open callback that may be called by any module/user that wishes to escrow funds in order to diff --git a/modules/light-clients/07-tendermint/types/tendermint.pb.go b/modules/light-clients/07-tendermint/types/tendermint.pb.go index 4be50fa8739..bcb71558313 100644 --- a/modules/light-clients/07-tendermint/types/tendermint.pb.go +++ b/modules/light-clients/07-tendermint/types/tendermint.pb.go @@ -322,75 +322,75 @@ func init() { } var fileDescriptor_c6d6cf2b288949be = []byte{ - // 1078 bytes of a gzipped FileDescriptorProto + // 1080 bytes of a gzipped FileDescriptorProto 0x1f, 0x8b, 0x08, 0x00, 0x00, 0x00, 0x00, 0x00, 0x02, 0xff, 0x9c, 0x56, 0xcf, 0x6f, 0xe3, 0x44, 0x14, 0x6e, 0xda, 0xb2, 0x4d, 0x26, 0xe9, 0x76, 0x31, 0xa5, 0x9b, 0x96, 0x6e, 0x1c, 0x19, 0xa9, 0xe4, 0x40, 0x6d, 0x92, 0x22, 0x21, 0x55, 0x5c, 0x70, 0x77, 0x51, 0x8b, 0x58, 0xa9, 0x72, 0xf9, 0x21, 0x21, 0x21, 0x33, 0xb1, 0x27, 0xc9, 0x68, 0x6d, 0x8f, 0xe5, 0x99, 0x84, 0x96, 0xbf, 0x00, - 0x4e, 0xec, 0x11, 0x71, 0xe2, 0xc0, 0x1f, 0xb3, 0xc7, 0x1e, 0x39, 0x19, 0xd4, 0x5e, 0x39, 0xe5, - 0xc8, 0x09, 0xcd, 0x0f, 0xdb, 0xd3, 0x6c, 0x97, 0x6a, 0xb9, 0x44, 0xf3, 0xde, 0xfb, 0xde, 0xf7, - 0x65, 0xe6, 0xbd, 0x79, 0x63, 0xe0, 0xe0, 0x61, 0xe0, 0x44, 0x78, 0x3c, 0x61, 0x41, 0x84, 0x51, - 0xc2, 0xa8, 0xc3, 0x50, 0x12, 0xa2, 0x2c, 0xc6, 0x09, 0x73, 0x66, 0x7d, 0xcd, 0xb2, 0xd3, 0x8c, - 0x30, 0x62, 0x74, 0xf0, 0x30, 0xb0, 0xf5, 0x04, 0x5b, 0x83, 0xcc, 0xfa, 0x3b, 0x5d, 0x2d, 0x9f, - 0x5d, 0xa4, 0x88, 0x3a, 0x33, 0x18, 0xe1, 0x10, 0x32, 0x92, 0x49, 0x86, 0x9d, 0xdd, 0x97, 0x10, - 0xe2, 0x57, 0x45, 0x5b, 0x69, 0x46, 0xc8, 0xa8, 0xb0, 0x3a, 0x63, 0x42, 0xc6, 0x11, 0x72, 0x84, - 0x35, 0x9c, 0x8e, 0x9c, 0x70, 0x9a, 0x41, 0x86, 0x49, 0xa2, 0xe2, 0xe6, 0x62, 0x9c, 0xe1, 0x18, - 0x51, 0x06, 0xe3, 0xb4, 0x00, 0xf0, 0xfd, 0x05, 0x24, 0x43, 0x8e, 0xfc, 0xbb, 0x7c, 0x4f, 0x72, - 0xa5, 0x00, 0xef, 0x55, 0x00, 0x12, 0xc7, 0x98, 0xc5, 0x05, 0xa8, 0xb4, 0x14, 0x70, 0x73, 0x4c, - 0xc6, 0x44, 0x2c, 0x1d, 0xbe, 0x92, 0x5e, 0xeb, 0xef, 0x35, 0xd0, 0x3c, 0x12, 0x7c, 0x67, 0x0c, - 0x32, 0x64, 0x6c, 0x83, 0x7a, 0x30, 0x81, 0x38, 0xf1, 0x71, 0xd8, 0xae, 0x75, 0x6b, 0xbd, 0x86, - 0xb7, 0x26, 0xec, 0x93, 0xd0, 0x40, 0xa0, 0xc9, 0xb2, 0x29, 0x65, 0x7e, 0x84, 0x66, 0x28, 0x6a, - 0x2f, 0x77, 0x6b, 0xbd, 0xe6, 0xa0, 0x67, 0xff, 0xf7, 0x79, 0xda, 0x9f, 0x66, 0x30, 0xe0, 0x1b, - 0x76, 0x77, 0x5e, 0xe4, 0xe6, 0xd2, 0x3c, 0x37, 0x8d, 0x0b, 0x18, 0x47, 0x87, 0x96, 0x46, 0x65, - 0x79, 0x40, 0x58, 0x9f, 0x73, 0xc3, 0x18, 0x81, 0x0d, 0x61, 0xe1, 0x64, 0xec, 0xa7, 0x28, 0xc3, - 0x24, 0x6c, 0xaf, 0x08, 0xa9, 0x6d, 0x5b, 0x1e, 0x96, 0x5d, 0x1c, 0x96, 0xfd, 0x58, 0x1d, 0xa6, - 0x6b, 0x29, 0xee, 0x2d, 0x8d, 0xbb, 0xca, 0xb7, 0x7e, 0xf9, 0xd3, 0xac, 0x79, 0xf7, 0x0b, 0xef, - 0xa9, 0x70, 0x1a, 0x18, 0x3c, 0x98, 0x26, 0x43, 0x92, 0x84, 0x9a, 0xd0, 0xea, 0x5d, 0x42, 0xef, - 0x2a, 0xa1, 0x87, 0x52, 0x68, 0x91, 0x40, 0x2a, 0x6d, 0x94, 0x6e, 0x25, 0x85, 0xc0, 0x46, 0x0c, - 0xcf, 0xfd, 0x20, 0x22, 0xc1, 0x33, 0x3f, 0xcc, 0xf0, 0x88, 0xb5, 0xdf, 0x78, 0xcd, 0x2d, 0x2d, - 0xe4, 0x4b, 0xa1, 0xf5, 0x18, 0x9e, 0x1f, 0x71, 0xe7, 0x63, 0xee, 0x33, 0xbe, 0x05, 0xeb, 0xa3, - 0x8c, 0xfc, 0x80, 0x12, 0x7f, 0x82, 0x78, 0x41, 0xda, 0xf7, 0x84, 0xc8, 0x8e, 0x28, 0x11, 0x6f, - 0x11, 0x5b, 0x75, 0xce, 0xac, 0x6f, 0x1f, 0x0b, 0x84, 0xbb, 0xab, 0x54, 0x36, 0xa5, 0xca, 0x8d, - 0x74, 0xcb, 0x6b, 0x49, 0x5b, 0x62, 0x39, 0x7d, 0x04, 0x19, 0xa2, 0xac, 0xa0, 0x5f, 0x7b, 0x5d, - 0xfa, 0x1b, 0xe9, 0x96, 0xd7, 0x92, 0xb6, 0xa2, 0x3f, 0x01, 0x4d, 0x71, 0x75, 0x7c, 0x9a, 0xa2, - 0x80, 0xb6, 0xeb, 0xdd, 0x95, 0x5e, 0x73, 0xf0, 0xc0, 0xc6, 0x01, 0x1d, 0x1c, 0xd8, 0xa7, 0x3c, - 0x72, 0x96, 0xa2, 0xc0, 0xdd, 0xaa, 0x5a, 0x48, 0x83, 0x5b, 0x1e, 0x48, 0x0b, 0x08, 0x35, 0x0e, - 0x41, 0x6b, 0x9a, 0x8e, 0x33, 0x18, 0x22, 0x3f, 0x85, 0x6c, 0xd2, 0x6e, 0x74, 0x57, 0x7a, 0x0d, - 0xf7, 0xe1, 0x3c, 0x37, 0xdf, 0x52, 0x75, 0xd3, 0xa2, 0x96, 0xd7, 0x54, 0xe6, 0x29, 0x64, 0x13, - 0x03, 0x82, 0x6d, 0x18, 0x45, 0xe4, 0x7b, 0x7f, 0x9a, 0x86, 0x90, 0x21, 0x1f, 0x8e, 0x18, 0xca, - 0x7c, 0x74, 0x9e, 0xe2, 0xec, 0xa2, 0x0d, 0xba, 0xb5, 0x5e, 0xdd, 0xdd, 0x9b, 0xe7, 0x66, 0x57, - 0x12, 0xbd, 0x12, 0x6a, 0xb5, 0x6b, 0xde, 0x96, 0x88, 0x7e, 0x29, 0x82, 0x9f, 0xf0, 0xd8, 0x13, - 0x11, 0x32, 0x28, 0x30, 0x6f, 0xc9, 0x8b, 0x31, 0x1d, 0xa2, 0x09, 0x9c, 0x61, 0x32, 0xcd, 0xda, - 0x4d, 0x21, 0xf4, 0xfe, 0x3c, 0x37, 0xf7, 0x5e, 0x29, 0xa4, 0x27, 0x70, 0xb9, 0xdd, 0x45, 0xb9, - 0xa7, 0x1a, 0xe0, 0x70, 0xf5, 0xc7, 0xdf, 0xcc, 0x25, 0xeb, 0xf7, 0x65, 0x70, 0xff, 0x88, 0x24, - 0x14, 0x25, 0x74, 0x4a, 0xe5, 0x8d, 0x77, 0x41, 0xa3, 0x1c, 0x3a, 0xe2, 0xca, 0xf3, 0x92, 0x2e, - 0xb6, 0xe5, 0x17, 0x05, 0xc2, 0xad, 0xf3, 0x92, 0x3e, 0xe7, 0xdd, 0x57, 0xa5, 0x19, 0x1f, 0x83, - 0xd5, 0x8c, 0x10, 0xa6, 0x66, 0x82, 0xa5, 0x75, 0x44, 0x35, 0x85, 0x66, 0x7d, 0xfb, 0x29, 0xca, - 0x9e, 0x45, 0xc8, 0x23, 0x84, 0xb9, 0xab, 0x9c, 0xc6, 0x13, 0x59, 0xc6, 0x4f, 0x35, 0xb0, 0x99, - 0xa0, 0x73, 0xe6, 0x97, 0x93, 0x96, 0xfa, 0x13, 0x48, 0x27, 0xe2, 0xde, 0xb7, 0xdc, 0xaf, 0xe7, - 0xb9, 0xf9, 0x8e, 0x3c, 0x85, 0xdb, 0x50, 0xd6, 0x3f, 0xb9, 0xf9, 0xe1, 0x18, 0xb3, 0xc9, 0x74, - 0xc8, 0xe5, 0xf4, 0xf9, 0xaf, 0x2d, 0x23, 0x3c, 0xa4, 0xce, 0xf0, 0x82, 0x21, 0x6a, 0x1f, 0xa3, - 0x73, 0x97, 0x2f, 0x3c, 0x83, 0xd3, 0x7d, 0x55, 0xb2, 0x1d, 0x43, 0x3a, 0x51, 0xc7, 0xf4, 0xf3, - 0x32, 0x68, 0xe9, 0xa7, 0x67, 0x1c, 0x80, 0x86, 0x6c, 0xee, 0x72, 0x2e, 0x8a, 0x46, 0x7c, 0x20, - 0xff, 0x56, 0x19, 0xe2, 0x65, 0xa8, 0x4b, 0xeb, 0x24, 0x34, 0x20, 0xa8, 0x4f, 0x10, 0x0c, 0x51, - 0xe6, 0xf7, 0xd5, 0xc9, 0xec, 0xdd, 0x35, 0x2d, 0x8f, 0x05, 0xde, 0xed, 0x5c, 0xe5, 0xe6, 0x9a, - 0x5c, 0xf7, 0xe7, 0xb9, 0xb9, 0x21, 0x65, 0x0a, 0x32, 0xcb, 0x5b, 0x93, 0xcb, 0xbe, 0x26, 0x31, - 0x50, 0x53, 0xf2, 0x7f, 0x48, 0x0c, 0x5e, 0x92, 0x18, 0x94, 0x12, 0x03, 0x75, 0x22, 0xbf, 0xae, - 0x80, 0x7b, 0x12, 0x6d, 0x40, 0xb0, 0x4e, 0xf1, 0x38, 0x41, 0xa1, 0x2f, 0x21, 0xaa, 0x69, 0x3a, - 0xba, 0x8e, 0x7c, 0x11, 0xcf, 0x04, 0x4c, 0x09, 0xee, 0x5e, 0xe6, 0x66, 0xad, 0x9a, 0x05, 0x37, - 0x28, 0x2c, 0xaf, 0x45, 0x35, 0x2c, 0x1f, 0x35, 0x65, 0x95, 0x7d, 0x8a, 0x8a, 0xc6, 0xba, 0x45, - 0xa2, 0x2c, 0xdf, 0x19, 0x62, 0x6e, 0xbb, 0xa2, 0xbf, 0x91, 0x6e, 0x79, 0xad, 0x99, 0x86, 0x33, - 0xbe, 0x03, 0xf2, 0x31, 0x10, 0xfa, 0x62, 0x94, 0xad, 0xdc, 0x39, 0xca, 0x1e, 0xa9, 0x51, 0xf6, - 0xb6, 0xf6, 0xc4, 0x94, 0xf9, 0x96, 0xb7, 0xae, 0x1c, 0x6a, 0x98, 0x45, 0xc0, 0x28, 0x10, 0x55, - 0xbb, 0xaa, 0xe7, 0xe5, 0xae, 0x5d, 0x3c, 0x9a, 0xe7, 0xe6, 0xf6, 0x4d, 0x95, 0x8a, 0xc3, 0xf2, - 0xde, 0x54, 0xce, 0xaa, 0x71, 0xad, 0xcf, 0x40, 0xbd, 0x78, 0x66, 0x8d, 0x5d, 0xd0, 0x48, 0xa6, - 0x31, 0xca, 0x78, 0x44, 0x54, 0x66, 0xd5, 0xab, 0x1c, 0x46, 0x17, 0x34, 0x43, 0x94, 0x90, 0x18, - 0x27, 0x22, 0xbe, 0x2c, 0xe2, 0xba, 0xcb, 0xf5, 0x5f, 0x5c, 0x75, 0x6a, 0x97, 0x57, 0x9d, 0xda, - 0x5f, 0x57, 0x9d, 0xda, 0xf3, 0xeb, 0xce, 0xd2, 0xe5, 0x75, 0x67, 0xe9, 0x8f, 0xeb, 0xce, 0xd2, - 0x37, 0x4f, 0xb4, 0x4b, 0x16, 0x10, 0x1a, 0x13, 0xca, 0x3f, 0xbe, 0xf6, 0xc7, 0xc4, 0x99, 0x1d, - 0x38, 0x31, 0x09, 0xa7, 0x11, 0xa2, 0xf2, 0x53, 0x6c, 0xbf, 0xf8, 0x16, 0xfb, 0xe0, 0xa3, 0xfd, - 0xc5, 0x8f, 0xa5, 0xe1, 0x3d, 0x31, 0x54, 0x0e, 0xfe, 0x0d, 0x00, 0x00, 0xff, 0xff, 0xdd, 0xc8, - 0x3e, 0xfe, 0xba, 0x09, 0x00, 0x00, + 0x0e, 0x48, 0x7b, 0x44, 0x9c, 0x38, 0xf0, 0xc7, 0xec, 0xb1, 0x47, 0x4e, 0x06, 0xb5, 0x57, 0x4e, + 0x39, 0x72, 0x42, 0xf3, 0xc3, 0xf6, 0x34, 0xdb, 0xa5, 0x5a, 0x2e, 0xd1, 0xbc, 0xf7, 0xbe, 0xf7, + 0x7d, 0x99, 0x37, 0x6f, 0xde, 0x18, 0x38, 0x78, 0x18, 0x38, 0x11, 0x1e, 0x4f, 0x58, 0x10, 0x61, + 0x94, 0x30, 0xea, 0x30, 0x94, 0x84, 0x28, 0x8b, 0x71, 0xc2, 0x9c, 0x59, 0x5f, 0xb3, 0xec, 0x34, + 0x23, 0x8c, 0x18, 0x1d, 0x3c, 0x0c, 0x6c, 0x3d, 0xc1, 0xd6, 0x20, 0xb3, 0xfe, 0x4e, 0x57, 0xcb, + 0x67, 0x17, 0x29, 0xa2, 0xce, 0x0c, 0x46, 0x38, 0x84, 0x8c, 0x64, 0x92, 0x61, 0x67, 0xf7, 0x25, + 0x84, 0xf8, 0x55, 0xd1, 0x56, 0x9a, 0x11, 0x32, 0x2a, 0xac, 0xce, 0x98, 0x90, 0x71, 0x84, 0x1c, + 0x61, 0x0d, 0xa7, 0x23, 0x27, 0x9c, 0x66, 0x90, 0x61, 0x92, 0xa8, 0xb8, 0xb9, 0x18, 0x67, 0x38, + 0x46, 0x94, 0xc1, 0x38, 0x2d, 0x00, 0x7c, 0x7f, 0x01, 0xc9, 0x90, 0x23, 0xff, 0x2e, 0xdf, 0x93, + 0x5c, 0x29, 0xc0, 0x7b, 0x15, 0x80, 0xc4, 0x31, 0x66, 0x71, 0x01, 0x2a, 0x2d, 0x05, 0xdc, 0x1c, + 0x93, 0x31, 0x11, 0x4b, 0x87, 0xaf, 0xa4, 0xd7, 0xfa, 0x7b, 0x0d, 0x34, 0x8f, 0x04, 0xdf, 0x19, + 0x83, 0x0c, 0x19, 0xdb, 0xa0, 0x1e, 0x4c, 0x20, 0x4e, 0x7c, 0x1c, 0xb6, 0x6b, 0xdd, 0x5a, 0xaf, + 0xe1, 0xad, 0x09, 0xfb, 0x24, 0x34, 0x10, 0x68, 0xb2, 0x6c, 0x4a, 0x99, 0x1f, 0xa1, 0x19, 0x8a, + 0xda, 0xcb, 0xdd, 0x5a, 0xaf, 0x39, 0xe8, 0xd9, 0xff, 0x5d, 0x4f, 0xfb, 0xd3, 0x0c, 0x06, 0x7c, + 0xc3, 0xee, 0xce, 0x8b, 0xdc, 0x5c, 0x9a, 0xe7, 0xa6, 0x71, 0x01, 0xe3, 0xe8, 0xd0, 0xd2, 0xa8, + 0x2c, 0x0f, 0x08, 0xeb, 0x73, 0x6e, 0x18, 0x23, 0xb0, 0x21, 0x2c, 0x9c, 0x8c, 0xfd, 0x14, 0x65, + 0x98, 0x84, 0xed, 0x15, 0x21, 0xb5, 0x6d, 0xcb, 0x62, 0xd9, 0x45, 0xb1, 0xec, 0xc7, 0xaa, 0x98, + 0xae, 0xa5, 0xb8, 0xb7, 0x34, 0xee, 0x2a, 0xdf, 0xfa, 0xe5, 0x4f, 0xb3, 0xe6, 0xdd, 0x2f, 0xbc, + 0xa7, 0xc2, 0x69, 0x60, 0xf0, 0x60, 0x9a, 0x0c, 0x49, 0x12, 0x6a, 0x42, 0xab, 0x77, 0x09, 0xbd, + 0xab, 0x84, 0x1e, 0x4a, 0xa1, 0x45, 0x02, 0xa9, 0xb4, 0x51, 0xba, 0x95, 0x14, 0x02, 0x1b, 0x31, + 0x3c, 0xf7, 0x83, 0x88, 0x04, 0xcf, 0xfc, 0x30, 0xc3, 0x23, 0xd6, 0x7e, 0xe3, 0x35, 0xb7, 0xb4, + 0x90, 0x2f, 0x85, 0xd6, 0x63, 0x78, 0x7e, 0xc4, 0x9d, 0x8f, 0xb9, 0xcf, 0xf8, 0x16, 0xac, 0x8f, + 0x32, 0xf2, 0x03, 0x4a, 0xfc, 0x09, 0xe2, 0x07, 0xd2, 0xbe, 0x27, 0x44, 0x76, 0xc4, 0x11, 0xf1, + 0x16, 0xb1, 0x55, 0xe7, 0xcc, 0xfa, 0xf6, 0xb1, 0x40, 0xb8, 0xbb, 0x4a, 0x65, 0x53, 0xaa, 0xdc, + 0x48, 0xb7, 0xbc, 0x96, 0xb4, 0x25, 0x96, 0xd3, 0x47, 0x90, 0x21, 0xca, 0x0a, 0xfa, 0xb5, 0xd7, + 0xa5, 0xbf, 0x91, 0x6e, 0x79, 0x2d, 0x69, 0x2b, 0xfa, 0x13, 0xd0, 0x14, 0x57, 0xc7, 0xa7, 0x29, + 0x0a, 0x68, 0xbb, 0xde, 0x5d, 0xe9, 0x35, 0x07, 0x0f, 0x6c, 0x1c, 0xd0, 0xc1, 0x81, 0x7d, 0xca, + 0x23, 0x67, 0x29, 0x0a, 0xdc, 0xad, 0xaa, 0x85, 0x34, 0xb8, 0xe5, 0x81, 0xb4, 0x80, 0x50, 0xe3, + 0x10, 0xb4, 0xa6, 0xe9, 0x38, 0x83, 0x21, 0xf2, 0x53, 0xc8, 0x26, 0xed, 0x46, 0x77, 0xa5, 0xd7, + 0x70, 0x1f, 0xce, 0x73, 0xf3, 0x2d, 0x75, 0x6e, 0x5a, 0xd4, 0xf2, 0x9a, 0xca, 0x3c, 0x85, 0x6c, + 0x62, 0x40, 0xb0, 0x0d, 0xa3, 0x88, 0x7c, 0xef, 0x4f, 0xd3, 0x10, 0x32, 0xe4, 0xc3, 0x11, 0x43, + 0x99, 0x8f, 0xce, 0x53, 0x9c, 0x5d, 0xb4, 0x41, 0xb7, 0xd6, 0xab, 0xbb, 0x7b, 0xf3, 0xdc, 0xec, + 0x4a, 0xa2, 0x57, 0x42, 0xad, 0x76, 0xcd, 0xdb, 0x12, 0xd1, 0x2f, 0x45, 0xf0, 0x13, 0x1e, 0x7b, + 0x22, 0x42, 0x06, 0x05, 0xe6, 0x2d, 0x79, 0x31, 0xa6, 0x43, 0x34, 0x81, 0x33, 0x4c, 0xa6, 0x59, + 0xbb, 0x29, 0x84, 0xde, 0x9f, 0xe7, 0xe6, 0xde, 0x2b, 0x85, 0xf4, 0x04, 0x2e, 0xb7, 0xbb, 0x28, + 0xf7, 0x54, 0x03, 0x1c, 0xae, 0xfe, 0xf8, 0x9b, 0xb9, 0x64, 0xfd, 0xbe, 0x0c, 0xee, 0x1f, 0x91, + 0x84, 0xa2, 0x84, 0x4e, 0xa9, 0xbc, 0xf1, 0x2e, 0x68, 0x94, 0x43, 0x47, 0x5c, 0x79, 0x7e, 0xa4, + 0x8b, 0x6d, 0xf9, 0x45, 0x81, 0x70, 0xeb, 0xfc, 0x48, 0x9f, 0xf3, 0xee, 0xab, 0xd2, 0x8c, 0x8f, + 0xc1, 0x6a, 0x46, 0x08, 0x53, 0x33, 0xc1, 0xd2, 0x3a, 0xa2, 0x9a, 0x42, 0xb3, 0xbe, 0xfd, 0x14, + 0x65, 0xcf, 0x22, 0xe4, 0x11, 0xc2, 0xdc, 0x55, 0x4e, 0xe3, 0x89, 0x2c, 0xe3, 0xa7, 0x1a, 0xd8, + 0x4c, 0xd0, 0x39, 0xf3, 0xcb, 0x49, 0x4b, 0xfd, 0x09, 0xa4, 0x13, 0x71, 0xef, 0x5b, 0xee, 0xd7, + 0xf3, 0xdc, 0x7c, 0x47, 0x56, 0xe1, 0x36, 0x94, 0xf5, 0x4f, 0x6e, 0x7e, 0x38, 0xc6, 0x6c, 0x32, + 0x1d, 0x72, 0x39, 0x7d, 0xfe, 0x6b, 0xcb, 0x08, 0x0f, 0xa9, 0x33, 0xbc, 0x60, 0x88, 0xda, 0xc7, + 0xe8, 0xdc, 0xe5, 0x0b, 0xcf, 0xe0, 0x74, 0x5f, 0x95, 0x6c, 0xc7, 0x90, 0x4e, 0x54, 0x99, 0x7e, + 0x5e, 0x06, 0x2d, 0xbd, 0x7a, 0x46, 0x1f, 0x34, 0x64, 0x73, 0x97, 0x73, 0xd1, 0xdd, 0x9c, 0xe7, + 0xe6, 0x03, 0xf9, 0xb7, 0xca, 0x90, 0xe5, 0xd5, 0xe5, 0xfa, 0x24, 0x34, 0x20, 0xa8, 0x4f, 0x10, + 0x0c, 0x51, 0xe6, 0xf7, 0x55, 0x5d, 0xf6, 0xee, 0x9a, 0x95, 0xc7, 0x02, 0xef, 0x76, 0xae, 0x72, + 0x73, 0x4d, 0xae, 0xfb, 0xf3, 0xdc, 0xdc, 0x90, 0x22, 0x05, 0x99, 0xe5, 0xad, 0xc9, 0x65, 0x5f, + 0x93, 0x18, 0xa8, 0x19, 0xf9, 0x3f, 0x24, 0x06, 0x2f, 0x49, 0x0c, 0x4a, 0x89, 0x81, 0xaa, 0xc7, + 0xaf, 0x2b, 0xe0, 0x9e, 0x44, 0x1b, 0x10, 0xac, 0x53, 0x3c, 0x4e, 0x50, 0xe8, 0x4b, 0x88, 0x6a, + 0x99, 0x8e, 0xae, 0x23, 0xdf, 0xc3, 0x33, 0x01, 0x53, 0x82, 0xbb, 0x97, 0xb9, 0x59, 0xab, 0x26, + 0xc1, 0x0d, 0x0a, 0xcb, 0x6b, 0x51, 0x0d, 0xcb, 0x07, 0x4d, 0x79, 0xc6, 0x3e, 0x45, 0x45, 0x5b, + 0xdd, 0x22, 0x51, 0x1e, 0xde, 0x19, 0x62, 0x6e, 0xbb, 0xa2, 0xbf, 0x91, 0x6e, 0x79, 0xad, 0x99, + 0x86, 0x33, 0xbe, 0x03, 0xf2, 0x29, 0x10, 0xfa, 0x62, 0x90, 0xad, 0xdc, 0x39, 0xc8, 0x1e, 0xa9, + 0x41, 0xf6, 0xb6, 0xf6, 0xc0, 0x94, 0xf9, 0x96, 0xb7, 0xae, 0x1c, 0x6a, 0x94, 0x45, 0xc0, 0x28, + 0x10, 0x55, 0xb3, 0xaa, 0xc7, 0xe5, 0xae, 0x5d, 0x3c, 0x9a, 0xe7, 0xe6, 0xf6, 0x4d, 0x95, 0x8a, + 0xc3, 0xf2, 0xde, 0x54, 0xce, 0xaa, 0x6d, 0xad, 0xcf, 0x40, 0xbd, 0x78, 0x64, 0x8d, 0x5d, 0xd0, + 0x48, 0xa6, 0x31, 0xca, 0x78, 0x44, 0x9c, 0xcc, 0xaa, 0x57, 0x39, 0x8c, 0x2e, 0x68, 0x86, 0x28, + 0x21, 0x31, 0x4e, 0x44, 0x7c, 0x59, 0xc4, 0x75, 0x97, 0xeb, 0xbf, 0xb8, 0xea, 0xd4, 0x2e, 0xaf, + 0x3a, 0xb5, 0xbf, 0xae, 0x3a, 0xb5, 0xe7, 0xd7, 0x9d, 0xa5, 0xcb, 0xeb, 0xce, 0xd2, 0x1f, 0xd7, + 0x9d, 0xa5, 0x6f, 0x9e, 0x68, 0x57, 0x2c, 0x20, 0x34, 0x26, 0x94, 0x7f, 0x7a, 0xed, 0x8f, 0x89, + 0x33, 0x3b, 0x70, 0x62, 0x12, 0x4e, 0x23, 0x44, 0xe5, 0x87, 0xd8, 0x7e, 0xf1, 0x25, 0xf6, 0xc1, + 0x47, 0xfb, 0x8b, 0x9f, 0x4a, 0xc3, 0x7b, 0x62, 0xa4, 0x1c, 0xfc, 0x1b, 0x00, 0x00, 0xff, 0xff, + 0x31, 0x4f, 0x07, 0x47, 0xb8, 0x09, 0x00, 0x00, } func (m *ClientState) Marshal() (dAtA []byte, err error) { diff --git a/proto/ibc/applications/fee/v1/tx.proto b/proto/ibc/applications/fee/v1/tx.proto index d8745f6d208..d3305c5452f 100644 --- a/proto/ibc/applications/fee/v1/tx.proto +++ b/proto/ibc/applications/fee/v1/tx.proto @@ -20,8 +20,9 @@ service Msg { // RegisterCounterpartyPayee defines a rpc handler method for MsgRegisterCounterpartyPayee // RegisterCounterpartyPayee is called by the relayer on each channelEnd and allows them to specify the counterparty // payee address before relaying. This ensures they will be properly compensated for forward relaying since - // the destination chain must include the registered counterparty payee address in the acknowledgement. This function + // the destination chain may include the registered counterparty payee address in the acknowledgement. This function // may be called more than once by a relayer, in which case, the latest counterparty payee address is always used. + // A registered payee on the source chain will always override a registered counterparty payee. rpc RegisterCounterpartyPayee(MsgRegisterCounterpartyPayee) returns (MsgRegisterCounterpartyPayeeResponse); // PayPacketFee defines a rpc handler method for MsgPayPacketFee From 88f01c277f50342278f2b8c7bafeca025cb45791 Mon Sep 17 00:00:00 2001 From: Damian Nolan Date: Mon, 13 Jun 2022 17:16:28 +0200 Subject: [PATCH 9/9] updating protodocs and godocs --- docs/ibc/proto-docs.md | 4 ++-- modules/apps/29-fee/keeper/msg_server.go | 6 +++--- modules/apps/29-fee/types/tx.pb.go | 18 ++++++++---------- proto/ibc/applications/fee/v1/tx.proto | 9 ++++----- 4 files changed, 17 insertions(+), 20 deletions(-) diff --git a/docs/ibc/proto-docs.md b/docs/ibc/proto-docs.md index 2b43f8262a4..2643d230ffc 100644 --- a/docs/ibc/proto-docs.md +++ b/docs/ibc/proto-docs.md @@ -1411,8 +1411,8 @@ Msg defines the ICS29 Msg service. | Method Name | Request Type | Response Type | Description | HTTP Verb | Endpoint | | ----------- | ------------ | ------------- | ------------| ------- | -------- | -| `RegisterPayee` | [MsgRegisterPayee](#ibc.applications.fee.v1.MsgRegisterPayee) | [MsgRegisterPayeeResponse](#ibc.applications.fee.v1.MsgRegisterPayeeResponse) | RegisterPayee defines a rpc handler method for MsgRegisterPayee RegisterPayee is called by the relayer on each channelEnd and allows them to set an optional payee to which escrowed packet fees will be paid out. The payee should be registered on the source chain from which packets originate as this is where fee distribution takes place. This function may be called more than once by a relayer, in which case, the latest payee is always used. | | -| `RegisterCounterpartyPayee` | [MsgRegisterCounterpartyPayee](#ibc.applications.fee.v1.MsgRegisterCounterpartyPayee) | [MsgRegisterCounterpartyPayeeResponse](#ibc.applications.fee.v1.MsgRegisterCounterpartyPayeeResponse) | RegisterCounterpartyPayee defines a rpc handler method for MsgRegisterCounterpartyPayee RegisterCounterpartyPayee is called by the relayer on each channelEnd and allows them to specify the counterparty payee address before relaying. This ensures they will be properly compensated for forward relaying since the destination chain may include the registered counterparty payee address in the acknowledgement. This function may be called more than once by a relayer, in which case, the latest counterparty payee address is always used. A registered payee on the source chain will always override a registered counterparty payee. | | +| `RegisterPayee` | [MsgRegisterPayee](#ibc.applications.fee.v1.MsgRegisterPayee) | [MsgRegisterPayeeResponse](#ibc.applications.fee.v1.MsgRegisterPayeeResponse) | RegisterPayee defines a rpc handler method for MsgRegisterPayee RegisterPayee is called by the relayer on each channelEnd and allows them to set an optional payee to which reverse and timeout relayer packet fees will be paid out. The payee should be registered on the source chain from which packets originate as this is where fee distribution takes place. This function may be called more than once by a relayer, in which case, the latest payee is always used. | | +| `RegisterCounterpartyPayee` | [MsgRegisterCounterpartyPayee](#ibc.applications.fee.v1.MsgRegisterCounterpartyPayee) | [MsgRegisterCounterpartyPayeeResponse](#ibc.applications.fee.v1.MsgRegisterCounterpartyPayeeResponse) | RegisterCounterpartyPayee defines a rpc handler method for MsgRegisterCounterpartyPayee RegisterCounterpartyPayee is called by the relayer on each channelEnd and allows them to specify the counterparty payee address before relaying. This ensures they will be properly compensated for forward relaying since the destination chain must include the registered counterparty payee address in the acknowledgement. This function may be called more than once by a relayer, in which case, the latest counterparty payee address is always used. | | | `PayPacketFee` | [MsgPayPacketFee](#ibc.applications.fee.v1.MsgPayPacketFee) | [MsgPayPacketFeeResponse](#ibc.applications.fee.v1.MsgPayPacketFeeResponse) | PayPacketFee defines a rpc handler method for MsgPayPacketFee PayPacketFee is an open callback that may be called by any module/user that wishes to escrow funds in order to incentivize the relaying of the packet at the next sequence NOTE: This method is intended to be used within a multi msg transaction, where the subsequent msg that follows initiates the lifecycle of the incentivized packet | | | `PayPacketFeeAsync` | [MsgPayPacketFeeAsync](#ibc.applications.fee.v1.MsgPayPacketFeeAsync) | [MsgPayPacketFeeAsyncResponse](#ibc.applications.fee.v1.MsgPayPacketFeeAsyncResponse) | PayPacketFeeAsync defines a rpc handler method for MsgPayPacketFeeAsync PayPacketFeeAsync is an open callback that may be called by any module/user that wishes to escrow funds in order to incentivize the relaying of a known packet (i.e. at a particular sequence) | | diff --git a/modules/apps/29-fee/keeper/msg_server.go b/modules/apps/29-fee/keeper/msg_server.go index dc4d902e895..fe7af407d2f 100644 --- a/modules/apps/29-fee/keeper/msg_server.go +++ b/modules/apps/29-fee/keeper/msg_server.go @@ -14,9 +14,9 @@ var _ types.MsgServer = Keeper{} // RegisterPayee defines a rpc handler method for MsgRegisterPayee // RegisterPayee is called by the relayer on each channelEnd and allows them to set an optional -// payee to which escrowed packet fees will be paid out. The payee should be registered on the source chain from which -// packets originate as this is where fee distribution takes place. This function may be called more than once by a relayer, -// in which case, the latest payee is always used. +// payee to which reverse and timeout relayer packet fees will be paid out. The payee should be registered on +// the source chain from which packets originate as this is where fee distribution takes place. This function may be +// called more than once by a relayer, in which case, the latest payee is always used. func (k Keeper) RegisterPayee(goCtx context.Context, msg *types.MsgRegisterPayee) (*types.MsgRegisterPayeeResponse, error) { ctx := sdk.UnwrapSDKContext(goCtx) diff --git a/modules/apps/29-fee/types/tx.pb.go b/modules/apps/29-fee/types/tx.pb.go index 1dccf3a8aed..e62ca434e8d 100644 --- a/modules/apps/29-fee/types/tx.pb.go +++ b/modules/apps/29-fee/types/tx.pb.go @@ -433,16 +433,15 @@ const _ = grpc.SupportPackageIsVersion4 type MsgClient interface { // RegisterPayee defines a rpc handler method for MsgRegisterPayee // RegisterPayee is called by the relayer on each channelEnd and allows them to set an optional - // payee to which escrowed packet fees will be paid out. The payee should be registered on the source chain from which - // packets originate as this is where fee distribution takes place. This function may be called more than once by a - // relayer, in which case, the latest payee is always used. + // payee to which reverse and timeout relayer packet fees will be paid out. The payee should be registered on + // the source chain from which packets originate as this is where fee distribution takes place. This function may be + // called more than once by a relayer, in which case, the latest payee is always used. RegisterPayee(ctx context.Context, in *MsgRegisterPayee, opts ...grpc.CallOption) (*MsgRegisterPayeeResponse, error) // RegisterCounterpartyPayee defines a rpc handler method for MsgRegisterCounterpartyPayee // RegisterCounterpartyPayee is called by the relayer on each channelEnd and allows them to specify the counterparty // payee address before relaying. This ensures they will be properly compensated for forward relaying since - // the destination chain may include the registered counterparty payee address in the acknowledgement. This function + // the destination chain must include the registered counterparty payee address in the acknowledgement. This function // may be called more than once by a relayer, in which case, the latest counterparty payee address is always used. - // A registered payee on the source chain will always override a registered counterparty payee. RegisterCounterpartyPayee(ctx context.Context, in *MsgRegisterCounterpartyPayee, opts ...grpc.CallOption) (*MsgRegisterCounterpartyPayeeResponse, error) // PayPacketFee defines a rpc handler method for MsgPayPacketFee // PayPacketFee is an open callback that may be called by any module/user that wishes to escrow funds in order to @@ -504,16 +503,15 @@ func (c *msgClient) PayPacketFeeAsync(ctx context.Context, in *MsgPayPacketFeeAs type MsgServer interface { // RegisterPayee defines a rpc handler method for MsgRegisterPayee // RegisterPayee is called by the relayer on each channelEnd and allows them to set an optional - // payee to which escrowed packet fees will be paid out. The payee should be registered on the source chain from which - // packets originate as this is where fee distribution takes place. This function may be called more than once by a - // relayer, in which case, the latest payee is always used. + // payee to which reverse and timeout relayer packet fees will be paid out. The payee should be registered on + // the source chain from which packets originate as this is where fee distribution takes place. This function may be + // called more than once by a relayer, in which case, the latest payee is always used. RegisterPayee(context.Context, *MsgRegisterPayee) (*MsgRegisterPayeeResponse, error) // RegisterCounterpartyPayee defines a rpc handler method for MsgRegisterCounterpartyPayee // RegisterCounterpartyPayee is called by the relayer on each channelEnd and allows them to specify the counterparty // payee address before relaying. This ensures they will be properly compensated for forward relaying since - // the destination chain may include the registered counterparty payee address in the acknowledgement. This function + // the destination chain must include the registered counterparty payee address in the acknowledgement. This function // may be called more than once by a relayer, in which case, the latest counterparty payee address is always used. - // A registered payee on the source chain will always override a registered counterparty payee. RegisterCounterpartyPayee(context.Context, *MsgRegisterCounterpartyPayee) (*MsgRegisterCounterpartyPayeeResponse, error) // PayPacketFee defines a rpc handler method for MsgPayPacketFee // PayPacketFee is an open callback that may be called by any module/user that wishes to escrow funds in order to diff --git a/proto/ibc/applications/fee/v1/tx.proto b/proto/ibc/applications/fee/v1/tx.proto index d3305c5452f..f876ea50483 100644 --- a/proto/ibc/applications/fee/v1/tx.proto +++ b/proto/ibc/applications/fee/v1/tx.proto @@ -12,17 +12,16 @@ import "ibc/core/channel/v1/channel.proto"; service Msg { // RegisterPayee defines a rpc handler method for MsgRegisterPayee // RegisterPayee is called by the relayer on each channelEnd and allows them to set an optional - // payee to which escrowed packet fees will be paid out. The payee should be registered on the source chain from which - // packets originate as this is where fee distribution takes place. This function may be called more than once by a - // relayer, in which case, the latest payee is always used. + // payee to which reverse and timeout relayer packet fees will be paid out. The payee should be registered on + // the source chain from which packets originate as this is where fee distribution takes place. This function may be + // called more than once by a relayer, in which case, the latest payee is always used. rpc RegisterPayee(MsgRegisterPayee) returns (MsgRegisterPayeeResponse); // RegisterCounterpartyPayee defines a rpc handler method for MsgRegisterCounterpartyPayee // RegisterCounterpartyPayee is called by the relayer on each channelEnd and allows them to specify the counterparty // payee address before relaying. This ensures they will be properly compensated for forward relaying since - // the destination chain may include the registered counterparty payee address in the acknowledgement. This function + // the destination chain must include the registered counterparty payee address in the acknowledgement. This function // may be called more than once by a relayer, in which case, the latest counterparty payee address is always used. - // A registered payee on the source chain will always override a registered counterparty payee. rpc RegisterCounterpartyPayee(MsgRegisterCounterpartyPayee) returns (MsgRegisterCounterpartyPayeeResponse); // PayPacketFee defines a rpc handler method for MsgPayPacketFee