Skip to content

Latest commit

 

History

History
90 lines (61 loc) · 3.4 KB

README.md

File metadata and controls

90 lines (61 loc) · 3.4 KB
Raw

pigeon • tests license solidity

A Simple, Easy tool to test cross-chain protocols.

What is Pigeon?

Pigeon is a set of helper contracts, one per cross-chain protocol, that is designed to help you simulate as closely as possible how the cross-chain transaction would go.

Installation

To install with Foundry:

forge install exp-table/pigeon

Set environment variables:

ETH_MAINNET_RPC_URL=
POLYGON_MAINNET_RPC_URL=

# Optional
ENABLE_ESTIMATES=

To enable gas estimation, from the utils/scripts directory, run the following command:

npm install
npm run compile

Usage

It is made to be as simple as instantiating the helper in your test file, and simple calling help with the appropriate parameters. We have provided examples in the test files.

Without gas estimation (Hyperlane):

vm.recordLogs();
_someCrossChainFunctionInYourContract(L2_DOMAIN, TypeCasts.addressToBytes32(address(target)));
Vm.Log[] memory logs = vm.getRecordedLogs();
hyperlaneHelper.help(L1_HLMailbox, L2_HLMailbox, L2_FORK_ID, logs);

With gas estimation (Hyperlane):

vm.recordLogs();
_someCrossChainFunctionInYourContract(L2_DOMAIN, TypeCasts.addressToBytes32(address(target)));
Vm.Log[] memory logs = vm.getRecordedLogs();
hyperlaneHelper.helpWithEstimates(L1_Mailbox, L2_HLMailbox, L2_FORK_ID, logs);

To display estimations, be sure to run the npm install and npm run compile commands from the utils/scripts directory before running your tests. Then run tests with the --ffi flag and ENABLE_ESTIMATES env variable set to true.

Gas estimation is the gas costs required in native tokens to pay for the message delivery.

Protocols support

Protocols Is supported
Hyperlane ✅
LayerZero ✅
Celer ✅
Axelar ✅
Stargate ✅

Warning

As of now, it only supports the message execution and is not sensible to gas limits (which is a function of the fee you pay to the protocols usually).

Notable Mentions

Disclaimer

These smart contracts are being provided as is. No guarantee, representation or warranty is being made, express or implied, as to the safety or correctness of the user interface or the smart contracts. They have not been audited and as such there can be no assurance they will work as intended, and users may experience delays, failures, errors, omissions, loss of transmitted information or loss of funds. The creators are not liable for any of the foregoing. Users should proceed with caution and use at their own risk.

See LICENSE for more details.