sdk: add Atoi function for ChainID (parsing ChainID from string representations of integers)

sdk/vaa/structs.go

@@ -10,6 +10,7 @@ import (
 	"fmt"
 	"io"
 	"math/big"
+	"strconv"
 	"strings"
 	"time"
 
@@ -262,6 +263,33 @@ func (c ChainID) String() string {
 	}
 }
 
+// Atoi converts from a string representation of an integer into a valid ChainID.
+func Atoi(s string) (chainId ChainID, err error) {
+	u16, err := strconv.ParseUint(s, 10, 16)
+	if err != nil {
+		return
+	}
+
+	fmt.Printf("Parsed %s to %d\n", s, u16)
+	// TODO: using slice.Contains would be nicer here, but it requires that users of the SDK are on Go version >= 1.21
+	// This is not the case for e.g. Wormchain, so this function can't be used here until SDK users upgrade their Go versions
+	found := false
+	// NOTE: This function does not contain ChainIDUnset, therefore this function returns an error if the argument is 0.
+	for _, id := range GetAllNetworkIDs() {
+		if ChainID(u16) == ChainID(id) {
+			found = true
+			break
+		}
+	}
+	if !found {
+		err = fmt.Errorf("value %s is not a valid chainId", s)
+		return
+	}
+	chainId = ChainID(u16)
+	return
+}
+
+// ChainIDFromString converts from a chain's full name (e.g. "solana") to its corresponding ChainID.
 func ChainIDFromString(s string) (ChainID, error) {
 	s = strings.ToLower(s)
 

sdk/vaa/structs_test.go

@@ -1111,3 +1111,79 @@ func TestUnmarshalBody(t *testing.T) {
 		})
 	}
 }
+
+func TestAtoi(t *testing.T) {
+
+	happy := []struct {
+		name     string
+		input    string
+		expected ChainID
+	}{
+		{
+			name:     "simple int 1",
+			input:    "1",
+			expected: ChainIDSolana,
+		},
+		{
+			name:     "simple int 2",
+			input:    "3104",
+			expected: ChainIDWormchain,
+		},
+	}
+	for _, tt := range happy {
+		// Avoid "loop variable capture".
+		tt := tt
+		t.Run(tt.name, func(t *testing.T) {
+			t.Parallel()
+
+			actual, err := Atoi(tt.input)
+			require.Equal(t, tt.expected, actual)
+			require.NoError(t, err)
+		})
+	}
+
+	sad := []struct {
+		name  string
+		input string
+	}{
+		{
+			name:  "zero is not a valid ChainID",
+			input: "0",
+		},
+		{
+			name:  "negative value",
+			input: "-1",
+		},
+		{
+			name:  "NaN",
+			input: "garbage",
+		},
+		{
+			name:  "overflow",
+			input: "65536",
+		},
+		{
+			name:  "not a real chain",
+			input: "12345",
+		},
+		{
+			name:  "empty string",
+			input: "",
+		},
+		{
+			name:  "no hex inputs",
+			input: "0x10",
+		},
+	}
+	for _, tt := range sad {
+		// Avoid "loop variable capture".
+		tt := tt
+		t.Run(tt.name, func(t *testing.T) {
+			t.Parallel()
+
+			actual, err := Atoi(tt.input)
+			require.Equal(t, ChainIDUnset, actual)
+			require.Error(t, err)
+		})
+	}
+}