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.

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

Add audit reports #5

Merged
merged 1 commit into from
Nov 12, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
10 changes: 7 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,13 @@ This repository contains contracts to support cross chain bridging on EVM chains
[OFTWrapper](contracts/OFTWrapper.sol) which supports bridging using LayerZero.

## OFTWrapper
This contract is a proxy around LayerZero's OFT standard. The `OFTWrapper` can be called
by LayerZero to mint and burn tokens like normal. The `OFTWrapper` then forwards those requests
to the underlying token. The underlying token must grant this contract permission to mint and burn.
`OFTWrapper` serves as a proxy for LayerZero's OFT standard, allowing LayerZero to mint and burn tokens as usual,
which includes the same AML standards as a same chain transfer. When LayerZero initiates a mint or burn request,
the `OFTWrapper` forwards it to the underlying token contract. For this to work, the underlying token must authorize
`OFTWrapper` to perform minting and burning operations on its behalf.

## Audits
Audits were performed by both Zellic and Trail of Bits. Audit reports can be found [here](audits/).

## Upgrade process
`OFTWrapper` is a non-upgradeable contract. If a change needs to be made a new contract should be deployed.
Expand Down
Binary file not shown.
Binary file not shown.