Skip to content

Commit

Permalink
docs: update readme with new protocol contract directories
Browse files Browse the repository at this point in the history
  • Loading branch information
lumtis committed Oct 16, 2024
1 parent ae6ab23 commit d447ad0
Showing 1 changed file with 16 additions and 6 deletions.
22 changes: 16 additions & 6 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,12 +19,22 @@ modular framework for building blockchain and
[Ethermint](https://github.com/zeta-chain/ethermint), a module that implements
EVM-compatibility (ZetaChain fork).

- [zeta-node](https://github.com/zeta-chain/zeta-node) (this repository)
contains the source code for the ZetaChain node (`zetacored`) and the
ZetaChain client (`zetaclientd`).
- [protocol-contracts](https://github.com/zeta-chain/protocol-contracts)
contains the source code for the Solidity smart contracts that implement the
core functionality of ZetaChain.
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

Expand Down

0 comments on commit d447ad0

Please sign in to comment.