docs: clarify unit for global min gas price (#3227)

It wasn't immediately obvious what the unit is for GlobalMinGasPrice: utia or tia. This PR clarifies that the unit is utia. Motivation: [Slack thread](https://celestia-team.slack.com/archives/C0358RKE6KW/p1711988967258639?thread_ts=1711982699.253989&cid=C0358RKE6KW).
celestiaorg · Apr 1, 2024 · 0993a5b · 0993a5b
1 parent a954bc1
commit 0993a5b
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 7 deletions.
diff --git a/pkg/appconsts/initial_consts.go b/pkg/appconsts/initial_consts.go
@@ -20,7 +20,7 @@ const (
 	// DefaultMinGasPrice is the default min gas price that gets set in the app.toml file.
 	// The min gas price acts as a filter. Transactions below that limit will not pass
 	// a nodes `CheckTx` and thus not be proposed by that node.
-	DefaultMinGasPrice = 0.002
+	DefaultMinGasPrice = 0.002 // utia
 
 	// DefaultUnbondingTime is the default time a validator must wait
 	// to unbond in a proof of stake system. Any validator within this

diff --git a/pkg/appconsts/v2/app_consts.go b/pkg/appconsts/v2/app_consts.go
@@ -1,8 +1,11 @@
 package v2
 
 const (
-	Version              uint64  = 2
-	SquareSizeUpperBound int     = 128
-	SubtreeRootThreshold int     = 64
-	GlobalMinGasPrice    float64 = 0.002 // same as DefaultMinGasPrice
+	Version              uint64 = 2
+	SquareSizeUpperBound int    = 128
+	SubtreeRootThreshold int    = 64
+	// GlobalMinGasPrice is used by x/minfee to prevent transactions from being
+	// included in a block if they specify a gas price lower than this
+	// parameter. GlobalMinGasPrice == DefaultMinGasPrice.
+	GlobalMinGasPrice float64 = 0.002 // utia
 )
diff --git a/specs/src/specs/params.md b/specs/src/specs/params.md
@@ -49,7 +49,7 @@ are blocked by the `x/paramfilter` module.
 | ibc.ConnectionGenesis.MaxExpectedTimePerBlock | 7500000000000 (75 seconds)                  | Maximum expected time per block in nanoseconds under normal operation.                                                                                                                          | True                      |
 | ibc.Transfer.ReceiveEnabled                   | true                                        | Enable receiving tokens via IBC.                                                                                                                                                                | True                      |
 | ibc.Transfer.SendEnabled                      | true                                        | Enable sending tokens via IBC.                                                                                                                                                                  | True                      |
-| minfee.GlobalMinGasPrice                      | 0.002                                        | All transactions must have a gas price greater than or equal to this value.                                                                                                                             | True                      |
+| minfee.GlobalMinGasPrice                      | 0.002 utia                                  | All transactions must have a gas price greater than or equal to this value.                                                                                                                     | True                      |
 | mint.BondDenom                                | utia                                        | Denomination that is inflated and sent to the distribution module account.                                                                                                                      | False                     |
 | mint.DisinflationRate                         | 0.10 (10%)                                  | The rate at which the inflation rate decreases each year.                                                                                                                                       | False                     |
 | mint.InitialInflationRate                     | 0.08 (8%)                                   | The inflation rate the network starts at.                                                                                                                                                       | False                     |
@@ -66,5 +66,4 @@ are blocked by the `x/paramfilter` module.
 | staking.MinCommissionRate                     | 0.05 (5%)                                   | Minimum commission rate used by all validators.                                                                                                                                                 | True                      |
 | staking.UnbondingTime                         | 1814400 (21 days)                           | Duration of time for unbonding in seconds.                                                                                                                                                      | False                     |
 
-
 Note: none of the mint module parameters are governance modifiable because they have been converted into hardcoded constants. See the x/mint README.md for more details.