Rust code generation

.github/workflows/rs.yml

@@ -0,0 +1,42 @@
+name: Rust - Build and test
+
+on: [ push ]
+
+jobs:
+  build-test:
+    name: Build and test
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout sources
+        uses: actions/checkout@v3
+      - name: Install rust toolchain
+        uses: dtolnay/rust-toolchain@stable
+        with:
+          components: rustfmt, clippy
+      - uses: Swatinem/rust-cache@v2
+        with:
+          cache-on-failure: true
+      - name: Set up Go
+        uses: actions/setup-go@v3
+        with:
+          go-version-file: "go.mod"
+          cache: false
+      - name: Make sure generated files are updated
+        run: |
+          if go generate ./rs | grep -q 'evm (rust): no changes detected'; then
+            exit 0;
+          fi
+          exit 1;
+      - name: cargo fmt
+        working-directory: rs/chainselectors
+        run: cargo fmt --all -- --check
+      - name: cargo clippy
+        working-directory: rs/chainselectors
+        run: cargo clippy --all-targets --all-features -- -D warnings
+      - name: cargo test
+        working-directory: rs/chainselectors
+        run: cargo test
+        timeout-minutes: 1
+      - name: cargo build
+        working-directory: rs/chainselectors
+        run: cargo build

README.md

@@ -124,7 +124,7 @@ Any new chains and selectors should be always added to [selectors.yml](selectors
 details from this file. This ensures that all client libraries are in sync and use the same mapping.
 To add a new chain, please add new entry to the `selectors.yml` file and use the following format:
 
-Make sure to run `go generate` after making any changes.
+Make sure to run `go generate ./...` after making any changes.
 
 ```yaml
 $chain_id:

evm_test.go

@@ -22,7 +22,7 @@ func TestNoSameChainSelectorsAreGenerated(t *testing.T) {
 }
 
 func TestNoOverlapBetweenRealAndTestChains(t *testing.T) {
-	for k, _ := range evmSelectorsMap {
+	for k := range evmSelectorsMap {
 		_, exist := evmTestSelectorsMap[k]
 		assert.False(t, exist, "Chain %d is duplicated between real and test chains", k)
 	}

genchains_aptos.go

@@ -3,17 +3,13 @@
 package main
 
 import (
-	"bytes"
 	"fmt"
 	"go/format"
-	"html/template"
 	"os"
-	"sort"
-	"strconv"
-	"strings"
-	"unicode"
+	"text/template"
 
 	chain_selectors "github.com/smartcontractkit/chain-selectors"
+	"github.com/smartcontractkit/chain-selectors/internal/gotmpl"
 )
 
 const filename = "generated_chains_aptos.go"
@@ -48,7 +44,7 @@ var AptosALL = []AptosChain{
 `)
 
 func main() {
-	src, err := genChainsSourceCode()
+	src, err := gotmpl.Run(chainTemplate, chain_selectors.AptosChainIdToChainSelector, chain_selectors.AptosNameFromChainId)
 	if err != nil {
 		panic(err)
 	}
@@ -74,41 +70,3 @@ func main() {
 		panic(err)
 	}
 }
-
-func genChainsSourceCode() (string, error) {
-	var wr = new(bytes.Buffer)
-	chains := make([]chain, 0)
-
-	for ChainID, chainSel := range chain_selectors.AptosChainIdToChainSelector() {
-		name, err := chain_selectors.AptosNameFromChainId(ChainID)
-		if err != nil {
-			return "", err
-		}
-
-		chains = append(chains, chain{
-			ChainID:  ChainID,
-			Selector: chainSel,
-			Name:     name,
-			VarName:  toVarName(name, chainSel),
-		})
-	}
-
-	sort.Slice(chains, func(i, j int) bool { return chains[i].VarName < chains[j].VarName })
-	if err := chainTemplate.ExecuteTemplate(wr, "", chains); err != nil {
-		return "", err
-	}
-	return wr.String(), nil
-}
-
-func toVarName(name string, chainSel uint64) string {
-	const unnamed = "TEST"
-	x := strings.ReplaceAll(name, "-", "_")
-	x = strings.ToUpper(x)
-	if len(x) > 0 && unicode.IsDigit(rune(x[0])) {
-		x = unnamed + "_" + x
-	}
-	if len(x) == 0 {
-		x = unnamed + "_" + strconv.FormatUint(chainSel, 10)
-	}
-	return x
-}

genchains_evm.go

@@ -3,28 +3,17 @@
 package main
 
 import (
-	"bytes"
 	"fmt"
 	"go/format"
-	"html/template"
 	"os"
-	"sort"
-	"strconv"
-	"strings"
-	"unicode"
+	"text/template"
 
 	chain_selectors "github.com/smartcontractkit/chain-selectors"
+	"github.com/smartcontractkit/chain-selectors/internal/gotmpl"
 )
 
 const filename = "generated_chains_evm.go"
 
-type chain struct {
-	EvmChainID uint64
-	Selector   uint64
-	Name       string
-	VarName    string
-}
-
 var chainTemplate, _ = template.New("").Parse(`// Code generated by go generate please DO NOT EDIT
 package chain_selectors
 
@@ -37,7 +26,7 @@ type Chain struct {
 
 var (
 {{ range . }}
-	{{.VarName}} = Chain{EvmChainID: {{ .EvmChainID }}, Selector: {{ .Selector }}, Name: "{{ .Name }}"}{{ end }}
+	{{.VarName}} = Chain{EvmChainID: {{ .ChainID }}, Selector: {{ .Selector }}, Name: "{{ .Name }}"}{{ end }}
 )
 
 var ALL = []Chain{
@@ -48,7 +37,7 @@ var ALL = []Chain{
 `)
 
 func main() {
-	src, err := genChainsSourceCode()
+	src, err := gotmpl.Run(chainTemplate, chain_selectors.EvmChainIdToChainSelector, chain_selectors.NameFromChainId)
 	if err != nil {
 		panic(err)
 	}
@@ -74,41 +63,3 @@ func main() {
 		panic(err)
 	}
 }
-
-func genChainsSourceCode() (string, error) {
-	var wr = new(bytes.Buffer)
-	chains := make([]chain, 0)
-
-	for evmChainID, chainSel := range chain_selectors.EvmChainIdToChainSelector() {
-		name, err := chain_selectors.NameFromChainId(evmChainID)
-		if err != nil {
-			return "", err
-		}
-
-		chains = append(chains, chain{
-			EvmChainID: evmChainID,
-			Selector:   chainSel,
-			Name:       name,
-			VarName:    toVarName(name, chainSel),
-		})
-	}
-
-	sort.Slice(chains, func(i, j int) bool { return chains[i].VarName < chains[j].VarName })
-	if err := chainTemplate.ExecuteTemplate(wr, "", chains); err != nil {
-		return "", err
-	}
-	return wr.String(), nil
-}
-
-func toVarName(name string, chainSel uint64) string {
-	const unnamed = "TEST"
-	x := strings.ReplaceAll(name, "-", "_")
-	x = strings.ToUpper(x)
-	if len(x) > 0 && unicode.IsDigit(rune(x[0])) {
-		x = unnamed + "_" + x
-	}
-	if len(x) == 0 {
-		x = unnamed + "_" + strconv.FormatUint(chainSel, 10)
-	}
-	return x
-}

genchains_solana.go

@@ -3,17 +3,13 @@
 package main
 
 import (
-	"bytes"
 	"fmt"
 	"go/format"
-	"html/template"
 	"os"
-	"sort"
-	"strconv"
-	"strings"
+	"text/template"
 
-	"github.com/mr-tron/base58"
 	chain_selectors "github.com/smartcontractkit/chain-selectors"
+	"github.com/smartcontractkit/chain-selectors/internal/gotmpl"
 )
 
 const filename = "generated_chains_solana.go"
@@ -48,7 +44,7 @@ var SolanaALL = []SolanaChain{
 `)
 
 func main() {
-	src, err := genChainsSourceCode()
+	src, err := gotmpl.Run(chainTemplate, chain_selectors.SolanaChainIdToChainSelector, chain_selectors.SolanaNameFromChainId)
 	if err != nil {
 		panic(err)
 	}
@@ -74,48 +70,3 @@ func main() {
 		panic(err)
 	}
 }
-
-func genChainsSourceCode() (string, error) {
-	var wr = new(bytes.Buffer)
-	chains := make([]chain, 0)
-
-	for ChainID, chainSel := range chain_selectors.SolanaChainIdToChainSelector() {
-		name, err := chain_selectors.SolanaNameFromChainId(ChainID)
-		if err != nil {
-			return "", err
-		}
-
-		chains = append(chains, chain{
-			ChainID:  ChainID,
-			Selector: chainSel,
-			Name:     name,
-			VarName:  toVarName(name, chainSel),
-		})
-	}
-
-	sort.Slice(chains, func(i, j int) bool { return chains[i].VarName < chains[j].VarName })
-	if err := chainTemplate.ExecuteTemplate(wr, "", chains); err != nil {
-		return "", err
-	}
-	return wr.String(), nil
-}
-
-func toVarName(name string, chainSel uint64) string {
-	const unnamed = "TEST"
-	x := strings.ReplaceAll(name, "-", "_")
-	x = strings.ToUpper(x)
-
-	// if len(x) > 0 && unicode.IsDigit(rune(x[0]))
-	// for evm, the above condition is used to detect if name == chainId == (some number) -> which means its a test chain
-	// for solana, as chainId is not a number but a base58 encoded hash, we cannot use the above condition
-	// we need to check if the name == chainId == a valid base58 encoded hash
-
-	_, err := base58.Decode(name)
-	if err == nil {
-		x = unnamed + "_" + x
-	}
-	if len(x) == 0 {
-		x = unnamed + "_" + strconv.FormatUint(chainSel, 10)
-	}
-	return x
-}

go.mod

@@ -11,4 +11,5 @@ require (
 require (
 	github.com/davecgh/go-spew v1.1.1 // indirect
 	github.com/pmezard/go-difflib v1.0.0 // indirect
+	golang.org/x/text v0.19.0 // indirect
 )

go.sum

@@ -6,6 +6,8 @@ github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZb
 github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
 github.com/stretchr/testify v1.8.4 h1:CcVxjf3Q8PM0mHUKJCdn+eZZtm5yQwehR5yeSVQQcUk=
 github.com/stretchr/testify v1.8.4/go.mod h1:sz/lmYIOXD/1dqDmKjjqLyZ2RngseejIcXlSw2iwfAo=
+golang.org/x/text v0.19.0 h1:kTxAhCbGbxhK0IwgSKiMO5awPoDQ0RpfiVYBfK860YM=
+golang.org/x/text v0.19.0/go.mod h1:BuEKDfySbSR4drPmRPG/7iBdf8hvFMuRexcpahXilzY=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
 gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=

internal/gotmpl/encoder.go

@@ -0,0 +1,51 @@
+package gotmpl
+
+import (
+	"regexp"
+	"strconv"
+	"strings"
+	"unicode"
+
+	"github.com/mr-tron/base58"
+	"golang.org/x/text/cases"
+	"golang.org/x/text/language"
+)
+
+var (
+	reSeperators = regexp.MustCompile("[-_]+")
+	caser        = cases.Title(language.English)
+)
+
+func encodeVarName(name string, chainSel uint64) string {
+	const unnamed = "TEST"
+	x := strings.ReplaceAll(name, "-", "_")
+	x = strings.ToUpper(x)
+	if len(x) > 0 && (unicode.IsDigit(rune(x[0])) || isSolTestChain(name)) {
+		x = unnamed + "_" + x
+	}
+	if len(x) == 0 {
+		x = unnamed + "_" + strconv.FormatUint(chainSel, 10)
+	}
+	return x
+}
+
+func encodeEnumName(name string, chainSel uint64) string {
+	const unnamed = "Test"
+	x := reSeperators.ReplaceAllString(name, " ")
+	varName := strings.ReplaceAll(caser.String(x), " ", "")
+	if len(varName) > 0 && (unicode.IsDigit(rune(varName[0])) || isSolTestChain(name)) {
+		varName = unnamed + varName
+	}
+	if len(varName) == 0 {
+		varName = unnamed + strconv.FormatUint(chainSel, 10)
+	}
+	return varName
+}
+
+// for evm, the above condition is used to detect if name == chainId == (some number) -> which means its a test chain
+// for solana, as chainId is not a number but a base58 encoded hash, we cannot use the above condition
+// we need to check if the name == chainId == a valid base58 encoded hash
+func isSolTestChain(name string) bool {
+	_, err := base58.Decode(name)
+	return err == nil
+}