refactor: Move FormatCoins to core (#13306)
* refactor: Move FormatCoins to `core` * Rename to shorter names * Add chaneglog * Don't panic * add comments * go mod tidy * fix changelog * move structs to top * Fix test * go mod tidy * Refactor tests
This commit is contained in:
Amaury
GitHub
parent
ff4f995b18
commit
10ac33edb8
@ -39,6 +39,8 @@ Ref: https://keepachangelog.com/en/1.0.0/
|
||||
|
||||
### Features
|
||||
|
||||
* (core) [#13306](https://github.com/cosmos/cosmos-sdk/pull/13306) Add a `FormatCoins` function to in `core/coins` to format sdk Coins following the Value Renderers spec.
|
||||
* (math) [#13306](https://github.com/cosmos/cosmos-sdk/pull/13306) Add `FormatInt` and `FormatDec` functiosn in `math` to format integers and decimals following the Value Renderers spec.
|
||||
* (grpc) [#13485](https://github.com/cosmos/cosmos-sdk/pull/13485) Implement a new gRPC query, `/cosmos/base/node/v1beta1/config`, which provides operator configuration.
|
||||
* (x/staking) [#13122](https://github.com/cosmos/cosmos-sdk/pull/13122) Add `UnbondingCanComplete` and `PutUnbondingOnHold` to `x/staking` module.
|
||||
* [#13437](https://github.com/cosmos/cosmos-sdk/pull/13437) Add new flag `--modules-to-export` in `simd export` command to export only selected modules.
|
||||
|
||||
92
core/coins/format.go
Normal file
92
core/coins/format.go
Normal file
@ -0,0 +1,92 @@
|
||||
package coins
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"sort"
|
||||
"strings"
|
||||
|
||||
bankv1beta1 "cosmossdk.io/api/cosmos/bank/v1beta1"
|
||||
basev1beta1 "cosmossdk.io/api/cosmos/base/v1beta1"
|
||||
"cosmossdk.io/math"
|
||||
)
|
||||
|
||||
// formatCoin formats a sdk.Coin into a value-rendered string, using the
|
||||
// given metadata about the denom. It returns the formatted coin string, the
|
||||
// display denom, and an optional error.
|
||||
func formatCoin(coin *basev1beta1.Coin, metadata *bankv1beta1.Metadata) (string, error) {
|
||||
coinDenom := coin.Denom
|
||||
|
||||
// Return early if no display denom or display denom is the current coin denom.
|
||||
if metadata == nil || metadata.Display == "" || coinDenom == metadata.Display {
|
||||
vr, err := math.FormatDec(coin.Amount)
|
||||
return vr + " " + coin.Denom, err
|
||||
}
|
||||
|
||||
dispDenom := metadata.Display
|
||||
|
||||
// Find exponents of both denoms.
|
||||
var coinExp, dispExp uint32
|
||||
foundCoinExp, foundDispExp := false, false
|
||||
for _, unit := range metadata.DenomUnits {
|
||||
if coinDenom == unit.Denom {
|
||||
coinExp = unit.Exponent
|
||||
foundCoinExp = true
|
||||
}
|
||||
if dispDenom == unit.Denom {
|
||||
dispExp = unit.Exponent
|
||||
foundDispExp = true
|
||||
}
|
||||
}
|
||||
|
||||
// If we didn't find either exponent, then we return early.
|
||||
if !foundCoinExp || !foundDispExp {
|
||||
vr, err := math.FormatInt(coin.Amount)
|
||||
return vr + " " + coin.Denom, err
|
||||
}
|
||||
|
||||
exponentDiff := int64(coinExp) - int64(dispExp)
|
||||
|
||||
dispAmount, err := math.LegacyNewDecFromStr(coin.Amount)
|
||||
if err != nil {
|
||||
return "", err
|
||||
}
|
||||
|
||||
if exponentDiff > 0 {
|
||||
dispAmount = dispAmount.Mul(math.LegacyNewDec(10).Power(uint64(exponentDiff)))
|
||||
} else {
|
||||
dispAmount = dispAmount.Quo(math.LegacyNewDec(10).Power(uint64(-exponentDiff)))
|
||||
}
|
||||
|
||||
vr, err := math.FormatDec(dispAmount.String())
|
||||
return vr + " " + dispDenom, err
|
||||
}
|
||||
|
||||
// formatCoins formats Coins into a value-rendered string, which uses
|
||||
// `formatCoin` separated by ", " (a comma and a space), and sorted
|
||||
// alphabetically by value-rendered denoms. It expects an array of metadata
|
||||
// (optionally nil), where each metadata at index `i` MUST match the coin denom
|
||||
// at the same index.
|
||||
func FormatCoins(coins []*basev1beta1.Coin, metadata []*bankv1beta1.Metadata) (string, error) {
|
||||
if len(coins) != len(metadata) {
|
||||
return "", fmt.Errorf("formatCoins expect one metadata for each coin; expected %d, got %d", len(coins), len(metadata))
|
||||
}
|
||||
|
||||
formatted := make([]string, len(coins))
|
||||
for i, coin := range coins {
|
||||
var err error
|
||||
formatted[i], err = formatCoin(coin, metadata[i])
|
||||
if err != nil {
|
||||
return "", err
|
||||
}
|
||||
}
|
||||
|
||||
// Sort the formatted coins by display denom.
|
||||
sort.SliceStable(formatted, func(i, j int) bool {
|
||||
denomI := strings.Split(formatted[i], " ")[1]
|
||||
denomJ := strings.Split(formatted[j], " ")[1]
|
||||
|
||||
return denomI < denomJ
|
||||
})
|
||||
|
||||
return strings.Join(formatted, ", "), nil
|
||||
}
|
||||
81
core/coins/format_test.go
Normal file
81
core/coins/format_test.go
Normal file
@ -0,0 +1,81 @@
|
||||
package coins_test
|
||||
|
||||
import (
|
||||
"encoding/json"
|
||||
"os"
|
||||
"testing"
|
||||
|
||||
bankv1beta1 "cosmossdk.io/api/cosmos/bank/v1beta1"
|
||||
basev1beta1 "cosmossdk.io/api/cosmos/base/v1beta1"
|
||||
"cosmossdk.io/core/coins"
|
||||
"github.com/stretchr/testify/require"
|
||||
)
|
||||
|
||||
// coinsJsonTest is the type of test cases in the coin.json file.
|
||||
type coinJsonTest struct {
|
||||
Proto *basev1beta1.Coin
|
||||
Metadata *bankv1beta1.Metadata
|
||||
Text string
|
||||
Error bool
|
||||
}
|
||||
|
||||
// coinsJsonTest is the type of test cases in the coins.json file.
|
||||
type coinsJsonTest struct {
|
||||
Proto []*basev1beta1.Coin
|
||||
Metadata map[string]*bankv1beta1.Metadata
|
||||
Text string
|
||||
Error bool
|
||||
}
|
||||
|
||||
func TestFormatCoin(t *testing.T) {
|
||||
var testcases []coinJsonTest
|
||||
raw, err := os.ReadFile("../../tx/textual/internal/testdata/coin.json")
|
||||
require.NoError(t, err)
|
||||
err = json.Unmarshal(raw, &testcases)
|
||||
require.NoError(t, err)
|
||||
|
||||
for _, tc := range testcases {
|
||||
t.Run(tc.Text, func(t *testing.T) {
|
||||
if tc.Proto != nil {
|
||||
out, err := coins.FormatCoins([]*basev1beta1.Coin{tc.Proto}, []*bankv1beta1.Metadata{tc.Metadata})
|
||||
|
||||
if tc.Error {
|
||||
require.Error(t, err)
|
||||
return
|
||||
}
|
||||
|
||||
require.NoError(t, err)
|
||||
require.Equal(t, tc.Text, out)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestFormatCoins(t *testing.T) {
|
||||
var testcases []coinsJsonTest
|
||||
raw, err := os.ReadFile("../../tx/textual/internal/testdata/coins.json")
|
||||
require.NoError(t, err)
|
||||
err = json.Unmarshal(raw, &testcases)
|
||||
require.NoError(t, err)
|
||||
|
||||
for _, tc := range testcases {
|
||||
t.Run(tc.Text, func(t *testing.T) {
|
||||
if tc.Proto != nil {
|
||||
metadata := make([]*bankv1beta1.Metadata, len(tc.Proto))
|
||||
for i, coin := range tc.Proto {
|
||||
metadata[i] = tc.Metadata[coin.Denom]
|
||||
}
|
||||
|
||||
out, err := coins.FormatCoins(tc.Proto, metadata)
|
||||
|
||||
if tc.Error {
|
||||
require.Error(t, err)
|
||||
return
|
||||
}
|
||||
|
||||
require.NoError(t, err)
|
||||
require.Equal(t, tc.Text, out)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
@ -5,17 +5,22 @@ go 1.19
|
||||
require (
|
||||
cosmossdk.io/api v0.2.1
|
||||
cosmossdk.io/depinject v1.0.0-alpha.3
|
||||
cosmossdk.io/math v1.0.0-beta.3
|
||||
github.com/cosmos/cosmos-proto v1.0.0-alpha8
|
||||
github.com/stretchr/testify v1.8.0
|
||||
google.golang.org/protobuf v1.28.1
|
||||
gotest.tools/v3 v3.4.0
|
||||
sigs.k8s.io/yaml v1.3.0
|
||||
)
|
||||
|
||||
require (
|
||||
github.com/cosmos/gogoproto v1.4.1 // indirect
|
||||
github.com/davecgh/go-spew v1.1.1 // indirect
|
||||
github.com/golang/protobuf v1.5.2 // indirect
|
||||
github.com/google/go-cmp v0.5.9 // indirect
|
||||
github.com/kr/text v0.2.0 // indirect
|
||||
github.com/pkg/errors v0.9.1 // indirect
|
||||
github.com/pmezard/go-difflib v1.0.0 // indirect
|
||||
golang.org/x/exp v0.0.0-20220827204233-334a2380cb91 // indirect
|
||||
golang.org/x/net v0.0.0-20221017152216-f25eb7ecb193 // indirect
|
||||
golang.org/x/sys v0.0.0-20221013171732-95e765b1cc43 // indirect
|
||||
@ -23,4 +28,8 @@ require (
|
||||
google.golang.org/genproto v0.0.0-20221014213838-99cd37c6964a // indirect
|
||||
google.golang.org/grpc v1.50.1 // indirect
|
||||
gopkg.in/yaml.v2 v2.4.0 // indirect
|
||||
gopkg.in/yaml.v3 v3.0.1 // indirect
|
||||
)
|
||||
|
||||
// temporary until we tag a new go module
|
||||
replace cosmossdk.io/math => ../math
|
||||
|
||||
10
core/go.sum
10
core/go.sum
@ -6,9 +6,12 @@ github.com/alecthomas/participle/v2 v2.0.0-alpha7 h1:cK4vjj0VSgb3lN1nuKA5F7dw+1s
|
||||
github.com/cockroachdb/apd/v3 v3.1.0 h1:MK3Ow7LH0W8zkd5GMKA1PvS9qG3bWFI95WaVNfyZJ/w=
|
||||
github.com/cosmos/cosmos-proto v1.0.0-alpha8 h1:d3pCRuMYYvGA5bM0ZbbjKn+AoQD4A7dyNG2wzwWalUw=
|
||||
github.com/cosmos/cosmos-proto v1.0.0-alpha8/go.mod h1:6/p+Bc4O8JKeZqe0VqUGTX31eoYqemTT4C1hLCWsO7I=
|
||||
github.com/cosmos/gogoproto v1.4.1 h1:WoyH+0/jbCTzpKNvyav5FL1ZTWsp1im1MxEpJEzKUB8=
|
||||
github.com/cosmos/gogoproto v1.4.1/go.mod h1:Ac9lzL4vFpBMcptJROQ6dQ4M3pOEK5Z/l0Q9p+LoCr4=
|
||||
github.com/creack/pty v1.1.9/go.mod h1:oKZEueFk5CKHvIhNR5MUki03XCEU+Q6VDXinZuGJ33E=
|
||||
github.com/cucumber/common/gherkin/go/v22 v22.0.0 h1:4K8NqptbvdOrjL9DEea6HFjSpbdT9+Q5kgLpmmsHYl0=
|
||||
github.com/cucumber/common/messages/go/v17 v17.1.1 h1:RNqopvIFyLWnKv0LfATh34SWBhXeoFTJnSrgm9cT/Ts=
|
||||
github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
|
||||
github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
|
||||
github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
|
||||
github.com/gofrs/uuid v4.2.0+incompatible h1:yyYWMnhkhrKwwr8gAOcOCYxOOscHgDS9yZgBrnJfGa0=
|
||||
@ -24,9 +27,14 @@ github.com/kr/text v0.2.0/go.mod h1:eLer722TekiGuMkidMxC/pM04lWEeraHUUmBw8l2grE=
|
||||
github.com/pkg/errors v0.9.1 h1:FEBLx1zS214owpjy7qsBeixbURkuhQAwrK5UwLGTwt4=
|
||||
github.com/pkg/errors v0.9.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0=
|
||||
github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
|
||||
github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
|
||||
github.com/regen-network/gocuke v0.6.2 h1:pHviZ0kKAq2U2hN2q3smKNxct6hS0mGByFMHGnWA97M=
|
||||
github.com/rogpeppe/go-internal v1.8.1 h1:geMPLpDpQOgVyCg5z5GoRwLHepNdb71NXb67XFkP+Eg=
|
||||
github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
|
||||
github.com/stretchr/objx v0.4.0/go.mod h1:YvHI0jy2hoMjB+UWwv71VJQ9isScKT/TqJzVSSt89Yw=
|
||||
github.com/stretchr/testify v1.7.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
|
||||
github.com/stretchr/testify v1.8.0 h1:pSgiaMZlXftHpm5L7V1+rVB+AZJydKsMxsQBIJw4PKk=
|
||||
github.com/stretchr/testify v1.8.0/go.mod h1:yNjHg4UonilssWZ8iaSj1OCr/vHnekPRkoO+kdMU+MU=
|
||||
github.com/yuin/goldmark v1.2.1/go.mod h1:3hX8gzYuyVAZsxl0MRgGTJEmQBFcNTphYh9decYSb74=
|
||||
golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w=
|
||||
golang.org/x/crypto v0.0.0-20191011191535-87dc89f01550/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI=
|
||||
@ -70,7 +78,9 @@ gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8
|
||||
gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c h1:Hei/4ADfdWqJk1ZMxUNpqntNwaWcugrBjAiHlqqRiVk=
|
||||
gopkg.in/yaml.v2 v2.4.0 h1:D8xgwECY7CYvx+Y2n4sBz93Jn9JRvxdiyyo8CTfuKaY=
|
||||
gopkg.in/yaml.v2 v2.4.0/go.mod h1:RDklbk79AGWmwhnvt/jBztapEOGDOx6ZbXqjP6csGnQ=
|
||||
gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
|
||||
gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
|
||||
gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
|
||||
gotest.tools/v3 v3.4.0 h1:ZazjZUfuVeZGLAmlKKuyv3IKP5orXcwtOwDQH6YVr6o=
|
||||
gotest.tools/v3 v3.4.0/go.mod h1:CtbdzLSsqVhDgMtKsx03ird5YTGB3ar27v0u/yKBW5g=
|
||||
pgregory.net/rapid v0.5.3 h1:163N50IHFqr1phZens4FQOdPgfJscR7a562mjQqeo4M=
|
||||
|
||||
32
math/dec.go
32
math/dec.go
@ -894,3 +894,35 @@ func LegacyDecApproxEq(t *testing.T, d1 LegacyDec, d2 LegacyDec, tol LegacyDec)
|
||||
diff := d1.Sub(d2).Abs()
|
||||
return t, diff.LTE(tol), "expected |d1 - d2| <:\t%v\ngot |d1 - d2| = \t\t%v", tol.String(), diff.String()
|
||||
}
|
||||
|
||||
// FormatDec formats a decimal (as encoded in protobuf) into a value-rendered
|
||||
// string following ADR-050. This function operates with string manipulation
|
||||
// (instead of manipulating the sdk.Dec object).
|
||||
func FormatDec(v string) (string, error) {
|
||||
parts := strings.Split(v, ".")
|
||||
if len(parts) > 2 {
|
||||
return "", fmt.Errorf("invalid decimal: too many points in %s", v)
|
||||
}
|
||||
|
||||
intPart, err := FormatInt(parts[0])
|
||||
if err != nil {
|
||||
return "", err
|
||||
}
|
||||
|
||||
if len(parts) == 1 {
|
||||
return intPart, nil
|
||||
}
|
||||
|
||||
decPart := strings.TrimRight(parts[1], "0")
|
||||
if len(decPart) == 0 {
|
||||
return intPart, nil
|
||||
}
|
||||
|
||||
// Ensure that the decimal part has only digits.
|
||||
// https://github.com/cosmos/cosmos-sdk/issues/12811
|
||||
if !hasOnlyDigits(decPart) {
|
||||
return "", fmt.Errorf("non-digits detected after decimal point in: %q", decPart)
|
||||
}
|
||||
|
||||
return intPart + "." + decPart, nil
|
||||
}
|
||||
|
||||
@ -5,6 +5,7 @@ import (
|
||||
"encoding/json"
|
||||
"fmt"
|
||||
"math/big"
|
||||
"os"
|
||||
"strings"
|
||||
"testing"
|
||||
|
||||
@ -666,3 +667,50 @@ func BenchmarkLegacyQuoRoundupMut(b *testing.B) {
|
||||
}
|
||||
sink = (interface{})(nil)
|
||||
}
|
||||
|
||||
func TestFormatDec(t *testing.T) {
|
||||
type decimalTest []string
|
||||
var testcases []decimalTest
|
||||
raw, err := os.ReadFile("../tx/textual/internal/testdata/decimals.json")
|
||||
require.NoError(t, err)
|
||||
err = json.Unmarshal(raw, &testcases)
|
||||
require.NoError(t, err)
|
||||
|
||||
for _, tc := range testcases {
|
||||
tc := tc
|
||||
t.Run(tc[0], func(t *testing.T) {
|
||||
out, err := math.FormatDec(tc[0])
|
||||
require.NoError(t, err)
|
||||
require.Equal(t, tc[1], out)
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestFormatDecNonDigits(t *testing.T) {
|
||||
badCases := []string{
|
||||
"10.a",
|
||||
"1a.10",
|
||||
"p1a10.",
|
||||
"0.10p",
|
||||
"--10",
|
||||
"12.😎😎",
|
||||
"11111111111133333333333333333333333333333a",
|
||||
"11111111111133333333333333333333333333333 192892",
|
||||
}
|
||||
|
||||
for _, value := range badCases {
|
||||
value := value
|
||||
t.Run(value, func(t *testing.T) {
|
||||
s, err := math.FormatDec(value)
|
||||
if err == nil {
|
||||
t.Fatal("Expected an error")
|
||||
}
|
||||
if g, w := err.Error(), "non-digits"; !strings.Contains(g, w) {
|
||||
t.Errorf("Error mismatch\nGot: %q\nWant substring: %q", g, w)
|
||||
}
|
||||
if s != "" {
|
||||
t.Fatalf("Got a non-empty string: %q", s)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
42
math/int.go
42
math/int.go
@ -5,6 +5,7 @@ import (
|
||||
"encoding/json"
|
||||
"fmt"
|
||||
"math/big"
|
||||
"strings"
|
||||
"testing"
|
||||
)
|
||||
|
||||
@ -432,3 +433,44 @@ func (i *Int) UnmarshalAmino(bz []byte) error { return i.Unmarshal(bz) }
|
||||
func IntEq(t *testing.T, exp, got Int) (*testing.T, bool, string, string, string) {
|
||||
return t, exp.Equal(got), "expected:\t%v\ngot:\t\t%v", exp.String(), got.String()
|
||||
}
|
||||
|
||||
func hasOnlyDigits(s string) bool {
|
||||
if s == "" {
|
||||
return false
|
||||
}
|
||||
for _, r := range s {
|
||||
if r < '0' || r > '9' {
|
||||
return false
|
||||
}
|
||||
}
|
||||
return true
|
||||
}
|
||||
|
||||
const thousandSeparator string = "'"
|
||||
|
||||
// FormatInt formats an integer (encoded as in protobuf) into a value-rendered
|
||||
// string following ADR-050. This function operates with string manipulation
|
||||
// (instead of manipulating the int or sdk.Int object).
|
||||
func FormatInt(v string) (string, error) {
|
||||
sign := ""
|
||||
if v[0] == '-' {
|
||||
sign = "-"
|
||||
v = v[1:]
|
||||
}
|
||||
if len(v) > 1 {
|
||||
v = strings.TrimLeft(v, "0")
|
||||
}
|
||||
|
||||
// Ensure that the string contains only digits at this point.
|
||||
if !hasOnlyDigits(v) {
|
||||
return "", fmt.Errorf("expecting only digits 0-9, but got non-digits in %q", v)
|
||||
}
|
||||
|
||||
startOffset := 3
|
||||
for outputIndex := len(v); outputIndex > startOffset; {
|
||||
outputIndex -= 3
|
||||
v = v[:outputIndex] + thousandSeparator + v[outputIndex:]
|
||||
}
|
||||
|
||||
return sign + v, nil
|
||||
}
|
||||
|
||||
@ -1,12 +1,16 @@
|
||||
package math_test
|
||||
|
||||
import (
|
||||
"encoding/json"
|
||||
"fmt"
|
||||
"math/big"
|
||||
"math/rand"
|
||||
"os"
|
||||
"strconv"
|
||||
"strings"
|
||||
"testing"
|
||||
|
||||
"github.com/stretchr/testify/require"
|
||||
"github.com/stretchr/testify/suite"
|
||||
|
||||
"cosmossdk.io/math"
|
||||
@ -424,3 +428,47 @@ func TestRoundTripMarshalToInt(t *testing.T) {
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestFormatInt(t *testing.T) {
|
||||
type integerTest []string
|
||||
var testcases []integerTest
|
||||
raw, err := os.ReadFile("../tx/textual/internal/testdata/integers.json")
|
||||
require.NoError(t, err)
|
||||
err = json.Unmarshal(raw, &testcases)
|
||||
require.NoError(t, err)
|
||||
|
||||
for _, tc := range testcases {
|
||||
out, err := math.FormatInt(tc[0])
|
||||
require.NoError(t, err)
|
||||
require.Equal(t, tc[1], out)
|
||||
}
|
||||
}
|
||||
|
||||
func TestFormatIntNonDigits(t *testing.T) {
|
||||
badCases := []string{
|
||||
"a10",
|
||||
"1a10",
|
||||
"p1a10",
|
||||
"10p",
|
||||
"--10",
|
||||
"😎😎",
|
||||
"11111111111133333333333333333333333333333a",
|
||||
"11111111111133333333333333333333333333333 192892",
|
||||
}
|
||||
|
||||
for _, value := range badCases {
|
||||
value := value
|
||||
t.Run(value, func(t *testing.T) {
|
||||
s, err := math.FormatInt(value)
|
||||
if err == nil {
|
||||
t.Fatal("Expected an error")
|
||||
}
|
||||
if g, w := err.Error(), "but got non-digits in"; !strings.Contains(g, w) {
|
||||
t.Errorf("Error mismatch\nGot: %q\nWant substring: %q", g, w)
|
||||
}
|
||||
if s != "" {
|
||||
t.Fatalf("Got a non-empty string: %q", s)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
10
tx/go.mod
10
tx/go.mod
@ -4,6 +4,7 @@ go 1.19
|
||||
|
||||
require (
|
||||
cosmossdk.io/api v0.2.1
|
||||
cosmossdk.io/core v0.0.0-00010101000000-000000000000
|
||||
cosmossdk.io/math v1.0.0-beta.3
|
||||
github.com/cosmos/cosmos-proto v1.0.0-alpha8
|
||||
github.com/stretchr/testify v1.8.0
|
||||
@ -14,14 +15,17 @@ require (
|
||||
github.com/cosmos/gogoproto v1.4.2 // indirect
|
||||
github.com/davecgh/go-spew v1.1.1 // indirect
|
||||
github.com/golang/protobuf v1.5.2 // indirect
|
||||
github.com/kr/pretty v0.3.0 // indirect
|
||||
github.com/pmezard/go-difflib v1.0.0 // indirect
|
||||
github.com/rogpeppe/go-internal v1.8.1 // indirect
|
||||
golang.org/x/net v0.0.0-20221017152216-f25eb7ecb193 // indirect
|
||||
golang.org/x/sys v0.0.0-20221013171732-95e765b1cc43 // indirect
|
||||
golang.org/x/text v0.3.8 // indirect
|
||||
google.golang.org/genproto v0.0.0-20221014213838-99cd37c6964a // indirect
|
||||
google.golang.org/grpc v1.50.1 // indirect
|
||||
gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c // indirect
|
||||
gopkg.in/yaml.v3 v3.0.1 // indirect
|
||||
)
|
||||
|
||||
// temporary until we tag a new go module
|
||||
replace (
|
||||
cosmossdk.io/core => ../core
|
||||
cosmossdk.io/math => ../math
|
||||
)
|
||||
|
||||
15
tx/go.sum
15
tx/go.sum
@ -1,12 +1,9 @@
|
||||
cosmossdk.io/api v0.2.1 h1:4m6vIHKJygrixSIfOsD3Mhij9vZlQC/+BTeb+Un9os0=
|
||||
cosmossdk.io/api v0.2.1/go.mod h1:kNpfY0UY7Cz4ZuLJ4hm9auUGfmj23UFpOQ/Bo8IKCFw=
|
||||
cosmossdk.io/math v1.0.0-beta.3 h1:TbZxSopz2LqjJ7aXYfn7nJSb8vNaBklW6BLpcei1qwM=
|
||||
cosmossdk.io/math v1.0.0-beta.3/go.mod h1:3LYasri3Zna4XpbrTNdKsWmD5fHHkaNAod/mNT9XdE4=
|
||||
github.com/cosmos/cosmos-proto v1.0.0-alpha8 h1:d3pCRuMYYvGA5bM0ZbbjKn+AoQD4A7dyNG2wzwWalUw=
|
||||
github.com/cosmos/cosmos-proto v1.0.0-alpha8/go.mod h1:6/p+Bc4O8JKeZqe0VqUGTX31eoYqemTT4C1hLCWsO7I=
|
||||
github.com/cosmos/gogoproto v1.4.2 h1:UeGRcmFW41l0G0MiefWhkPEVEwvu78SZsHBvI78dAYw=
|
||||
github.com/cosmos/gogoproto v1.4.2/go.mod h1:cLxOsn1ljAHSV527CHOtaIP91kK6cCrZETRBrkzItWU=
|
||||
github.com/creack/pty v1.1.9/go.mod h1:oKZEueFk5CKHvIhNR5MUki03XCEU+Q6VDXinZuGJ33E=
|
||||
github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
|
||||
github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
|
||||
github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
|
||||
@ -15,20 +12,11 @@ github.com/golang/protobuf v1.5.2 h1:ROPKBNFfQgOUMifHyP+KYbvpjbdoFNs+aK7DXlji0Tw
|
||||
github.com/golang/protobuf v1.5.2/go.mod h1:XVQd3VNwM+JqD3oG2Ue2ip4fOMUkwXdXDdiuN0vRsmY=
|
||||
github.com/google/go-cmp v0.5.5/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE=
|
||||
github.com/google/go-cmp v0.5.9 h1:O2Tfq5qg4qc4AmwVlvv0oLiVAGB7enBSJ2x2DqQFi38=
|
||||
github.com/kr/pretty v0.1.0/go.mod h1:dAy3ld7l9f0ibDNOQOHHMYYIIbhfbHSm3C4ZsoJORNo=
|
||||
github.com/kr/pretty v0.2.1/go.mod h1:ipq/a2n7PKx3OHsz4KJII5eveXtPO4qwEXGdVfWzfnI=
|
||||
github.com/kr/pretty v0.3.0 h1:WgNl7dwNpEZ6jJ9k1snq4pZsg7DOEN8hP9Xw0Tsjwk0=
|
||||
github.com/kr/pretty v0.3.0/go.mod h1:640gp4NfQd8pI5XOwp5fnNeVWj67G7CFk/SaSQn7NBk=
|
||||
github.com/kr/pty v1.1.1/go.mod h1:pFQYn66WHrOpPYNljwOMqo10TkYh1fy3cYio2l3bCsQ=
|
||||
github.com/kr/text v0.1.0/go.mod h1:4Jbv+DJW3UT/LiOwJeYQe1efqtUx/iVham/4vfdArNI=
|
||||
github.com/kr/text v0.2.0 h1:5Nx0Ya0ZqY2ygV366QzturHI13Jq95ApcVaJBhpS+AY=
|
||||
github.com/kr/text v0.2.0/go.mod h1:eLer722TekiGuMkidMxC/pM04lWEeraHUUmBw8l2grE=
|
||||
github.com/pkg/diff v0.0.0-20210226163009-20ebb0f2a09e/go.mod h1:pJLUxLENpZxwdsKMEsNbx1VGcRFpLqf3715MtcvvzbA=
|
||||
github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
|
||||
github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
|
||||
github.com/rogpeppe/go-internal v1.6.1/go.mod h1:xXDCJY+GAPziupqXw64V24skbSoqbTEfhy4qGm1nDQc=
|
||||
github.com/rogpeppe/go-internal v1.8.1 h1:geMPLpDpQOgVyCg5z5GoRwLHepNdb71NXb67XFkP+Eg=
|
||||
github.com/rogpeppe/go-internal v1.8.1/go.mod h1:JeRgkft04UBgHMgCIwADu4Pn6Mtm5d4nPKWu0nJ5d+o=
|
||||
github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
|
||||
github.com/stretchr/objx v0.4.0/go.mod h1:YvHI0jy2hoMjB+UWwv71VJQ9isScKT/TqJzVSSt89Yw=
|
||||
github.com/stretchr/testify v1.7.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
|
||||
@ -50,10 +38,7 @@ google.golang.org/protobuf v1.26.0/go.mod h1:9q0QmTI4eRPtz6boOQmLYwt+qCgq0jsYwAQ
|
||||
google.golang.org/protobuf v1.28.1 h1:d0NfwRgPtno5B1Wa6L2DAG+KivqkdutMf1UhdNx175w=
|
||||
google.golang.org/protobuf v1.28.1/go.mod h1:HV8QOd/L58Z+nl8r43ehVNZIU/HEI6OcFqwMG9pJV4I=
|
||||
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
|
||||
gopkg.in/check.v1 v1.0.0-20180628173108-788fd7840127/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
|
||||
gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c h1:Hei/4ADfdWqJk1ZMxUNpqntNwaWcugrBjAiHlqqRiVk=
|
||||
gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c/go.mod h1:JHkPIbrfpd72SG/EVd6muEfDQjcINNoR0C8j2r3qZ4Q=
|
||||
gopkg.in/errgo.v2 v2.1.0/go.mod h1:hNsd1EY+bozCKY1Ytp96fpM3vjJbqLJn88ws8XvfDNI=
|
||||
gopkg.in/yaml.v2 v2.4.0 h1:D8xgwECY7CYvx+Y2n4sBz93Jn9JRvxdiyyo8CTfuKaY=
|
||||
gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
|
||||
gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
|
||||
|
||||
@ -3,13 +3,12 @@ package valuerenderer
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
"sort"
|
||||
"strings"
|
||||
|
||||
"google.golang.org/protobuf/reflect/protoreflect"
|
||||
|
||||
bankv1beta1 "cosmossdk.io/api/cosmos/bank/v1beta1"
|
||||
basev1beta1 "cosmossdk.io/api/cosmos/base/v1beta1"
|
||||
"cosmossdk.io/math"
|
||||
"google.golang.org/protobuf/reflect/protoreflect"
|
||||
corecoins "cosmossdk.io/core/coins"
|
||||
)
|
||||
|
||||
// NewCoinsValueRenderer returns a ValueRenderer for SDK Coin and Coins.
|
||||
@ -48,7 +47,7 @@ func (vr coinsValueRenderer) Format(ctx context.Context, v protoreflect.Value) (
|
||||
}
|
||||
}
|
||||
|
||||
formatted, err := formatCoins(coins, metadatas)
|
||||
formatted, err := corecoins.FormatCoins(coins, metadatas)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
@ -65,7 +64,7 @@ func (vr coinsValueRenderer) Format(ctx context.Context, v protoreflect.Value) (
|
||||
return nil, err
|
||||
}
|
||||
|
||||
formatted, err := formatCoin(coin, metadata)
|
||||
formatted, err := corecoins.FormatCoins([]*basev1beta1.Coin{coin}, []*bankv1beta1.Metadata{metadata})
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
@ -81,84 +80,3 @@ func (vr coinsValueRenderer) Parse(_ context.Context, screens []Screen) (protore
|
||||
// ref: https://github.com/cosmos/cosmos-sdk/issues/13153
|
||||
panic("implement me, see #13153")
|
||||
}
|
||||
|
||||
// formatCoin formats a sdk.Coin into a value-rendered string, using the
|
||||
// given metadata about the denom. It returns the formatted coin string, the
|
||||
// display denom, and an optional error.
|
||||
func formatCoin(coin *basev1beta1.Coin, metadata *bankv1beta1.Metadata) (string, error) {
|
||||
coinDenom := coin.Denom
|
||||
|
||||
// Return early if no display denom or display denom is the current coin denom.
|
||||
if metadata == nil || metadata.Display == "" || coinDenom == metadata.Display {
|
||||
vr, err := formatDecimal(coin.Amount)
|
||||
return vr + " " + coin.Denom, err
|
||||
}
|
||||
|
||||
dispDenom := metadata.Display
|
||||
|
||||
// Find exponents of both denoms.
|
||||
var coinExp, dispExp uint32
|
||||
foundCoinExp, foundDispExp := false, false
|
||||
for _, unit := range metadata.DenomUnits {
|
||||
if coinDenom == unit.Denom {
|
||||
coinExp = unit.Exponent
|
||||
foundCoinExp = true
|
||||
}
|
||||
if dispDenom == unit.Denom {
|
||||
dispExp = unit.Exponent
|
||||
foundDispExp = true
|
||||
}
|
||||
}
|
||||
|
||||
// If we didn't find either exponent, then we return early.
|
||||
if !foundCoinExp || !foundDispExp {
|
||||
vr, err := formatInteger(coin.Amount)
|
||||
return vr + " " + coin.Denom, err
|
||||
}
|
||||
|
||||
exponentDiff := int64(coinExp) - int64(dispExp)
|
||||
|
||||
dispAmount, err := math.LegacyNewDecFromStr(coin.Amount)
|
||||
if err != nil {
|
||||
return "", err
|
||||
}
|
||||
|
||||
if exponentDiff > 0 {
|
||||
dispAmount = dispAmount.Mul(math.LegacyNewDec(10).Power(uint64(exponentDiff)))
|
||||
} else {
|
||||
dispAmount = dispAmount.Quo(math.LegacyNewDec(10).Power(uint64(-exponentDiff)))
|
||||
}
|
||||
|
||||
vr, err := formatDecimal(dispAmount.String())
|
||||
return vr + " " + dispDenom, err
|
||||
}
|
||||
|
||||
// formatCoins formats Coins into a value-rendered string, which uses
|
||||
// `formatCoin` separated by ", " (a comma and a space), and sorted
|
||||
// alphabetically by value-rendered denoms. It expects an array of metadata
|
||||
// (optionally nil), where each metadata at index `i` MUST match the coin denom
|
||||
// at the same index.
|
||||
func formatCoins(coins []*basev1beta1.Coin, metadata []*bankv1beta1.Metadata) (string, error) {
|
||||
if len(coins) != len(metadata) {
|
||||
panic(fmt.Errorf("formatCoins expect one metadata for each coin; expected %d, got %d", len(coins), len(metadata)))
|
||||
}
|
||||
|
||||
formatted := make([]string, len(coins))
|
||||
for i, coin := range coins {
|
||||
var err error
|
||||
formatted[i], err = formatCoin(coin, metadata[i])
|
||||
if err != nil {
|
||||
return "", err
|
||||
}
|
||||
}
|
||||
|
||||
// Sort the formatted coins by display denom.
|
||||
sort.SliceStable(formatted, func(i, j int) bool {
|
||||
denomI := strings.Split(formatted[i], " ")[1]
|
||||
denomJ := strings.Split(formatted[j], " ")[1]
|
||||
|
||||
return denomI < denomJ
|
||||
})
|
||||
|
||||
return strings.Join(formatted, ", "), nil
|
||||
}
|
||||
|
||||
@ -2,13 +2,11 @@ package valuerenderer
|
||||
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
"strings"
|
||||
|
||||
"google.golang.org/protobuf/reflect/protoreflect"
|
||||
)
|
||||
|
||||
const thousandSeparator string = "'"
|
||||
"cosmossdk.io/math"
|
||||
)
|
||||
|
||||
// NewDecValueRenderer returns a ValueRenderer for encoding sdk.Dec cosmos
|
||||
// scalars.
|
||||
@ -21,7 +19,7 @@ type decValueRenderer struct{}
|
||||
var _ ValueRenderer = decValueRenderer{}
|
||||
|
||||
func (vr decValueRenderer) Format(_ context.Context, v protoreflect.Value) ([]Screen, error) {
|
||||
formatted, err := formatDecimal(v.String())
|
||||
formatted, err := math.FormatDec(v.String())
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
@ -31,35 +29,3 @@ func (vr decValueRenderer) Format(_ context.Context, v protoreflect.Value) ([]Sc
|
||||
func (vr decValueRenderer) Parse(_ context.Context, screens []Screen) (protoreflect.Value, error) {
|
||||
panic("implement me")
|
||||
}
|
||||
|
||||
// formatDecimal formats a decimal into a value-rendered string. This function
|
||||
// operates with string manipulation (instead of manipulating the sdk.Dec
|
||||
// object).
|
||||
func formatDecimal(v string) (string, error) {
|
||||
parts := strings.Split(v, ".")
|
||||
if len(parts) > 2 {
|
||||
return "", fmt.Errorf("invalid decimal: too many points in %s", v)
|
||||
}
|
||||
|
||||
intPart, err := formatInteger(parts[0])
|
||||
if err != nil {
|
||||
return "", err
|
||||
}
|
||||
|
||||
if len(parts) == 1 {
|
||||
return intPart, nil
|
||||
}
|
||||
|
||||
decPart := strings.TrimRight(parts[1], "0")
|
||||
if len(decPart) == 0 {
|
||||
return intPart, nil
|
||||
}
|
||||
|
||||
// Ensure that the decimal part has only digits.
|
||||
// https://github.com/cosmos/cosmos-sdk/issues/12811
|
||||
if !hasOnlyDigits(decPart) {
|
||||
return "", fmt.Errorf("non-digits detected after decimal point in: %q", decPart)
|
||||
}
|
||||
|
||||
return intPart + "." + decPart, nil
|
||||
}
|
||||
|
||||
@ -1,35 +1,32 @@
|
||||
package valuerenderer
|
||||
package valuerenderer_test
|
||||
|
||||
import (
|
||||
"strings"
|
||||
"encoding/json"
|
||||
"os"
|
||||
"testing"
|
||||
|
||||
"cosmossdk.io/tx/textual/valuerenderer"
|
||||
"github.com/stretchr/testify/require"
|
||||
"google.golang.org/protobuf/reflect/protoreflect"
|
||||
)
|
||||
|
||||
func TestFormatDecimalNonDigits(t *testing.T) {
|
||||
badCases := []string{
|
||||
"10.a",
|
||||
"1a.10",
|
||||
"p1a10.",
|
||||
"0.10p",
|
||||
"--10",
|
||||
"12.😎😎",
|
||||
"11111111111133333333333333333333333333333a",
|
||||
"11111111111133333333333333333333333333333 192892",
|
||||
}
|
||||
func TestDecJsonTestcases(t *testing.T) {
|
||||
type decimalTest []string
|
||||
var testcases []decimalTest
|
||||
raw, err := os.ReadFile("../internal/testdata/decimals.json")
|
||||
require.NoError(t, err)
|
||||
err = json.Unmarshal(raw, &testcases)
|
||||
require.NoError(t, err)
|
||||
|
||||
for _, value := range badCases {
|
||||
value := value
|
||||
t.Run(value, func(t *testing.T) {
|
||||
s, err := formatDecimal(value)
|
||||
if err == nil {
|
||||
t.Fatal("Expected an error")
|
||||
}
|
||||
if g, w := err.Error(), "non-digits"; !strings.Contains(g, w) {
|
||||
t.Errorf("Error mismatch\nGot: %q\nWant substring: %q", g, w)
|
||||
}
|
||||
if s != "" {
|
||||
t.Fatalf("Got a non-empty string: %q", s)
|
||||
}
|
||||
textual := valuerenderer.NewTextual(nil)
|
||||
|
||||
for _, tc := range testcases {
|
||||
tc := tc
|
||||
t.Run(tc[0], func(t *testing.T) {
|
||||
r, err := textual.GetValueRenderer(fieldDescriptorFromName("SDKDEC"))
|
||||
require.NoError(t, err)
|
||||
|
||||
checkNumberTest(t, r, protoreflect.ValueOf(tc[0]), tc[1])
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
@ -2,9 +2,8 @@ package valuerenderer
|
||||
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
"strings"
|
||||
|
||||
"cosmossdk.io/math"
|
||||
"google.golang.org/protobuf/reflect/protoreflect"
|
||||
)
|
||||
|
||||
@ -19,7 +18,7 @@ type intValueRenderer struct{}
|
||||
var _ ValueRenderer = intValueRenderer{}
|
||||
|
||||
func (vr intValueRenderer) Format(_ context.Context, v protoreflect.Value) ([]Screen, error) {
|
||||
formatted, err := formatInteger(v.String())
|
||||
formatted, err := math.FormatInt(v.String())
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
@ -29,42 +28,3 @@ func (vr intValueRenderer) Format(_ context.Context, v protoreflect.Value) ([]Sc
|
||||
func (vr intValueRenderer) Parse(_ context.Context, screens []Screen) (protoreflect.Value, error) {
|
||||
panic("implement me")
|
||||
}
|
||||
|
||||
func hasOnlyDigits(s string) bool {
|
||||
if s == "" {
|
||||
return false
|
||||
}
|
||||
for _, r := range s {
|
||||
if r < '0' || r > '9' {
|
||||
return false
|
||||
}
|
||||
}
|
||||
return true
|
||||
}
|
||||
|
||||
// formatInteger formats an integer into a value-rendered string. This function
|
||||
// operates with string manipulation (instead of manipulating the int or sdk.Int
|
||||
// object).
|
||||
func formatInteger(v string) (string, error) {
|
||||
sign := ""
|
||||
if v[0] == '-' {
|
||||
sign = "-"
|
||||
v = v[1:]
|
||||
}
|
||||
if len(v) > 1 {
|
||||
v = strings.TrimLeft(v, "0")
|
||||
}
|
||||
|
||||
// Ensure that the string contains only digits at this point.
|
||||
if !hasOnlyDigits(v) {
|
||||
return "", fmt.Errorf("expecting only digits 0-9, but got non-digits in %q", v)
|
||||
}
|
||||
|
||||
startOffset := 3
|
||||
for outputIndex := len(v); outputIndex > startOffset; {
|
||||
outputIndex -= 3
|
||||
v = v[:outputIndex] + thousandSeparator + v[outputIndex:]
|
||||
}
|
||||
|
||||
return sign + v, nil
|
||||
}
|
||||
|
||||
@ -1,35 +1,67 @@
|
||||
package valuerenderer
|
||||
package valuerenderer_test
|
||||
|
||||
import (
|
||||
"strings"
|
||||
"context"
|
||||
"encoding/json"
|
||||
"os"
|
||||
"strconv"
|
||||
"testing"
|
||||
|
||||
"github.com/stretchr/testify/require"
|
||||
"google.golang.org/protobuf/reflect/protoreflect"
|
||||
|
||||
"cosmossdk.io/math"
|
||||
"cosmossdk.io/tx/textual/valuerenderer"
|
||||
)
|
||||
|
||||
func TestFormatIntegerNonDigits(t *testing.T) {
|
||||
badCases := []string{
|
||||
"a10",
|
||||
"1a10",
|
||||
"p1a10",
|
||||
"10p",
|
||||
"--10",
|
||||
"😎😎",
|
||||
"11111111111133333333333333333333333333333a",
|
||||
"11111111111133333333333333333333333333333 192892",
|
||||
}
|
||||
func TestIntJsonTestcases(t *testing.T) {
|
||||
type integerTest []string
|
||||
var testcases []integerTest
|
||||
raw, err := os.ReadFile("../internal/testdata/integers.json")
|
||||
require.NoError(t, err)
|
||||
err = json.Unmarshal(raw, &testcases)
|
||||
require.NoError(t, err)
|
||||
|
||||
for _, value := range badCases {
|
||||
value := value
|
||||
t.Run(value, func(t *testing.T) {
|
||||
s, err := formatInteger(value)
|
||||
if err == nil {
|
||||
t.Fatal("Expected an error")
|
||||
}
|
||||
if g, w := err.Error(), "but got non-digits in"; !strings.Contains(g, w) {
|
||||
t.Errorf("Error mismatch\nGot: %q\nWant substring: %q", g, w)
|
||||
}
|
||||
if s != "" {
|
||||
t.Fatalf("Got a non-empty string: %q", s)
|
||||
}
|
||||
})
|
||||
textual := valuerenderer.NewTextual(nil)
|
||||
|
||||
for _, tc := range testcases {
|
||||
// Parse test case strings as protobuf uint64
|
||||
i, err := strconv.ParseUint(tc[0], 10, 64)
|
||||
if err == nil {
|
||||
r, err := textual.GetValueRenderer(fieldDescriptorFromName("UINT64"))
|
||||
require.NoError(t, err)
|
||||
|
||||
checkNumberTest(t, r, protoreflect.ValueOf(i), tc[1])
|
||||
}
|
||||
|
||||
// Parse test case strings as protobuf uint32
|
||||
i, err = strconv.ParseUint(tc[0], 10, 32)
|
||||
if err == nil {
|
||||
r, err := textual.GetValueRenderer(fieldDescriptorFromName("UINT32"))
|
||||
require.NoError(t, err)
|
||||
|
||||
checkNumberTest(t, r, protoreflect.ValueOf(i), tc[1])
|
||||
}
|
||||
|
||||
// Parse test case strings as sdk.Ints
|
||||
_, ok := math.NewIntFromString(tc[0])
|
||||
if ok {
|
||||
r, err := textual.GetValueRenderer(fieldDescriptorFromName("SDKINT"))
|
||||
require.NoError(t, err)
|
||||
|
||||
checkNumberTest(t, r, protoreflect.ValueOf(tc[0]), tc[1])
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// checkNumberTest checks that the output of a number value renderer
|
||||
// matches the expected string. Only use it to test numbers.
|
||||
func checkNumberTest(t *testing.T, r valuerenderer.ValueRenderer, pv protoreflect.Value, expected string) {
|
||||
screens, err := r.Format(context.Background(), pv)
|
||||
require.NoError(t, err)
|
||||
require.Len(t, screens, 1)
|
||||
require.Equal(t, 0, screens[0].Indent)
|
||||
require.Equal(t, false, screens[0].Expert)
|
||||
|
||||
require.Equal(t, expected, screens[0].Text)
|
||||
}
|
||||
|
||||
@ -1,90 +1,16 @@
|
||||
package valuerenderer_test
|
||||
|
||||
import (
|
||||
"context"
|
||||
"encoding/json"
|
||||
"fmt"
|
||||
"os"
|
||||
"strconv"
|
||||
"testing"
|
||||
|
||||
"github.com/stretchr/testify/require"
|
||||
"google.golang.org/protobuf/reflect/protoreflect"
|
||||
|
||||
"cosmossdk.io/math"
|
||||
"cosmossdk.io/tx/textual/internal/testpb"
|
||||
"cosmossdk.io/tx/textual/valuerenderer"
|
||||
)
|
||||
|
||||
func TestFormatInteger(t *testing.T) {
|
||||
type integerTest []string
|
||||
var testcases []integerTest
|
||||
raw, err := os.ReadFile("../internal/testdata/integers.json")
|
||||
require.NoError(t, err)
|
||||
err = json.Unmarshal(raw, &testcases)
|
||||
require.NoError(t, err)
|
||||
|
||||
textual := valuerenderer.NewTextual(nil)
|
||||
|
||||
for _, tc := range testcases {
|
||||
// Parse test case strings as protobuf uint64
|
||||
i, err := strconv.ParseUint(tc[0], 10, 64)
|
||||
if err == nil {
|
||||
r, err := textual.GetValueRenderer(fieldDescriptorFromName("UINT64"))
|
||||
require.NoError(t, err)
|
||||
screens, err := r.Format(context.Background(), protoreflect.ValueOf(i))
|
||||
require.NoError(t, err)
|
||||
require.Equal(t, 1, len(screens))
|
||||
require.Equal(t, tc[1], screens[0].Text)
|
||||
}
|
||||
|
||||
// Parse test case strings as protobuf uint32
|
||||
i, err = strconv.ParseUint(tc[0], 10, 32)
|
||||
if err == nil {
|
||||
r, err := textual.GetValueRenderer(fieldDescriptorFromName("UINT32"))
|
||||
require.NoError(t, err)
|
||||
screens, err := r.Format(context.Background(), protoreflect.ValueOf(i))
|
||||
require.NoError(t, err)
|
||||
require.Equal(t, 1, len(screens))
|
||||
require.Equal(t, tc[1], screens[0].Text)
|
||||
}
|
||||
|
||||
// Parse test case strings as sdk.Ints
|
||||
_, ok := math.NewIntFromString(tc[0])
|
||||
if ok {
|
||||
r, err := textual.GetValueRenderer(fieldDescriptorFromName("SDKINT"))
|
||||
require.NoError(t, err)
|
||||
screens, err := r.Format(context.Background(), protoreflect.ValueOf(tc[0]))
|
||||
require.NoError(t, err)
|
||||
require.Equal(t, 1, len(screens))
|
||||
require.Equal(t, tc[1], screens[0].Text)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func TestFormatDecimal(t *testing.T) {
|
||||
type decimalTest []string
|
||||
var testcases []decimalTest
|
||||
raw, err := os.ReadFile("../internal/testdata/decimals.json")
|
||||
require.NoError(t, err)
|
||||
err = json.Unmarshal(raw, &testcases)
|
||||
require.NoError(t, err)
|
||||
|
||||
textual := valuerenderer.NewTextual(nil)
|
||||
|
||||
for _, tc := range testcases {
|
||||
tc := tc
|
||||
t.Run(tc[0], func(t *testing.T) {
|
||||
r, err := textual.GetValueRenderer(fieldDescriptorFromName("SDKDEC"))
|
||||
require.NoError(t, err)
|
||||
screens, err := r.Format(context.Background(), protoreflect.ValueOf(tc[0]))
|
||||
require.NoError(t, err)
|
||||
require.Equal(t, 1, len(screens))
|
||||
require.Equal(t, tc[1], screens[0].Text)
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestDispatcher(t *testing.T) {
|
||||
testcases := []struct {
|
||||
name string
|
||||
|
||||
Loading…
Reference in New Issue
Block a user