add string method to gas meter (#6137)

* add string method to gas meter * update changelog * Update store/types/gas.go Co-authored-by: Alexander Bezobchuk <[email protected]> Co-authored-by: Alexander Bezobchuk <[email protected]>
cosmos · May 4, 2020 · 18890a2 · 18890a2
1 parent 687d424
commit 18890a2
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 1 deletion.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -230,6 +230,7 @@ functionality that requires an online connection.
 * (simulation) [\#6002](https://github.com/cosmos/cosmos-sdk/pull/6002) Add randomized consensus params into simulation.
 * (x/staking) [\#6059](https://github.com/cosmos/cosmos-sdk/pull/6059) Updated `HistoricalEntries` parameter default to 100.
 * (x/ibc) [\#5948](https://github.com/cosmos/cosmos-sdk/issues/5948) Add `InitGenesis` and `ExportGenesis` functions for `ibc` module.
+* (types) [\#6128](https://github.com/cosmos/cosmos-sdk/pull/6137) Add String() method to GasMeter
 
 ## [v0.38.3] - 2020-04-09
 

diff --git a/store/types/gas.go b/store/types/gas.go
@@ -1,6 +1,9 @@
 package types
 
-import "math"
+import (
+	"fmt"
+	"math"
+)
 
 // Gas consumption descriptors.
 const (
@@ -36,6 +39,7 @@ type GasMeter interface {
 	ConsumeGas(amount Gas, descriptor string)
 	IsPastLimit() bool
 	IsOutOfGas() bool
+	String() string
 }
 
 type basicGasMeter struct {
@@ -98,6 +102,10 @@ func (g *basicGasMeter) IsOutOfGas() bool {
 	return g.consumed >= g.limit
 }
 
+func (g *basicGasMeter) String() string {
+	return fmt.Sprintf("BasicGasMeter:\n  limit: %d\n  consumed: %d", g.limit, g.consumed)
+}
+
 type infiniteGasMeter struct {
 	consumed Gas
 }
@@ -138,6 +146,10 @@ func (g *infiniteGasMeter) IsOutOfGas() bool {
 	return false
 }
 
+func (g *infiniteGasMeter) String() string {
+	return fmt.Sprintf("InfiniteGasMeter:\n  consumed: %d", g.consumed)
+}
+
 // GasConfig defines gas cost for each operation on KVStores
 type GasConfig struct {
 	HasCost          Gas