ICS 29: Fee Middleware #276
* feat: adding MsgServer for RegisterCounterPartyAddress & EscrowPacketFree * test: adding test for ValidateBasic * fix: removing validate basic check * fix: removing empty file * Update modules/apps/29-fee/keeper/msg_server.go Co-authored-by: colin axnér <25233464+colin-axner@users.noreply.github.com> * Update modules/apps/29-fee/types/msgs.go Co-authored-by: colin axnér <25233464+colin-axner@users.noreply.github.com> * Update modules/apps/29-fee/types/keys.go Co-authored-by: colin axnér <25233464+colin-axner@users.noreply.github.com> * Update modules/apps/29-fee/keeper/keeper.go Co-authored-by: Aditya <adityasripal@gmail.com> * fix: fixing typos, variable names, comments * fix: updating import comments * test: adding test for KeyRelayerAddress * update: comments & key_test * Update modules/apps/29-fee/keeper/msg_server.go Co-authored-by: colin axnér <25233464+colin-axner@users.noreply.github.com> * fix: error message * docs: updating RegisterCounterpartyAddress fn description Co-authored-by: colin axnér <25233464+colin-axner@users.noreply.github.com> Co-authored-by: Aditya <adityasripal@gmail.com>
- Loading branch information
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,33 @@ | ||
| package keeper | ||
|
|
||
| import ( | ||
| "context" | ||
|
|
||
| sdk "github.com/cosmos/cosmos-sdk/types" | ||
|
|
||
| "github.com/cosmos/ibc-go/modules/apps/29-fee/types" | ||
| ) | ||
|
|
||
| var _ types.MsgServer = Keeper{} | ||
|
|
||
| // 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) { | ||
| ctx := sdk.UnwrapSDKContext(goCtx) | ||
|
|
||
| k.SetCounterpartyAddress( | ||
|
There was a problem hiding this comment. We may want to validate that On the other hand, we cannot really validate There was a problem hiding this comment.
This will already be checked during antehandler, since address must sign message. Do you have suggestions on Counterparty address validation? There was a problem hiding this comment. I think we can do basic validation with an acceptable address format for the majority of blockchains that exist today. Something like |
||
| ctx, msg.Address, msg.CounterpartyAddress, | ||
| ) | ||
|
|
||
| k.Logger(ctx).Info("Registering counterparty address for relayer.", "Address:", msg.Address, "Counterparty Address:", msg.CounterpartyAddress) | ||
|
|
||
| return &types.MsgRegisterCounterpartyAddressResponse{}, nil | ||
| } | ||
|
|
||
| // EscrowPacketFee defines a rpc handler method for MsgEscrowPacketFee | ||
| // EscrowPacketFee 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 given packet. | ||
| func (k Keeper) EscrowPacketFee(goCtx context.Context, msg *types.MsgEscrowPacketFee) (*types.MsgEscrowPacketFeeResponse, error) { | ||
| return &types.MsgEscrowPacketFeeResponse{}, nil | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,15 +1,29 @@ | ||
| package types | ||
|
|
||
| // standard library imports | ||
| import "fmt" | ||
|
|
||
| const ( | ||
| // ModuleName defines the 29-fee name | ||
| ModuleName = "ibcfee" | ||
|
|
||
| // StoreKey is the store key string for IBC transfer | ||
| StoreKey = ModuleName | ||
|
|
||
| // PortKey is the port id that is wrapped by fee middleware | ||
| PortKey = "feetransfer" | ||
|
|
||
| // RouterKey is the message route for IBC transfer | ||
| RouterKey = ModuleName | ||
|
|
||
| // QuerierRoute is the querier route for IBC transfer | ||
| QuerierRoute = ModuleName | ||
|
|
||
| // RelayerAddressKeyPrefix is the key prefix for relayer address mapping | ||
| RelayerAddressKeyPrefix = "relayerAddress" | ||
| ) | ||
|
|
||
| // KeyRelayerAddress returns the key for relayer address -> counteryparty address mapping | ||
| func KeyRelayerAddress(address string) []byte { | ||
| return []byte(fmt.Sprintf("%s/%s", RelayerAddressKeyPrefix, address)) | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
| package types_test | ||
|
|
||
| import ( | ||
| fmt "fmt" | ||
| "testing" | ||
|
|
||
| "github.com/stretchr/testify/require" | ||
|
|
||
| "github.com/cosmos/ibc-go/modules/apps/29-fee/types" | ||
| ) | ||
|
|
||
| func TestKeyRelayerAddress(t *testing.T) { | ||
| var ( | ||
| relayerAddress = "relayer_address" | ||
| ) | ||
|
|
||
| key := types.KeyRelayerAddress(relayerAddress) | ||
| require.Equal(t, string(key), fmt.Sprintf("%s/relayer_address", types.RelayerAddressKeyPrefix)) | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,32 +1,44 @@ | ||
| package types | ||
|
|
||
| import ( | ||
| // external library imports | ||
| sdk "github.com/cosmos/cosmos-sdk/types" | ||
| sdkerrors "github.com/cosmos/cosmos-sdk/types/errors" | ||
| ) | ||
|
|
||
| // msg types | ||
| const ( | ||
| TypeMsgRegisterCounterpartyAddress = "registerCounterpartyAddress" | ||
| ) | ||
|
|
||
| // NewMsgRegisterCounterpartyAddress creates a new instance of MsgRegisterCounterpartyAddress | ||
| func NewMsgRegisterCounterpartyAddress(address, counterpartyAddress string) *MsgRegisterCounterpartyAddress { | ||
| return &MsgRegisterCounterpartyAddress{ | ||
| Address: address, | ||
| CounterpartyAddress: counterpartyAddress, | ||
| } | ||
| } | ||
|
|
||
| // 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") | ||
| } | ||
|
|
||
| _, err = sdk.AccAddressFromBech32(msg.CounterpartyAddress) | ||
| if err != nil { | ||
| return sdkerrors.Wrap(err, "failed to convert msg.CounterpartyAddress into sdk.AccAddress") | ||
| } | ||
|
|
||
| return nil | ||
| } | ||
|
|
||
| // GetSigners implements sdk.Msg | ||
| func (msg MsgRegisterCounterpartyAddress) GetSigners() []sdk.AccAddress { | ||
| signer, err := sdk.AccAddressFromBech32(msg.Address) | ||
| if err != nil { | ||
| panic(err) | ||
| } | ||
| return []sdk.AccAddress{signer} | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,36 +1,36 @@ | ||
| package types | ||
|
|
||
| import ( | ||
| "testing" | ||
|
|
||
| sdk "github.com/cosmos/cosmos-sdk/types" | ||
| "github.com/stretchr/testify/require" | ||
| "github.com/tendermint/tendermint/crypto/secp256k1" | ||
| ) | ||
|
|
||
| var ( | ||
| validAddr = sdk.AccAddress(secp256k1.GenPrivKey().PubKey().Address()).String() | ||
| invalidAddr = "invalid_address" | ||
| ) | ||
|
|
||
| // TestMsgTransferValidation tests ValidateBasic for MsgTransfer | ||
| func TestMsgRegisterCountepartyAddressValidation(t *testing.T) { | ||
| testCases := []struct { | ||
| name string | ||
| msg *MsgRegisterCounterpartyAddress | ||
| expPass bool | ||
| }{ | ||
| {"validate with correct sdk.AccAddress", NewMsgRegisterCounterpartyAddress(validAddr, validAddr), true}, | ||
| {"validate with incorrect destination relayer address", NewMsgRegisterCounterpartyAddress(invalidAddr, validAddr), false}, | ||
| {"validate with incorrect counterparty relayer address", NewMsgRegisterCounterpartyAddress(validAddr, invalidAddr), false}, | ||
| } | ||
|
|
||
| for i, tc := range testCases { | ||
| err := tc.msg.ValidateBasic() | ||
| if tc.expPass { | ||
| require.NoError(t, err, "valid test case %d failed: %s", i, tc.name) | ||
| } else { | ||
| require.Error(t, err, "invalid test case %d passed: %s", i, tc.name) | ||
| } | ||
| } | ||
| } | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This looks to me like a global API, as I do not see the
channelEndbeing specified anywhere. But in a multi-chain setting, a relayer usually use the same wallet to relay from multiple chains. We cannot use the same counterparty address address for all channels that are relayed by the same relayer wallet, as the relayer's counterparty address for each chain is different.