feat: add vesting util functions (backport #11652) (#11666)

* feat: add vesting util functions (#11652) * feat: add vesting util functions * changelog * revert string deletion * fix build * Update x/auth/vesting/types/period.go Co-authored-by: Aleksandr Bezobchuk <[email protected]> Co-authored-by: Aleksandr Bezobchuk <[email protected]> Co-authored-by: Marko <[email protected]> (cherry picked from commit c676952) # Conflicts: # CHANGELOG.md * Update CHANGELOG.md Co-authored-by: Federico Kunze Küllmer <[email protected]>
cosmos · Apr 18, 2022 · 4f2453b · 4f2453b
1 parent 6499ae7
commit 4f2453b
Show file tree

Hide file tree

Showing 2 changed files with 39 additions and 5 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -179,6 +179,8 @@ Ref: https://keepachangelog.com/en/1.0.0/
 
 ### Improvements
 
+* (x/auth/vesting) [\#11652](https://github.com/cosmos/cosmos-sdk/pull/11652) Add util functions for `Period(s)`
+* [\#11630](https://github.com/cosmos/cosmos-sdk/pull/11630) Add SafeSub method to sdk.Coin.
 * [\#11511](https://github.com/cosmos/cosmos-sdk/pull/11511) Add api server flags to start command.
 * [\#11484](https://github.com/cosmos/cosmos-sdk/pull/11484) Implement getter for keyring backend option.
 * [\#11449](https://github.com/cosmos/cosmos-sdk/pull/11449) Improved error messages when node isn't synced.

diff --git a/x/auth/vesting/types/period.go b/x/auth/vesting/types/period.go
@@ -3,23 +3,55 @@ package types
 import (
 	"fmt"
 	"strings"
+	"time"
 
 	"sigs.k8s.io/yaml"
+
+	sdk "github.com/cosmos/cosmos-sdk/types"
 )
 
 // Periods stores all vesting periods passed as part of a PeriodicVestingAccount
 type Periods []Period
 
-// String Period implements stringer interface
+// Duration is converts the period Length from seconds to a time.Duration
+func (p Period) Duration() time.Duration {
+	return time.Duration(p.Length) * time.Second
+}
+
+// String implements the fmt.Stringer interface
 func (p Period) String() string {
 	out, _ := yaml.Marshal(p)
 	return string(out)
 }
 
-// String Periods implements stringer interface
-func (vp Periods) String() string {
-	periodsListString := make([]string, len(vp))
-	for _, period := range vp {
+// TotalLength return the total length in seconds for a period
+func (p Periods) TotalLength() int64 {
+	var total int64
+	for _, period := range p {
+		total += period.Length
+	}
+	return total
+}
+
+// TotalDuration returns the total duration of the period
+func (p Periods) TotalDuration() time.Duration {
+	len := p.TotalLength()
+	return time.Duration(len) * time.Second
+}
+
+// TotalDuration returns the sum of coins for the period
+func (p Periods) TotalAmount() sdk.Coins {
+	total := sdk.Coins{}
+	for _, period := range p {
+		total = total.Add(period.Amount...)
+	}
+	return total
+}
+
+// String implements the fmt.Stringer interface
+func (p Periods) String() string {
+	periodsListString := make([]string, len(p))
+	for _, period := range p {
 		periodsListString = append(periodsListString, period.String())
 	}