From f24185c544fefadc0ed09a62ffed6ac902b4ef06 Mon Sep 17 00:00:00 2001 From: Rohan Kulkarni Date: Wed, 27 Sep 2023 10:59:23 -0400 Subject: [PATCH] chore: run lint & update natspec --- src/upgrades/UpgradeGate.sol | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/src/upgrades/UpgradeGate.sol b/src/upgrades/UpgradeGate.sol index 3d00f5947..292536442 100644 --- a/src/upgrades/UpgradeGate.sol +++ b/src/upgrades/UpgradeGate.sol @@ -8,34 +8,34 @@ import {UpgradeGateStorageV1} from "./UpgradeGateStorageV1.sol"; /// @title UpgradeGate /// @notice Contract for managing upgrades and safe upgrade paths for 1155 contracts contract UpgradeGate is IUpgradeGate, Ownable2StepUpgradeable, UpgradeGateStorageV1 { - /// @notice Constructor for deployment pathway + /// @notice Constructor for deployment pathway constructor(address _defaultOwner) initializer { __Ownable_init(_defaultOwner); emit UpgradeGateSetup(); } - /// @notice ContractURI for contract information with the strategy + /// @notice The URI of the upgrade grate contract function contractURI() external pure returns (string memory) { return "https://github.com/ourzora/zora-1155-contracts/"; } - /// @notice The name of the sale strategy + /// @notice The name of the upgrade gate contract function contractName() external pure returns (string memory) { return "ZORA 1155 Factory Managed Upgrade Gate"; } /// /// - /// CREATOR TOKEN UPGRADES /// + /// CREATOR TOKEN UPGRADES /// /// /// - /// @notice If an implementation is registered by the Builder DAO as an optional upgrade + /// @notice If an implementation is registered as an optional upgrade /// @param baseImpl The base implementation address /// @param upgradeImpl The upgrade implementation address function isRegisteredUpgradePath(address baseImpl, address upgradeImpl) public view returns (bool) { return isAllowedUpgrade[baseImpl][upgradeImpl]; } - /// @notice Called by the Builder DAO to offer implementation upgrades for created DAOs + /// @notice Registers optional upgrades /// @param baseImpls The base implementation addresses /// @param upgradeImpl The upgrade implementation address function registerUpgradePath(address[] memory baseImpls, address upgradeImpl) public onlyOwner { @@ -47,7 +47,7 @@ contract UpgradeGate is IUpgradeGate, Ownable2StepUpgradeable, UpgradeGateStorag } } - /// @notice Called by the Builder DAO to remove an upgrade + /// @notice Removes an upgrade /// @param baseImpl The base implementation address /// @param upgradeImpl The upgrade implementation address function removeUpgradePath(address baseImpl, address upgradeImpl) public onlyOwner {