README
¶
ZetaChain
ZetaChain is an EVM-compatible L1 blockchain that enables omnichain, generic smart contracts and messaging between any blockchain.
Prerequisites
- Go 1.22
- Docker and Docker Compose (optional, for running tests locally)
- buf (optional, for processing protocol buffer files)
- jq (optional, for running scripts)
Components of ZetaChain
ZetaChain is built with Cosmos SDK, a modular framework for building blockchain and Ethermint, a module that implements EVM-compatibility (ZetaChain fork).
This repository contains the core components:
- Blockchain Modules (ZetaCore): This section contains the core logic of the ZetaChain blockchain, built using Cosmos SDK modules. These modules are responsible for managing the state, state transitions, and overall functionality of the ZetaChain network.
- ZetaClient: The ZetaClient is a specialized client designed to act as an observer and signer for the ZetaChain network. It is responsible for communicating with the blockchain, relaying messages, and performing signature tasks to ensure the network operates cross-chain transactions.
Protocol Contracts
In addition to the blockchain codebase, ZetaChain’s architecture includes a set of protocol contracts that serve as an interface for developers to interact with the blockchain. These smart contracts are deployed across various blockchain networks. The smart contract source code is maintained in separate repositories, depending on the network they are deployed on:
These repositories contain the necessary code and tools to deploy, interact with, and extend the functionality of ZetaChain’s cross-chain protocol on each respective blockchain network.
Building the zetacored/zetaclientd binaries
Clone this repository, checkout the latest release tag, and type the following command to build the binaries:
make install
to build.
This command will install the zetacored and zetaclientd binaries in your
$GOPATH/bin directory.
Verify that the version of the binaries match the release tag.
zetacored version
zetaclientd version
Making changes to the source code
After making changes to any of the protocol buffer files, run the following command to run generated files generation (ProtoBuf, OpenAPI and docs):
make generate
This command will use buf to generate the Go files from the protocol buffer
files and move them to the correct directories inside x/. It will also
generate an OpenAPI spec.
This command will run a script to update the modules' documentation. The script
uses static code analysis to read the protocol buffer files and identify all
Cosmos SDK messages. It then searches the source code for the corresponding
message handler functions and retrieves the documentation for those functions.
Finally, it creates a messages.md file for each module, which contains the
documentation for all the messages in that module.
Further Reading
Find below further documentation for development and running your own ZetaChain node:
- Run the E2E tests and interact with the localnet
- Make a new ZetaChain release
- Deploy your own ZetaChain or Bitcoin node
- Run the simulation tests
Community
Directories
¶
| Path | Synopsis |
|---|---|
|
Package cmd provides cosmos constants for ZetaClient.
|
Package cmd provides cosmos constants for ZetaClient. |
|
contrib
|
|
|
e2e
|
|
|
pkg
|
|
|
bg
Package bg provides primitives for the background tasks
|
Package bg provides primitives for the background tasks |
|
contracts/solana
Package solana privides structures and constants that are used when interacting with the gateway program on Solana chain.
|
Package solana privides structures and constants that are used when interacting with the gateway program on Solana chain. |
|
contracts/ton
Package ton provider bindings for TON blockchain including Gateway contract wrapper.
|
Package ton provider bindings for TON blockchain including Gateway contract wrapper. |
|
ptr
Package ptr provides helper functions for working with pointers.
|
Package ptr provides helper functions for working with pointers. |
|
retry
Package retry provides a generic retry mechanism with exponential backoff.
|
Package retry provides a generic retry mechanism with exponential backoff. |
|
ticker
Package ticker provides a dynamic ticker that can change its interval at runtime.
|
Package ticker provides a dynamic ticker that can change its interval at runtime. |
|
nullify
Package nullify provides methods to init nil values structs for test assertion.
|
Package nullify provides methods to init nil values structs for test assertion. |
|
x
|
|
|
authority/types
Package types is a reverse proxy.
|
Package types is a reverse proxy. |
|
crosschain/types
Package types is a reverse proxy.
|
Package types is a reverse proxy. |
|
emissions/types
NOTE: Usage of x/params to manage parameters is deprecated in favor of x/gov controlled execution of MsgUpdateParams messages.
|
NOTE: Usage of x/params to manage parameters is deprecated in favor of x/gov controlled execution of MsgUpdateParams messages. |
|
fungible/types
Package types is a reverse proxy.
|
Package types is a reverse proxy. |
|
lightclient/types
Package types is a reverse proxy.
|
Package types is a reverse proxy. |
|
observer/types
Package types is a reverse proxy.
|
Package types is a reverse proxy. |
|
zetaclient
|
|
|
authz
Package authz provides a signer object for transactions using grants grants are used to allow a hotkey to sign transactions on behalf of the observers
|
Package authz provides a signer object for transactions using grants grants are used to allow a hotkey to sign transactions on behalf of the observers |
|
chains/bitcoin/observer
Package observer implements the Bitcoin chain observer
|
Package observer implements the Bitcoin chain observer |
|
chains/bitcoin/signer
Package signer implements the ChainSigner interface for BTC
|
Package signer implements the ChainSigner interface for BTC |
|
chains/evm/observer
Package observer implements the EVM chain observer
|
Package observer implements the EVM chain observer |
|
chains/evm/signer
Package signer implements the ChainSigner interface for EVM chains
|
Package signer implements the ChainSigner interface for EVM chains |
|
chains/interfaces
Package interfaces provides interfaces for clients and signers for the chain to interact with
|
Package interfaces provides interfaces for clients and signers for the chain to interact with |
|
compliance
Package compliance provides functions to check for compliance of cross-chain transactions
|
Package compliance provides functions to check for compliance of cross-chain transactions |
|
config
Package config provides functions to load and save ZetaClient config
|
Package config provides functions to load and save ZetaClient config |
|
context
Package context provides global app context for ZetaClient
|
Package context provides global app context for ZetaClient |
|
db
Package db represents API for database operations.
|
Package db represents API for database operations. |
|
maintenance
Package maintenance provides maintenance functionalities for the zetaclient.
|
Package maintenance provides maintenance functionalities for the zetaclient. |
|
metrics
Package metrics provides metrics functionalities for the zetaclient
|
Package metrics provides metrics functionalities for the zetaclient |
|
orchestrator
Package orchestrator provides the orchestrator for orchestrating cross-chain transactions
|
Package orchestrator provides the orchestrator for orchestrating cross-chain transactions |
|
outboundprocessor
Package outboundprocessor provides functionalities to track outbound processing
|
Package outboundprocessor provides functionalities to track outbound processing |
|
ratelimiter
Package ratelimiter provides functionalities for rate limiting the cross-chain transactions
|
Package ratelimiter provides functionalities for rate limiting the cross-chain transactions |
|
zetacore
Package zetacore provides the client to interact with zetacore node via GRPC.
|
Package zetacore provides the client to interact with zetacore node via GRPC. |