feegrant PR (#1140)

* Feegrant support

* Test case for address caching bugfix

* Bugfix for SDK account prefix. Feegrant test passing.

* Mutex for signer expanded to include feegrantees

* Cleaned up feegrant test case

* Cleaned up feegrant test case

* Cleaned up feegrant test case

* check round robin feegrant behavior by counting number of TXs each grantee signer

* module updates from merge

* v0.47.0 with bech32 address cache fix

* Move SetAddrCacheEnabled to NewRelayer func for full coverage

* Do not hardcode chain id in feegrant test case

* Wait more blocks for ibc transfers

* disable cosmos SDK bech32 address cache for rly start command

* Fix sloppy comments/remove unnecessary code

* Faster acc caching unit test

* Penumbra provider feegrant support

* Merge upstream

* Fixed merge issue where feegrant config wasn't being written to file

* feegrant patch for cosmos-sdk v0.47.1

* merge from main

* Update to cosmos-sdk v0.47.2

* Increase test case blocks to wait

* Fixed data race by moving test parallelization after relayer wallet build

* Increased TestScenarioICAChannelClose timeout height

* Cleanup feegrant test case

* Fixed race condition in sequence guard w/ mutex

* Automatic retry for TX lookup in feegrant test case

---------

Co-authored-by: Andrew Gouin <andrew@gouin.io>

cmd/chains.go

@@ -39,6 +39,7 @@ func chainsCmd(a *appState) *cobra.Command {
 		chainsShowCmd(a),
 		chainsAddrCmd(a),
 		chainsAddDirCmd(a),
+		cmdChainsConfigure(a),
 	)
 
 	return cmd
@@ -144,6 +145,19 @@ $ %s ch d ibc-0`, appName, appName)),
 	return cmd
 }
 
+func cmdChainsConfigure(a *appState) *cobra.Command {
+	cmd := &cobra.Command{
+		Use:   "configure",
+		Short: "manage local chain configurations",
+	}
+
+	cmd.AddCommand(
+		feegrantConfigureBaseCmd(a),
+	)
+
+	return cmd
+}
+
 func chainsRegistryList(a *appState) *cobra.Command {
 	cmd := &cobra.Command{
 		Use:     "registry-list",

cmd/feegrant.go

@@ -0,0 +1,197 @@
+package cmd
+
+import (
+	"errors"
+	"fmt"
+
+	"github.com/cosmos/relayer/v2/relayer/chains/cosmos"
+	"github.com/spf13/cobra"
+)
+
+// feegrantConfigureCmd returns the fee grant configuration commands for this module
+func feegrantConfigureBaseCmd(a *appState) *cobra.Command {
+	cmd := &cobra.Command{
+		Use:   "feegrant",
+		Short: "Configure the client to use round-robin feegranted accounts when sending TXs",
+		Long:  "Use round-robin feegranted accounts when sending TXs. Useful for relayers and applications where sequencing is important",
+	}
+
+	cmd.AddCommand(
+		feegrantConfigureBasicCmd(a),
+	)
+
+	return cmd
+}
+
+func feegrantConfigureBasicCmd(a *appState) *cobra.Command {
+	var numGrantees int
+	var update bool
+	var updateGrantees bool
+	var grantees []string
+
+	cmd := &cobra.Command{
+		Use:   "basicallowance [chain-name] [granter] --num-grantees [int] --overwrite-granter --overwrite-grantees",
+		Short: "feegrants for the given chain and granter (if granter is unspecified, use the default key)",
+		Long:  "feegrants for the given chain. 10 grantees by default, all with an unrestricted BasicAllowance.",
+		Args:  cobra.MinimumNArgs(1),
+		RunE: func(cmd *cobra.Command, args []string) error {
+			chain := args[0]
+			cosmosChain, ok := a.config.Chains[chain]
+			if !ok {
+				return errChainNotFound(args[0])
+			}
+
+			prov, ok := cosmosChain.ChainProvider.(*cosmos.CosmosProvider)
+			if !ok {
+				return errors.New("only CosmosProvider can be feegranted")
+			}
+
+			granterKeyOrAddr := ""
+
+			if len(args) > 1 {
+				granterKeyOrAddr = args[1]
+			} else if prov.PCfg.FeeGrants != nil {
+				granterKeyOrAddr = prov.PCfg.FeeGrants.GranterKey
+			} else {
+				granterKeyOrAddr = prov.PCfg.Key
+			}
+
+			granterKey, err := prov.KeyFromKeyOrAddress(granterKeyOrAddr)
+			if err != nil {
+				return fmt.Errorf("could not get granter key from '%s'", granterKeyOrAddr)
+			}
+
+			if prov.PCfg.FeeGrants != nil && granterKey != prov.PCfg.FeeGrants.GranterKey && !update {
+				return fmt.Errorf("you specified granter '%s' which is different than configured feegranter '%s', but you did not specify the --overwrite-granter flag", granterKeyOrAddr, prov.PCfg.FeeGrants.GranterKey)
+			} else if prov.PCfg.FeeGrants != nil && granterKey != prov.PCfg.FeeGrants.GranterKey && update {
+				cfgErr := a.performConfigLockingOperation(cmd.Context(), func() error {
+					prov.PCfg.FeeGrants.GranterKey = granterKey
+					return nil
+				})
+				cobra.CheckErr(cfgErr)
+			}
+
+			if prov.PCfg.FeeGrants == nil || updateGrantees || len(grantees) > 0 {
+				var feegrantErr error
+
+				//No list of grantees was provided, so we will use the default naming convention "grantee1, ... granteeN"
+				if grantees == nil {
+					feegrantErr = prov.ConfigureFeegrants(numGrantees, granterKey)
+				} else {
+					feegrantErr = prov.ConfigureWithGrantees(grantees, granterKey)
+				}
+
+				if feegrantErr != nil {
+					return feegrantErr
+				}
+
+				cfgErr := a.performConfigLockingOperation(cmd.Context(), func() error {
+					chain := a.config.Chains[chain]
+					oldProv := chain.ChainProvider.(*cosmos.CosmosProvider)
+					oldProv.PCfg.FeeGrants = prov.PCfg.FeeGrants
+					return nil
+				})
+				cobra.CheckErr(cfgErr)
+			}
+
+			memo, err := cmd.Flags().GetString(flagMemo)
+			if err != nil {
+				return err
+			}
+
+			ctx := cmd.Context()
+			_, err = prov.EnsureBasicGrants(ctx, memo)
+			if err != nil {
+				return fmt.Errorf("error writing grants on chain: '%s'", err.Error())
+			}
+
+			//Get latest height from the chain, mark feegrant configuration as verified up to that height.
+			//This means we've verified feegranting is enabled on-chain and TXs can be sent with a feegranter.
+			if prov.PCfg.FeeGrants != nil {
+				fmt.Printf("Querying latest chain height to mark FeeGrant height... \n")
+				h, err := prov.QueryLatestHeight(ctx)
+				cobra.CheckErr(err)
+
+				cfgErr := a.performConfigLockingOperation(cmd.Context(), func() error {
+					chain := a.config.Chains[chain]
+					oldProv := chain.ChainProvider.(*cosmos.CosmosProvider)
+					oldProv.PCfg.FeeGrants = prov.PCfg.FeeGrants
+					oldProv.PCfg.FeeGrants.BlockHeightVerified = h
+					fmt.Printf("Feegrant chain height marked: %d\n", h)
+					return nil
+				})
+				cobra.CheckErr(cfgErr)
+			}
+
+			return nil
+		},
+	}
+	cmd.Flags().BoolVar(&update, "overwrite-granter", false, "allow overwriting the existing granter")
+	cmd.Flags().BoolVar(&updateGrantees, "overwrite-grantees", false, "allow overwriting existing grantees")
+	cmd.Flags().IntVar(&numGrantees, "num-grantees", 10, "number of grantees that will be feegranted with basic allowances")
+	cmd.Flags().StringSliceVar(&grantees, "grantees", []string{}, "comma separated list of grantee key names (keys are created if they do not exist)")
+	cmd.MarkFlagsMutuallyExclusive("num-grantees", "grantees")
+
+	memoFlag(a.viper, cmd)
+	return cmd
+}
+
+func feegrantBasicGrantsCmd(a *appState) *cobra.Command {
+	cmd := &cobra.Command{
+		Use:   "basic chain-name [granter]",
+		Short: "query the grants for an account (if none is specified, the default account is returned)",
+		Args:  cobra.RangeArgs(1, 2),
+		RunE: func(cmd *cobra.Command, args []string) error {
+			chain := args[0]
+			cosmosChain, ok := a.config.Chains[chain]
+			if !ok {
+				return errChainNotFound(args[0])
+			}
+
+			prov, ok := cosmosChain.ChainProvider.(*cosmos.CosmosProvider)
+			if !ok {
+				return errors.New("only CosmosProvider can be feegranted")
+			}
+
+			// TODO fix pagination
+			// pageReq, err := client.ReadPageRequest(cmd.Flags())
+			// if err != nil {
+			// 	return err
+			// }
+
+			//TODO fix height
+			// height, err := lensCmd.ReadHeight(cmd.Flags())
+			// if err != nil {
+			// 	return err
+			// }
+
+			keyNameOrAddress := ""
+			if len(args) == 0 {
+				keyNameOrAddress = prov.PCfg.Key
+			} else {
+				keyNameOrAddress = args[0]
+			}
+
+			granterAcc, err := prov.AccountFromKeyOrAddress(keyNameOrAddress)
+			if err != nil {
+				fmt.Printf("Error retrieving account from key '%s'\n", keyNameOrAddress)
+				return err
+			}
+			granterAddr := prov.MustEncodeAccAddr(granterAcc)
+
+			res, err := prov.QueryFeegrantsByGranter(granterAddr, nil)
+			if err != nil {
+				return err
+			}
+
+			for _, grant := range res {
+				allowance, e := prov.Sprint(grant.Allowance)
+				cobra.CheckErr(e)
+				fmt.Printf("Granter: %s, Grantee: %s, Allowance: %s\n", grant.Granter, grant.Grantee, allowance)
+			}
+
+			return nil
+		},
+	}
+	return paginationFlags(a.viper, cmd, "feegrant")
+}

cmd/query.go

@@ -47,6 +47,21 @@ func queryCmd(a *appState) *cobra.Command {
 		lineBreakCommand(),
 		queryIBCDenoms(a),
 		queryBaseDenomFromIBCDenom(a),
+		feegrantQueryCmd(a),
+	)
+
+	return cmd
+}
+
+// feegrantQueryCmd returns the fee grant query commands for this module
+func feegrantQueryCmd(a *appState) *cobra.Command {
+	cmd := &cobra.Command{
+		Use:   "feegrant",
+		Short: "Querying commands for the feegrant module [currently BasicAllowance only]",
+	}
+
+	cmd.AddCommand(
+		feegrantBasicGrantsCmd(a),
 	)
 
 	return cmd