Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/zeta-chain/node
ZetaChain’s blockchain node and an observer validator client
https://github.com/zeta-chain/node
bitcoin blockchain cosmos-sdk ethereum interoperability omnichain zetachain
Last synced: 4 days ago
JSON representation
ZetaChain’s blockchain node and an observer validator client
- Host: GitHub
- URL: https://github.com/zeta-chain/node
- Owner: zeta-chain
- License: mit
- Created: 2021-09-24T07:09:25.000Z (about 3 years ago)
- Default Branch: develop
- Last Pushed: 2024-05-15T23:40:03.000Z (6 months ago)
- Last Synced: 2024-05-16T04:43:37.418Z (6 months ago)
- Topics: bitcoin, blockchain, cosmos-sdk, ethereum, interoperability, omnichain, zetachain
- Language: Go
- Homepage: https://zetachain.com
- Size: 16.2 MB
- Stars: 149
- Watchers: 8
- Forks: 88
- Open Issues: 388
-
Metadata Files:
- Readme: readme.md
- Changelog: changelog.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
- awesome-ccamel - zeta-chain/node - ZetaChain’s blockchain node and an observer validator client (Go)
README
# ZetaChain
ZetaChain is an EVM-compatible L1 blockchain that enables omnichain, generic
smart contracts and messaging between any blockchain.
## Prerequisites
- [Go](https://golang.org/doc/install) 1.22
- [Docker](https://docs.docker.com/install/) and
[Docker Compose](https://docs.docker.com/compose/install/) (optional, for
running tests locally)
- [buf](https://buf.build/) (optional, for processing protocol buffer files)
- [jq](https://stedolan.github.io/jq/download/) (optional, for running scripts)
## Components of ZetaChain
ZetaChain is built with [Cosmos SDK](https://github.com/cosmos/cosmos-sdk), a
modular framework for building blockchain and
[Ethermint](https://github.com/zeta-chain/ethermint), a module that implements
EVM-compatibility (ZetaChain fork).
This repository contains the core components:
* [Blockchain Modules (ZetaCore)](x):
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](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:
* [ZetaChain EVM and EVM connected chains](https://github.com/zeta-chain/protocol-contracts)
* [Solana connected chains (SVM)](https://github.com/zeta-chain/protocol-contracts-solana)
* [TON connected chains (TVM)](https://github.com/zeta-chain/protocol-contracts-ton)
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](docs/development/LOCAL_TESTING.md)
- [Make a new ZetaChain release](docs/development/RELEASES.md)
- [Deploy your own ZetaChain or Bitcoin node](docs/development/DEPLOY_NODES.md)
- [Run the simulation tests](docs/development/SIMULATION_TESTING.md)
## Community
[Twitter](https://twitter.com/zetablockchain) |
[Discord](https://discord.com/invite/zetachain) |
[Telegram](https://t.me/zetachainofficial) | [Website](https://zetachain.com)