diff --git a/LICENSE b/LICENSE deleted file mode 100644 index 963c501..0000000 --- a/LICENSE +++ /dev/null @@ -1,21 +0,0 @@ -MIT License - -Copyright (c) 2024 Paxos - -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE. diff --git a/README.md b/README.md index c98aed8..b08ce6d 100644 --- a/README.md +++ b/README.md @@ -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` \ No newline at end of file diff --git a/contracts/OFTWrapper.sol b/contracts/OFTWrapper.sol index e1c2bd5..09db7f4 100644 --- a/contracts/OFTWrapper.sol +++ b/contracts/OFTWrapper.sol @@ -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 smart-contract-security@paxos.com */ contract OFTWrapper is OFTCore { //The Paxos token