feat: #258 Register Counterparty Address #376
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
| 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 since destination chain must send back relayer's source address (counterparty address) in acknowledgement | ||
| // This function may be called more than once by relayer, in which case, latest counterparty address is always used. | ||
|
There was a problem hiding this comment. @AdityaSripal I took this to mean that the address can be overwritten by calling |
||
| func (k Keeper) RegisterCounterpartyAddress(goCtx context.Context, msg *types.MsgRegisterCounterpartyAddress) (*types.MsgRegisterCounterpartyAddressResponse, error) { | ||
| ctx := sdk.UnwrapSDKContext(goCtx) | ||
|
|
||
| k.SetCounterpartyAddress( | ||
| ctx, msg.Address, msg.CounterpartyAddress, | ||
| ) | ||
|
|
||
| k.Logger(ctx).Info("Registering counterparty address for relayer with", "Source address:", msg.Address, "With counterparty address:", msg.CounterpartyAddress) | ||
seantking marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| 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,25 @@ | ||
| package types | ||
|
|
||
| import fmt "fmt" | ||
seantking marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| 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 | ||
| ) | ||
|
|
||
| // Key for relayer source address -> counteryparty address mapping | ||
| func KeySourceAddress(sourceAddress string) []byte { | ||
| return []byte(fmt.Sprintf("relayerSourceAddress/%s", sourceAddress)) | ||
|
There was a problem hiding this comment. It might be useful to make |
||
| } | ||
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,40 @@ | ||
| package types | ||
|
|
||
| import ( | ||
| sdk "github.com/cosmos/cosmos-sdk/types" | ||
| sdkerrors "github.com/cosmos/cosmos-sdk/types/errors" | ||
| ) | ||
|
|
||
| // msg types | ||
| const ( | ||
| TypeMsgRegisterCounterPartyAddress = "registerCounterPartyAddress" | ||
| ) | ||
|
|
||
| // NewMsgRegisterCounterPartyAddress | ||
|
|
||
| func NewMsgRegisterCounterpartyAddress(sourceAddress, counterpartyAddress string) *MsgRegisterCounterpartyAddress { | ||
colin-axner marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| return &MsgRegisterCounterpartyAddress{Address: sourceAddress, CounterpartyAddress: counterpartyAddress} | ||
seantking marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| } | ||
|
|
||
| // ValidateBasic performs a basic check of the Msg fields | ||
| func (msg MsgRegisterCounterpartyAddress) ValidateBasic() error { | ||
| _, err := sdk.AccAddressFromBech32(msg.Address) | ||
| if err != nil { | ||
| return sdkerrors.Wrap(err, "Incorrect source relayer address") | ||
|
There was a problem hiding this comment. nit: golang error string best practice There was a problem hiding this comment. Maybe the error message should indicate it failed to convert to SDK bech32 addr? |
||
| } | ||
|
|
||
| _, err = sdk.AccAddressFromBech32(msg.CounterpartyAddress) | ||
| if err != nil { | ||
| return sdkerrors.Wrap(err, "Incorrect counterparty relayer address") | ||
| } | ||
|
|
||
| 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,38 @@ | ||
| package types | ||
|
|
||
| import ( | ||
| "testing" | ||
|
|
||
| sdk "github.com/cosmos/cosmos-sdk/types" | ||
| "github.com/stretchr/testify/require" | ||
| "github.com/tendermint/tendermint/crypto/secp256k1" | ||
| ) | ||
|
|
||
| var ( | ||
| validAadr1 = sdk.AccAddress(secp256k1.GenPrivKey().PubKey().Address()).String() | ||
|
There was a problem hiding this comment.
I'm also fine with just a |
||
| validAadr2 = sdk.AccAddress(secp256k1.GenPrivKey().PubKey().Address()).String() | ||
| invalidAadr1 = "invalid_address" | ||
| invalidAadr2 = "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(validAadr1, validAadr2), true}, | ||
| {"validate with incorrect source relayer address", NewMsgRegisterCounterpartyAddress(invalidAadr1, validAadr2), false}, | ||
| {"validate with incorrect counterparty source relayer address", NewMsgRegisterCounterpartyAddress(validAadr1, invalidAadr2), 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.
for clarity?