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

Update README.md #35

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

Update README.md #35

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
62 changes: 47 additions & 15 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,23 +6,55 @@

# Mainnet to Testnet Bridge

Mainnet to Testnet Bridge creates a market on both testnets and mainnets for native gas tokens.
## Overview
The Mainnet to Testnet Bridge is a tool designed for the transfer of native gas tokens between mainnet and testnet environments. It facilitates the creation of a market for these tokens across both networks, serving the needs of developers and users involved in blockchain testing and development.

## Getting Started

### Setup

- Clone the repository
- run `yarn`
## Features
- **Token Bridging**: Enables the transfer of native gas tokens between mainnet and testnet.
- **Market Support**: Assists in establishing a market for gas tokens on both networks.
- **Development Utility**: Aids in the testing and development process by providing a mechanism for token transfer.

### Test

`yarn test`

Run the full suite of unit tests.
## Getting Started

### Coverage
### Prerequisites
Ensure you have [Node.js](https://nodejs.org/) and [Yarn](https://yarnpkg.com/) installed on your system to work with the project and run the commands detailed below.

`yarn coverage`
### Setup
1. **Clone the repository** to your local machine using Git:
```
git clone https://github.com/LayerZero-Labs/mainnet-testnet-bridge.git
```
2. **Navigate** into the cloned repository directory:
```
cd mainnet-testnet-bridge
```
3. **Install dependencies** using Yarn:
```
yarn
```

### Usage

#### Testing
To execute the unit tests, run:
```
yarn test
```
This command executes the test suite to verify functionality across various scenarios.

#### Coverage Report
For a coverage report, run:
```
yarn coverage
```
The coverage report evaluates the extent to which the tests cover the codebase.

## Contributing
Contributions are welcome. This includes bug reports, feature proposals, and code submissions. Refer to [CONTRIBUTING.md](CONTRIBUTING.md) for our code of conduct and submission process.

## License
This project is licensed under the MIT License. See [LICENSE](LICENSE) for more details.

## Support
For questions or more information, refer to [our website](https://layerzero.network/) or join [our Discord channel](https://discord.gg/layerzero).

Get the coverage report.