diff --git a/proto/osmosis/mint/v1beta1/genesis.proto b/proto/osmosis/mint/v1beta1/genesis.proto index 4d26589e8d2..38b8dfd5874 100644 --- a/proto/osmosis/mint/v1beta1/genesis.proto +++ b/proto/osmosis/mint/v1beta1/genesis.proto @@ -8,13 +8,13 @@ option go_package = "github.com/osmosis-labs/osmosis/v7/x/mint/types"; // GenesisState defines the mint module's genesis state. message GenesisState { - // Minter is an abstraction for holding current rewards information. + // minter is an abstraction for holding current rewards information. Minter minter = 1 [ (gogoproto.nullable) = false ]; - // Params defines all the paramaters of the mint module. + // params defines all the paramaters of the mint module. Params params = 2 [ (gogoproto.nullable) = false ]; - // ReductionStartedEpoch the first epoch in which the reduction of mint + // reduction_started_epoch the first epoch in which the reduction of mint // begins. int64 reduction_started_epoch = 3 [ (gogoproto.moretags) = "yaml:\"reduction_started_epoch\"" ]; diff --git a/proto/osmosis/mint/v1beta1/mint.proto b/proto/osmosis/mint/v1beta1/mint.proto index 92fba5913d9..667b4ef3a61 100644 --- a/proto/osmosis/mint/v1beta1/mint.proto +++ b/proto/osmosis/mint/v1beta1/mint.proto @@ -10,7 +10,7 @@ import "google/protobuf/duration.proto"; // Minter represents the minting state. message Minter { - // EpochProvisions represent rewards for the current epoch. + // epoch_provisions represent rewards for the current epoch. string epoch_provisions = 1 [ (gogoproto.moretags) = "yaml:\"epoch_provisions\"", (gogoproto.customtype) = "github.com/cosmos/cosmos-sdk/types.Dec", @@ -68,43 +68,42 @@ message DistributionProportions { message Params { option (gogoproto.goproto_stringer) = false; - // MintDenom the denom of the coin to mint. + // mint_denom the denom of the coin to mint. string mint_denom = 1; - // GenesisEpochProvisions epoch provisions from the first epoch. + // genesis_epoch_provisions epoch provisions from the first epoch. string genesis_epoch_provisions = 2 [ (gogoproto.moretags) = "yaml:\"genesis_epoch_provisions\"", (gogoproto.customtype) = "github.com/cosmos/cosmos-sdk/types.Dec", (gogoproto.nullable) = false ]; - // EpochIdentifier mint epoch identifier e.g. (day, week). + // epoch_identifier mint epoch identifier e.g. (day, week). string epoch_identifier = 3 [ (gogoproto.moretags) = "yaml:\"epoch_identifier\"" ]; - // ReductionPeriodInEpochs the number of epochs it takes + // reduction_period_in_epochs the number of epochs it takes // to reduce the rewards. int64 reduction_period_in_epochs = 4 [ (gogoproto.moretags) = "yaml:\"reduction_period_in_epochs\"" ]; - // ReductionFactor is the reduction multiplier to execute + // reduction_factor is the reduction multiplier to execute // at the end of each period set by ReductionPeriodInEpochs. string reduction_factor = 5 [ (gogoproto.moretags) = "yaml:\"reduction_factor\"", (gogoproto.customtype) = "github.com/cosmos/cosmos-sdk/types.Dec", (gogoproto.nullable) = false ]; - // DistributionProportions defines the distribution proportions of the minted + // distribution_proportions defines the distribution proportions of the minted // denom. In other words, defines which stakeholders will receive the minted // denoms and how much. DistributionProportions distribution_proportions = 6 [ (gogoproto.nullable) = false ]; - // WeightedDeveloperRewardsReceivers the address to receive developer rewards - // with weights assignedt to each address. The final amount that each address - // receives is: - // EpochProvisions * DistributionProportions.DeveloperRewards * Address's - // Weight. + // weighted_developer_rewards_receivers the address to receive developer + // rewards with weights assignedt to each address. The final amount that each + // address receives is: epoch_provisions * + // distribution_proportions.developer_rewards * Address's Weight. repeated WeightedAddress weighted_developer_rewards_receivers = 7 [ (gogoproto.moretags) = "yaml:\"developer_rewards_receiver\"", (gogoproto.nullable) = false ]; - // MintingRewardsDistributionStartEpoch start epoch to distribute minting + // minting_rewards_distribution_start_epoch start epoch to distribute minting // rewards int64 minting_rewards_distribution_start_epoch = 8 [ (gogoproto.moretags) = diff --git a/proto/osmosis/mint/v1beta1/query.proto b/proto/osmosis/mint/v1beta1/query.proto index a327c75b266..90bbdfb252d 100644 --- a/proto/osmosis/mint/v1beta1/query.proto +++ b/proto/osmosis/mint/v1beta1/query.proto @@ -26,7 +26,7 @@ message QueryParamsRequest {} // QueryParamsResponse is the response type for the Query/Params RPC method. message QueryParamsResponse { - // Params defines the parameters of the module. + // params defines the parameters of the module. Params params = 1 [ (gogoproto.nullable) = false ]; } @@ -37,7 +37,7 @@ message QueryEpochProvisionsRequest {} // QueryEpochProvisionsResponse is the response type for the // Query/EpochProvisions RPC method. message QueryEpochProvisionsResponse { - // EpochProvisions is the current minting per epoch provisions value. + // epoch_provisions is the current minting per epoch provisions value. bytes epoch_provisions = 1 [ (gogoproto.customtype) = "github.com/cosmos/cosmos-sdk/types.Dec", (gogoproto.nullable) = false diff --git a/x/mint/types/genesis.pb.go b/x/mint/types/genesis.pb.go index 6d296b8bd83..efd1542c836 100644 --- a/x/mint/types/genesis.pb.go +++ b/x/mint/types/genesis.pb.go @@ -25,11 +25,11 @@ const _ = proto.GoGoProtoPackageIsVersion3 // please upgrade the proto package // GenesisState defines the mint module's genesis state. type GenesisState struct { - // Minter is an abstraction for holding current rewards information. + // minter is an abstraction for holding current rewards information. Minter Minter `protobuf:"bytes,1,opt,name=minter,proto3" json:"minter"` - // Params defines all the paramaters of the mint module. + // params defines all the paramaters of the mint module. Params Params `protobuf:"bytes,2,opt,name=params,proto3" json:"params"` - // ReductionStartedEpoch the first epoch in which the reduction of mint + // reduction_started_epoch the first epoch in which the reduction of mint // begins. ReductionStartedEpoch int64 `protobuf:"varint,3,opt,name=reduction_started_epoch,json=reductionStartedEpoch,proto3" json:"reduction_started_epoch,omitempty" yaml:"reduction_started_epoch"` } diff --git a/x/mint/types/mint.pb.go b/x/mint/types/mint.pb.go index e74ad61a2f7..63932980ead 100644 --- a/x/mint/types/mint.pb.go +++ b/x/mint/types/mint.pb.go @@ -28,7 +28,7 @@ const _ = proto.GoGoProtoPackageIsVersion3 // please upgrade the proto package // Minter represents the minting state. type Minter struct { - // EpochProvisions represent rewards for the current epoch. + // epoch_provisions represent rewards for the current epoch. EpochProvisions github_com_cosmos_cosmos_sdk_types.Dec `protobuf:"bytes,1,opt,name=epoch_provisions,json=epochProvisions,proto3,customtype=github.com/cosmos/cosmos-sdk/types.Dec" json:"epoch_provisions" yaml:"epoch_provisions"` } @@ -166,29 +166,28 @@ var xxx_messageInfo_DistributionProportions proto.InternalMessageInfo // Params holds parameters for the x/mint module. type Params struct { - // MintDenom the denom of the coin to mint. + // mint_denom the denom of the coin to mint. MintDenom string `protobuf:"bytes,1,opt,name=mint_denom,json=mintDenom,proto3" json:"mint_denom,omitempty"` - // GenesisEpochProvisions epoch provisions from the first epoch. + // genesis_epoch_provisions epoch provisions from the first epoch. GenesisEpochProvisions github_com_cosmos_cosmos_sdk_types.Dec `protobuf:"bytes,2,opt,name=genesis_epoch_provisions,json=genesisEpochProvisions,proto3,customtype=github.com/cosmos/cosmos-sdk/types.Dec" json:"genesis_epoch_provisions" yaml:"genesis_epoch_provisions"` - // EpochIdentifier mint epoch identifier e.g. (day, week). + // epoch_identifier mint epoch identifier e.g. (day, week). EpochIdentifier string `protobuf:"bytes,3,opt,name=epoch_identifier,json=epochIdentifier,proto3" json:"epoch_identifier,omitempty" yaml:"epoch_identifier"` - // ReductionPeriodInEpochs the number of epochs it takes + // reduction_period_in_epochs the number of epochs it takes // to reduce the rewards. ReductionPeriodInEpochs int64 `protobuf:"varint,4,opt,name=reduction_period_in_epochs,json=reductionPeriodInEpochs,proto3" json:"reduction_period_in_epochs,omitempty" yaml:"reduction_period_in_epochs"` - // ReductionFactor is the reduction multiplier to execute + // reduction_factor is the reduction multiplier to execute // at the end of each period set by ReductionPeriodInEpochs. ReductionFactor github_com_cosmos_cosmos_sdk_types.Dec `protobuf:"bytes,5,opt,name=reduction_factor,json=reductionFactor,proto3,customtype=github.com/cosmos/cosmos-sdk/types.Dec" json:"reduction_factor" yaml:"reduction_factor"` - // DistributionProportions defines the distribution proportions of the minted + // distribution_proportions defines the distribution proportions of the minted // denom. In other words, defines which stakeholders will receive the minted // denoms and how much. DistributionProportions DistributionProportions `protobuf:"bytes,6,opt,name=distribution_proportions,json=distributionProportions,proto3" json:"distribution_proportions"` - // WeightedDeveloperRewardsReceivers the address to receive developer rewards - // with weights assignedt to each address. The final amount that each address - // receives is: - // EpochProvisions * DistributionProportions.DeveloperRewards * Address's - // Weight. + // weighted_developer_rewards_receivers the address to receive developer + // rewards with weights assignedt to each address. The final amount that each + // address receives is: epoch_provisions * + // distribution_proportions.developer_rewards * Address's Weight. WeightedDeveloperRewardsReceivers []WeightedAddress `protobuf:"bytes,7,rep,name=weighted_developer_rewards_receivers,json=weightedDeveloperRewardsReceivers,proto3" json:"weighted_developer_rewards_receivers" yaml:"developer_rewards_receiver"` - // MintingRewardsDistributionStartEpoch start epoch to distribute minting + // minting_rewards_distribution_start_epoch start epoch to distribute minting // rewards MintingRewardsDistributionStartEpoch int64 `protobuf:"varint,8,opt,name=minting_rewards_distribution_start_epoch,json=mintingRewardsDistributionStartEpoch,proto3" json:"minting_rewards_distribution_start_epoch,omitempty" yaml:"minting_rewards_distribution_start_epoch"` } diff --git a/x/mint/types/query.pb.go b/x/mint/types/query.pb.go index 07ae98df383..d394f9f53d7 100644 --- a/x/mint/types/query.pb.go +++ b/x/mint/types/query.pb.go @@ -69,7 +69,7 @@ var xxx_messageInfo_QueryParamsRequest proto.InternalMessageInfo // QueryParamsResponse is the response type for the Query/Params RPC method. type QueryParamsResponse struct { - // Params defines the parameters of the module. + // params defines the parameters of the module. Params Params `protobuf:"bytes,1,opt,name=params,proto3" json:"params"` } @@ -154,7 +154,7 @@ var xxx_messageInfo_QueryEpochProvisionsRequest proto.InternalMessageInfo // QueryEpochProvisionsResponse is the response type for the // Query/EpochProvisions RPC method. type QueryEpochProvisionsResponse struct { - // EpochProvisions is the current minting per epoch provisions value. + // epoch_provisions is the current minting per epoch provisions value. EpochProvisions github_com_cosmos_cosmos_sdk_types.Dec `protobuf:"bytes,1,opt,name=epoch_provisions,json=epochProvisions,proto3,customtype=github.com/cosmos/cosmos-sdk/types.Dec" json:"epoch_provisions"` }