Skip to content

Commit

Permalink
feat: update natspec
Browse files Browse the repository at this point in the history
  • Loading branch information
QEDK committed Aug 6, 2023
1 parent dd3606a commit 81f3e50
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 5 deletions.
5 changes: 2 additions & 3 deletions src/Polygon.sol
Original file line number Diff line number Diff line change
@@ -1,17 +1,16 @@
// SPDX-License-Identifier: MIT
pragma solidity 0.8.20;

import {ERC20, ERC20Permit} from "openzeppelin-contracts/contracts/token/ERC20/extensions/ERC20Permit.sol";
import {IPolygon} from "./interfaces/IPolygon.sol";
import {ERC20, ERC20Permit} from "openzeppelin-contracts/contracts/token/ERC20/extensions/ERC20Votes.sol";
import {Ownable2Step} from "openzeppelin-contracts/contracts/access/Ownable2Step.sol";

/// @title Polygon ERC20 token
/// @author QEDK <[email protected]> (https://polygon.technology)
/// @notice This is the Polygon ERC20 token contract on Ethereum L1
/// @dev The contract allows for a 1-to-1 representation between $POL and $MATIC and allows for additional inflation based
/// on hub and treasury requirements
/// @custom:security-contact [email protected]
contract Polygon is Ownable2Step, ERC20Permit, IPolygon {
contract Polygon is ERC20Permit, IPolygon {
address public immutable inflationManager;

constructor(address migration_, address inflationManager_, address owner_)
Expand Down
4 changes: 2 additions & 2 deletions src/PolygonMigration.sol
Original file line number Diff line number Diff line change
Expand Up @@ -76,8 +76,8 @@ contract PolygonMigration is Ownable2Step {
releaseTimestamp = timestamp_;
}

/// @notice Allows governance to lock the unmigration process
/// @dev The function does not do any validation since governance can unlock the unmigration process if required
/// @notice Allows governance to lock or unlock the unmigration process
/// @dev The function does not do any validation since governance can update the unmigration process if required
/// @param unmigrationLock_ New unmigration lock status
function updateUnmigrationLock(uint256 unmigrationLock_) external onlyOwner {
unmigrationLock = unmigrationLock_;
Expand Down

0 comments on commit 81f3e50

Please sign in to comment.