fix: use default String implementation for types

Merge pull request #214 from hallazzang/207-stringer
tendermint · Nov 8, 2021 · acfe280 · acfe280
2 parents fedca46 + 2691957
commit acfe280
Show file tree

Hide file tree

Showing 8 changed files with 101 additions and 144 deletions.
diff --git a/proto/tendermint/farming/v1beta1/farming.proto b/proto/tendermint/farming/v1beta1/farming.proto
@@ -43,8 +43,7 @@ message Params {
 // extend this type for additional functionality (for example, fixed amount plan, ratio
 // plan).
 message BasePlan {
-  option (gogoproto.goproto_getters)  = false;
-  option (gogoproto.goproto_stringer) = false;
+  option (gogoproto.goproto_getters) = false;
 
   option (cosmos_proto.implements_interface) = "PlanI";
 
@@ -100,8 +99,7 @@ message BasePlan {
 // FixedAmountPlan defines a fixed amount plan that distributes a fixed amount
 // of coins for every epoch.
 message FixedAmountPlan {
-  option (gogoproto.goproto_getters)  = false;
-  option (gogoproto.goproto_stringer) = false;
+  option (gogoproto.goproto_getters) = false;
 
   BasePlan base_plan = 1 [(gogoproto.embed) = true, (gogoproto.moretags) = "yaml:\"base_plan\""];
 
@@ -116,8 +114,7 @@ message FixedAmountPlan {
 // RatioPlan defines a plan that distributes to farmers by ratio
 // distribution for every epoch day.
 message RatioPlan {
-  option (gogoproto.goproto_getters)  = false;
-  option (gogoproto.goproto_stringer) = false;
+  option (gogoproto.goproto_getters) = false;
 
   BasePlan base_plan = 1 [(gogoproto.embed) = true, (gogoproto.moretags) = "yaml:\"base_plan\""];
 
@@ -143,8 +140,7 @@ enum PlanType {
 
 // Staking defines a farmer's staking information.
 message Staking {
-  option (gogoproto.goproto_getters)  = false;
-  option (gogoproto.goproto_stringer) = false;
+  option (gogoproto.goproto_getters) = false;
 
   string amount = 1 [(gogoproto.customtype) = "github.com/cosmos/cosmos-sdk/types.Int", (gogoproto.nullable) = false];
 
@@ -165,7 +161,7 @@ message TotalStakings {
   string amount = 1 [(gogoproto.customtype) = "github.com/cosmos/cosmos-sdk/types.Int", (gogoproto.nullable) = false];
 }
 
-// HistoricalRewards defines the culative unit rewards for a given staking coin denom and an epoch number.
+// HistoricalRewards defines the cumulative unit rewards for a given staking coin denom and an epoch number.
 message HistoricalRewards {
   option (gogoproto.goproto_getters) = false;
 
@@ -179,6 +175,8 @@ message HistoricalRewards {
 // OutstandingRewards represents outstanding (un-withdrawn) rewards
 // for a staking coin denom.
 message OutstandingRewards {
+  option (gogoproto.goproto_getters) = false;
+
   repeated cosmos.base.v1beta1.DecCoin rewards = 1
       [(gogoproto.castrepeated) = "github.com/cosmos/cosmos-sdk/types.DecCoins", (gogoproto.nullable) = false];
 }
diff --git a/proto/tendermint/farming/v1beta1/proposal.proto b/proto/tendermint/farming/v1beta1/proposal.proto
@@ -82,7 +82,7 @@ message ModifyPlanRequest {
   // plan_id specifies index of the farming plan
   uint64 plan_id = 1;
 
-  // name specifies the plan name for diplay
+  // name specifies the plan name for display
   string name = 2;
 
   // farming_pool_address defines the bech32-encoded address of the farming pool

diff --git a/x/farming/spec/02_state.md b/x/farming/spec/02_state.md
@@ -50,8 +50,6 @@ type PlanI interface {
 
     GetBasePlan() *BasePlan
 
-    String() string
-
     Validate() error
 }
 ```

diff --git a/x/farming/types/farming.pb.go b/x/farming/types/farming.pb.go
diff --git a/x/farming/types/plan.go b/x/farming/types/plan.go
@@ -5,7 +5,6 @@ import (
 	"strings"
 	"time"
 
-	"github.com/cosmos/cosmos-sdk/codec"
 	codectypes "github.com/cosmos/cosmos-sdk/codec/types"
 	sdk "github.com/cosmos/cosmos-sdk/types"
 	"github.com/cosmos/cosmos-sdk/types/address"
@@ -189,20 +188,6 @@ func (plan BasePlan) Validate() error {
 	return nil
 }
 
-func (plan BasePlan) String() string {
-	out, _ := plan.MarshalYAML()
-	return out.(string)
-}
-
-// MarshalYAML returns the YAML representation of a Plan.
-func (plan BasePlan) MarshalYAML() (interface{}, error) {
-	bz, err := codec.MarshalYAML(codec.NewProtoCodec(codectypes.NewInterfaceRegistry()), &plan)
-	if err != nil {
-		return nil, err
-	}
-	return string(bz), err
-}
-
 // NewFixedAmountPlan returns a new fixed amount plan.
 func NewFixedAmountPlan(basePlan *BasePlan, epochAmount sdk.Coins) *FixedAmountPlan {
 	return &FixedAmountPlan{
@@ -258,8 +243,6 @@ type PlanI interface {
 
 	GetBasePlan() *BasePlan
 
-	String() string
-
 	Validate() error
 }
 

diff --git a/x/farming/types/proposal.go b/x/farming/types/proposal.go
@@ -74,9 +74,9 @@ func (p *PublicPlanProposal) ValidateBasic() error {
 
 func (p PublicPlanProposal) String() string {
 	return fmt.Sprintf(`Public Plan Proposal:
-  Title:       			  %s
-  Description: 		      %s
-  AddPlanRequests: 	  %s
+  Title:              %s
+  Description:        %s
+  AddPlanRequests:    %s
   UpdatePlanRequests: %s
   DeletePlanRequests: %s
 `, p.Title, p.Description, p.AddPlanRequests, p.ModifyPlanRequests, p.DeletePlanRequests)

diff --git a/x/farming/types/proposal.pb.go b/x/farming/types/proposal.pb.go
diff --git a/x/farming/types/staking.go b/x/farming/types/staking.go
-Original file line number
+Diff line change
@@ Expand Up / @@ -50,8 +50,6 @@ type PlanI interface { @@
         GetBasePlan() *BasePlan
-        String() string
         Validate() error
     }
     ```
@@ Expand Down @@