refactor: lightclient verification flags

changelog.md

@@ -1,10 +1,15 @@
 # CHANGELOG
 
 ## Unreleased
+### Breaking Changes
+* `MsgUpdateVerificationFlags` has been removed, and replaced with `MsgEnableVerificationFlags` and `MsgDisableVerificationFlags` messages.
+ * `MsgEnableVerificationFlags` message enables the verification flags for a list of chains and can be triggered via `PolicyType_groupOperational`
+ * `MsgDisableVerificationFlags` message disables the verification flags for a list of chains and can be triggered via `PolicyType_emergency`
 
 ### Refactor
 
 * [2032](https://github.com/zeta-chain/node/pull/2032) - improve some general structure of the ZetaClient codebase
+* [2097](https://github.com/zeta-chain/node/pull/2097) - refactor lightclient verification flags to account for individual chains
 
 ## Unreleased
 ### Breaking Changes
@@ -66,6 +71,8 @@
 * [2046](https://github.com/zeta-chain/node/pull/2046) - add state variable in crosschain for rate limiter flags
 * [2034](https://github.com/zeta-chain/node/pull/2034) - add support for zEVM message passing
 
+
+
 ### Tests
 
 * [1767](https://github.com/zeta-chain/node/pull/1767) - add unit tests for emissions module begin blocker

cmd/zetae2e/local/local.go

@@ -13,6 +13,7 @@ import (
 	"github.com/zeta-chain/zetacore/e2e/e2etests"
 	"github.com/zeta-chain/zetacore/e2e/runner"
 	"github.com/zeta-chain/zetacore/e2e/utils"
+	"github.com/zeta-chain/zetacore/pkg/chains"
 	"golang.org/x/sync/errgroup"
 )
 
@@ -189,7 +190,9 @@ func localE2ETest(cmd *cobra.Command, _ []string) {
 		logger.Print("⚙️ setting up networks")
 		startTime := time.Now()
 
-		if err := deployerRunner.EnableVerificationFlags(); err != nil {
+		if err := deployerRunner.EnableVerificationFlags([]int64{
+			chains.GoerliLocalnetChain.ChainId,
+			chains.BtcRegtestChain.ChainId}); err != nil {
 			panic(err)
 		}
 

docs/cli/zetacored/zetacored_tx_lightclient.md

@@ -25,5 +25,6 @@ zetacored tx lightclient [flags]
 ### SEE ALSO
 
 * [zetacored tx](zetacored_tx.md)	 - Transactions subcommands
-* [zetacored tx lightclient update-verification-flags](zetacored_tx_lightclient_update-verification-flags.md)	 - Update verification flags
+* [zetacored tx lightclient disable-verification-flags](zetacored_tx_lightclient_disable-verification-flags.md)	 - Disable verification flags for the list of chains separated by comma
+* [zetacored tx lightclient enable-verification-flags](zetacored_tx_lightclient_enable-verification-flags.md)	 - Enable verification flags for the list of chains separated by comma
 

docs/cli/zetacored/zetacored_tx_lightclient_disable-verification-flags.md

@@ -0,0 +1,61 @@
+# tx lightclient disable-verification-flags
+
+Disable verification flags for the list of chains separated by comma
+
+### Synopsis
+
+Provide a list of chain ids separated by comma to disable block header verification for the specified chain ids.
+
+  				Example:
+                    To disable verification flags for chain ids 1 and 56
+					zetacored tx lightclient disable-verification-flags "1,56"
+
+
+```
+zetacored tx lightclient disable-verification-flags [list of chain-id] [flags]
+```
+
+### Options
+
+```
+  -a, --account-number uint      The account number of the signing account (offline mode only)
+      --aux                      Generate aux signer data instead of sending a tx
+  -b, --broadcast-mode string    Transaction broadcasting mode (sync|async|block) 
+      --dry-run                  ignore the --gas flag and perform a simulation of a transaction, but don't broadcast it (when enabled, the local Keybase is not accessible)
+      --fee-granter string       Fee granter grants fees for the transaction
+      --fee-payer string         Fee payer pays fees for the transaction instead of deducting from the signer
+      --fees string              Fees to pay along with transaction; eg: 10uatom
+      --from string              Name or address of private key with which to sign
+      --gas string               gas limit to set per-transaction; set to "auto" to calculate sufficient gas automatically. Note: "auto" option doesn't always report accurate results. Set a valid coin value to adjust the result. Can be used instead of "fees". (default 200000)
+      --gas-adjustment float     adjustment factor to be multiplied against the estimate returned by the tx simulation; if the gas limit is set manually this flag is ignored  (default 1)
+      --gas-prices string        Gas prices in decimal format to determine the transaction fee (e.g. 0.1uatom)
+      --generate-only            Build an unsigned transaction and write it to STDOUT (when enabled, the local Keybase only accessed when providing a key name)
+  -h, --help                     help for disable-verification-flags
+      --keyring-backend string   Select keyring's backend (os|file|kwallet|pass|test|memory) 
+      --keyring-dir string       The client Keyring directory; if omitted, the default 'home' directory will be used
+      --ledger                   Use a connected Ledger device
+      --node string              [host]:[port] to tendermint rpc interface for this chain 
+      --note string              Note to add a description to the transaction (previously --memo)
+      --offline                  Offline mode (does not allow any online functionality)
+  -o, --output string            Output format (text|json) 
+  -s, --sequence uint            The sequence number of the signing account (offline mode only)
+      --sign-mode string         Choose sign mode (direct|amino-json|direct-aux), this is an advanced feature
+      --timeout-height uint      Set a block timeout height to prevent the tx from being committed past a certain height
+      --tip string               Tip is the amount that is going to be transferred to the fee payer on the target chain. This flag is only valid when used with --aux, and is ignored if the target chain didn't enable the TipDecorator
+  -y, --yes                      Skip tx broadcasting prompt confirmation
+```
+
+### Options inherited from parent commands
+
+```
+      --chain-id string     The network chain ID
+      --home string         directory for config and data 
+      --log_format string   The logging format (json|plain) 
+      --log_level string    The logging level (trace|debug|info|warn|error|fatal|panic) 
+      --trace               print out full stack trace on errors
+```
+
+### SEE ALSO
+
+* [zetacored tx lightclient](zetacored_tx_lightclient.md)	 - lightclient transactions subcommands
+

docs/cli/zetacored/zetacored_tx_lightclient_update-verification-flags.md → docs/cli/zetacored/zetacored_tx_lightclient_enable-verification-flags.md

@@ -1,9 +1,18 @@
-# tx lightclient update-verification-flags
+# tx lightclient enable-verification-flags
 
-Update verification flags
+Enable verification flags for the list of chains separated by comma
+
+### Synopsis
+
+Provide a list of chain ids separated by comma to enable block header verification for the specified chain ids.
+
+  				Example:
+                    To enable verification flags for chain ids 1 and 56
+					zetacored tx lightclient enable-verification-flags "1,56"
+
 
 ```
-zetacored tx lightclient update-verification-flags [eth-type-chain-enabled] [btc-type-chain-enabled] [flags]
+zetacored tx lightclient enable-verification-flags [list of chain-id] [flags]
 ```
 
 ### Options
@@ -21,7 +30,7 @@ zetacored tx lightclient update-verification-flags [eth-type-chain-enabled] [btc
       --gas-adjustment float     adjustment factor to be multiplied against the estimate returned by the tx simulation; if the gas limit is set manually this flag is ignored  (default 1)
       --gas-prices string        Gas prices in decimal format to determine the transaction fee (e.g. 0.1uatom)
       --generate-only            Build an unsigned transaction and write it to STDOUT (when enabled, the local Keybase only accessed when providing a key name)
-  -h, --help                     help for update-verification-flags
+  -h, --help                     help for enable-verification-flags
       --keyring-backend string   Select keyring's backend (os|file|kwallet|pass|test|memory) 
       --keyring-dir string       The client Keyring directory; if omitted, the default 'home' directory will be used
       --ledger                   Use a connected Ledger device

docs/openapi/openapi.swagger.yaml

@@ -53602,8 +53602,6 @@ definitions:
         $ref: '#/definitions/chainsConsensus'
       is_external:
         type: boolean
-      is_header_supported:
-        type: boolean
   chainsChainName:
     type: string
     enum:
@@ -54306,7 +54304,9 @@ definitions:
         type: string
         format: byte
     title: ChainState defines the overall state of the block headers for a given chain
-  lightclientMsgUpdateVerificationFlagsResponse:
+  lightclientMsgDisableVerificationFlagsResponse:
+    type: object
+  lightclientMsgEnableVerificationFlagsResponse:
     type: object
   lightclientQueryAllBlockHeaderResponse:
     type: object
@@ -54347,15 +54347,19 @@ definitions:
     type: object
     properties:
       verification_flags:
-        $ref: '#/definitions/lightclientVerificationFlags'
+        type: array
+        items:
+          type: object
+          $ref: '#/definitions/lightclientVerificationFlags'
   lightclientVerificationFlags:
     type: object
     properties:
-      ethTypeChainEnabled:
-        type: boolean
-      btcTypeChainEnabled:
+      chain_id:
+        type: string
+        format: int64
+      enabled:
         type: boolean
-    title: VerificationFlags is a structure containing information which chain types are enabled for block header verification
+    title: VerificationFlags is a structure containing information of weather a chain is enabled or not for block header verification
   observerAdmin_Policy:
     type: object
     properties:

docs/spec/lightclient/messages.md

@@ -1,15 +1,26 @@
 # Messages
 
-## MsgUpdateVerificationFlags
+## MsgEnableVerificationFlags
 
-UpdateVerificationFlags updates the light client verification flags.
-This disables/enables blocks verification of the light client for the specified chain.
-Emergency group can disable flags, it requires operational group if at least one flag is being enabled
+EnableVerificationFlags enables the verification flags for the given chain IDs
+Enabled chains allow the submissions of block headers and using it to verify the correctness of proofs
 
 ```proto
-message MsgUpdateVerificationFlags {
+message MsgEnableVerificationFlags {
 	string creator = 1;
-	VerificationFlags verification_flags = 2;
+	int64 chain_id_list = 2;
+}
+```
+
+## MsgDisableVerificationFlags
+
+DisableVerificationFlags disables the verification flags for the given chain IDs
+Disabled chains do not allow the submissions of block headers or using it to verify the correctness of proofs
+
+```proto
+message MsgDisableVerificationFlags {
+	string creator = 1;
+	int64 chain_id_list = 2;
 }
 ```
 

e2e/runner/setup_zeta.go

@@ -215,10 +215,10 @@ func (runner *E2ERunner) SetupBTCZRC20() {
 }
 
 // EnableVerificationFlags enables the verification flags on ZetaChain
-func (runner *E2ERunner) EnableVerificationFlags() error {
+func (runner *E2ERunner) EnableVerificationFlags(chainIDList []int64) error {
 	runner.Logger.Print("⚙️ enabling verification flags for block headers")
 
-	return runner.ZetaTxServer.EnableVerificationFlags(e2eutils.FungibleAdminName)
+	return runner.ZetaTxServer.EnableVerificationFlags(e2eutils.FungibleAdminName, chainIDList)
 }
 
 // FundEmissionsPool funds the emissions pool on ZetaChain with the same value as used originally on mainnet (20M ZETA)

e2e/txserver/zeta_tx_server.go

@@ -251,7 +251,7 @@ type intoAny interface {
 }
 
 // EnableVerificationFlags enables the verification flags for the lightclient module
-func (zts ZetaTxServer) EnableVerificationFlags(account string) error {
+func (zts ZetaTxServer) EnableVerificationFlags(account string, chainIDList []int64) error {
 	// retrieve account
 	acc, err := zts.clientCtx.Keyring.Key(account)
 	if err != nil {
@@ -262,10 +262,9 @@ func (zts ZetaTxServer) EnableVerificationFlags(account string) error {
 		return err
 	}
 
-	_, err = zts.BroadcastTx(account, lightclienttypes.NewMsgUpdateVerificationFlags(
+	_, err = zts.BroadcastTx(account, lightclienttypes.NewMsgEnableVerificationFlags(
 		addr.String(),
-		true,
-		true,
+		chainIDList,
 	))
 
 	return err

pkg/chains/chain.go

@@ -101,8 +101,8 @@ func IsZetaChain(chainID int64) bool {
 	return ChainIDInChainList(chainID, ChainListByNetwork(Network_zeta))
 }
 
-// IsHeaderSupportedEvmChain returns true if the chain is an EVM chain supporting block header-based verification
-func IsHeaderSupportedEvmChain(chainID int64) bool {
+// IsHeaderSupportedChain returns true if the chain is supports block header-based verification
+func IsHeaderSupportedChain(chainID int64) bool {
 	return ChainIDInChainList(chainID, ChainListForHeaderSupport())
 }
 

pkg/chains/chain_test.go

@@ -185,7 +185,7 @@ func TestIsEVMChain(t *testing.T) {
 	}
 }
 
-func TestIsHeaderSupportedEVMChain(t *testing.T) {
+func TestIsHeaderSupportedChain(t *testing.T) {
 	tests := []struct {
 		name    string
 		chainID int64
@@ -197,13 +197,13 @@ func TestIsHeaderSupportedEVMChain(t *testing.T) {
 		{"Sepolia Testnet", SepoliaChain.ChainId, true},
 		{"BSC Testnet", BscTestnetChain.ChainId, true},
 		{"BSC Mainnet", BscMainnetChain.ChainId, true},
-		{"Non-EVM", BtcMainnetChain.ChainId, false},
+		{"BTC", BtcMainnetChain.ChainId, true},
 		{"Zeta Mainnet", ZetaChainMainnet.ChainId, false},
 	}
 
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {
-			require.Equal(t, tt.want, IsHeaderSupportedEvmChain(tt.chainID))
+			require.Equal(t, tt.want, IsHeaderSupportedChain(tt.chainID))
 		})
 	}
 }