solidstate-network / layerzero-client

💬 SolidState integration with the LayerZero cross-chain messaging protocol 🧅

SolidState LayerZero Client

SolidState integration with the LayerZero cross-chain messaging protocol.

This project is built with SolidState. See the solidstate-solidity documentation for information about contract integration and testing.

Installation

npm install --save-dev @solidstate/layerzero-client
# or
yarn add --dev @solidstate/layerzero-client

Development

Install dependencies via Yarn:

yarn install

Setup Husky to format code on commit:

yarn prepare

Compile contracts via Hardhat:

yarn run hardhat compile

Testing

Test contracts with Hardhat and generate gas report using hardhat-gas-reporter:

yarn run hardhat test

Generate a code coverage report using solidity-coverage:

yarn run hardhat coverage

Documentation

A static documentation site can be generated using hardhat-docgen:

yarn run hardhat docgen