Skip to content

Commit

Permalink
chore: update README (#34)
Browse files Browse the repository at this point in the history
  • Loading branch information
sujithsomraaj authored May 11, 2024
1 parent 306f4f0 commit 6a5485a
Showing 1 changed file with 7 additions and 2 deletions.
9 changes: 7 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,19 +8,22 @@
- Helps run cross-chain unit tests on forked mainnet.
- Simulate the off-chain infrastructure of AMBs.

The library is designed to work with the Foundry testing framework and can be used to streamline the testing process for applications that rely on cross-chain communication.

## Why Pigeon?
Arbitrary Message Bridges (AMB) like LayerZero, Hyperlane, Connext, Wormhole, etc., operate alongside multiple off-chain actors. Hence mocking their entire infrastructure during unit testing is tricky for cross-chain application developers.
Arbitrary Message Bridges (AMB) like LayerZero, Axelar, Hyperlane, Celer IM, Wormhole, etc., operate alongside multiple off-chain actors. Hence mocking their entire infrastructure during unit testing is tricky for cross-chain application developers.

Thanks to Pigeon, which will simplify the life of cross-chain application developers by simulating the off-chain infrastructure of such AMBs, helping developers write unit testing across multiple forked networks seamlessly.

By doing near mainnet testing, developers can quickly check sender authentication & other security assumptions associated with cross-chain application development.

### Supported Bridges

| bridge | messaging | gas estimation |
| Bridge | Messaging | Gas Estimation |
| --------- | :----------: | :---------: |
| Hyperlane |||
| LayerZero |||
| LayerZero V2 |||
| Celer || |
| Axelar || |
| Wormhole || |
Expand Down Expand Up @@ -97,6 +100,8 @@ $ npm run compile

**Step 4:** Create a PR to the `main` branch. Clearly specify your changes in the PR description with a suitable title. Please make sure to double-check if the tests are passing.

If you have any further questions or need assistance, please don't hesitate to reach out by opening an issue on the GitHub repository.

### Notable Mentions

- [femplate](https://github.com/refcell/femplate)
Expand Down

0 comments on commit 6a5485a

Please sign in to comment.