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
@@ -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
|
||||
}
|
||||
@@ -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
@@ -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=
|
||||
|
||||
Reference in New Issue
Block a user