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

Update README.md #50

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update README.md #50

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
6 changes: 6 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,12 @@ This repository contains the smart contracts for LayerZero Endpoints. For develo
LayerZero is an Omnichain Interoperability Protocol designed for lightweight message passing across chains. LayerZero provides authentic and guaranteed message delivery with configurable trustlessness. The protocol is implemented as a set of gas-efficient, non-upgradable smart contracts.

## Development
For streamlined development with LayerZero, integrate our smart contracts by adding `"@layerzerolabs/contracts": "latest"` to your `package.json`.
Begin by duplicating `.env.example` as `.env`, customizing variables before running `yarn install`.
Testing is straightforward: use `yarn test` for the full suite or target individual tests, e.g., `yarn test test/Endpoint.test.js`.
For insights into gas usage and coverage, `yarn test:gas` and `yarn test:coverage` are available.
Ensure code quality with `yarn lint`, noting it applies solely to `.js` and `.ts` files.

### Interfaces
add this to your package.json

Expand Down