Skip to content

Commit

Permalink
revert proto comments
Browse files Browse the repository at this point in the history
  • Loading branch information
p0mvn committed Jun 24, 2022
1 parent 33dd873 commit cbb683e
Show file tree
Hide file tree
Showing 6 changed files with 34 additions and 36 deletions.
6 changes: 3 additions & 3 deletions proto/osmosis/mint/v1beta1/genesis.proto
Original file line number Diff line number Diff line change
Expand Up @@ -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\"" ];
Expand Down
25 changes: 12 additions & 13 deletions proto/osmosis/mint/v1beta1/mint.proto
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down Expand Up @@ -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) =
Expand Down
4 changes: 2 additions & 2 deletions proto/osmosis/mint/v1beta1/query.proto
Original file line number Diff line number Diff line change
Expand Up @@ -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 ];
}

Expand All @@ -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
Expand Down
6 changes: 3 additions & 3 deletions x/mint/types/genesis.pb.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

25 changes: 12 additions & 13 deletions x/mint/types/mint.pb.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions x/mint/types/query.pb.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit cbb683e

Please sign in to comment.