refactor(pkg/chains): deprecate ChainName field in Chain object (…

…#2541) * add name field * chain name read * write * format * fix unit test * breaking change note * changelogs * fix db path error * goimports * comments
zeta-chain · Jul 26, 2024 · 545896d · 545896d
1 parent 5cd5f5a
commit 545896d
Show file tree

Hide file tree

Showing 34 changed files with 281 additions and 168 deletions.
diff --git a/changelog.md b/changelog.md
@@ -65,6 +65,7 @@
 * [2428](https://github.com/zeta-chain/node/pull/2428) - propagate context across codebase & refactor zetacore client
 * [2464](https://github.com/zeta-chain/node/pull/2464) - move common voting logic to voting.go and add new function VoteOnBallot
 * [2515](https://github.com/zeta-chain/node/pull/2515) - replace chainName by chainID for ChainNonces indexing
+* [2541](https://github.com/zeta-chain/node/pull/2541) - deprecate ChainName field in Chain object
 * [2542](https://github.com/zeta-chain/node/pull/2542) - adjust permissions to be more restrictive
 
 ### Tests

diff --git a/docs/openapi/openapi.swagger.yaml b/docs/openapi/openapi.swagger.yaml
@@ -56946,7 +56946,9 @@ definitions:
         title: ChainId is the unique identifier of the chain
       chain_name:
         $ref: '#/definitions/chainsChainName'
-        title: ChainName is the name of the chain
+        title: |-
+          ChainName is the name of the chain
+          Deprecated(v19): replaced with Name
       network:
         $ref: '#/definitions/chainsNetwork'
         title: Network is the network of the chain
@@ -56965,6 +56967,9 @@ definitions:
       cctx_gateway:
         $ref: '#/definitions/chainsCCTXGateway'
         title: CCTXGateway is the gateway used to handle CCTX outbounds
+      name:
+        type: string
+        title: Name is the name of the chain
     title: |-
       Chain represents static data about a blockchain network
       it is identified by a unique chain ID
@@ -56994,7 +56999,9 @@ definitions:
       - solana_devnet
       - solana_localnet
     default: empty
-    title: ChainName represents the name of the chain
+    title: |-
+      ChainName represents the name of the chain
+      Deprecated(v19): replaced with Chain.Name as string
   chainsConsensus:
     type: string
     enum:

diff --git a/docs/releases/v17_breaking_changes.md → docs/releases/v19_breaking_changes.md b/docs/releases/v17_breaking_changes.md → docs/releases/v19_breaking_changes.md
@@ -1,5 +1,5 @@
 
-# V17 Breaking Changes
+# V19 Breaking Changes
 
 ### Verification Flags update
 
@@ -62,3 +62,7 @@
 ### `MsgAddBlameVote` renaming
 
 * `MsgAddBlameVote` has been renamed to `MsgVoteBlame` to maintain consistency with other voting messages
+
+### `Chain.ChainName` deprecated
+
+* `Chain.ChainName` has been deprecated and will be removed from the `Chain` structure. The `Chain.Name` should be used instead.
diff --git a/docs/releases/v17_observer_migration.md → docs/releases/v19_observer_migration.md b/docs/releases/v17_observer_migration.md → docs/releases/v19_observer_migration.md
@@ -1,5 +1,5 @@
 
-# V17 Observer Migration Guide
+# V19 Observer Migration Guide
 
 ## Authorizations Update
 

diff --git a/pkg/chains/chain.go b/pkg/chains/chain.go
@@ -1,6 +1,7 @@
 package chains
 
 import (
+	"errors"
 	"fmt"
 	"strings"
 
@@ -15,10 +16,6 @@ func (chain Chain) Validate() error {
 		return fmt.Errorf("chain ID must be positive")
 	}
 
-	if _, ok := ChainName_name[int32(chain.ChainName)]; !ok {
-		return fmt.Errorf("invalid chain name %d", int32(chain.ChainName))
-	}
-
 	if _, ok := Network_name[int32(chain.Network)]; !ok {
 		return fmt.Errorf("invalid network %d", int32(chain.Network))
 	}
@@ -35,6 +32,10 @@ func (chain Chain) Validate() error {
 		return fmt.Errorf("invalid consensus %d", int32(chain.Consensus))
 	}
 
+	if chain.Name == "" {
+		return errors.New("chain name cannot be empty")
+	}
+
 	return nil
 }
 

diff --git a/pkg/chains/chain_test.go b/pkg/chains/chain_test.go
@@ -21,7 +21,7 @@ func TestChain_Validate(t *testing.T) {
 			name: "should pass if chain is valid",
 			chain: chains.Chain{
 				ChainId:     42,
-				ChainName:   chains.ChainName_empty,
+				Name:        "foo",
 				Network:     chains.Network_optimism,
 				NetworkType: chains.NetworkType_testnet,
 				Vm:          chains.Vm_evm,
@@ -33,7 +33,7 @@ func TestChain_Validate(t *testing.T) {
 			name: "should error if chain ID is zero",
 			chain: chains.Chain{
 				ChainId:     0,
-				ChainName:   chains.ChainName_empty,
+				Name:        "foo",
 				Network:     chains.Network_optimism,
 				NetworkType: chains.NetworkType_testnet,
 				Vm:          chains.Vm_evm,
@@ -46,7 +46,7 @@ func TestChain_Validate(t *testing.T) {
 			name: "should error if chain ID is negative",
 			chain: chains.Chain{
 				ChainId:     0,
-				ChainName:   chains.ChainName_empty,
+				Name:        "foo",
 				Network:     chains.Network_optimism,
 				NetworkType: chains.NetworkType_testnet,
 				Vm:          chains.Vm_evm,
@@ -56,23 +56,23 @@ func TestChain_Validate(t *testing.T) {
 			errStr: "chain ID must be positive",
 		},
 		{
-			name: "should error if chain name invalid",
+			name: "should error if chain name empty",
 			chain: chains.Chain{
 				ChainId:     42,
-				ChainName:   chains.ChainName_solana_localnet + 1,
+				Name:        "",
 				Network:     chains.Network_optimism,
 				NetworkType: chains.NetworkType_testnet,
 				Vm:          chains.Vm_evm,
 				Consensus:   chains.Consensus_op_stack,
 				IsExternal:  true,
 			},
-			errStr: "invalid chain name",
+			errStr: "chain name cannot be empty",
 		},
 		{
 			name: "should error if network invalid",
 			chain: chains.Chain{
 				ChainId:     42,
-				ChainName:   chains.ChainName_empty,
+				Name:        "foo",
 				Network:     chains.Network_solana + 1,
 				NetworkType: chains.NetworkType_testnet,
 				Vm:          chains.Vm_evm,
@@ -85,7 +85,7 @@ func TestChain_Validate(t *testing.T) {
 			name: "should error if network type invalid",
 			chain: chains.Chain{
 				ChainId:     42,
-				ChainName:   chains.ChainName_empty,
+				Name:        "foo",
 				Network:     chains.Network_base,
 				NetworkType: chains.NetworkType_devnet + 1,
 				Vm:          chains.Vm_evm,
@@ -98,7 +98,7 @@ func TestChain_Validate(t *testing.T) {
 			name: "should error if vm invalid",
 			chain: chains.Chain{
 				ChainId:     42,
-				ChainName:   chains.ChainName_empty,
+				Name:        "foo",
 				Network:     chains.Network_base,
 				NetworkType: chains.NetworkType_devnet,
 				Vm:          chains.Vm_svm + 1,
@@ -111,7 +111,7 @@ func TestChain_Validate(t *testing.T) {
 			name: "should error if consensus invalid",
 			chain: chains.Chain{
 				ChainId:     42,
-				ChainName:   chains.ChainName_empty,
+				Name:        "foo",
 				Network:     chains.Network_base,
 				NetworkType: chains.NetworkType_devnet,
 				Vm:          chains.Vm_evm,
@@ -191,8 +191,7 @@ func TestChain_EncodeAddress(t *testing.T) {
 		{
 			name: "should error if chain not supported",
 			chain: chains.Chain{
-				ChainName: 999,
-				ChainId:   999,
+				ChainId: 999,
 			},
 			b:       ethcommon.Hex2Bytes("0x321"),
 			want:    "",

diff --git a/pkg/chains/chains.go b/pkg/chains/chains.go
@@ -17,6 +17,7 @@ var (
 		Consensus:   Consensus_tendermint,
 		IsExternal:  false,
 		CctxGateway: CCTXGateway_zevm,
+		Name:        "zeta_mainnet",
 	}
 
 	// Ethereum is Ethereum mainnet
@@ -29,6 +30,7 @@ var (
 		Consensus:   Consensus_ethereum,
 		IsExternal:  true,
 		CctxGateway: CCTXGateway_observers,
+		Name:        "eth_mainnet",
 	}
 
 	// BscMainnet is Binance Smart Chain mainnet
@@ -41,6 +43,7 @@ var (
 		Consensus:   Consensus_ethereum,
 		IsExternal:  true,
 		CctxGateway: CCTXGateway_observers,
+		Name:        "bsc_mainnet",
 	}
 
 	// BitcoinMainnet is Bitcoin mainnet
@@ -53,6 +56,7 @@ var (
 		Consensus:   Consensus_bitcoin,
 		IsExternal:  true,
 		CctxGateway: CCTXGateway_observers,
+		Name:        "btc_mainnet",
 	}
 
 	// Polygon is Polygon mainnet
@@ -65,6 +69,7 @@ var (
 		Consensus:   Consensus_ethereum,
 		IsExternal:  true,
 		CctxGateway: CCTXGateway_observers,
+		Name:        "polygon_mainnet",
 	}
 
 	// OptimismMainnet is Optimism mainnet
@@ -77,6 +82,7 @@ var (
 		Consensus:   Consensus_op_stack,
 		IsExternal:  true,
 		CctxGateway: CCTXGateway_observers,
+		Name:        "optimism_mainnet",
 	}
 
 	// BaseMainnet is Base mainnet
@@ -89,6 +95,7 @@ var (
 		Consensus:   Consensus_op_stack,
 		IsExternal:  true,
 		CctxGateway: CCTXGateway_observers,
+		Name:        "base_mainnet",
 	}
 
 	// SolanaMainnet is Solana mainnet
@@ -103,6 +110,7 @@ var (
 		Consensus:   Consensus_solana_consensus,
 		IsExternal:  true,
 		CctxGateway: CCTXGateway_observers,
+		Name:        "solana_mainnet",
 	}
 
 	/**
@@ -119,6 +127,7 @@ var (
 		Consensus:   Consensus_tendermint,
 		IsExternal:  false,
 		CctxGateway: CCTXGateway_zevm,
+		Name:        "zeta_testnet",
 	}
 
 	// Sepolia is Ethereum sepolia testnet
@@ -131,6 +140,7 @@ var (
 		Consensus:   Consensus_ethereum,
 		IsExternal:  true,
 		CctxGateway: CCTXGateway_observers,
+		Name:        "sepolia_testnet",
 	}
 
 	// BscTestnet is Binance Smart Chain testnet
@@ -143,6 +153,7 @@ var (
 		Consensus:   Consensus_ethereum,
 		IsExternal:  true,
 		CctxGateway: CCTXGateway_observers,
+		Name:        "bsc_testnet",
 	}
 
 	// BitcoinTestnet is Bitcoin testnet3
@@ -155,6 +166,7 @@ var (
 		Consensus:   Consensus_bitcoin,
 		IsExternal:  true,
 		CctxGateway: CCTXGateway_observers,
+		Name:        "btc_testnet",
 	}
 
 	// Amoy is Polygon amoy testnet
@@ -167,6 +179,7 @@ var (
 		Consensus:   Consensus_ethereum,
 		IsExternal:  true,
 		CctxGateway: CCTXGateway_observers,
+		Name:        "amoy_testnet",
 	}
 
 	// OptimismSepolia is Optimism sepolia testnet
@@ -179,6 +192,7 @@ var (
 		Consensus:   Consensus_op_stack,
 		IsExternal:  true,
 		CctxGateway: CCTXGateway_observers,
+		Name:        "optimism_sepolia",
 	}
 
 	// BaseSepolia is Base sepolia testnet
@@ -191,6 +205,7 @@ var (
 		Consensus:   Consensus_op_stack,
 		IsExternal:  true,
 		CctxGateway: CCTXGateway_observers,
+		Name:        "base_sepolia",
 	}
 
 	// SolanaDevnet is Solana devnet
@@ -207,6 +222,7 @@ var (
 		Consensus:   Consensus_solana_consensus,
 		IsExternal:  true,
 		CctxGateway: CCTXGateway_observers,
+		Name:        "solana_devnet",
 	}
 
 	/**
@@ -224,6 +240,7 @@ var (
 		Consensus:   Consensus_tendermint,
 		IsExternal:  false,
 		CctxGateway: CCTXGateway_zevm,
+		Name:        "zeta_mainnet",
 	}
 
 	/**
@@ -240,6 +257,7 @@ var (
 		Consensus:   Consensus_tendermint,
 		IsExternal:  false,
 		CctxGateway: CCTXGateway_zevm,
+		Name:        "zeta_mainnet",
 	}
 
 	// BitcoinRegtest is Bitcoin regtest (localnet)
@@ -252,6 +270,7 @@ var (
 		Consensus:   Consensus_bitcoin,
 		IsExternal:  true,
 		CctxGateway: CCTXGateway_observers,
+		Name:        "btc_regtest",
 	}
 
 	// GoerliLocalnet is Ethereum local goerli (localnet)
@@ -264,6 +283,7 @@ var (
 		Consensus:   Consensus_ethereum,
 		IsExternal:  true,
 		CctxGateway: CCTXGateway_observers,
+		Name:        "goerli_localnet",
 	}
 
 	// SolanaLocalnet is Solana localnet
@@ -278,6 +298,7 @@ var (
 		Consensus:   Consensus_solana_consensus,
 		IsExternal:  true,
 		CctxGateway: CCTXGateway_observers,
+		Name:        "solana_localnet",
 	}
 
 	/**
@@ -294,6 +315,7 @@ var (
 		Consensus:   Consensus_ethereum,
 		IsExternal:  true,
 		CctxGateway: CCTXGateway_observers,
+		Name:        "goerli_testnet",
 	}
 
 	// Mumbai is Polygon mumbai testnet (deprecated for amoy)
@@ -306,6 +328,7 @@ var (
 		Consensus:   Consensus_ethereum,
 		IsExternal:  true,
 		CctxGateway: CCTXGateway_observers,
+		Name:        "mumbai_testnet",
 	}
 )