diff --git a/proto/dymensionxyz/dymension/incentives/params.proto b/proto/dymensionxyz/dymension/incentives/params.proto index 0e93c2407..c0b77c907 100644 --- a/proto/dymensionxyz/dymension/incentives/params.proto +++ b/proto/dymensionxyz/dymension/incentives/params.proto @@ -29,4 +29,7 @@ message Params { (gogoproto.nullable) = false, (gogoproto.customtype) = "github.com/cosmos/cosmos-sdk/types.Int" ]; + // FeatureFlagEpochEndDistribution enables distribution of gauge rewards + // at the end of each epoch. If disabled, rewards are not distributed. + bool feature_flag_epoch_end_distribution = 5; } diff --git a/x/incentives/keeper/hooks.go b/x/incentives/keeper/hooks.go index ee8d8b136..e0b7a5f83 100644 --- a/x/incentives/keeper/hooks.go +++ b/x/incentives/keeper/hooks.go @@ -14,6 +14,11 @@ func (k Keeper) BeforeEpochStart(ctx sdk.Context, epochIdentifier string, epochN // AfterEpochEnd is the epoch end hook. func (k Keeper) AfterEpochEnd(ctx sdk.Context, epochIdentifier string, epochNumber int64) error { params := k.GetParams(ctx) + + if !params.FeatureFlagEpochEndDistribution { + return nil + } + if epochIdentifier == params.DistrEpochIdentifier { // begin distribution if it's start time gauges := k.GetUpcomingGauges(ctx) diff --git a/x/incentives/types/params.go b/x/incentives/types/params.go index 52a43252c..755768d6b 100644 --- a/x/incentives/types/params.go +++ b/x/incentives/types/params.go @@ -12,10 +12,11 @@ import ( // Incentives parameters key store. var ( - KeyDistrEpochIdentifier = []byte("DistrEpochIdentifier") - KeyCreateGaugeFee = []byte("CreateGaugeFee") - KeyAddToGaugeFee = []byte("AddToGaugeFee") - KeyAddDenomFee = []byte("AddDenomFee") + KeyDistrEpochIdentifier = []byte("DistrEpochIdentifier") + KeyCreateGaugeFee = []byte("CreateGaugeFee") + KeyAddToGaugeFee = []byte("AddToGaugeFee") + KeyAddDenomFee = []byte("AddDenomFee") + KeyFeatureFlagEpochEndDistribution = []byte("FeatureFlagEpochEndDistribution") ) // ParamKeyTable returns the key table for the incentive module's parameters. @@ -24,22 +25,24 @@ func ParamKeyTable() paramtypes.KeyTable { } // NewParams takes an epoch distribution identifier, then returns an incentives Params struct. -func NewParams(distrEpochIdentifier string, createGaugeFee, addToGaugeFee, addDenomFee math.Int) Params { +func NewParams(distrEpochIdentifier string, createGaugeFee, addToGaugeFee, addDenomFee math.Int, ffEpochEndDistribution bool) Params { return Params{ - DistrEpochIdentifier: distrEpochIdentifier, - CreateGaugeBaseFee: createGaugeFee, - AddToGaugeBaseFee: addToGaugeFee, - AddDenomFee: addDenomFee, + DistrEpochIdentifier: distrEpochIdentifier, + CreateGaugeBaseFee: createGaugeFee, + AddToGaugeBaseFee: addToGaugeFee, + AddDenomFee: addDenomFee, + FeatureFlagEpochEndDistribution: ffEpochEndDistribution, } } // DefaultParams returns the default incentives module parameters. func DefaultParams() Params { return Params{ - DistrEpochIdentifier: DefaultDistrEpochIdentifier, - CreateGaugeBaseFee: DefaultCreateGaugeFee, - AddToGaugeBaseFee: DefaultAddToGaugeFee, - AddDenomFee: DefaultAddDenomFee, + DistrEpochIdentifier: DefaultDistrEpochIdentifier, + CreateGaugeBaseFee: DefaultCreateGaugeFee, + AddToGaugeBaseFee: DefaultAddToGaugeFee, + AddDenomFee: DefaultAddDenomFee, + FeatureFlagEpochEndDistribution: false, } } @@ -57,6 +60,9 @@ func (p Params) Validate() error { if err := validateAddDenomFee(p.AddDenomFee); err != nil { return err } + if err := validateBool(p.FeatureFlagEpochEndDistribution); err != nil { + return err + } return nil } @@ -67,6 +73,7 @@ func (p *Params) ParamSetPairs() paramtypes.ParamSetPairs { paramtypes.NewParamSetPair(KeyCreateGaugeFee, &p.CreateGaugeBaseFee, validateCreateGaugeFeeInterface), paramtypes.NewParamSetPair(KeyAddToGaugeFee, &p.AddToGaugeBaseFee, validateAddToGaugeFeeInterface), paramtypes.NewParamSetPair(KeyAddDenomFee, &p.AddDenomFee, validateAddDenomFee), + paramtypes.NewParamSetPair(KeyFeatureFlagEpochEndDistribution, &p.FeatureFlagEpochEndDistribution, validateBool), } } @@ -102,3 +109,11 @@ func validateAddDenomFee(i interface{}) error { } return nil } + +func validateBool(i interface{}) error { + _, ok := i.(bool) + if !ok { + return fmt.Errorf("invalid parameter type: %T", i) + } + return nil +} diff --git a/x/incentives/types/params.pb.go b/x/incentives/types/params.pb.go index 0773d1bc4..97f28c9f8 100644 --- a/x/incentives/types/params.pb.go +++ b/x/incentives/types/params.pb.go @@ -39,6 +39,9 @@ type Params struct { AddToGaugeBaseFee github_com_cosmos_cosmos_sdk_types.Int `protobuf:"bytes,3,opt,name=add_to_gauge_base_fee,json=addToGaugeBaseFee,proto3,customtype=github.com/cosmos/cosmos-sdk/types.Int" json:"add_to_gauge_base_fee"` // AddDenomFee is a fee charged for adding every new denom to the gauge. AddDenomFee github_com_cosmos_cosmos_sdk_types.Int `protobuf:"bytes,4,opt,name=add_denom_fee,json=addDenomFee,proto3,customtype=github.com/cosmos/cosmos-sdk/types.Int" json:"add_denom_fee"` + // FeatureFlagEpochEndDistribution enables distribution of gauge rewards + // at the end of each epoch. If disabled, rewards are not distributed. + FeatureFlagEpochEndDistribution bool `protobuf:"varint,5,opt,name=feature_flag_epoch_end_distribution,json=featureFlagEpochEndDistribution,proto3" json:"feature_flag_epoch_end_distribution,omitempty"` } func (m *Params) Reset() { *m = Params{} } @@ -81,6 +84,13 @@ func (m *Params) GetDistrEpochIdentifier() string { return "" } +func (m *Params) GetFeatureFlagEpochEndDistribution() bool { + if m != nil { + return m.FeatureFlagEpochEndDistribution + } + return false +} + func init() { proto.RegisterType((*Params)(nil), "dymensionxyz.dymension.incentives.Params") } @@ -90,28 +100,31 @@ func init() { } var fileDescriptor_256a114c8e13cfa0 = []byte{ - // 332 bytes of a gzipped FileDescriptorProto - 0x1f, 0x8b, 0x08, 0x00, 0x00, 0x00, 0x00, 0x00, 0x02, 0xff, 0x9c, 0x92, 0x31, 0x4f, 0xf2, 0x40, - 0x18, 0xc7, 0x5b, 0xde, 0x37, 0x24, 0xd6, 0x38, 0xd8, 0x80, 0x21, 0x26, 0x16, 0x61, 0x30, 0x2e, - 0xf6, 0x06, 0x06, 0x13, 0x47, 0xa2, 0x18, 0x36, 0x25, 0x26, 0x26, 0x2e, 0xf5, 0xe8, 0x3d, 0x94, - 0x8b, 0xde, 0x3d, 0x4d, 0xef, 0x20, 0xd4, 0x4f, 0xe1, 0xc7, 0x62, 0x64, 0x34, 0x0e, 0xc4, 0xc0, - 0x37, 0x70, 0x74, 0x32, 0x77, 0x18, 0x40, 0xa3, 0x0b, 0x53, 0x7b, 0xcf, 0xfd, 0xff, 0xbf, 0xdf, - 0x70, 0x8f, 0x17, 0xb2, 0x5c, 0x80, 0x54, 0x1c, 0xe5, 0x28, 0x7f, 0x22, 0xcb, 0x03, 0xe1, 0x32, - 0x06, 0xa9, 0xf9, 0x10, 0x14, 0x49, 0x69, 0x46, 0x85, 0x0a, 0xd3, 0x0c, 0x35, 0xfa, 0xb5, 0xf5, - 0xfc, 0xaa, 0x1c, 0xae, 0xf2, 0xfb, 0xa5, 0x04, 0x13, 0xb4, 0x69, 0x62, 0xfe, 0x16, 0xc5, 0xfa, - 0x47, 0xc1, 0x2b, 0x5e, 0x59, 0x92, 0x7f, 0xeb, 0xed, 0x31, 0xae, 0x74, 0x16, 0x41, 0x8a, 0x71, - 0x3f, 0xe2, 0xcc, 0x34, 0x7b, 0x1c, 0xb2, 0x8a, 0x7b, 0xe8, 0x1e, 0x6f, 0x35, 0x6b, 0xef, 0xd3, - 0xea, 0x41, 0x4e, 0xc5, 0xe3, 0x59, 0xfd, 0xf7, 0x5c, 0xbd, 0x53, 0xb2, 0x17, 0x17, 0x66, 0xde, - 0x5e, 0x8e, 0x7d, 0xea, 0x95, 0xe3, 0x0c, 0xa8, 0x86, 0x28, 0xa1, 0x83, 0x04, 0xa2, 0x2e, 0x55, - 0x10, 0xf5, 0x00, 0x2a, 0x05, 0xcb, 0x0d, 0xc7, 0xd3, 0xaa, 0xf3, 0x3a, 0xad, 0x1e, 0x25, 0x5c, - 0xf7, 0x07, 0xdd, 0x30, 0x46, 0x41, 0x62, 0x54, 0x02, 0xd5, 0xd7, 0xe7, 0x44, 0xb1, 0x07, 0xa2, - 0xf3, 0x14, 0x54, 0xd8, 0x96, 0xba, 0xe3, 0x2f, 0x60, 0x97, 0x86, 0xd5, 0xa4, 0x0a, 0x5a, 0x00, - 0xfe, 0xbd, 0x57, 0xa6, 0x8c, 0x45, 0x1a, 0x7f, 0x2a, 0xfe, 0x6d, 0xa4, 0xd8, 0xa5, 0x8c, 0xdd, - 0xe0, 0x37, 0x43, 0xc7, 0xdb, 0x31, 0x06, 0x06, 0x12, 0x85, 0x25, 0xff, 0xdf, 0x88, 0xbc, 0x4d, - 0x19, 0x3b, 0x37, 0x8c, 0x16, 0x40, 0xf3, 0x7a, 0x3c, 0x0b, 0xdc, 0xc9, 0x2c, 0x70, 0xdf, 0x66, - 0x81, 0xfb, 0x3c, 0x0f, 0x9c, 0xc9, 0x3c, 0x70, 0x5e, 0xe6, 0x81, 0x73, 0x77, 0xba, 0x86, 0xfb, - 0x63, 0x15, 0x86, 0x0d, 0x32, 0x5a, 0xdf, 0x07, 0xeb, 0xe8, 0x16, 0xed, 0xb3, 0x36, 0x3e, 0x03, - 0x00, 0x00, 0xff, 0xff, 0x71, 0x76, 0x81, 0x6d, 0x41, 0x02, 0x00, 0x00, + // 379 bytes of a gzipped FileDescriptorProto + 0x1f, 0x8b, 0x08, 0x00, 0x00, 0x00, 0x00, 0x00, 0x02, 0xff, 0x9c, 0x92, 0x41, 0x6b, 0xe2, 0x40, + 0x14, 0xc7, 0x93, 0x75, 0x57, 0x76, 0xb3, 0xec, 0x61, 0x83, 0x2e, 0xb2, 0xb0, 0x89, 0xba, 0x50, + 0xbc, 0x34, 0x39, 0x78, 0x28, 0xf4, 0x28, 0x6a, 0x11, 0x7a, 0x68, 0x43, 0xa1, 0xd0, 0xcb, 0x74, + 0x92, 0x79, 0x89, 0x43, 0xcd, 0x4c, 0xc8, 0x4c, 0xc4, 0xf4, 0x53, 0xf4, 0x63, 0x79, 0xf4, 0x58, + 0x7a, 0x90, 0xa2, 0xdf, 0xa0, 0x9f, 0xa0, 0x64, 0x14, 0x4d, 0x4b, 0x7b, 0xf1, 0x34, 0x33, 0x6f, + 0xfe, 0xef, 0xf7, 0x7f, 0x3c, 0xfe, 0x86, 0x43, 0xf2, 0x18, 0x98, 0xa0, 0x9c, 0xcd, 0xf2, 0x7b, + 0x77, 0xf7, 0x70, 0x29, 0x0b, 0x80, 0x49, 0x3a, 0x05, 0xe1, 0x26, 0x38, 0xc5, 0xb1, 0x70, 0x92, + 0x94, 0x4b, 0x6e, 0xb6, 0xca, 0xfa, 0x7d, 0xb3, 0xb3, 0xd7, 0xff, 0xad, 0x45, 0x3c, 0xe2, 0x4a, + 0xed, 0x16, 0xb7, 0x4d, 0x63, 0x7b, 0x5e, 0x31, 0xaa, 0x17, 0x8a, 0x64, 0x5e, 0x1b, 0x7f, 0x08, + 0x15, 0x32, 0x45, 0x90, 0xf0, 0x60, 0x8c, 0x28, 0x29, 0x3a, 0x43, 0x0a, 0x69, 0x43, 0x6f, 0xea, + 0x9d, 0x1f, 0xbd, 0xd6, 0xcb, 0xd2, 0xfe, 0x97, 0xe3, 0x78, 0x72, 0xda, 0xfe, 0x58, 0xd7, 0xf6, + 0x6a, 0xea, 0x63, 0x50, 0xd4, 0x47, 0xbb, 0xb2, 0x89, 0x8d, 0x7a, 0x90, 0x02, 0x96, 0x80, 0x22, + 0x9c, 0x45, 0x80, 0x7c, 0x2c, 0x00, 0x85, 0x00, 0x8d, 0x2f, 0x8a, 0xeb, 0xcc, 0x97, 0xb6, 0xf6, + 0xb4, 0xb4, 0x8f, 0x22, 0x2a, 0xc7, 0x99, 0xef, 0x04, 0x3c, 0x76, 0x03, 0x2e, 0x62, 0x2e, 0xb6, + 0xc7, 0xb1, 0x20, 0x77, 0xae, 0xcc, 0x13, 0x10, 0xce, 0x88, 0x49, 0xcf, 0xdc, 0xc0, 0xce, 0x0a, + 0x56, 0x0f, 0x0b, 0x18, 0x02, 0x98, 0xb7, 0x46, 0x1d, 0x13, 0x82, 0x24, 0x7f, 0x6f, 0x51, 0x39, + 0xc8, 0xe2, 0x37, 0x26, 0xe4, 0x8a, 0xbf, 0x71, 0xf0, 0x8c, 0x5f, 0x85, 0x03, 0x01, 0xc6, 0x63, + 0x45, 0xfe, 0x7a, 0x10, 0xf9, 0x27, 0x26, 0xa4, 0x5f, 0x30, 0x0a, 0xe6, 0xb9, 0xf1, 0x3f, 0x04, + 0x2c, 0xb3, 0x14, 0x50, 0x38, 0xc1, 0xd1, 0x76, 0xa1, 0xc0, 0x08, 0x52, 0x7b, 0xa4, 0x7e, 0x26, + 0x29, 0x67, 0x8d, 0x6f, 0x4d, 0xbd, 0xf3, 0xdd, 0xb3, 0xb7, 0xd2, 0xe1, 0x04, 0x47, 0x6a, 0xc3, + 0x03, 0x46, 0xfa, 0x25, 0x59, 0xef, 0x72, 0xbe, 0xb2, 0xf4, 0xc5, 0xca, 0xd2, 0x9f, 0x57, 0x96, + 0xfe, 0xb0, 0xb6, 0xb4, 0xc5, 0xda, 0xd2, 0x1e, 0xd7, 0x96, 0x76, 0x73, 0x52, 0x1a, 0xee, 0x93, + 0x60, 0x4d, 0xbb, 0xee, 0xac, 0x9c, 0x2e, 0x35, 0xb1, 0x5f, 0x55, 0x21, 0xe9, 0xbe, 0x06, 0x00, + 0x00, 0xff, 0xff, 0x52, 0x46, 0x0d, 0x10, 0x8f, 0x02, 0x00, 0x00, } func (m *Params) Marshal() (dAtA []byte, err error) { @@ -134,6 +147,16 @@ func (m *Params) MarshalToSizedBuffer(dAtA []byte) (int, error) { _ = i var l int _ = l + if m.FeatureFlagEpochEndDistribution { + i-- + if m.FeatureFlagEpochEndDistribution { + dAtA[i] = 1 + } else { + dAtA[i] = 0 + } + i-- + dAtA[i] = 0x28 + } { size := m.AddDenomFee.Size() i -= size @@ -201,6 +224,9 @@ func (m *Params) Size() (n int) { n += 1 + l + sovParams(uint64(l)) l = m.AddDenomFee.Size() n += 1 + l + sovParams(uint64(l)) + if m.FeatureFlagEpochEndDistribution { + n += 2 + } return n } @@ -373,6 +399,26 @@ func (m *Params) Unmarshal(dAtA []byte) error { return err } iNdEx = postIndex + case 5: + if wireType != 0 { + return fmt.Errorf("proto: wrong wireType = %d for field FeatureFlagEpochEndDistribution", wireType) + } + var v int + for shift := uint(0); ; shift += 7 { + if shift >= 64 { + return ErrIntOverflowParams + } + if iNdEx >= l { + return io.ErrUnexpectedEOF + } + b := dAtA[iNdEx] + iNdEx++ + v |= int(b&0x7F) << shift + if b < 0x80 { + break + } + } + m.FeatureFlagEpochEndDistribution = bool(v != 0) default: iNdEx = preIndex skippy, err := skipParams(dAtA[iNdEx:]) diff --git a/x/iro/types/iro.pb.go b/x/iro/types/iro.pb.go index 99c11fe33..9909a1862 100644 --- a/x/iro/types/iro.pb.go +++ b/x/iro/types/iro.pb.go @@ -33,7 +33,10 @@ const _ = proto.GoGoProtoPackageIsVersion3 // please upgrade the proto package // Params is a module parameters. type Params struct { - TakerFee github_com_cosmos_cosmos_sdk_types.Dec `protobuf:"bytes,1,opt,name=taker_fee,json=takerFee,proto3,customtype=github.com/cosmos/cosmos-sdk/types.Dec" json:"taker_fee"` + TakerFee github_com_cosmos_cosmos_sdk_types.Dec `protobuf:"bytes,1,opt,name=taker_fee,json=takerFee,proto3,customtype=github.com/cosmos/cosmos-sdk/types.Dec" json:"taker_fee"` + // The fee for creating a plan in rollapp tokens (e.g 1000000000000000000 for 1Token fee) + // must be > 1 + // The cost in dym is charged from the creator CreationFee github_com_cosmos_cosmos_sdk_types.Int `protobuf:"bytes,2,opt,name=creation_fee,json=creationFee,proto3,customtype=github.com/cosmos/cosmos-sdk/types.Int" json:"creation_fee"` // Minimum plan duration // when creating a plan, the plan duration should be greater than or equal to