ZetaChain is an EVM-compatible L1 blockchain that enables omnichain, generic smart contracts and messaging between any blockchain.
- Go 1.19
- Docker and Docker Compose (optional, for running tests locally)
- buf (optional, for processing protocol buffer files)
- jq (optional, for running scripts)
ZetaChain is built with Cosmos SDK, a modular framework for building blockchain and Ethermint, a module that implements EVM-compatibility.
- zeta-node (this repository)
contains the source code for the ZetaChain node (
zetacored) and the ZetaChain client (zetaclientd). - protocol-contracts contains the source code for the Solidity smart contracts that implement the core functionality of ZetaChain.
For the Athens 3 testnet, clone this repository, checkout the latest release tag, and type the following command to build the binaries:
make install-testnet
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
After making changes to any of the protocol buffer files, run the following command to generate the Go files:
make proto
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.
To generate the documentation, run the following command:
make specs
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 search 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.
To check that the source code is working as expected, refer to the manual on how to run the smoke test.