Standardize decimals (#1620)

cli/cli.go

@@ -14,7 +14,6 @@ import (
 type Controller interface {
  DatabasePath() string
  Symbol() string
- Decimals() uint8
  GetParser(string) (chain.Parser, error)
  HandleTx(*chain.Transaction, *chain.Result)
  LookupBalance(address codec.Address, uri string) (uint64, error)

cli/key.go

@@ -36,7 +36,7 @@ func (h *Handler) SetKey() error {
  "%d) {{cyan}}address:{{/}} %s {{cyan}}balance:{{/}} %s %s\n",
  i,
  addrStr,
- utils.FormatBalance(balance, h.c.Decimals()),
+ utils.FormatBalance(balance),
  h.c.Symbol(),
  )
  }
@@ -73,7 +73,7 @@ func (h *Handler) Balance(checkAllChains bool) error {
  utils.Outf(
  "{{cyan}}address:{{/}} %s {{cyan}}balance:{{/}} %s %s\n",
  addr,
- utils.FormatBalance(balance, h.c.Decimals()),
+ utils.FormatBalance(balance),
  h.c.Symbol(),
  )
  }

cli/prompt/prompt.go

@@ -124,7 +124,6 @@ func Asset(label string, symbol string, allowNative bool) (ids.ID, error) {
 
 func Amount(
  label string,
- decimals uint8,
  balance uint64,
  f func(input uint64) error,
 ) (uint64, error) {
@@ -134,7 +133,7 @@ func Amount(
  if len(input) == 0 {
  return ErrInputEmpty
  }
- amount, err := utils.ParseBalance(input, decimals)
+ amount, err := utils.ParseBalance(input)
  if err != nil {
  return err
  }
@@ -152,7 +151,7 @@ func Amount(
  return 0, err
  }
  rawAmount = strings.TrimSpace(rawAmount)
- return utils.ParseBalance(rawAmount, decimals)
+ return utils.ParseBalance(rawAmount)
 }
 
 func Int(

cli/spam.go

@@ -204,7 +204,7 @@ func (h *Handler) Spam(sh SpamHelper) error {
  distAmount := (balance - withholding) / uint64(numAccounts)
  utils.Outf(
  "{{yellow}}distributing funds to each account:{{/}} %s %s\n",
- utils.FormatBalance(distAmount, h.c.Decimals()),
+ utils.FormatBalance(distAmount),
  h.c.Symbol(),
  )
  accounts := make([]*PrivateKey, numAccounts)
@@ -455,7 +455,7 @@ func (h *Handler) Spam(sh SpamHelper) error {
  }
  utils.Outf(
  "{{yellow}}returned funds:{{/}} %s %s\n",
- utils.FormatBalance(returnedBalance, h.c.Decimals()),
+ utils.FormatBalance(returnedBalance),
  h.c.Symbol(),
  )
  return nil

consts/consts.go

@@ -30,4 +30,5 @@ const (
  MaxUint64 = ^uint64(0)
  MaxFloat64 = math.MaxFloat64
  MillisecondsPerSecond = 1000
+ Decimals = 9
 )

docs/tutorials/morpheusvm/options.md

@@ -29,12 +29,6 @@ func GetBalanceFromState(
 This function is almost identical to `getBalance()` except that we are passing
 along `f` of type `ReadState` instead of `im` of type `state.Immutable`. 
 
-We also need to specify the precision of our VM token. To do this, go to
-`consts/consts.go` and add the following constant:
-
-```golang
-const Decimals = 9
-```
 
 ## Getting Started
 
@@ -233,7 +227,7 @@ func (cli *JSONRPCClient) WaitForBalance(
  if !shouldExit {
  utils.Outf(
  "{{yellow}}waiting for %s balance: %s{{/}}\n",
- utils.FormatBalance(min, consts.Decimals),
+ utils.FormatBalance(min),
  addr,
  )
  }

examples/morpheusvm/cmd/morpheus-cli/cmd/action.go

@@ -11,7 +11,6 @@ import (
  "github.com/ava-labs/hypersdk/chain"
  "github.com/ava-labs/hypersdk/cli/prompt"
  "github.com/ava-labs/hypersdk/examples/morpheusvm/actions"
- "github.com/ava-labs/hypersdk/examples/morpheusvm/consts"
 )
 
 var actionCmd = &cobra.Command{
@@ -43,7 +42,7 @@ var transferCmd = &cobra.Command{
  }
 
  // Select amount
- amount, err := prompt.Amount("amount", consts.Decimals, balance, nil)
+ amount, err := prompt.Amount("amount", balance, nil)
  if err != nil {
  return err
  }

examples/morpheusvm/cmd/morpheus-cli/cmd/handler.go

@@ -99,7 +99,7 @@ func (*Handler) GetBalance(
  }
  utils.Outf(
  "{{yellow}}balance:{{/}} %s %s\n",
- utils.FormatBalance(balance, consts.Decimals),
+ utils.FormatBalance(balance),
  consts.Symbol,
  )
  return balance, nil
@@ -121,10 +121,6 @@ func (*Controller) Symbol() string {
  return consts.Symbol
 }
 
-func (*Controller) Decimals() uint8 {
- return consts.Decimals
-}
-
 func (*Controller) GetParser(uri string) (chain.Parser, error) {
  cli := vm.NewJSONRPCClient(uri)
  return cli.Parser(context.TODO())

examples/morpheusvm/cmd/morpheus-cli/cmd/resolutions.go

@@ -70,7 +70,7 @@ func handleTx(tx *chain.Transaction, result *chain.Result) {
  actor,
  result.Error,
  float64(result.Fee)/float64(tx.Base.MaxFee)*100,
- utils.FormatBalance(result.Fee, consts.Decimals),
+ utils.FormatBalance(result.Fee),
  consts.Symbol,
  result.Units,
  )
@@ -81,7 +81,7 @@ func handleTx(tx *chain.Transaction, result *chain.Result) {
  var summaryStr string
  switch act := action.(type) { //nolint:gocritic
  case *actions.Transfer:
- summaryStr = fmt.Sprintf("%s %s -> %s\n", utils.FormatBalance(act.Value, consts.Decimals), consts.Symbol, actor)
+ summaryStr = fmt.Sprintf("%s %s -> %s\n", utils.FormatBalance(act.Value), consts.Symbol, actor)
  }
  utils.Outf(
  "%s {{yellow}}%s{{/}} {{yellow}}actor:{{/}} %s {{yellow}}summary (%s):{{/}} [%s] {{yellow}}fee (max %.2f%%):{{/}} %s %s {{yellow}}consumed:{{/}} [%s]\n",
@@ -91,7 +91,7 @@ func handleTx(tx *chain.Transaction, result *chain.Result) {
  reflect.TypeOf(action),
  summaryStr,
  float64(result.Fee)/float64(tx.Base.MaxFee)*100,
- utils.FormatBalance(result.Fee, consts.Decimals),
+ utils.FormatBalance(result.Fee),
  consts.Symbol,
  result.Units,
  )

examples/morpheusvm/cmd/morpheus-cli/cmd/spam.go

@@ -73,7 +73,7 @@ func (sh *SpamHelper) LookupBalance(choice int, address codec.Address) (uint64,
  "%d) {{cyan}}address:{{/}} %s {{cyan}}balance:{{/}} %s %s\n",
  choice,
  address,
- utils.FormatBalance(balance, consts.Decimals),
+ utils.FormatBalance(balance),
  consts.Symbol,
  )
  return balance, err

examples/morpheusvm/vm/client.go

@@ -80,7 +80,7 @@ func (cli *JSONRPCClient) WaitForBalance(
  if !shouldExit {
  utils.Outf(
  "{{yellow}}waiting for %s balance: %s{{/}}\n",
- utils.FormatBalance(min, consts.Decimals),
+ utils.FormatBalance(min),
  addr,
  )
  }

examples/vmwithcontracts/cmd/vmwithcontracts-cli/cmd/action.go

@@ -15,7 +15,6 @@ import (
  "github.com/ava-labs/hypersdk/cli/prompt"
  "github.com/ava-labs/hypersdk/codec"
  "github.com/ava-labs/hypersdk/examples/vmwithcontracts/actions"
- "github.com/ava-labs/hypersdk/examples/vmwithcontracts/consts"
  "github.com/ava-labs/hypersdk/utils"
 )
 
@@ -48,7 +47,7 @@ var transferCmd = &cobra.Command{
  }
 
  // Select amount
- amount, err := prompt.Amount("amount", consts.Decimals, balance, nil)
+ amount, err := prompt.Amount("amount", balance, nil)
  if err != nil {
  return err
  }
@@ -127,7 +126,7 @@ var callCmd = &cobra.Command{
  }
 
  // Select amount
- amount, err := prompt.Amount("amount", consts.Decimals, balance, nil)
+ amount, err := prompt.Amount("amount", balance, nil)
  if err != nil {
  return err
  }
@@ -174,7 +173,7 @@ var callCmd = &cobra.Command{
  if err != nil {
  return err
  }
- utils.Outf("%s\n", utils.FormatBalance(intValue, consts.Decimals))
+ utils.Outf("%s\n", utils.FormatBalance(intValue))
  }
  case "get_value":
  {

examples/vmwithcontracts/cmd/vmwithcontracts-cli/cmd/handler.go

@@ -99,7 +99,7 @@ func (*Handler) GetBalance(
  }
  utils.Outf(
  "{{yellow}}balance:{{/}} %s %s\n",
- utils.FormatBalance(balance, consts.Decimals),
+ utils.FormatBalance(balance),
  consts.Symbol,
  )
  return balance, nil

examples/vmwithcontracts/cmd/vmwithcontracts-cli/cmd/resolutions.go

@@ -67,7 +67,7 @@ func handleTx(tx *chain.Transaction, result *chain.Result) {
  actor,
  result.Error,
  float64(result.Fee)/float64(tx.Base.MaxFee)*100,
- utils.FormatBalance(result.Fee, consts.Decimals),
+ utils.FormatBalance(result.Fee),
  consts.Symbol,
  result.Units,
  )
@@ -78,7 +78,7 @@ func handleTx(tx *chain.Transaction, result *chain.Result) {
  var summaryStr string
  switch act := action.(type) { //nolint:gocritic
  case *actions.Transfer:
- summaryStr = fmt.Sprintf("%s %s -> %s\n", utils.FormatBalance(act.Value, consts.Decimals), consts.Symbol, act.To)
+ summaryStr = fmt.Sprintf("%s %s -> %s\n", utils.FormatBalance(act.Value), consts.Symbol, act.To)
  }
  utils.Outf(
  "%s {{yellow}}%s{{/}} {{yellow}}actor:{{/}} %s {{yellow}}summary (%s):{{/}} [%s] {{yellow}}fee (max %.2f%%):{{/}} %s %s {{yellow}}consumed:{{/}} [%s]\n",
@@ -88,7 +88,7 @@ func handleTx(tx *chain.Transaction, result *chain.Result) {
  reflect.TypeOf(action),
  summaryStr,
  float64(result.Fee)/float64(tx.Base.MaxFee)*100,
- utils.FormatBalance(result.Fee, consts.Decimals),
+ utils.FormatBalance(result.Fee),
  consts.Symbol,
  result.Units,
  )

examples/vmwithcontracts/cmd/vmwithcontracts-cli/cmd/spam.go

@@ -73,7 +73,7 @@ func (sh *SpamHelper) LookupBalance(choice int, address codec.Address) (uint64,
  "%d) {{cyan}}address:{{/}} %s {{cyan}}balance:{{/}} %s %s\n",
  choice,
  address,
- utils.FormatBalance(balance, consts.Decimals),
+ utils.FormatBalance(balance),
  consts.Symbol,
  )
  return balance, err

examples/vmwithcontracts/vm/client.go

@@ -83,7 +83,7 @@ func (cli *JSONRPCClient) WaitForBalance(
  if !shouldExit {
  utils.Outf(
  "{{yellow}}waiting for %s balance: %s{{/}}\n",
- utils.FormatBalance(min, consts.Decimals),
+ utils.FormatBalance(min),
  addr,
  )
  }

utils/utils.go

@@ -65,16 +65,16 @@ func GetPort(uri string) (string, error) {
  return purl.Port(), err
 }
 
-func FormatBalance(bal uint64, decimals uint8) string {
- return strconv.FormatFloat(float64(bal)/math.Pow10(int(decimals)), 'f', int(decimals), 64)
+func FormatBalance(bal uint64) string {
+ return strconv.FormatFloat(float64(bal)/math.Pow10(int(consts.Decimals)), 'f', int(consts.Decimals), 64)
 }
 
-func ParseBalance(bal string, decimals uint8) (uint64, error) {
+func ParseBalance(bal string) (uint64, error) {
  f, err := strconv.ParseFloat(bal, 64)
  if err != nil {
  return 0, err
  }
- return uint64(f * math.Pow10(int(decimals))), nil
+ return uint64(f * math.Pow10(int(consts.Decimals))), nil
 }
 
 func Repeat[T any](v T, n int) []T {

utils/utils_test.go

@@ -7,6 +7,7 @@ import (
  "bytes"
  "os"
  "path/filepath"
+ "strconv"
  "testing"
 
  "github.com/ava-labs/avalanchego/ids"
@@ -82,3 +83,31 @@ func TestLoadBytes(t *testing.T) {
  // Remove
  _ = os.Remove(fileName)
 }
+
+func TestFormatAndParseBalance(t *testing.T) {
+ // this test assumes that the number of decimals is 9
+ require := require.New(t)
+
+ testCases := []struct {
+ input uint64
+ expected string
+ }{
+ {1000000000, "1.000000000"},
+ {123456789, "0.123456789"},
+ {1234567890, "1.234567890"},
+ {9876543210, "9.876543210"},
+ {0, "0.000000000"},
+ }
+
+ for _, tc := range testCases {
+ formatted := FormatBalance(tc.input)
+ require.Equal(tc.expected, formatted)
+
+ parsed, err := ParseBalance(tc.expected)
+ require.NoError(err)
+ require.Equal(tc.input, parsed)
+ }
+
+ _, err := ParseBalance("invalid")
+ require.ErrorIs(err, strconv.ErrSyntax)
+}