Skip to content

Latest commit

 

History

History
91 lines (56 loc) · 1.7 KB

README.md

File metadata and controls

91 lines (56 loc) · 1.7 KB
Raw

ZetaChain

ZetaChain is a public, decentralized blockchain and smart contract platform built for omnichain interoperability.

What's in this repo?

  • Utilities to interact with ZetaChain's contracts from your dApp, scripts, or tests.
  • Interfaces to easily develop omnichain contracts.

Learn more about ZetaChain

Usage

  1. Install Node.js LTS (previous versions may, but are not guaranteed to work).

  2. Install yarn (make sure NPM has the right permissions to add global packages):

     npm i -g yarn

  3. Install the dependencies:

     yarn

  4. From the root folder, compile the contracts:

     yarn compile

Packages

Zeta App contracts

ZEVM App contracts

Cross-repo commands

Package-specific commands

They run independently, only on the packages that implement them:

yarn compile
yarn clean
yarn test

Repo commands

They run once, across the whole repo:

yarn lint
yarn lint:fix

Coverage

To check the test coverage run the follow command on the desire package

npx hardhat coverage

Static test

We run slither on our packages. If you want to run it should install slither

brew install slither-analyzer

and execute it

slither . --filter-paths "contracts/test/|node_modules/" --exclude naming-convention

Contributing

We welcome (and appreciate) everyone's contributions. If you wanna contribute, read CONTRIBUTING.md for next steps.