chore(uibc): update quota -> outflows (#1865)

* chore(uibc): update quota -> outflows

* renames

* review

---------

Co-authored-by: Sai Kumar <17549398+gsk967@users.noreply.github.com>

Author: robert-zaremba

proto/umee/uibc/v1/genesis.proto

@@ -12,19 +12,19 @@ option (gogoproto.goproto_getters_all) = false;
 
 // GenesisState defines the uibc module's genesis state.
 message GenesisState {
-  Params   params                             = 1 [(gogoproto.nullable) = false];
-  repeated cosmos.base.v1beta1.DecCoin quotas = 2 [
+  Params   params                               = 1 [(gogoproto.nullable) = false];
+  repeated cosmos.base.v1beta1.DecCoin outflows = 2 [
     (gogoproto.castrepeated) = "github.com/cosmos/cosmos-sdk/types.DecCoins",
     (gogoproto.nullable)     = false
   ];
 
-  // total_outflow_sum defines the total outflow sum of ibc-transfer in USD
+  // total_outflow_sum defines the total outflow sum of ibc-transfer in USD.
   string total_outflow_sum = 3 [
     (cosmos_proto.scalar)  = "cosmos.Dec",
     (gogoproto.customtype) = "github.com/cosmos/cosmos-sdk/types.Dec",
     (gogoproto.nullable)   = false
   ];
-  // quota_expires defines quota expires for  ibc-transfer denom in seconds
+  // quota_expires defines quota expire time (as unix timestamp) for ibc-transfer denom.
   google.protobuf.Timestamp quota_expires = 4 [
     (gogoproto.nullable) = false,
     (gogoproto.stdtime)  = true,

proto/umee/uibc/v1/query.proto

@@ -17,10 +17,10 @@ service Query {
     option (google.api.http).get = "/umee/uibc/v1/params";
   }
 
-  // Quota queries the rate limits of ibc denoms.
-  // If denom is empty, returns quota for all tokens.
-  rpc Quota(QueryQuota) returns (QueryQuotaResponse) {
-    option (google.api.http).get = "/umee/uibc/v1/quota/{denom}";
+  // Outflow returns IBC denom outflows in the current epoch.
+  // If denom is empty, returns outflows of all tokens in the current epoch.
+  rpc Outflows(QueryOutflows) returns (QueryOutflowsResponse) {
+    option (google.api.http).get = "/umee/uibc/v1/outflows/{denom}";
   }
 }
 
@@ -34,14 +34,14 @@ message QueryParamsResponse {
   Params params = 1 [(gogoproto.nullable) = false];
 }
 
-// QueryQuota defines request type for query the quota of denoms
-message QueryQuota {
+// QueryOutflow defines request type for query the quota of denoms
+message QueryOutflows {
   string denom = 1;
 }
 
-// QueryQuotaResponse defines response type of Query/Quota
-message QueryQuotaResponse {
-  repeated cosmos.base.v1beta1.DecCoin quotas = 1 [
+// QueryOutflowResponse defines response type of Query/Outflow
+message QueryOutflowsResponse {
+  repeated cosmos.base.v1beta1.DecCoin outflows = 1 [
     (gogoproto.castrepeated) = "github.com/cosmos/cosmos-sdk/types.DecCoins",
     (gogoproto.nullable)     = false
   ];

x/uibc/client/cli/query.go

@@ -22,7 +22,7 @@ func GetQueryCmd() *cobra.Command {
 
 	cmd.AddCommand(
 		GetCmdQueryParams(),
-		GetQuota(),
+		GetOutflows(),
 	)
 
 	return cmd
@@ -52,24 +52,24 @@ func GetCmdQueryParams() *cobra.Command {
 	return cmd
 }
 
-// GetQuota returns cmd to get the quota of ibc denoms.
-func GetQuota() *cobra.Command {
+// GetOutflows returns cmd creator
+func GetOutflows() *cobra.Command {
 	cmd := &cobra.Command{
-		Use:   "quota [denom]",
+		Use:   "outflows [denom]",
 		Args:  cobra.MaximumNArgs(1),
-		Short: "Get the quota for ibc and native denoms",
+		Short: "Get the outflows for ibc and native denoms",
 		RunE: func(cmd *cobra.Command, args []string) error {
 			clientCtx, err := client.GetClientQueryContext(cmd)
 			if err != nil {
 				return err
 			}
 
 			queryClient := uibc.NewQueryClient(clientCtx)
-			queryReq := uibc.QueryQuota{}
+			queryReq := uibc.QueryOutflows{}
 			if len(args) > 0 {
 				queryReq.Denom = args[0]
 			}
-			resp, err := queryClient.Quota(cmd.Context(), &queryReq)
+			resp, err := queryClient.Outflows(cmd.Context(), &queryReq)
 			return cli.PrintOrErr(resp, err, clientCtx)
 		},
 	}

x/uibc/client/tests/cli_test.go

@@ -41,7 +41,7 @@ func TestIntegrationSuite(t *testing.T) {
 
 	var uibcGenState uibc.GenesisState
 	assert.NilError(t, cfg.Codec.UnmarshalJSON(cfg.GenesisState[uibc.ModuleName], &uibcGenState))
-	uibcGenState.Quotas = sdk.DecCoins{sdk.NewInt64DecCoin("uumee", 0)}
+	uibcGenState.Outflows = sdk.DecCoins{sdk.NewInt64DecCoin("uumee", 0)}
 	uibcGenState.TotalOutflowSum = sdk.NewDec(10)
 
 	bz, err = cfg.Codec.MarshalJSON(&uibcGenState)

x/uibc/client/tests/query_test.go

@@ -67,11 +67,11 @@ func (s *IntegrationTestSuite) TestGetQuota(t *testing.T) {
 
 	for _, tc := range tests {
 		t.Run(tc.name, func(t *testing.T) {
-			out, err := clitestutil.ExecTestCLICmd(clientCtx, cli.GetQuota(), tc.args)
+			out, err := clitestutil.ExecTestCLICmd(clientCtx, cli.GetOutflows(), tc.args)
 			if tc.errMsg == "" {
-				var res uibc.QueryQuotaResponse
+				var res uibc.QueryOutflowsResponse
 				assert.NilError(t, clientCtx.Codec.UnmarshalJSON(out.Bytes(), &res))
-				assert.Equal(t, len(res.Quotas), tc.noOfRecords)
+				assert.Equal(t, len(res.Outflows), tc.noOfRecords)
 			} else {
 				assert.ErrorContains(t, err, tc.errMsg)
 			}

x/uibc/genesis.go

@@ -7,18 +7,18 @@ import (
 	sdkerrors "github.com/cosmos/cosmos-sdk/types/errors"
 )
 
-func NewGenesisState(params Params, quotas sdk.DecCoins, outflowSum sdk.Dec) *GenesisState {
+func NewGenesisState(params Params, outflows sdk.DecCoins, outflowSum sdk.Dec) *GenesisState {
 	return &GenesisState{
 		Params:          params,
-		Quotas:          quotas,
+		Outflows:        outflows,
 		TotalOutflowSum: outflowSum,
 	}
 }
 
 func DefaultGenesisState() *GenesisState {
 	return &GenesisState{
 		Params:          DefaultParams(),
-		Quotas:          nil,
+		Outflows:        nil,
 		TotalOutflowSum: sdk.NewDec(0),
 	}
 }
@@ -29,11 +29,11 @@ func (gs GenesisState) Validate() error {
 		return err
 	}
 
-	for _, quota := range gs.Quotas {
-		if quota.Amount.IsNil() {
-			return sdkerrors.ErrInvalidRequest.Wrap("ibc denom quota must be defined")
+	for _, o := range gs.Outflows {
+		if o.Amount.IsNil() {
+			return sdkerrors.ErrInvalidRequest.Wrap("ibc denom outflow must be defined")
 		}
-		if err := quota.Validate(); err != nil {
+		if err := o.Validate(); err != nil {
 			return err
 		}
 	}

x/uibc/genesis.pb.go

@@ -16,7 +16,7 @@ func TestGenesisValidation(t *testing.T) {
 	err = gs.Validate()
 	assert.ErrorContains(t, err, "total outflow sum cannot be negative")
 
-	gs.Quotas = []sdk.DecCoin{{Denom: "umee", Amount: sdk.NewDec(-11123123)}}
+	gs.Outflows = []sdk.DecCoin{{Denom: "umee", Amount: sdk.NewDec(-11123123)}}
 	err = gs.Validate()
 	assert.ErrorContains(t, err, "amount cannot be negative")
 }

x/uibc/genesis_test.go

@@ -16,7 +16,7 @@ const (
 )
 
 var (
-	KeyPrefixDenomQuota    = []byte{0x01}
+	KeyPrefixDenomOutflows = []byte{0x01}
 	KeyPrefixTotalOutflows = []byte{0x02}
 	// KeyPrefixParams is the key to query all gov params
 	KeyPrefixParams = []byte{0x03}
@@ -26,5 +26,5 @@ var (
 
 func KeyTotalOutflows(ibcDenom string) []byte {
 	//  KeyPrefixDenomQuota| denom
-	return util.ConcatBytes(0, KeyPrefixDenomQuota, []byte(ibcDenom))
+	return util.ConcatBytes(0, KeyPrefixDenomOutflows, []byte(ibcDenom))
 }

x/uibc/keys.go

@@ -14,7 +14,7 @@ func BeginBlock(ctx sdk.Context, keeper keeper.Keeper) {
 
 	// reset quotas
 	if quotaExpires == nil || quotaExpires.Before(ctx.BlockTime()) {
-		util.Panic(keeper.ResetQuota(ctx))
+		util.Panic(keeper.ResetAllQuotas(ctx))
 	}
 }