Merge pull request #33 from 0xPolygon/sec/audit

Audit Reports
0xPolygon · Oct 5, 2023 · 37726c3 · 37726c3
2 parents a780764 + 9287331
commit 37726c3
Show file tree

Hide file tree

Showing 10 changed files with 68 additions and 9 deletions.
diff --git a/audit/ChainSecurity_Polygon_Polygon_Token_(POL)_audit.pdf b/audit/ChainSecurity_Polygon_Polygon_Token_(POL)_audit.pdf
diff --git a/audit/Sigma Prime - Polygon - PolToken - Security Assessment Report - v2.0.pdf b/audit/Sigma Prime - Polygon - PolToken - Security Assessment Report - v2.0.pdf
diff --git a/docs/src/README.md b/docs/src/README.md
@@ -26,6 +26,26 @@ A default implementation is included and this contract will be proxy upgradable
 
 [Source Code](https://github.com/0xPolygon/pol-token/tree/main/src/DefaultEmissionManager.sol)
 
+## Development
+
+### Setup
+
+-   [Install foundry](https://book.getfoundry.sh/getting-started/installation)
+-   Install Dependencies: `forge install`
+-   Build: `forge build`
+-   Test: `forge test`
+
+### Deployment
+
+1. Ensure .env file is set, `cp .env.example`
+2. Populate Enviornment variables: `source .env`
+3. We use a forge script to deploy the contracts, and have an additional extract.js script to store a JSON file with coalesced deployment information. (see [output](./output/))
+
+-   (mainnet): `forge script script/Deploy.s.sol --broadcast --verify --rpc-url $RPC_URL --private-key $PRIVATE_KEY --etherscan-api-key $ETHERSCAN_API_KEY`
+-   (testnet, goerli for example): `forge script script/Deploy.s.sol --broadcast --verify --rpc-url $RPC_URL --private-key $PRIVATE_KEY --verifier-url https://api-goerli.etherscan.io/api --chain-id 5`
+
+4. Run `node script/util/extract.js <chainId>` to extract deployment information from forge broadcast output (broadcast/latest-run.json).
+
 ---
 
 Copyright (C) 2023 PT Services DMCC
diff --git a/docs/src/src/DefaultEmissionManager.sol/contract.DefaultEmissionManager.md b/docs/src/src/DefaultEmissionManager.sol/contract.DefaultEmissionManager.md
@@ -1,5 +1,5 @@
 # DefaultEmissionManager
-[Git Source](https://github.com/0xPolygon/pol-token/blob/c05c8984ac856501829862c1f6d199208aa77a8e/src/DefaultEmissionManager.sol)
+[Git Source](https://github.com/0xPolygon/pol-token/blob/a780764684dd1ef1ca70707f8069da35cddbd074/src/DefaultEmissionManager.sol)
 
 **Inherits:**
 Ownable2StepUpgradeable, [IDefaultEmissionManager](/src/interfaces/IDefaultEmissionManager.sol/interface.IDefaultEmissionManager.md)
@@ -76,7 +76,7 @@ See https://docs.openzeppelin.com/contracts/4.x/upgradeable#storage_gaps*
 
 
 ```solidity
-uint256[50] private __gap;
+uint256[48] private __gap;
 ```
 
 

diff --git a/docs/src/src/PolygonEcosystemToken.sol/contract.PolygonEcosystemToken.md b/docs/src/src/PolygonEcosystemToken.sol/contract.PolygonEcosystemToken.md
@@ -1,5 +1,5 @@
 # PolygonEcosystemToken
-[Git Source](https://github.com/0xPolygon/pol-token/blob/c05c8984ac856501829862c1f6d199208aa77a8e/src/PolygonEcosystemToken.sol)
+[Git Source](https://github.com/0xPolygon/pol-token/blob/a780764684dd1ef1ca70707f8069da35cddbd074/src/PolygonEcosystemToken.sol)
 
 **Inherits:**
 ERC20Permit, AccessControlEnumerable, [IPolygonEcosystemToken](/src/interfaces/IPolygonEcosystemToken.sol/interface.IPolygonEcosystemToken.md)
@@ -129,6 +129,24 @@ The permit2 contract has full approval by default. If the approval is revoked, i
 function allowance(address owner, address spender) public view override(ERC20, IERC20) returns (uint256);
 ```
 
+### getVersion
+
+Returns the implementation version
+
+*This is to support our dev pipeline, and is present despite
+this contract not being behind a proxy*
+
+
+```solidity
+function getVersion() external pure returns (string memory);
+```
+**Returns**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`<none>`|`string`|Version string|
+
+
 ### _updatePermit2Allowance
 
 

diff --git a/docs/src/src/PolygonMigration.sol/contract.PolygonMigration.md b/docs/src/src/PolygonMigration.sol/contract.PolygonMigration.md
@@ -1,5 +1,5 @@
 # PolygonMigration
-[Git Source](https://github.com/0xPolygon/pol-token/blob/c05c8984ac856501829862c1f6d199208aa77a8e/src/PolygonMigration.sol)
+[Git Source](https://github.com/0xPolygon/pol-token/blob/a780764684dd1ef1ca70707f8069da35cddbd074/src/PolygonMigration.sol)
 
 **Inherits:**
 Ownable2StepUpgradeable, [IPolygonMigration](/src/interfaces/IPolygonMigration.sol/interface.IPolygonMigration.md)
@@ -41,7 +41,7 @@ See https://docs.openzeppelin.com/contracts/4.x/upgradeable#storage_gaps*
 
 
 ```solidity
-uint256[50] private __gap;
+uint256[49] private __gap;
 ```
 
 

diff --git a/...src/interfaces/IDefaultEmissionManager.sol/interface.IDefaultEmissionManager.md b/...src/interfaces/IDefaultEmissionManager.sol/interface.IDefaultEmissionManager.md
@@ -1,5 +1,5 @@
 # IDefaultEmissionManager
-[Git Source](https://github.com/0xPolygon/pol-token/blob/c05c8984ac856501829862c1f6d199208aa77a8e/src/interfaces/IDefaultEmissionManager.sol)
+[Git Source](https://github.com/0xPolygon/pol-token/blob/a780764684dd1ef1ca70707f8069da35cddbd074/src/interfaces/IDefaultEmissionManager.sol)
 
 
 ## Functions
@@ -10,6 +10,13 @@
 function getVersion() external pure returns (string memory version);
 ```
 
+### token
+
+
+```solidity
+function token() external view returns (IPolygonEcosystemToken polygonEcosystemToken);
+```
+
 ### startTimestamp
 
 

diff --git a/...c/src/interfaces/IPolygonEcosystemToken.sol/interface.IPolygonEcosystemToken.md b/...c/src/interfaces/IPolygonEcosystemToken.sol/interface.IPolygonEcosystemToken.md
@@ -1,5 +1,5 @@
 # IPolygonEcosystemToken
-[Git Source](https://github.com/0xPolygon/pol-token/blob/c05c8984ac856501829862c1f6d199208aa77a8e/src/interfaces/IPolygonEcosystemToken.sol)
+[Git Source](https://github.com/0xPolygon/pol-token/blob/a780764684dd1ef1ca70707f8069da35cddbd074/src/interfaces/IPolygonEcosystemToken.sol)
 
 **Inherits:**
 IERC20, IERC20Permit, IAccessControlEnumerable
@@ -13,6 +13,13 @@ IERC20, IERC20Permit, IAccessControlEnumerable
 function mintPerSecondCap() external view returns (uint256 currentMintPerSecondCap);
 ```
 
+### getVersion
+
+
+```solidity
+function getVersion() external pure returns (string memory version);
+```
+
 ### lastMint
 
 

diff --git a/docs/src/src/interfaces/IPolygonMigration.sol/interface.IPolygonMigration.md b/docs/src/src/interfaces/IPolygonMigration.sol/interface.IPolygonMigration.md
@@ -1,5 +1,5 @@
 # IPolygonMigration
-[Git Source](https://github.com/0xPolygon/pol-token/blob/c05c8984ac856501829862c1f6d199208aa77a8e/src/interfaces/IPolygonMigration.sol)
+[Git Source](https://github.com/0xPolygon/pol-token/blob/a780764684dd1ef1ca70707f8069da35cddbd074/src/interfaces/IPolygonMigration.sol)
 
 
 ## Functions
@@ -10,6 +10,13 @@
 function unmigrationLocked() external view returns (bool isUnmigrationLocked);
 ```
 
+### polygon
+
+
+```solidity
+function polygon() external view returns (IERC20 polygonEcosystemToken);
+```
+
 ### getVersion
 
 

diff --git a/docs/src/src/lib/PowUtil.sol/library.PowUtil.md b/docs/src/src/lib/PowUtil.sol/library.PowUtil.md
@@ -1,5 +1,5 @@
 # PowUtil
-[Git Source](https://github.com/0xPolygon/pol-token/blob/c05c8984ac856501829862c1f6d199208aa77a8e/src/lib/PowUtil.sol)
+[Git Source](https://github.com/0xPolygon/pol-token/blob/a780764684dd1ef1ca70707f8069da35cddbd074/src/lib/PowUtil.sol)
 
 
 ## Functions