From ec08969258ba8326c48b3de0250854e276bb36dd Mon Sep 17 00:00:00 2001 From: Sid Sethi Date: Thu, 2 Jul 2020 14:19:03 -0400 Subject: [PATCH 1/2] Remove unnused var from and add natspec to InitializableV2 --- eth-contracts/contracts/InitializableV2.sol | 13 ++++++++++++- eth-contracts/test/upgradeability.test.js | 4 +--- 2 files changed, 13 insertions(+), 4 deletions(-) diff --git a/eth-contracts/contracts/InitializableV2.sol b/eth-contracts/contracts/InitializableV2.sol index a6186012397..a047ba91b0f 100644 --- a/eth-contracts/contracts/InitializableV2.sol +++ b/eth-contracts/contracts/InitializableV2.sol @@ -13,16 +13,27 @@ contract InitializableV2 is Initializable { bool private isInitialized; string private constant ERROR_NOT_INITIALIZED = "InitializableV2: Not initialized"; - string private constant ERROR_ALREADY_INITIALIZED = "InitializableV2: Already initialized"; + /** + * @notice wrapper function around parent contract Initializable's `initializable` modifier + * initializable modifier ensures this function can only be called once by each deployed child contract + * sets isInitialized flag to true to which is used by _requireIsInitialized() + */ function initialize() public initializer { isInitialized = true; } + /** + * @notice Reverts transaction if isInitialized is false. Used by child contracts to ensure + * contract is initialized before functions can be called. + */ function _requireIsInitialized() internal view { require(isInitialized == true, ERROR_NOT_INITIALIZED); } + /** + * @notice Exposes isInitialized bool var to child contracts with read-only access + */ function _isInitialized() internal view returns (bool) { return isInitialized; } diff --git a/eth-contracts/test/upgradeability.test.js b/eth-contracts/test/upgradeability.test.js index 28c162cad60..dc15295b3fb 100644 --- a/eth-contracts/test/upgradeability.test.js +++ b/eth-contracts/test/upgradeability.test.js @@ -3,15 +3,14 @@ import * as _lib from '../utils/lib.js' const Registry = artifacts.require('Registry') const Staking = artifacts.require('Staking') const StakingUpgraded = artifacts.require('StakingUpgraded') -const AudiusToken = artifacts.require('AudiusToken') const MockStakingCaller = artifacts.require('MockStakingCaller') const AudiusAdminUpgradeabilityProxy = artifacts.require('AudiusAdminUpgradeabilityProxy') +const TestContract = artifacts.require('TestContract') const claimsManagerProxyKey = web3.utils.utf8ToHex('ClaimsManagerProxy') const delegateManagerKey = web3.utils.utf8ToHex('DelegateManager') const serviceProviderFactoryKey = web3.utils.utf8ToHex('ServiceProviderFactory') const governanceKey = web3.utils.utf8ToHex('Governance') -const serviceTypeManagerProxyKey = web3.utils.utf8ToHex('ServiceTypeManagerProxy') const tokenRegKey = web3.utils.utf8ToHex('TokenKey') const DEFAULT_AMOUNT = _lib.audToWeiBN(120) @@ -62,7 +61,6 @@ contract('Upgrade proxy test', async (accounts) => { ) // await registry.addContract(governanceKey, governance.address, { from: proxyDeployerAddress }) - // Deploy + register AudiusToken token = await _lib.deployToken( artifacts, proxyAdminAddress, From 64df4eb935052bca09beab96addd180524e74e9a Mon Sep 17 00:00:00 2001 From: Sid Sethi Date: Thu, 2 Jul 2020 14:22:02 -0400 Subject: [PATCH 2/2] Revert test file changes --- eth-contracts/test/upgradeability.test.js | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/eth-contracts/test/upgradeability.test.js b/eth-contracts/test/upgradeability.test.js index dc15295b3fb..28c162cad60 100644 --- a/eth-contracts/test/upgradeability.test.js +++ b/eth-contracts/test/upgradeability.test.js @@ -3,14 +3,15 @@ import * as _lib from '../utils/lib.js' const Registry = artifacts.require('Registry') const Staking = artifacts.require('Staking') const StakingUpgraded = artifacts.require('StakingUpgraded') +const AudiusToken = artifacts.require('AudiusToken') const MockStakingCaller = artifacts.require('MockStakingCaller') const AudiusAdminUpgradeabilityProxy = artifacts.require('AudiusAdminUpgradeabilityProxy') -const TestContract = artifacts.require('TestContract') const claimsManagerProxyKey = web3.utils.utf8ToHex('ClaimsManagerProxy') const delegateManagerKey = web3.utils.utf8ToHex('DelegateManager') const serviceProviderFactoryKey = web3.utils.utf8ToHex('ServiceProviderFactory') const governanceKey = web3.utils.utf8ToHex('Governance') +const serviceTypeManagerProxyKey = web3.utils.utf8ToHex('ServiceTypeManagerProxy') const tokenRegKey = web3.utils.utf8ToHex('TokenKey') const DEFAULT_AMOUNT = _lib.audToWeiBN(120) @@ -61,6 +62,7 @@ contract('Upgrade proxy test', async (accounts) => { ) // await registry.addContract(governanceKey, governance.address, { from: proxyDeployerAddress }) + // Deploy + register AudiusToken token = await _lib.deployToken( artifacts, proxyAdminAddress,