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

Sync repo to audited commit hash #2

Merged
merged 2 commits into from
Oct 18, 2024
Merged

Sync repo to audited commit hash #2

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
456c3a6
Sync repo
zpetersen-paxos Oct 17, 2024
6dfae0b
Sync repos
zpetersen-paxos Oct 17, 2024
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
21 changes: 0 additions & 21 deletions LICENSE
View file
Open in desktop

This file was deleted.

29 changes: 0 additions & 29 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,30 +1 @@
# cross-chain-contracts-internal
This repository contains contracts to support cross chain bridging on EVM chains. The main contract is
[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.

## Upgrade process
`OFTWrapper` is a non-upgradeable contract. If a change needs to be made a new contract should be deployed.
The underlying token should then revoke mint and burn permissions on the old contract and grant mint and burn
permissions to the new contract.

## Contract Tests
Install dependencies:

`npm install`

Compile the contracts:

`npx hardhat compile`

Run unit tests:

`npx hardhat test`

Check test coverage:

`npx hardhat coverage`
1 change: 0 additions & 1 deletion contracts/OFTWrapper.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@ import {PaxosTokenV2} from "PaxosToken/contracts/PaxosTokenV2.sol";
* @dev 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.
* @custom:security-contact [email protected]
*/
contract OFTWrapper is OFTCore {
//The Paxos token
Expand Down