feat(pkg/chains): add a CCTXGateway field to chain static data (#…

…2279) * proto gen * add field to chains * make generate * changelog * fix test * update comment * make format
zeta-chain · May 29, 2024 · 180fcef · 180fcef
1 parent 42fe69c
commit 180fcef
Show file tree

Hide file tree

Showing 7 changed files with 196 additions and 44 deletions.
diff --git a/changelog.md b/changelog.md
@@ -16,6 +16,7 @@
 * [2113](https://github.com/zeta-chain/node/pull/2113) - add zetaclientd-supervisor process
 * [2154](https://github.com/zeta-chain/node/pull/2154) - add `ibccrosschain` module
 * [2258](https://github.com/zeta-chain/node/pull/2258) - add Optimism and Base in static chain information
+* [2279](https://github.com/zeta-chain/node/pull/2279) - add a CCTXGateway field to chain static data
 * [2275](https://github.com/zeta-chain/node/pull/2275) - add ChainInfo singleton state variable in authority
 
 ### Refactor

diff --git a/docs/openapi/openapi.swagger.yaml b/docs/openapi/openapi.swagger.yaml
@@ -56744,6 +56744,18 @@ definitions:
     description: |-
       QueryGetPoliciesResponse is the response type for the Query/Policies RPC
       method.
+  chainsCCTXGateway:
+    type: string
+    enum:
+      - zevm
+      - observers
+    default: zevm
+    description: |-
+      - zevm: zevm is the internal CCTX gateway to process outbound on the ZEVM and read
+      inbound events from the ZEVM only used for ZetaChain chains
+       - observers: observers is the CCTX gateway for chains relying on the observer set to
+      observe inbounds and TSS for outbounds
+    title: CCTXGateway describes for the chain the gateway used to handle CCTX outbounds
   chainsChain:
     type: object
     properties:
@@ -56769,6 +56781,9 @@ definitions:
       is_external:
         type: boolean
         title: IsExternal describe if the chain is ZetaChain or external
+      cctx_gateway:
+        $ref: '#/definitions/chainsCCTXGateway'
+        title: CCTXGateway is the gateway used to handle CCTX outbounds
     title: |-
       Chain represents static data about a blockchain network
       it is identified by a unique chain ID

diff --git a/pkg/chains/chains.go b/pkg/chains/chains.go
@@ -16,6 +16,7 @@ var (
 		Vm:          Vm_evm,
 		Consensus:   Consensus_tendermint,
 		IsExternal:  false,
+		CctxGateway: CCTXGateway_zevm,
 	}
 
 	// Ethereum is Ethereum mainnet
@@ -27,6 +28,7 @@ var (
 		Vm:          Vm_evm,
 		Consensus:   Consensus_ethereum,
 		IsExternal:  true,
+		CctxGateway: CCTXGateway_observers,
 	}
 
 	// BscMainnet is Binance Smart Chain mainnet
@@ -38,6 +40,7 @@ var (
 		Vm:          Vm_evm,
 		Consensus:   Consensus_ethereum,
 		IsExternal:  true,
+		CctxGateway: CCTXGateway_observers,
 	}
 
 	// BitcoinMainnet is Bitcoin mainnet
@@ -49,6 +52,7 @@ var (
 		Vm:          Vm_no_vm,
 		Consensus:   Consensus_bitcoin,
 		IsExternal:  true,
+		CctxGateway: CCTXGateway_observers,
 	}
 
 	// Polygon is Polygon mainnet
@@ -60,6 +64,7 @@ var (
 		Vm:          Vm_evm,
 		Consensus:   Consensus_ethereum,
 		IsExternal:  true,
+		CctxGateway: CCTXGateway_observers,
 	}
 
 	// OptimismMainnet is Optimism mainnet
@@ -71,6 +76,7 @@ var (
 		Vm:          Vm_evm,
 		Consensus:   Consensus_op_stack,
 		IsExternal:  true,
+		CctxGateway: CCTXGateway_observers,
 	}
 
 	// BaseMainnet is Base mainnet
@@ -82,6 +88,7 @@ var (
 		Vm:          Vm_evm,
 		Consensus:   Consensus_op_stack,
 		IsExternal:  true,
+		CctxGateway: CCTXGateway_observers,
 	}
 
 	/**
@@ -97,6 +104,7 @@ var (
 		Vm:          Vm_evm,
 		Consensus:   Consensus_tendermint,
 		IsExternal:  false,
+		CctxGateway: CCTXGateway_zevm,
 	}
 
 	// Sepolia is Ethereum sepolia testnet
@@ -108,6 +116,7 @@ var (
 		Vm:          Vm_evm,
 		Consensus:   Consensus_ethereum,
 		IsExternal:  true,
+		CctxGateway: CCTXGateway_observers,
 	}
 
 	// BscTestnet is Binance Smart Chain testnet
@@ -119,6 +128,7 @@ var (
 		Vm:          Vm_evm,
 		Consensus:   Consensus_ethereum,
 		IsExternal:  true,
+		CctxGateway: CCTXGateway_observers,
 	}
 
 	// BitcoinTestnet is Bitcoin testnet3
@@ -130,6 +140,7 @@ var (
 		Vm:          Vm_no_vm,
 		Consensus:   Consensus_bitcoin,
 		IsExternal:  true,
+		CctxGateway: CCTXGateway_observers,
 	}
 
 	// Amoy is Polygon amoy testnet
@@ -141,6 +152,7 @@ var (
 		Vm:          Vm_evm,
 		Consensus:   Consensus_ethereum,
 		IsExternal:  true,
+		CctxGateway: CCTXGateway_observers,
 	}
 
 	// OptimismSepolia is Optimism sepolia testnet
@@ -152,6 +164,7 @@ var (
 		Vm:          Vm_evm,
 		Consensus:   Consensus_op_stack,
 		IsExternal:  true,
+		CctxGateway: CCTXGateway_observers,
 	}
 
 	// BaseSepolia is Base sepolia testnet
@@ -163,6 +176,7 @@ var (
 		Vm:          Vm_evm,
 		Consensus:   Consensus_op_stack,
 		IsExternal:  true,
+		CctxGateway: CCTXGateway_observers,
 	}
 
 	/**
@@ -179,6 +193,7 @@ var (
 		Vm:          Vm_evm,
 		Consensus:   Consensus_tendermint,
 		IsExternal:  false,
+		CctxGateway: CCTXGateway_zevm,
 	}
 
 	/**
@@ -194,6 +209,7 @@ var (
 		Vm:          Vm_evm,
 		Consensus:   Consensus_tendermint,
 		IsExternal:  false,
+		CctxGateway: CCTXGateway_zevm,
 	}
 
 	// BitcoinRegtest is Bitcoin regtest (localnet)
@@ -205,6 +221,7 @@ var (
 		Vm:          Vm_no_vm,
 		Consensus:   Consensus_bitcoin,
 		IsExternal:  true,
+		CctxGateway: CCTXGateway_observers,
 	}
 
 	// GoerliLocalnet is Ethereum local goerli (localnet)
@@ -216,6 +233,7 @@ var (
 		Vm:          Vm_evm,
 		Consensus:   Consensus_ethereum,
 		IsExternal:  true,
+		CctxGateway: CCTXGateway_observers,
 	}
 
 	/**
@@ -231,6 +249,7 @@ var (
 		Vm:          Vm_evm,
 		Consensus:   Consensus_ethereum,
 		IsExternal:  true,
+		CctxGateway: CCTXGateway_observers,
 	}
 
 	// Mumbai is Polygon mumbai testnet (deprecated for amoy)
@@ -242,6 +261,7 @@ var (
 		Vm:          Vm_evm,
 		Consensus:   Consensus_ethereum,
 		IsExternal:  true,
+		CctxGateway: CCTXGateway_observers,
 	}
 )