fix: cli command to claim fees (#209)

cmd/tx.go

@@ -53,6 +53,8 @@ Most of these commands take a [path] argument. Make sure:
 		closeChannelCmd(a),
 		lineBreakCommand(),
 		registerCounterpartyCmd(a),
+		lineBreakCommand(),
+		claimFeesCmd(a),
 	)
 
 	return cmd
@@ -1173,3 +1175,47 @@ $ %s reg-cpt channel-1 cosmos1skjwj5whet0lpe65qaq4rpq03hjxlwd9nf39lk juno1g0ny48
 	}
 	return cmd
 }
+
+func claimFeesCmd(a *appState) *cobra.Command {
+	cmd := &cobra.Command{
+		Use:     "claim-fees src_chain dst_chain dst_connection_address src_network_id ",
+		Aliases: []string{"cf"},
+		Short:   "claim fees of src_chain on dst_chain. dst_chain.claimFees(src_network_id, src_relayer_address)",
+		Args:    withUsage(cobra.MatchAll(cobra.ExactArgs(4))),
+		Example: strings.TrimSpace(fmt.Sprintf(`
+$ %s claim-fees archway icon cx6f86ed848f9f0d03ba1220811d95d864c72da88c archway-1
+$ %s claim-fees icon archway archway1f68v03g2646z7wk9h9sy5uxhztajcrdgwvdrsftyp4448h067v0shn6l5w 0x1.icon`,
+			appName, appName)),
+		RunE: func(cmd *cobra.Command, args []string) error {
+
+			src, ok := a.config.Chains[args[0]]
+			if !ok {
+				return errChainNotFound(args[0])
+			}
+			dst, ok := a.config.Chains[args[1]]
+			if !ok {
+				return errChainNotFound(args[1])
+			}
+
+			keyName := src.ChainProvider.Key()
+			relayAddress, err := src.ChainProvider.ShowAddress(keyName)
+			if err != nil {
+				return errKeyDoesntExist(keyName)
+			}
+
+			connectionAdd := args[2]
+			srcNetworkId := args[3]
+
+			msg, err := dst.ChainProvider.MsgClaimFees(srcNetworkId, relayAddress)
+			if err != nil {
+				return err
+			}
+			_, success, err := dst.ChainProvider.SendCustomMessage(cmd.Context(), connectionAdd, msg, "")
+			if success {
+				fmt.Println("Fee claim request successful---")
+			}
+			return err
+		},
+	}
+	return cmd
+}

relayer/chains/cosmos/tx.go

@@ -1054,6 +1054,14 @@ func (cc *CosmosProvider) MsgSubmitMisbehaviour(clientID string, misbehaviour ib
 	return NewCosmosMessage(msg), nil
 }
 
+func (ap *CosmosProvider) SendCustomMessage(ctx context.Context, contract string, msg provider.RelayerMessage, memo string) (*provider.RelayerTxResponse, bool, error) {
+	panic("Not implemented for Cosmos")
+}
+
+func (cc *CosmosProvider) MsgClaimFees(dstChainID, dstAddress string) (provider.RelayerMessage, error) {
+	panic("Not implemented for Cosmos")
+}
+
 // RelayPacketFromSequence relays a packet with a given seq on src and returns recvPacket msgs, timeoutPacketmsgs and error
 func (cc *CosmosProvider) RelayPacketFromSequence(
 	ctx context.Context,

relayer/chains/icon/fees.go

@@ -0,0 +1,23 @@
+package icon
+
+import (
+	"github.com/cosmos/relayer/v2/relayer/chains/icon/types"
+	"github.com/cosmos/relayer/v2/relayer/provider"
+)
+
+type MsgClaimFees struct {
+	Nid     string         `json:"nid"`
+	Address types.HexBytes `json:"address"`
+}
+
+func (icp *IconProvider) MsgClaimFees(dstChainID, dstAddress string) (provider.RelayerMessage, error) {
+
+	params := MsgClaimFees{
+		Nid:     dstChainID,
+		Address: types.NewHexBytes([]byte(dstAddress)),
+	}
+
+	msg := icp.NewIconMessage(params, MethodClaimFees)
+
+	return msg, nil
+}

relayer/chains/icon/methods.go

@@ -42,4 +42,6 @@ const (
 	MethodTimeoutPacket  = "timeoutPacket"
 
 	MethodGetAllPorts = "getAllPorts"
+
+	MethodClaimFees = "claimFees"
 )

relayer/chains/icon/tx.go

@@ -692,7 +692,7 @@ func (icp *IconProvider) SendMessagesToMempool(
 
 	for _, msg := range msgs {
 		if msg != nil {
-			err := icp.SendIconTransaction(ctx, msg, asyncCtx, asyncCallback)
+			err := icp.SendIconTransaction(ctx, types.Address(icp.PCfg.IbcHandlerAddress), msg, asyncCtx, asyncCallback)
 			if err != nil {
 				icp.log.Warn("Send Icon Transaction Error", zap.String("method", msg.Type()), zap.Error(err))
 				continue
@@ -703,8 +703,73 @@ func (icp *IconProvider) SendMessagesToMempool(
 	return nil
 }
 
+func (icp *IconProvider) SendCustomMessage(ctx context.Context, contract string, msg provider.RelayerMessage, memo string) (*provider.RelayerTxResponse, bool, error) {
+	var (
+		rlyResp     *provider.RelayerTxResponse
+		callbackErr error
+		wg          sync.WaitGroup
+	)
+
+	callback := func(rtr *provider.RelayerTxResponse, err error) {
+		rlyResp = rtr
+		callbackErr = err
+		wg.Done()
+	}
+
+	wg.Add(1)
+	if err := retry.Do(func() error {
+		return icp.SendCustomMessageToMempool(ctx, types.Address(contract), msg, memo, ctx, callback)
+	}, retry.Context(ctx), rtyAtt, rtyDel, rtyErr, retry.OnRetry(func(n uint, err error) {
+		icp.log.Info(
+			"Error building or broadcasting transaction",
+			zap.String("chain_id", icp.PCfg.ChainID),
+			zap.Uint("attempt", n+1),
+			zap.Uint("max_attempts", rtyAttNum),
+			zap.Error(err),
+		)
+	})); err != nil {
+		return nil, false, err
+	}
+
+	wg.Wait()
+
+	if callbackErr != nil {
+		return rlyResp, false, callbackErr
+	}
+
+	if rlyResp.Code != 1 {
+		return rlyResp, false, fmt.Errorf("transaction failed with code: %d", rlyResp.Code)
+	}
+
+	return rlyResp, true, callbackErr
+
+}
+
+func (icp *IconProvider) SendCustomMessageToMempool(
+	ctx context.Context,
+	contract types.Address,
+	msg provider.RelayerMessage,
+	memo string,
+	asyncCtx context.Context,
+	asyncCallback func(*provider.RelayerTxResponse, error),
+) error {
+	icp.txMu.Lock()
+	defer icp.txMu.Unlock()
+
+	if msg != nil {
+		err := icp.SendIconTransaction(ctx, contract, msg, asyncCtx, asyncCallback)
+		if err != nil {
+			icp.log.Warn("Send Icon Transaction Error", zap.String("method", msg.Type()), zap.Error(err))
+			return err
+		}
+	}
+
+	return nil
+}
+
 func (icp *IconProvider) SendIconTransaction(
 	ctx context.Context,
+	contract types.Address,
 	msg provider.RelayerMessage,
 	asyncCtx context.Context,
 	asyncCallback func(*provider.RelayerTxResponse, error)) error {
@@ -717,7 +782,7 @@ func (icp *IconProvider) SendIconTransaction(
 	txParamEst := &types.TransactionParamForEstimate{
 		Version:     types.NewHexInt(types.JsonrpcApiVersion),
 		FromAddress: types.Address(wallet.Address().String()),
-		ToAddress:   types.Address(icp.PCfg.IbcHandlerAddress),
+		ToAddress:   contract,
 		NetworkID:   types.NewHexInt(icp.PCfg.ICONNetworkID),
 		DataType:    "call",
 		Data: types.CallData{
@@ -739,7 +804,7 @@ func (icp *IconProvider) SendIconTransaction(
 	txParam := &types.TransactionParam{
 		Version:     types.NewHexInt(types.JsonrpcApiVersion),
 		FromAddress: types.Address(wallet.Address().String()),
-		ToAddress:   types.Address(icp.PCfg.IbcHandlerAddress),
+		ToAddress:   contract,
 		NetworkID:   types.NewHexInt(icp.PCfg.ICONNetworkID),
 		StepLimit:   stepLimit,
 		DataType:    "call",

relayer/chains/penumbra/tx.go

@@ -434,6 +434,14 @@ func parseEventsFromTxResponse(resp *sdk.TxResponse) []provider.RelayerEvent {
 	return events
 }
 
+func (cc *PenumbraProvider) MsgClaimFees(dstChainID, dstAddress string) (provider.RelayerMessage, error) {
+	panic("Not implemented for Penumbra")
+}
+
+func (ap *PenumbraProvider) SendCustomMessage(ctx context.Context, contract string, msg provider.RelayerMessage, memo string) (*provider.RelayerTxResponse, bool, error) {
+	panic("Not implemented for Penumbra")
+}
+
 // CreateClient creates an sdk.Msg to update the client on src with consensus state from dst
 func (cc *PenumbraProvider) MsgCreateClient(clientState ibcexported.ClientState, consensusState ibcexported.ConsensusState) (provider.RelayerMessage, error) {
 	signer, err := cc.Address()

relayer/chains/wasm/consts.go

@@ -23,6 +23,8 @@ const (
 	MethodGetNextClientSequence     = "get_next_client_sequence"
 	MethodGetNextChannelSequence    = "get_next_channel_sequence"
 	MethodGetNextConnectionSequence = "get_next_connection_sequence"
+
+	MethodClaimFees = "claim_fees"
 )
 
 const (

relayer/chains/wasm/fees.go

@@ -0,0 +1,35 @@
+package wasm
+
+import (
+	"encoding/json"
+
+	"github.com/cosmos/relayer/v2/relayer/provider"
+)
+
+type ClaimFeesMsg struct {
+	ClaimFees struct {
+		Nid     string `json:"nid"`
+		Address string `json:"address"`
+	} `json:"claim_fees"`
+}
+
+func (c *ClaimFeesMsg) Type() string {
+	return "claim_fees"
+}
+
+func (c *ClaimFeesMsg) MsgBytes() ([]byte, error) {
+	return json.Marshal(c)
+}
+
+func (ap *WasmProvider) MsgClaimFees(dstChainID, dstAddress string) (provider.RelayerMessage, error) {
+	params := &ClaimFeesMsg{
+		ClaimFees: struct {
+			Nid     string "json:\"nid\""
+			Address string "json:\"address\""
+		}{
+			Nid:     dstChainID,
+			Address: dstAddress,
+		},
+	}
+	return params, nil
+}

relayer/chains/wasm/tx.go

@@ -14,6 +14,7 @@ import (
 	"sync"
 	"time"
 
+	wasmtypes "github.com/CosmWasm/wasmd/x/wasm/types"
 	"github.com/cosmos/cosmos-sdk/codec/types"
 	codectypes "github.com/cosmos/cosmos-sdk/codec/types"
 
@@ -708,6 +709,101 @@ func (ap *WasmProvider) SendMessages(ctx context.Context, msgs []provider.Relaye
 	return rlyResp, true, callbackErr
 }
 
+func (ap *WasmProvider) SendCustomMessage(ctx context.Context, contract string, msg provider.RelayerMessage, memo string) (*provider.RelayerTxResponse, bool, error) {
+	var (
+		rlyResp     *provider.RelayerTxResponse
+		callbackErr error
+		wg          sync.WaitGroup
+	)
+
+	callback := func(rtr *provider.RelayerTxResponse, err error) {
+		callbackErr = err
+
+		if err != nil {
+			wg.Done()
+			return
+		}
+
+		for i, e := range rtr.Events {
+			if startsWithWasm(e.EventType) {
+				rtr.Events[i].EventType = findEventType(e.EventType)
+			}
+		}
+		rlyResp = rtr
+		wg.Done()
+	}
+
+	wg.Add(1)
+
+	if err := retry.Do(func() error {
+		return ap.SendTransactionCosmWasm(ctx, contract, msg, ctx, callback)
+	}, retry.Context(ctx), rtyAtt, rtyDel, rtyErr, retry.OnRetry(func(n uint, err error) {
+		ap.log.Info(
+			"Error building or broadcasting transaction",
+			zap.String("chain_id", ap.PCfg.ChainID),
+			zap.Uint("attempt", n+1),
+			zap.Uint("max_attempts", rtyAttNum),
+			zap.Error(err),
+		)
+	})); err != nil {
+		return nil, false, err
+	}
+
+	wg.Wait()
+
+	if callbackErr != nil {
+		return rlyResp, false, callbackErr
+	}
+
+	if rlyResp.Code != 0 {
+		return rlyResp, false, fmt.Errorf("transaction failed with code: %d", rlyResp.Code)
+	}
+
+	return rlyResp, true, callbackErr
+
+}
+
+func (ap *WasmProvider) SendTransactionCosmWasm(
+	ctx context.Context,
+	contract string,
+	msg provider.RelayerMessage,
+
+	asyncCtx context.Context,
+	asyncCallback func(*provider.RelayerTxResponse, error),
+) error {
+	ap.txMu.Lock()
+	defer ap.txMu.Unlock()
+
+	cliCtx := ap.ClientContext()
+	factory, err := ap.PrepareFactory(ap.TxFactory())
+	if err != nil {
+		return err
+	}
+	msgByte, err := msg.MsgBytes()
+	if err != nil {
+		return err
+	}
+
+	signer, _ := ap.Address()
+	params := &wasmtypes.MsgExecuteContract{
+		Sender:   signer,
+		Contract: contract,
+		Msg:      msgByte,
+	}
+
+	txBytes, sequence, err := ap.buildMessages(cliCtx, factory, params)
+	if err != nil {
+		return err
+	}
+	if err := ap.BroadcastTx(cliCtx, txBytes, []provider.RelayerMessage{msg}, asyncCtx, defaultBroadcastWaitTimeout, asyncCallback, false); err != nil {
+		if strings.Contains(err.Error(), sdkerrors.ErrWrongSequence.Error()) {
+			ap.handleAccountSequenceMismatchError(err)
+		}
+	}
+	ap.updateNextAccountSequence(sequence + 1)
+	return nil
+}
+
 func (ap *WasmProvider) SendMessagesToMempool(
 	ctx context.Context,
 	msgs []provider.RelayerMessage,

relayer/provider/provider.go

@@ -235,6 +235,8 @@ type ChainProvider interface {
 
 	Init(ctx context.Context) error
 
+	MsgClaimFees(dstChainID string, dstAddress string) (RelayerMessage, error)
+
 	// [Begin] Client IBC message assembly functions
 	NewClientState(dstChainID string, dstIBCHeader IBCHeader, dstTrustingPeriod, dstUbdPeriod time.Duration, allowUpdateAfterExpiry, allowUpdateAfterMisbehaviour bool) (ibcexported.ClientState, error)
 
@@ -391,6 +393,7 @@ type ChainProvider interface {
 	AcknowledgementFromSequence(ctx context.Context, dst ChainProvider, dsth, seq uint64, dstChanID, dstPortID, srcChanID, srcPortID string) (RelayerMessage, error)
 
 	SendMessage(ctx context.Context, msg RelayerMessage, memo string) (*RelayerTxResponse, bool, error)
+	SendCustomMessage(ctx context.Context, contract string, msg RelayerMessage, memo string) (*RelayerTxResponse, bool, error)
 	SendMessages(ctx context.Context, msgs []RelayerMessage, memo string) (*RelayerTxResponse, bool, error)
 	SendMessagesToMempool(
 		ctx context.Context,