feat!: ibc transfer quota

app/app.go

@@ -127,6 +127,10 @@ import (
 	"github.com/umee-network/umee/v3/x/oracle"
 	oraclekeeper "github.com/umee-network/umee/v3/x/oracle/keeper"
 	oracletypes "github.com/umee-network/umee/v3/x/oracle/types"
+
+	ibcratelimit "github.com/umee-network/umee/v3/x/ibc-rate-limit"
+	ibcratelimitkeeper "github.com/umee-network/umee/v3/x/ibc-rate-limit/keeper"
+	ibcratelimittypes "github.com/umee-network/umee/v3/x/ibc-rate-limit/types"
 )
 
 var (
@@ -172,6 +176,7 @@ func init() {
 		leverage.AppModuleBasic{},
 		oracle.AppModuleBasic{},
 		bech32ibc.AppModuleBasic{},
+		ibcratelimit.AppModuleBasic{},
 	}
 
 	if Experimental {
@@ -189,10 +194,11 @@ func init() {
 		govtypes.ModuleName:            {authtypes.Burner},
 		nft.ModuleName:                 nil,
 
-		ibctransfertypes.ModuleName: {authtypes.Minter, authtypes.Burner},
-		gravitytypes.ModuleName:     {authtypes.Minter, authtypes.Burner},
-		leveragetypes.ModuleName:    {authtypes.Minter, authtypes.Burner},
-		oracletypes.ModuleName:      nil,
+		ibctransfertypes.ModuleName:  {authtypes.Minter, authtypes.Burner},
+		gravitytypes.ModuleName:      {authtypes.Minter, authtypes.Burner},
+		leveragetypes.ModuleName:     {authtypes.Minter, authtypes.Burner},
+		oracletypes.ModuleName:       nil,
+		ibcratelimittypes.ModuleName: nil,
 	}
 
 	if Experimental {
@@ -242,6 +248,7 @@ type UmeeApp struct {
 	LeverageKeeper     leveragekeeper.Keeper
 	OracleKeeper       oraclekeeper.Keeper
 	bech32IbcKeeper    bech32ibckeeper.Keeper
+	ibcRateLimitKeeper ibcratelimitkeeper.Keeper
 
 	// make scoped keepers public for testing purposes
 	ScopedIBCKeeper      capabilitykeeper.ScopedKeeper
@@ -303,7 +310,7 @@ func New(
 		authzkeeper.StoreKey, nftkeeper.StoreKey, group.StoreKey,
 		ibchost.StoreKey, ibctransfertypes.StoreKey,
 		gravitytypes.StoreKey,
-		leveragetypes.StoreKey, oracletypes.StoreKey, bech32ibctypes.StoreKey,
+		leveragetypes.StoreKey, oracletypes.StoreKey, bech32ibctypes.StoreKey, ibcratelimittypes.StoreKey,
 	}
 	if Experimental {
 		storeKeys = append(storeKeys, wasm.StoreKey)
@@ -494,13 +501,35 @@ func New(
 	// If evidence needs to be handled for the app, set routes in router here and seal
 	app.EvidenceKeeper = *evidenceKeeper
 
+	app.ibcRateLimitKeeper = ibcratelimitkeeper.NewKeeper(
+		appCodec,
+		keys[ibcratelimittypes.StoreKey], app.GetSubspace(ibcratelimittypes.ModuleName),
+		app.IBCKeeper.ChannelKeeper,
+		authtypes.NewModuleAddress(govtypes.ModuleName).String(),
+	)
+
+	app.IBCKeeper = ibckeeper.NewKeeper(
+		appCodec,
+		keys[ibchost.StoreKey],
+		app.GetSubspace(ibchost.ModuleName),
+		*app.StakingKeeper,
+		app.UpgradeKeeper,
+		app.ScopedIBCKeeper,
+	)
+
+	// Create IBC Router
+	// create static IBC router, add transfer route, then set and seal it
+	ibcRouter := ibcporttypes.NewRouter()
+
+	// Middleware Stacks
+
 	// Create an original ICS-20 transfer keeper and AppModule and then use it to
 	// created an Umee wrapped ICS-20 transfer keeper and AppModule.
 	ibcTransferKeeper := ibctransferkeeper.NewKeeper(
 		appCodec,
 		keys[ibctransfertypes.StoreKey],
 		app.GetSubspace(ibctransfertypes.ModuleName),
-		app.IBCKeeper.ChannelKeeper,
+		app.ibcRateLimitKeeper, // ISC4 Wrapper: IBC Rate Limit middleware
 		app.IBCKeeper.ChannelKeeper,
 		&app.IBCKeeper.PortKeeper,
 		app.AccountKeeper,
@@ -509,14 +538,28 @@ func New(
 	)
 
 	app.UIBCTransferKeeper = uibctransferkeeper.New(ibcTransferKeeper, app.BankKeeper)
-	ibcTransferModule := ibctransfer.NewAppModule(ibcTransferKeeper)
-	uibcTransferIBCModule := uibctransfer.NewIBCModule(
-		ibctransfer.NewIBCModule(ibcTransferKeeper), app.UIBCTransferKeeper,
+
+	// Create Transfer Stack
+	// SendPacket, since it is originating from the application to core IBC:
+	// transferKeeper.SendPacket -> ibcratelimit.SendPacket -> channel.SendPacket
+
+	// RecvPacket, message that originates from core IBC and goes down to app, the flow is the other way
+	// channel.RecvPacket -> ibcratelimit.OnRecvPacket -> transfer.OnRecvPacket
+
+	// transfer stack contains (from top to bottom):
+	// - Umee IBC Transfer
+	// - IBC Rate Limit Middleware
+
+	// create IBC module from bottom to top of stack
+	var transferStack ibcporttypes.IBCModule
+	transferStack = uibctransfer.NewIBCModule(
+		ibctransfer.NewIBCModule(ibcTransferKeeper),
+		app.UIBCTransferKeeper,
 	)
+	transferStack = ibcratelimit.NewIBCMiddleware(transferStack, app.ibcRateLimitKeeper)
 
-	// create static IBC router, add transfer route, then set and seal it
-	ibcRouter := ibcporttypes.NewRouter()
-	ibcRouter.AddRoute(ibctransfertypes.ModuleName, uibcTransferIBCModule)
+	ibcRouter.AddRoute(ibctransfertypes.ModuleName, transferStack)
+	// Add transfer stack to IBC Router
 
 	ibcRouter.AddRoute(wasm.ModuleName, wasm.NewIBCHandler(app.WasmKeeper, app.IBCKeeper.ChannelKeeper))
 	app.IBCKeeper.SetRouter(ibcRouter)
@@ -595,11 +638,12 @@ func New(
 		groupmodule.NewAppModule(appCodec, app.GroupKeeper, app.AccountKeeper, app.BankKeeper, app.interfaceRegistry),
 		nftmodule.NewAppModule(appCodec, app.NFTKeeper, app.AccountKeeper, app.BankKeeper, app.interfaceRegistry),
 
-		ibcTransferModule,
+		ibctransfer.NewAppModule(ibcTransferKeeper),
 		gravity.NewAppModule(app.GravityKeeper, app.BankKeeper),
 		leverage.NewAppModule(appCodec, app.LeverageKeeper, app.AccountKeeper, app.BankKeeper),
 		oracle.NewAppModule(appCodec, app.OracleKeeper, app.AccountKeeper, app.BankKeeper),
 		bech32ibc.NewAppModule(appCodec, app.bech32IbcKeeper),
+		ibcratelimit.NewAppModule(appCodec, app.ibcRateLimitKeeper),
 	}
 	if Experimental {
 		appModules = append(appModules,
@@ -626,6 +670,7 @@ func New(
 		oracletypes.ModuleName,
 		gravitytypes.ModuleName,
 		bech32ibctypes.ModuleName,
+		ibcratelimittypes.ModuleName,
 	}
 	endBlockers := []string{
 		crisistypes.ModuleName,
@@ -641,6 +686,7 @@ func New(
 		leveragetypes.ModuleName,
 		gravitytypes.ModuleName,
 		bech32ibctypes.ModuleName,
+		ibcratelimittypes.ModuleName,
 	}
 
 	// NOTE: The genutils module must occur after staking so that pools are
@@ -661,6 +707,7 @@ func New(
 		leveragetypes.ModuleName,
 		gravitytypes.ModuleName,
 		bech32ibctypes.ModuleName,
+		ibcratelimittypes.ModuleName,
 	}
 	orderMigrations := []string{
 		capabilitytypes.ModuleName, authtypes.ModuleName, banktypes.ModuleName, distrtypes.ModuleName,
@@ -674,7 +721,7 @@ func New(
 		leveragetypes.ModuleName,
 		gravitytypes.ModuleName,
 		bech32ibctypes.ModuleName,
-	}
+		ibcratelimittypes.ModuleName}
 
 	if Experimental {
 		beginBlockers = append(beginBlockers, wasm.ModuleName)
@@ -975,6 +1022,7 @@ func initParamsKeeper(
 	paramsKeeper.Subspace(ibchost.ModuleName)
 	// paramsKeeper.Subspace(icacontrollertypes.SubModuleName)
 	// paramsKeeper.Subspace(icahosttypes.SubModuleName)
+	paramsKeeper.Subspace(ibcratelimittypes.ModuleName)
 	paramsKeeper.Subspace(gravitytypes.ModuleName)
 	paramsKeeper.Subspace(leveragetypes.ModuleName)
 	paramsKeeper.Subspace(oracletypes.ModuleName)

proto/umee/ibc_rate_limit/v1beta1/genesis.proto

@@ -0,0 +1,13 @@
+syntax = "proto3";
+package umee.ibcratelimit.v1beta1;
+
+import "gogoproto/gogo.proto";
+import "umee/ibc_rate_limit/v1beta1/ibc_rate_limit.proto";
+
+option go_package = "github.com/umee-network/umee/v3/x/ibc-rate-limit/types";
+option (gogoproto.goproto_getters_all) = false;
+
+message GenesisState {
+    Params params = 1 [(gogoproto.nullable) = false];
+    repeated RateLimit rate_limits = 2 [(gogoproto.nullable) = false];
+}

proto/umee/ibc_rate_limit/v1beta1/ibc_rate_limit.proto

@@ -0,0 +1,18 @@
+syntax = "proto3";
+package umee.ibcratelimit.v1beta1;
+
+import "gogoproto/gogo.proto";
+
+option go_package = "github.com/umee-network/umee/v3/x/ibc-rate-limit/types";
+
+// RateLimit
+message RateLimit {
+    string ibc_denom = 1;
+    uint64 outflow_limit = 2;
+    uint64 window = 3;
+}
+
+// Params 
+message Params {
+    bool ibc_pause = 1;
+}

proto/umee/ibc_rate_limit/v1beta1/metadata.proto

@@ -0,0 +1,15 @@
+syntax = "proto3";
+package umee.ibcratelimit.v1beta1;
+
+import "gogoproto/gogo.proto";
+
+option go_package = "github.com/umee-network/umee/v3/x/ibc-rate-limit/types";
+
+// Metadata defines the ICS29 channel specific metadata encoded into the channel version bytestring
+// See ICS004: https://github.com/cosmos/ibc/tree/master/spec/core/ics-004-channel-and-packet-semantics#Versioning
+message Metadata {
+  // fee_version defines the ICS29 fee version
+  string fee_version = 1 [(gogoproto.moretags) = "yaml:\"fee_version\""];
+  // app_version defines the underlying application version, which may or may not be a JSON encoded bytestring
+  string app_version = 2 [(gogoproto.moretags) = "yaml:\"app_version\""];
+}

proto/umee/ibc_rate_limit/v1beta1/query.proto

@@ -0,0 +1,57 @@
+syntax = "proto3";
+package umee.ibcratelimit.v1beta1;
+
+import "google/api/annotations.proto";
+import "gogoproto/gogo.proto";
+import "umee/ibc_rate_limit/v1beta1/ibc_rate_limit.proto";
+
+
+option go_package = "github.com/umee-network/umee/v3/x/ibc-rate-limit/types";
+
+option (gogoproto.goproto_getters_all) = false;
+
+// Query defines the gRPC querier service.
+service Query {
+  // Params queries the parameters of the x/ibc-rate-limit module.
+  rpc Params(QueryParams) returns (QueryParamsResponse) {
+    option (google.api.http).get = "/umee/ibc_rate_limit/v1/params";
+  }
+
+  // RateLimitsOfIBCDenoms queries the rate limits of ibc denoms.
+  rpc RateLimitsOfIBCDenoms(QueryRateLimitsOfIBCDenoms) returns (QueryRateLimitsOfIBCDenomsResponse) {
+    option (google.api.http).get = "/umee/ibc_rate_limit/v1/rate_limits";
+  }
+
+  // RateLimitsOfIBCDenom queries the rate limits of ibc denom.
+  rpc RateLimitsOfIBCDenom(QueryRateLimitsOfIBCDenom) returns (QueryRateLimitsOfIBCDenomResponse) {
+    option (google.api.http).get = "/umee/ibc_rate_limit/v1/rate_limits/{ibc_denom}";
+  }
+}
+
+// QueryParams defines the request structure for the Params gRPC service
+// handler.
+message QueryParams {}
+
+// QueryParamsResponse defines the response structure for the Params gRPC
+// service handler.
+message QueryParamsResponse {
+  Params params = 1 [(gogoproto.nullable) = false];
+}
+
+// QueryRateLimitsOfIBCDenoms defines request type
+message QueryRateLimitsOfIBCDenoms{}
+
+// QueryRateLimitsOfIBCDenomsResponse defines response type 
+message QueryRateLimitsOfIBCDenomsResponse{
+  repeated RateLimit rate_limits = 1 [(gogoproto.nullable) = false];
+}
+
+// QueryRateLimitsOfIBCDenom defines request type 
+message QueryRateLimitsOfIBCDenom{
+  string ibc_denom = 1;
+}
+
+// QueryRateLimitsOfIBCDenomResponse defines response type of QueryRateLimitsOfIBCDenom
+message QueryRateLimitsOfIBCDenomResponse{
+  RateLimit rate_limit = 1 [(gogoproto.nullable) = false];
+}

proto/umee/ibc_rate_limit/v1beta1/tx.proto

@@ -0,0 +1,58 @@
+syntax = "proto3";
+package umee.ibcratelimit.v1beta1;
+
+
+import "gogoproto/gogo.proto";
+import "cosmos/msg/v1/msg.proto";
+import "cosmos_proto/cosmos.proto";
+import "umee/ibc_rate_limit/v1beta1/ibc_rate_limit.proto";
+
+option go_package = "github.com/umee-network/umee/v3/x/ibc-rate-limit/types";
+
+option (gogoproto.goproto_getters_all) = false;
+option (gogoproto.messagename_all)     = true;
+
+// Msg defines the x/ibctransfer module's Msg service.
+service Msg {
+    // UpdateIBCDenomsRateLimit adds new rate limits for ibc denoms or 
+    // updates the rate limits for existed ibc denoms.
+    rpc UpdateIBCDenomsRateLimit(MsgUpdateIBCDenomsRateLimit) returns (MsgUpdateIBCDenomsRateLimitResponse);
+
+    // UpdateIBCTransferPauseStatus
+    rpc UpdateIBCTransferPauseStatus(MsgUpdateIBCTransferPauseStatus) returns (MsgUpdateIBCTransferPauseStatusResponse);
+}
+
+// MsgUpdateIBCDenomsRateLimit defines the Msg/UpdateIBCDenomsRateLimit request type.
+message MsgUpdateIBCDenomsRateLimit {
+    option (gogoproto.goproto_getters)  = false;
+    option (gogoproto.goproto_stringer) = false;
+    option (cosmos.msg.v1.signer) = "authority";
+
+    // authority is the address of the governance account.
+    string         authority   = 1 [(cosmos_proto.scalar) = "cosmos.AddressString"];
+    string         title       = 2;
+    string         description = 3;
+    // new_ibc_denoms_rate_limits defines the rate limits for ibc denoms tokens.
+    repeated RateLimit new_ibc_denoms_rate_limits = 4 [(gogoproto.nullable) = false];
+     // update_ibc_denoms_rate_limits defines the new rate limits for ibc denoms tokens.
+    repeated RateLimit update_ibc_denoms_rate_limits = 5 [(gogoproto.nullable) = false];
+}
+
+// MsgUpdateIBCDenomsRateLimitResponse defines response type for the Msg/UpdateIBCDenomsRateLimit
+message MsgUpdateIBCDenomsRateLimitResponse {};
+
+// MsgUpdateIBCTransferPauseStatus defines request type for UpdateIBCTransferStatus
+message MsgUpdateIBCTransferPauseStatus {
+    option (gogoproto.goproto_getters)  = false;
+    option (gogoproto.goproto_stringer) = false;
+    option (cosmos.msg.v1.signer) = "authority";
+    // authority is the address of the governance account.
+    string         authority   = 1 [(cosmos_proto.scalar) = "cosmos.AddressString"];
+    string         title       = 2;
+    string         description = 3;
+    // ibc_pause_status defines ibc transfer pause status
+    bool ibc_pause_status = 4;
+}
+
+// MsgUpdateIBCTransferPauseStatusResponse definesresponse type for Msg/MsgUpdateIBCTransferPauseStatus
+message MsgUpdateIBCTransferPauseStatusResponse {}

x/ibc-rate-limit/abci.go

@@ -0,0 +1,12 @@
+package ibc_rate_limit
+
+import (
+	sdk "github.com/cosmos/cosmos-sdk/types"
+	abci "github.com/tendermint/tendermint/abci/types"
+	"github.com/umee-network/umee/v3/x/ibc-rate-limit/keeper"
+)
+
+// EndBlocker implements EndBlock for the x/leverage module.
+func EndBlocker(ctx sdk.Context, k keeper.Keeper) []abci.ValidatorUpdate {
+	return []abci.ValidatorUpdate{}
+}