@artblocks/contracts 1.0.4 → 1.1.0

package/contracts/DependencyRegistryV0.sol

@@ -23,7 +23,7 @@ import "./libs/v0.8.x/Bytes32Strings.sol";
  * Permissions managed by ACL contract. If/when we ever call
  * renounceOwnership() this will becom a frozen, immutable registry
  * as no upgrades will be possible.
- * This contract This contract is intended to be an auxiliary reference registry
+ * This contract is intended to be an auxiliary reference registry
  * to our non-upgradeable and immutable ERC-721 conforming core contracts,
  * and has been made upgradeable as we expect its required functionality in
  * relation to the Art Blocks ecosystem to evolve over time.
@@ -46,6 +46,7 @@ contract DependencyRegistryV0 is
     IAdminACLV0 public adminACLContract;
 
     struct Dependency {
+        bytes32 licenseType;
         string preferredCDN;
         // mapping from additional CDN index to CDN URLr
         mapping(uint256 => string) additionalCDNs;
@@ -60,9 +61,14 @@ contract DependencyRegistryV0 is
         uint24 scriptCount;
     }
 
+    // dependency types, i.e. "type@version"
     EnumerableSet.Bytes32Set private _dependencyTypes;
+    // mapping from dependencyTypes to Dependency, which stores the properties of each dependency
     mapping(bytes32 => Dependency) dependencyDetails;
+    // source code license types, MIT, GPL, etc.
+    EnumerableSet.Bytes32Set private _licenseTypes;
 
+    // set of supported core ArtBlocks contracts
     EnumerableSet.AddressSet private _supportedCoreContracts;
     mapping(address => mapping(uint256 => bytes32)) projectDependencyTypeOverrides;
 
@@ -103,6 +109,13 @@ contract DependencyRegistryV0 is
         require(_index < _length, "Index out of range");
     }
 
+    function _onlyExistingLicenseType(bytes32 _licenseType) internal view {
+        require(
+            _licenseTypes.contains(_licenseType),
+            "License type does not exist"
+        );
+    }
+
     /**
      * @notice Initializes contract.
      * @param _adminACLContract Address of admin access control contract, to be
@@ -114,23 +127,36 @@ contract DependencyRegistryV0 is
         _transferOwnership(_adminACLContract);
     }
 
+    /**
+     * @notice Adds a new license type that can be used by dependencies.
+     */
+    function addLicenseType(bytes32 _licenseType) external {
+        _onlyAdminACL(this.addLicenseType.selector);
+        // @dev the add function returns false if set already contains value
+        require(_licenseTypes.add(_licenseType), "License type already exists");
+        require(
+            _licenseType != bytes32(""),
+            "License type cannot be empty string"
+        );
+        emit LicenseTypeAdded(_licenseType);
+    }
+
     /**
      * @notice Adds a new dependency.
      * @param _dependencyType Name of dependency type (i.e. "type@version") used to identify dependency.
+     * @param _licenseType License type for dependency, must be a registered license type.
      * @param _preferredCDN Preferred CDN for dependency.
      * @param _preferredRepository Preferred repository for dependency.
      */
     function addDependency(
         bytes32 _dependencyType,
+        bytes32 _licenseType,
         string memory _preferredCDN,
         string memory _preferredRepository,
         string memory _referenceWebsite
     ) external {
         _onlyAdminACL(this.addDependency.selector);
-        require(
-            !_dependencyTypes.contains(_dependencyType),
-            "Dependency type already exists"
-        );
+        _onlyExistingLicenseType(_licenseType);
         require(
             _dependencyType.containsExactCharacterQty(
                 AT_CHARACTER_CODE,
@@ -138,15 +164,21 @@ contract DependencyRegistryV0 is
             ),
             "must contain exactly one @"
         );
+        require(
+            // @dev the add function returns false if set already contains value
+            _dependencyTypes.add(_dependencyType),
+            "Dependency type already exists"
+        );
 
-        _dependencyTypes.add(_dependencyType);
         Dependency storage dependency = dependencyDetails[_dependencyType];
+        dependency.licenseType = _licenseType;
         dependency.preferredCDN = _preferredCDN;
         dependency.preferredRepository = _preferredRepository;
         dependency.referenceWebsite = _referenceWebsite;
 
         emit DependencyAdded(
             _dependencyType,
+            _licenseType,
             _preferredCDN,
             _preferredRepository,
             _referenceWebsite
@@ -525,12 +557,10 @@ contract DependencyRegistryV0 is
         _onlyAdminACL(this.addSupportedCoreContract.selector);
         _onlyNonZeroAddress(_contractAddress);
         require(
-            !_supportedCoreContracts.contains(_contractAddress),
+            // @dev the add function returns false if set already contains value
+            _supportedCoreContracts.add(_contractAddress),
             "Contract already supported"
         );
-
-        _supportedCoreContracts.add(_contractAddress);
-
         emit SupportedCoreContractAdded(_contractAddress);
     }
 
@@ -540,9 +570,11 @@ contract DependencyRegistryV0 is
      */
     function removeSupportedCoreContract(address _contractAddress) external {
         _onlyAdminACL(this.removeSupportedCoreContract.selector);
-        _onlySupportedCoreContract(_contractAddress);
-        _supportedCoreContracts.remove(_contractAddress);
-
+        require(
+            // @dev the remove function returns false if set does not contain value
+            _supportedCoreContracts.remove(_contractAddress),
+            "Core contract already removed or not in set"
+        );
         emit SupportedCoreContractRemoved(_contractAddress);
     }
 
@@ -603,10 +635,8 @@ contract DependencyRegistryV0 is
      * execution where there is no gas limit.
      */
     function getDependencyTypes() external view returns (string[] memory) {
-        string[] memory dependencyTypes = new string[](
-            _dependencyTypes.length()
-        );
         uint256 numDependencyTypes = _dependencyTypes.length();
+        string[] memory dependencyTypes = new string[](numDependencyTypes);
 
         for (uint256 i = 0; i < numDependencyTypes; i++) {
             dependencyTypes[i] = _dependencyTypes.at(i).toString();
@@ -633,11 +663,47 @@ contract DependencyRegistryV0 is
         return _dependencyTypes.at(_index).toString();
     }
 
+    /**
+     * @notice Returns number of registered license types
+     * @return Number of registered license types.
+     * @dev This is only intended to be called outside of block
+     * execution where there is no gas limit.
+     */
+    function getLicenseTypes() external view returns (string[] memory) {
+        uint256 numLicenseTypes = _licenseTypes.length();
+        string[] memory licenseTypes = new string[](numLicenseTypes);
+
+        for (uint256 i = 0; i < numLicenseTypes; i++) {
+            licenseTypes[i] = _licenseTypes.at(i).toString();
+        }
+        return licenseTypes;
+    }
+
+    /**
+     * @notice Returns number of registered license types
+     * @return Number of registered license types.
+     */
+    function getLicenseTypeCount() external view returns (uint256) {
+        return _licenseTypes.length();
+    }
+
+    /**
+     * @notice Returns registered license type at index `_index`.
+     * @return Registered license type at `_index`, relative to the overall length of the license type set.
+     */
+    function getLicenseType(
+        uint256 _index
+    ) external view returns (string memory) {
+        _onlyInRangeIndex({_index: _index, _length: _licenseTypes.length()});
+        return _licenseTypes.at(_index).toString();
+    }
+
     /**
      * @notice Returns details for a given depedency type `_dependencyType`.
      * @param _dependencyType Name of dependency type (i.e. "type@version") used to identify dependency.
      * @return typeAndVersion String representation of `_dependencyType`.
      *                        (e.g. "p5js(atSymbol)1.0.0")
+     * @return licenseType License type for dependency
      * @return preferredCDN Preferred CDN URL for dependency
      * @return additionalCDNCount Count of additional CDN URLs for dependency
      * @return preferredRepository Preferred repository URL for dependency
@@ -653,6 +719,7 @@ contract DependencyRegistryV0 is
         view
         returns (
             string memory typeAndVersion,
+            string memory licenseType,
             string memory preferredCDN,
             uint24 additionalCDNCount,
             string memory preferredRepository,
@@ -666,6 +733,7 @@ contract DependencyRegistryV0 is
 
         return (
             _dependencyType.toString(),
+            dependency.licenseType.toString(),
             dependency.preferredCDN,
             dependency.additionalCDNCount,
             dependency.preferredRepository,

package/contracts/archive/readme.md

@@ -0,0 +1,16 @@
+## Directory Overview
+
+The file(s) in this directory remain under the root `/contracts/` directory, and are therefore compiled. they are no longer being actively developed, however, and should be considered deprecated. The contracts are in this directory for one or more of the following reasons:
+
+- They must be included in our published npm package
+  - For example, the legacy Art Blocks V1 core contract's ABI created by Hardhat during compiling, must be available in the npm package
+- They must be available for integration testing purposes
+  - For example, tests may want to ensure new minters are compatible with legacy core contracts
+
+## Directory Structure
+
+In general, the directory structure of this directory mimics the directory structure of the `/contracts/` directory.
+
+## Contract modifications
+
+All contracts in this directory should be considered deprecated, and should not be modified. The exception is that when a contract is archived, import paths must be updated to continue to allow the contract to be compiled.

package/contracts/engine/README.md

@@ -0,0 +1,21 @@
+## Overview of this Directory
+
+This directory is intended to contain all common Art Blocks Engine smart contract source code, as well as any other relevant information about contracts that are in development. That may include directories specific to each partner prior to mainnet deployments.
+
+## Forked Engine Contracts
+
+We welcome submission of forked versions of our engine contracts. If you would like to fork our contracts, please create a new directory in this directory with the name of your project. Please include a CHANGELOG.md file with a description the changes implemnted in the fork.
+
+Additionally, the following requirements must be met for all forked contracts:
+
+- The forked contracts must conform to the same interface as the original contracts.
+  - They may implement a forked interface, as long as the new interface only extends the original interface.
+  - This requirement is to ensure that our indexing and other services can continue to function as expected.
+- Core, AdminACL, and Minter contracts may be forked
+  - We do not recommend forking the MitnerFilter contract, as it is a critical component of our indexing model that is in active development.
+
+## Data Management Process
+
+After a partner's contracts are deployed to mainnet and no longer in development, the contracts should be migrated to the `/posterity/engine/` directory.
+
+Note: any deployment logs should be maintained in the `/deployments/V3/partners/<partner>/` or `/deployments/V2/<partner>/` directory.

package/contracts/engine/V3/GenArt721CoreV3_Engine.sol

@@ -5,7 +5,6 @@ pragma solidity 0.8.19;
 
 import "../../interfaces/v0.8.x/IRandomizer_V3CoreBase.sol";
 import "../../interfaces/v0.8.x/IAdminACLV0.sol";
-import "../../interfaces/v0.8.x/IEngineRegistryV0.sol";
 import "../../interfaces/v0.8.x/IGenArt721CoreContractV3_Engine.sol";
 import "../../interfaces/v0.8.x/IGenArt721CoreContractExposesHashSeed.sol";
 import "../../interfaces/v0.8.x/IDependencyRegistryCompatibleV0.sol";
@@ -259,7 +258,7 @@ contract GenArt721CoreV3_Engine is
     bool public immutable autoApproveArtistSplitProposals;
 
     /// version & type of this core contract
-    bytes32 constant CORE_VERSION = "v3.1.3";
+    bytes32 constant CORE_VERSION = "v3.1.4";
 
     function coreVersion() external pure returns (string memory) {
         return CORE_VERSION.toString();
@@ -366,8 +365,7 @@ contract GenArt721CoreV3_Engine is
         address _randomizerContract,
         address _adminACLContract,
         uint248 _startingProjectId,
-        bool _autoApproveArtistSplitProposals,
-        address _engineRegistryContract
+        bool _autoApproveArtistSplitProposals
     ) ERC721_PackedHashSeed(_tokenName, _tokenSymbol) {
         _onlyNonZeroAddress(_renderProviderAddress);
         _onlyNonZeroAddress(_platformProviderAddress);
@@ -398,12 +396,8 @@ contract GenArt721CoreV3_Engine is
         // initialize next project ID
         _nextProjectId = _startingProjectId;
         emit PlatformUpdated(FIELD_NEXT_PROJECT_ID);
-        // register contract as an Engine contract
-        IEngineRegistryV0(_engineRegistryContract).registerContract(
-            address(this),
-            CORE_VERSION,
-            CORE_TYPE
-        );
+        // @dev follow-on action: This contract does not self-register. A core
+        // registry owner must register contract in a subsequent call.
     }
 
     /**

package/contracts/engine/V3/GenArt721CoreV3_Engine_Flex.sol

@@ -5,7 +5,6 @@ pragma solidity 0.8.19;
 
 import "../../interfaces/v0.8.x/IRandomizer_V3CoreBase.sol";
 import "../../interfaces/v0.8.x/IAdminACLV0.sol";
-import "../../interfaces/v0.8.x/IEngineRegistryV0.sol";
 import "../../interfaces/v0.8.x/IGenArt721CoreContractV3_Engine_Flex.sol";
 import "../../interfaces/v0.8.x/IGenArt721CoreContractExposesHashSeed.sol";
 import "../../interfaces/v0.8.x/IDependencyRegistryCompatibleV0.sol";
@@ -271,7 +270,7 @@ contract GenArt721CoreV3_Engine_Flex is
     bool public immutable autoApproveArtistSplitProposals;
 
     /// version & type of this core contract
-    bytes32 constant CORE_VERSION = "v3.1.3";
+    bytes32 constant CORE_VERSION = "v3.1.4";
 
     function coreVersion() external pure returns (string memory) {
         return CORE_VERSION.toString();
@@ -387,8 +386,7 @@ contract GenArt721CoreV3_Engine_Flex is
         address _randomizerContract,
         address _adminACLContract,
         uint248 _startingProjectId,
-        bool _autoApproveArtistSplitProposals,
-        address _engineRegistryContract
+        bool _autoApproveArtistSplitProposals
     ) ERC721_PackedHashSeed(_tokenName, _tokenSymbol) {
         _onlyNonZeroAddress(_renderProviderAddress);
         _onlyNonZeroAddress(_platformProviderAddress);
@@ -419,12 +417,8 @@ contract GenArt721CoreV3_Engine_Flex is
         // initialize next project ID
         _nextProjectId = _startingProjectId;
         emit PlatformUpdated(FIELD_NEXT_PROJECT_ID);
-        // register contract as an Engine contract
-        IEngineRegistryV0(_engineRegistryContract).registerContract(
-            address(this),
-            CORE_VERSION,
-            CORE_TYPE
-        );
+        // @dev follow-on action: This contract does not self-register. A core
+        // registry owner must register contract in a subsequent call.
     }
 
     /**

package/contracts/engine/V3/forks/GenArt721CoreV3_Engine_Flex_PROOF.sol

@@ -5,7 +5,6 @@ pragma solidity 0.8.19;
 
 import "../../../interfaces/v0.8.x/IRandomizerV2.sol";
 import "../../../interfaces/v0.8.x/IAdminACLV0.sol";
-import "../../../interfaces/v0.8.x/IEngineRegistryV0.sol";
 import "../../../interfaces/v0.8.x/IGenArt721CoreContractV3_Engine_Flex.sol";
 import "../../../interfaces/v0.8.x/IDependencyRegistryCompatibleV0.sol";
 import "../../../interfaces/v0.8.x/IManifold.sol";
@@ -272,7 +271,7 @@ contract GenArt721CoreV3_Engine_Flex_PROOF is
     bool public immutable autoApproveArtistSplitProposals;
 
     /// version & type of this core contract
-    bytes32 constant CORE_VERSION = "v3.1.2";
+    bytes32 constant CORE_VERSION = "v3.1.6";
 
     function coreVersion() external pure returns (string memory) {
         return CORE_VERSION.toString();
@@ -381,8 +380,7 @@ contract GenArt721CoreV3_Engine_Flex_PROOF is
         address _randomizerContract,
         address _adminACLContract,
         uint248 _startingProjectId,
-        bool _autoApproveArtistSplitProposals,
-        address _engineRegistryContract
+        bool _autoApproveArtistSplitProposals
     ) ERC721_PackedHashSeed(_tokenName, _tokenSymbol) {
         _onlyNonZeroAddress(_renderProviderAddress);
         _onlyNonZeroAddress(_platformProviderAddress);
@@ -413,12 +411,8 @@ contract GenArt721CoreV3_Engine_Flex_PROOF is
         // initialize next project ID
         _nextProjectId = _startingProjectId;
         emit PlatformUpdated(FIELD_NEXT_PROJECT_ID);
-        // register contract as an Engine contract
-        IEngineRegistryV0(_engineRegistryContract).registerContract(
-            address(this),
-            CORE_VERSION,
-            CORE_TYPE
-        );
+        // @dev follow-on action: This contract does not self-register. A core
+        // registry owner must register contract in a subsequent call.
     }
 
     /**

package/contracts/engine/V3/forks/PROHIBITION/GenArt721CoreV3_Engine_Flex_PROHIBITION.sol

@@ -7,7 +7,6 @@ import "./interfaces/IAdminACLV0_PROHIBITION.sol";
 import "./interfaces/IGenArt721CoreContractV3_Engine_Flex_PROHIBITION.sol";
 
 import "../../../../interfaces/v0.8.x/IRandomizerV2.sol";
-import "../../../../interfaces/v0.8.x/IEngineRegistryV0.sol";
 import "../../../../interfaces/v0.8.x/IDependencyRegistryCompatibleV0.sol";
 import "../../../../interfaces/v0.8.x/IManifold.sol";
 
@@ -271,7 +270,7 @@ contract GenArt721CoreV3_Engine_Flex_PROHIBITION is
     bool public immutable autoApproveArtistSplitProposals;
 
     /// version & type of this core contract
-    bytes32 constant CORE_VERSION = "v3.1.3";
+    bytes32 constant CORE_VERSION = "v3.1.5";
 
     function coreVersion() external pure returns (string memory) {
         return CORE_VERSION.toString();
@@ -392,8 +391,7 @@ contract GenArt721CoreV3_Engine_Flex_PROHIBITION is
         address _randomizerContract,
         address _adminACLContract,
         uint248 _startingProjectId,
-        bool _autoApproveArtistSplitProposals,
-        address _engineRegistryContract
+        bool _autoApproveArtistSplitProposals
     ) ERC721_PackedHashSeed(_tokenName, _tokenSymbol) {
         _onlyNonZeroAddress(_renderProviderAddress);
         _onlyNonZeroAddress(_platformProviderAddress);
@@ -424,12 +422,8 @@ contract GenArt721CoreV3_Engine_Flex_PROHIBITION is
         // initialize next project ID
         _nextProjectId = _startingProjectId;
         emit PlatformUpdated(FIELD_NEXT_PROJECT_ID);
-        // register contract as an Engine contract
-        IEngineRegistryV0(_engineRegistryContract).registerContract(
-            address(this),
-            CORE_VERSION,
-            CORE_TYPE
-        );
+        // @dev follow-on action: This contract does not self-register. A core
+        // registry owner must register contract in a subsequent call.
     }
 
     /**

package/contracts/engine-registry/CoreRegistryV1.sol

@@ -1,10 +1,13 @@
 // SPDX-License-Identifier: MIT
 
+// @dev fixed to specific solidity version for clarity and for more clear
+// source code verification purposes.
 pragma solidity 0.8.19;
 
-import "../interfaces/v0.8.x/ICoreRegistryV1.sol";
-import "@openzeppelin-4.7/contracts/access/Ownable.sol";
-import "@openzeppelin-4.7/contracts/utils/structs/EnumerableSet.sol";
+import {ICoreRegistryV1} from "../interfaces/v0.8.x/ICoreRegistryV1.sol";
+
+import {Ownable} from "@openzeppelin-4.7/contracts/access/Ownable.sol";
+import {EnumerableSet} from "@openzeppelin-4.7/contracts/utils/structs/EnumerableSet.sol";
 
 /**
  * @title Art Blocks Core Contract Registry, V1.
@@ -57,20 +60,11 @@ contract CoreRegistryV1 is Ownable, ICoreRegistryV1 {
     using EnumerableSet for EnumerableSet.AddressSet;
 
     /// private enumerable set of registered contracts
-    EnumerableSet.AddressSet private registeredContracts;
+    EnumerableSet.AddressSet private _registeredContracts;
 
     /// private mapping of registered contract addresses to
     EnumerableSet.AddressSet
-        private registeredMinterFilterV2CompatibleContracts;
-
-    /**
-     * @notice Reverts if `tx.origin` is not the owner.
-     * @dev Warning that this check is only against tx.origin, which may be
-     * misleading when used for security.
-     */
-    function _onlyOwnerOrigin() internal view {
-        require(tx.origin == owner(), "Only tx origin of owner");
-    }
+        private _registeredMinterFilterV2CompatibleContracts;
 
     constructor() Ownable() {}
 
@@ -82,24 +76,19 @@ contract CoreRegistryV1 is Ownable, ICoreRegistryV1 {
      * registered.
      */
     function registerContract(
-        address _contractAddress,
-        bytes32 _coreVersion,
-        bytes32 _coreType
+        address contractAddress,
+        bytes32 coreVersion,
+        bytes32 coreType
     ) external {
         // CHECKS
-        // Validate against `tx.origin` rather than `msg.sender` as it is
-        // intended that this registration be performed in an automated
-        // fashion at the time of contract deployment of `_contractAddress`.
-        // @dev Security implications of using `tx.origin` are acknowledged
-        _onlyOwnerOrigin();
-        // only allow registration of a contract registering itself, or allow
-        // the owner to register any contract.
-        require(
-            msg.sender == _contractAddress || msg.sender == owner(),
-            "Only owner or registrant"
-        );
+        // revert if not called by owner
+        Ownable._checkOwner();
         // EFFECTS
-        _registerContract(_contractAddress, _coreVersion, _coreType);
+        _registerContract({
+            contractAddress: contractAddress,
+            coreVersion: coreVersion,
+            coreType: coreType
+        });
     }
 
     /**
@@ -108,12 +97,12 @@ contract CoreRegistryV1 is Ownable, ICoreRegistryV1 {
      * Reverts if authorization fails, or if the contract is not already
      * registered.
      */
-    function unregisterContract(address _contractAddress) external {
+    function unregisterContract(address contractAddress) external {
         // CHECKS
         // revert if not called by owner
         Ownable._checkOwner();
         // EFFECTS
-        _unregisterContract(_contractAddress);
+        _unregisterContract(contractAddress);
     }
 
     /**
@@ -122,32 +111,32 @@ contract CoreRegistryV1 is Ownable, ICoreRegistryV1 {
      * Reverts if any contract is already registered.
      * @dev This should primarily be used for backfilling the registry with
      * existing contracts shortly after deployment.
-     * @param _contractAddresses Array of contract addresses to register.
-     * @param _coreVersions Array of core versions for each contract (aligned).
-     * @param _coreTypes Array of core types for each contract (aligned).
+     * @param contractAddresses Array of contract addresses to register.
+     * @param coreVersions Array of core versions for each contract (aligned).
+     * @param coreTypes Array of core types for each contract (aligned).
      */
     function registerContracts(
-        address[] calldata _contractAddresses,
-        bytes32[] calldata _coreVersions,
-        bytes32[] calldata _coreTypes
+        address[] calldata contractAddresses,
+        bytes32[] calldata coreVersions,
+        bytes32[] calldata coreTypes
     ) external {
         // CHECKS
         // revert if not called by owner
         Ownable._checkOwner();
         // validate same length arrays
-        uint256 numContracts = _contractAddresses.length;
+        uint256 numContracts = contractAddresses.length;
         require(
-            numContracts == _coreVersions.length &&
-                numContracts == _coreTypes.length,
+            numContracts == coreVersions.length &&
+                numContracts == coreTypes.length,
             "Mismatched array lengths"
         );
         // EFFECTS
         for (uint256 i = 0; i < numContracts; ) {
-            _registerContract(
-                _contractAddresses[i],
-                _coreVersions[i],
-                _coreTypes[i]
-            );
+            _registerContract({
+                contractAddress: contractAddresses[i],
+                coreVersion: coreVersions[i],
+                coreType: coreTypes[i]
+            });
             unchecked {
                 ++i;
             }
@@ -158,18 +147,18 @@ contract CoreRegistryV1 is Ownable, ICoreRegistryV1 {
      * @notice Unregister multiple contracts at once.
      * Only callable by the owner.
      * Reverts if any contract is not already registered.
-     * @param _contractAddresses Array of contract addresses to unregister.
+     * @param contractAddresses Array of contract addresses to unregister.
      */
     function unregisterContracts(
-        address[] calldata _contractAddresses
+        address[] calldata contractAddresses
     ) external {
         // CHECKS
         // revert if not called by owner
         Ownable._checkOwner();
         // EFFECTS
-        uint256 numContracts = _contractAddresses.length;
+        uint256 numContracts = contractAddresses.length;
         for (uint256 i = 0; i < numContracts; ) {
-            _unregisterContract(_contractAddresses[i]);
+            _unregisterContract(contractAddresses[i]);
             unchecked {
                 ++i;
             }
@@ -181,18 +170,18 @@ contract CoreRegistryV1 is Ownable, ICoreRegistryV1 {
      * @return The number of registered contracts.
      */
     function getNumRegisteredContracts() external view returns (uint256) {
-        return registeredContracts.length();
+        return _registeredContracts.length();
     }
 
     /**
      * @notice Get the address of a registered contract by index.
-     * @param _index The index of the contract to get.
+     * @param index The index of the contract to get.
      * @return The address of the contract at the given index.
      */
     function getRegisteredContractAt(
-        uint256 _index
+        uint256 index
     ) external view returns (address) {
-        return registeredContracts.at(_index);
+        return _registeredContracts.at(index);
     }
 
     /**
@@ -207,19 +196,19 @@ contract CoreRegistryV1 is Ownable, ICoreRegistryV1 {
         view
         returns (address[] memory)
     {
-        return registeredContracts.values();
+        return _registeredContracts.values();
     }
 
     /**
      * @notice Returns boolean representing if contract is registered on this
      * registry.
-     * @param _contractAddress The address of the contract to check.
+     * @param contractAddress The address of the contract to check.
      * @return isRegistered True if the contract is registered.
      */
     function isRegisteredContract(
-        address _contractAddress
+        address contractAddress
     ) external view returns (bool isRegistered) {
-        return registeredContracts.contains(_contractAddress);
+        return _registeredContracts.contains(contractAddress);
     }
 
     /**
@@ -227,28 +216,32 @@ contract CoreRegistryV1 is Ownable, ICoreRegistryV1 {
      * Reverts if the contract is already registered.
      */
     function _registerContract(
-        address _contractAddress,
-        bytes32 _coreVersion,
-        bytes32 _coreType
+        address contractAddress,
+        bytes32 coreVersion,
+        bytes32 coreType
     ) internal {
         // @dev add returns true only if not already registered
         require(
-            registeredContracts.add(_contractAddress),
+            _registeredContracts.add(contractAddress),
             "Contract already registered"
         );
-        emit ContractRegistered(_contractAddress, _coreVersion, _coreType);
+        emit ContractRegistered({
+            _contractAddress: contractAddress,
+            _coreVersion: coreVersion,
+            _coreType: coreType
+        });
     }
 
     /**
      * @notice Internal function to unregister a contract.
      * Reverts if the contract is not already registered.
      */
-    function _unregisterContract(address _contractAddress) internal {
+    function _unregisterContract(address contractAddress) internal {
         // @dev remove returns true only if already in set
         require(
-            registeredContracts.remove(_contractAddress),
+            _registeredContracts.remove(contractAddress),
             "Only registered contracts"
         );
-        emit ContractUnregistered(_contractAddress);
+        emit ContractUnregistered({_contractAddress: contractAddress});
     }
 }