Skip to content

Commit

Permalink
improve documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
gretzke committed Sep 1, 2023
1 parent 0aefc00 commit ae1d210
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 4 deletions.
4 changes: 2 additions & 2 deletions src/DefaultInflationManager.sol
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import {SafeERC20} from "openzeppelin-contracts/contracts/token/ERC20/utils/Safe
import {PowUtil} from "./lib/PowUtil.sol";

/// @title Default Inflation Manager
/// @author QEDK <[email protected]> (https://polygon.technology)
/// @author Polygon Labs (@DhairyaSethi, @gretzke, @qedk)
/// @notice A default inflation manager implementation for the Polygon ERC20 token contract on Ethereum L1
/// @dev The contract allows for a 1% mint *each* per year (compounded every second) to the stakeManager and treasury contracts
/// @custom:security-contact [email protected]
Expand Down Expand Up @@ -61,7 +61,7 @@ contract DefaultInflationManager is
assert(START_SUPPLY == token.totalSupply());

token.safeApprove(migration_, type(uint256).max);

// initial ownership setup bypassing 2 step ownership transfer process
_transferOwnership(owner_);
}

Expand Down
2 changes: 1 addition & 1 deletion src/Polygon.sol
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ import {IPolygon} from "./interfaces/IPolygon.sol";
import {IDefaultInflationManager} from "./interfaces/IDefaultInflationManager.sol";

/// @title Polygon ERC20 token
/// @author QEDK <[email protected]> (https://polygon.technology)
/// @author Polygon Labs (@DhairyaSethi, @gretzke, @qedk)
/// @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
Expand Down
2 changes: 1 addition & 1 deletion src/PolygonMigration.sol
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import {Ownable2Step} from "openzeppelin-contracts/contracts/access/Ownable2Step
import {IPolygonMigration} from "./interfaces/IPolygonMigration.sol";

/// @title Polygon Migration
/// @author QEDK <[email protected]> (https://polygon.technology)
/// @author Polygon Labs (@DhairyaSethi, @gretzke, @qedk)
/// @notice This is the migration contract for Matic <-> Polygon ERC20 token on Ethereum L1
/// @dev The contract allows for a 1-to-1 conversion from $MATIC into $POL and vice-versa
/// @custom:security-contact [email protected]
Expand Down

0 comments on commit ae1d210

Please sign in to comment.