Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: update readme with new protocol contract directories #3011

Merged
merged 1 commit into from
Oct 16, 2024
+16 −6
Merged

docs: update readme with new protocol contract directories #3011

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 16 additions & 6 deletions readme.md
View file
Open in desktop
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
Loading