feat: method to get network by name, tests

Author: uded

network.go

@@ -7,6 +7,11 @@
 
 package etherscan
 
+import (
+	"fmt"
+	"strings"
+)
+
 var (
 	// EthMainnet Ethereum mainnet for production
 	EthMainnet Network = Network{"Ethereum", "main", "https://api.etherscan.io/api?"}
@@ -28,8 +33,37 @@ var (
 	BscMainnet Network = Network{"Binance", "main", "https://api.bscscan.com/api?"}
 	// BscTestnet Bsc testnet for development
 	BscTestnet Network = Network{"Binance test", "test", "https://api-testnet.bscscan.com/api?"}
+
+	networks = map[string]*Network{
+		"ethmainnet":   &EthMainnet,
+		"ethereum":     &EthMainnet,
+		"eth":          &EthMainnet,
+		"ethropsten":   &EthRopsten,
+		"ropsten":      &EthRopsten,
+		"ethkovan":     &EthKovan,
+		"ethrinkby":    &EthRinkby,
+		"ethgoerli":    &EthGoerli,
+		"ethtobalaba":  &EthTobalaba,
+		"maticmainnet": &MaticMainnet,
+		"polygon":      &MaticMainnet,
+		"matic":        &MaticMainnet,
+		"matictestnet": &MaticTestnet,
+		"mumbai":       &MaticTestnet,
+		"bscmainnet":   &BscMainnet,
+		"binance":      &BscMainnet,
+		"bsctestnet":   &BscTestnet,
+	}
+
+	networkNames []string
 )
 
+func init() {
+	for name, _ := range networks {
+		networkNames = append(networkNames, name)
+	}
+
+}
+
 // Network is ethereum network type (mainnet, ropsten, etc)
 type Network struct {
 	Name    string // Name of the network or chain
@@ -41,3 +75,15 @@ type Network struct {
 func (n Network) Domain() (sub string) {
 	return n.baseURL
 }
+
+func ParseNetworkName(network string) (Network, error) {
+	if x, ok := networks[network]; ok {
+		return *x, nil
+	}
+	// Case insensitive parse, do a separate lookup to prevent unnecessary cost of lowercasing a string if we don't need to.
+	if x, ok := networks[strings.ToLower(network)]; ok {
+		return *x, nil
+	}
+	return Network{}, fmt.Errorf("%s is not a valid ETHNetworkType, try one of [%s]", network, strings.Join(networkNames, ", "))
+
+}

network_test.go

@@ -0,0 +1,45 @@
+package etherscan
+
+import (
+	"reflect"
+	"testing"
+)
+
+func TestParseNetworkName(t *testing.T) {
+	tests := []struct {
+		name    string
+		want    Network
+		wantErr bool
+	}{
+		{"ethmainnet", EthMainnet, false},
+		{"eth main net", Network{}, true},
+		{"ethereum", EthMainnet, false},
+		{"eth", EthMainnet, false},
+		{"ethropsten", EthRopsten, false},
+		{"ropsten", EthRopsten, false},
+		{"ethkovan", EthKovan, false},
+		{"ethrinkby", EthRinkby, false},
+		{"ethgoerli", EthGoerli, false},
+		{"ethtobalaba", EthTobalaba, false},
+		{"maticmainnet", MaticMainnet, false},
+		{"polygon", MaticMainnet, false},
+		{"matic", MaticMainnet, false},
+		{"matictestnet", MaticTestnet, false},
+		{"mumbai", MaticTestnet, false},
+		{"bscmainnet", BscMainnet, false},
+		{"binance", BscMainnet, false},
+		{"bsctestnet", BscTestnet, false},
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			got, err := ParseNetworkName(tt.name)
+			if (err != nil) != tt.wantErr {
+				t.Errorf("ParseNetworkName() error = %v, wantErr %v", err, tt.wantErr)
+				return
+			}
+			if !reflect.DeepEqual(got, tt.want) {
+				t.Errorf("ParseNetworkName() got = %v, want %v", got, tt.want)
+			}
+		})
+	}
+}