fix!: unsorted addresses in wallet listing (#721)

Co-authored-by: b00f <[email protected]>

wallet/addresspath/path.go

@@ -22,7 +22,7 @@ func NewPathFromString(str string) (Path, error) {
 	if sub[0] != "m" {
 		return nil, ErrInvalidPath
 	}
-	path := []uint32{}
+	var path []uint32
 	for i := 1; i < len(sub); i++ {
 		indexStr := sub[i]
 		added := uint32(0)
@@ -55,3 +55,7 @@ func (p Path) String() string {
 func (p Path) LastIndex() uint32 {
 	return p[len(p)-1]
 }
+
+func (p Path) AddressType() uint32 {
+	return p[len(p)-2] - HardenedKeyStart
+}

wallet/addresspath/path_test.go

@@ -33,7 +33,7 @@ func TestStringToPath(t *testing.T) {
 		wantPath Path
 		wantErr  error
 	}{
-		{"m", Path{}, nil},
+		{"m", nil, nil},
 		{"m/0", Path{0}, nil},
 		{"m/0/1", Path{0, 1}, nil},
 		{"m/0/1/1000000000", Path{0, 1, 1000000000}, nil},

wallet/vault/vault.go

@@ -2,6 +2,7 @@ package vault
 
 import (
 	"encoding/json"
+	"sort"
 	"strings"
 
 	"golang.org/x/exp/slices"
@@ -205,16 +206,43 @@ func (v *Vault) SetLabel(addr, label string) error {
 }
 
 func (v *Vault) AddressInfos() []AddressInfo {
+	importedAddrs := make([]AddressInfo, 0)
 	addrs := make([]AddressInfo, 0, v.AddressCount())
+	addrsMap := make(map[int][]AddressInfo)
 
 	for _, info := range v.Addresses {
-		addrs = append(addrs, info)
+		if strings.TrimSpace(info.Path) == "" {
+			importedAddrs = append(importedAddrs, info)
+			continue
+		}
+
+		path, _ := addresspath.NewPathFromString(info.Path)
+		addressType := path.AddressType()
+		addrsMap[int(addressType)] = append(addrsMap[int(addressType)], info)
 	}
 
-	slices.SortFunc(addrs, func(a, b AddressInfo) int {
-		return strings.Compare(a.Path, b.Path)
-	})
+	keys := make([]int, 0)
+	for key := range addrsMap {
+		keys = append(keys, key)
+	}
+
+	sort.Ints(keys)
+	for _, key := range keys {
+		addrsValue := addrsMap[key]
+		slices.SortFunc(addrsValue, func(a, b AddressInfo) int {
+			pathA, _ := addresspath.NewPathFromString(a.Path)
+			pathB, _ := addresspath.NewPathFromString(b.Path)
 
+			if pathA.LastIndex() < pathB.LastIndex() {
+				return -1
+			}
+			return 1
+		})
+
+		addrs = append(addrs, addrsValue...)
+	}
+
+	addrs = append(addrs, importedAddrs...)
 	return addrs
 }
 
@@ -385,7 +413,8 @@ func (v *Vault) NewValidatorAddress(label string) (string, error) {
 	return addr, nil
 }
 
-// TODO change structure of AddressInfo to more informativelay object
+// TODO change structure of AddressInfo to more informatively object
+
 // AddressInfo like it can return bls.PublicKey instead of string.
 func (v *Vault) AddressInfo(addr string) *AddressInfo {
 	info, ok := v.Addresses[addr]