SSTORE2-compatible dependency registry (for scripts)

packages/contracts/contracts/DependencyRegistryV0.sol

@@ -149,7 +149,7 @@ contract DependencyRegistryV0 is
 
     /**
      * @notice Removes a dependency.
-     * @param _dependencyType Name of dependency type (i.e. "type@version")
+     * @param _dependencyType Name of dependency type (i.e. "type@version") used to identify dependency.
      */
     function removeDependency(bytes32 _dependencyType) external {
         _onlyAdminACL(this.removeDependency.selector);
@@ -169,8 +169,9 @@ contract DependencyRegistryV0 is
     }
 
     /**
-     * @notice Adds a script to dependency `_dependencyType`.
-     * @param _dependencyType dependency to be updated.
+     * @notice Adds a script to dependency `_dependencyType`, by way of
+     *         providing a string to write to bytecode storage.
+     * @param _dependencyType Name of dependency type (i.e. "type@version") used to identify dependency.
      * @param _script Script to be added. Required to be a non-empty string,
      * but no further validation is performed.
      */
@@ -191,11 +192,12 @@ contract DependencyRegistryV0 is
     }
 
     /**
-     * @notice Updates script for dependencyType `_dependencyType` at script ID `_scriptId`.
-     * @param _dependencyType dependency to be updated.
+     * @notice Updates script for dependencyType `_dependencyType` at script ID `_scriptId`,
+     *         by way of providing a string to write to bytecode storage.
+     * @param _dependencyType Name of dependency type (i.e. "type@version") used to identify dependency.
      * @param _scriptId Script ID to be updated.
      * @param _script The updated script value. Required to be a non-empty
-     * string, but no further validation is performed.
+     *                string, but no further validation is performed.
      */
     function updateDependencyScript(
         bytes32 _dependencyType,
@@ -215,9 +217,56 @@ contract DependencyRegistryV0 is
         emit DependencyScriptUpdated(_dependencyType);
     }
 
+    /**
+     * @notice Adds a script to dependency `_dependencyType`, by way of
+     *         providing an already written chunk of bytecode storage.
+     * @param _dependencyType Name of dependency type (i.e. "type@version") used to identify dependency.
+     * @param _scriptPointer Address of script to be added. Required to be a non-zero address,
+     *                       but no further validation is performed.
+     */
+    function addDependencyScriptPointer(
+        bytes32 _dependencyType,
+        address _scriptPointer
+    ) external {
+        _onlyAdminACL(this.addDependencyScriptPointer.selector);
+        _onlyNonZeroAddress(_scriptPointer);
+        _onlyExistingDependencyType(_dependencyType);
+        Dependency storage dependency = dependencyDetails[_dependencyType];
+        // store script in contract bytecode
+        dependency.scriptBytecodeAddresses[
+            dependency.scriptCount
+        ] = _scriptPointer;
+        dependency.scriptCount = dependency.scriptCount + 1;
+
+        emit DependencyScriptUpdated(_dependencyType);
+    }
+
+    /**
+     * @notice Updates script for dependencyType `_dependencyType` at script ID `_scriptId`,
+     *         by way of providing an already written chunk of bytecode storage.
+     * @param _dependencyType Name of dependency type (i.e. "type@version") used to identify dependency.
+     * @param _scriptId Script ID to be updated.
+     * @param _scriptPointer The updated script pointer (address of bytecode storage).
+     *                Required to be a non-zero address, but no further validation is performed.
+     */
+    function updateDependencyScriptPointer(
+        bytes32 _dependencyType,
+        uint256 _scriptId,
+        address _scriptPointer
+    ) external {
+        _onlyAdminACL(this.updateDependencyScriptPointer.selector);
+        _onlyNonZeroAddress(_scriptPointer);
+        _onlyExistingDependencyType(_dependencyType);
+        Dependency storage dependency = dependencyDetails[_dependencyType];
+        require(_scriptId < dependency.scriptCount, "scriptId out of range");
+        dependency.scriptBytecodeAddresses[_scriptId] = _scriptPointer;
+
+        emit DependencyScriptUpdated(_dependencyType);
+    }
+
     /**
      * @notice Removes last script from dependency `_dependencyType`.
-     * @param _dependencyType dependency to be updated.
+     * @param _dependencyType Name of dependency type (i.e. "type@version") used to identify dependency.
      */
     function removeDependencyLastScript(bytes32 _dependencyType) external {
         _onlyAdminACL(this.removeDependencyLastScript.selector);
@@ -235,7 +284,7 @@ contract DependencyRegistryV0 is
 
     /**
      * @notice Updates preferred CDN for dependency `_dependencyType`.
-     * @param _dependencyType dependency to be updated.
+     * @param _dependencyType Name of dependency type (i.e. "type@version") used to identify dependency.
      * @param _preferredCDN URL for preferred CDN.
      */
     function updateDependencyPreferredCDN(
@@ -251,7 +300,7 @@ contract DependencyRegistryV0 is
 
     /**
      * @notice Updates preferred repository for dependency `_dependencyType`.
-     * @param _dependencyType dependency to be updated.
+     * @param _dependencyType Name of dependency type (i.e. "type@version") used to identify dependency.
      * @param _preferredRepository URL for preferred repository.
      */
     function updateDependencyPreferredRepository(
@@ -271,7 +320,7 @@ contract DependencyRegistryV0 is
 
     /**
      * @notice Updates project website for dependency `_dependencyType`.
-     * @param _dependencyType dependency to be updated.
+     * @param _dependencyType Name of dependency type (i.e. "type@version") used to identify dependency.
      * @param _referenceWebsite URL for project website.
      */
     function updateDependencyReferenceWebsite(
@@ -290,7 +339,7 @@ contract DependencyRegistryV0 is
 
     /**
      * @notice Adds a new CDN url to `_dependencyType`.
-     * @param _dependencyType dependency to be updated.
+     * @param _dependencyType Name of dependency type (i.e. "type@version") used to identify dependency.
      * @param _additionalCDN CDN URL to be added. Required to be a non-empty string,
      * but no further validation is performed.
      */
@@ -318,7 +367,7 @@ contract DependencyRegistryV0 is
      * @notice Removes additional CDN for dependency `_dependencyId` at index `_index`.
      * Removal is done by swapping the element to be removed with the last element in the array, then deleting this last element.
      * Assets with indices higher than `_index` can have their indices adjusted as a result of this operation.
-     * @param _dependencyType dependency to be updated.
+     * @param _dependencyType Name of dependency type (i.e. "type@version") used to identify dependency.
      * @param _index Additional CDN index
      */
     function removeDependencyAdditionalCDNAtIndex(
@@ -346,7 +395,7 @@ contract DependencyRegistryV0 is
 
     /**
      * @notice Updates additional CDN for dependency `_dependencyType` at `_index`.
-     * @param _dependencyType dependency to be updated.
+     * @param _dependencyType Name of dependency type (i.e. "type@version") used to identify dependency.
      * @param _index Additional CDN index.
      * @param _additionalCDN New CDN URL.
      */
@@ -373,7 +422,7 @@ contract DependencyRegistryV0 is
 
     /**
      * @notice Adds a new repository URL to dependency `_dependencyType`.
-     * @param _dependencyType dependency to be updated.
+     * @param _dependencyType Name of dependency type (i.e. "type@version") used to identify dependency.
      * @param _additionalRepository Repository URL to be added. Required to be a non-empty string,
      * but no further validation is performed.
      */
@@ -406,7 +455,7 @@ contract DependencyRegistryV0 is
      * @notice Removes additional repository for depenency `_dependencyId` at index `_index`.
      * Removal is done by swapping the element to be removed with the last element in the array, then deleting this last element.
      * Assets with indices higher than `_index` can have their indices adjusted as a result of this operation.
-     * @param _dependencyType dependency to be updated.
+     * @param _dependencyType Name of dependency type (i.e. "type@version") used to identify dependency.
      * @param _index Additional repository index.
      */
     function removeDependencyAdditionalRepositoryAtIndex(
@@ -437,7 +486,7 @@ contract DependencyRegistryV0 is
 
     /**
      * @notice Updates additional repository for dependency `_dependencyType` at `_index`.
-     * @param _dependencyType dependency to be updated.
+     * @param _dependencyType Name of dependency type (i.e. "type@version") used to identify dependency.
      * @param _index Additional repository index.
      * @param _additionalRepository New Repository URL.
      */
@@ -500,7 +549,7 @@ contract DependencyRegistryV0 is
      * type (`_dependencyType`).
      * @param _contractAddress Core contract address.
      * @param _projectId Project to override script type and version for.
-     * @param _dependencyType Dependency type to return for project.
+     * @param _dependencyType Name of dependency type (i.e. "type@version") used to identify dependency.
      */
     function addProjectDependencyTypeOverride(
         address _contractAddress,
@@ -581,8 +630,8 @@ contract DependencyRegistryV0 is
     }
 
     /**
-     * @notice Returns details for depedency type `_dependencyType`.
-     * @param _dependencyType Dependency type to be queried.
+     * @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 preferredCDN Preferred CDN URL for dependency
@@ -682,7 +731,7 @@ contract DependencyRegistryV0 is
 
     /**
      * @notice Returns the additional CDN URL at index `_index` for dependency `_dependencyType`.
-     * @param _dependencyType Dependency type to be queried.
+     * @param _dependencyType Name of dependency type (i.e. "type@version") used to identify dependency.
      * @param _index Index of the additional CDN URL to be returned.
      */
     function getDependencyAdditionalCDNAtIndex(
@@ -694,7 +743,7 @@ contract DependencyRegistryV0 is
 
     /**
      * @notice Returns the additional repository URL at index `_index` for dependency `_dependencyType`.
-     * @param _dependencyType Dependency type to be queried.
+     * @param _dependencyType Name of dependency type (i.e. "type@version") used to identify dependency.
      * @param _index Index of the additional repository URL to be returned.
      */
     function getDependencyAdditionalRepositoryAtIndex(
@@ -707,7 +756,7 @@ contract DependencyRegistryV0 is
 
     /**
      * @notice Returns the count of scripts for dependency `_dependencyType`.
-     * @param _dependencyType Dependency type to be queried.
+     * @param _dependencyType Name of dependency type (i.e. "type@version") used to identify dependency.
      */
     function getDependencyScriptCount(
         bytes32 _dependencyType
@@ -717,7 +766,7 @@ contract DependencyRegistryV0 is
 
     /**
      * @notice Returns address with bytecode containing script for
-     * dependency `_dependencyTypes` at script index `_index`.
+     *         dependency `_dependencyTypes` at script index `_index`.
      */
     function getDependencyScriptBytecodeAddressAtIndex(
         bytes32 _dependencyType,
@@ -727,10 +776,40 @@ contract DependencyRegistryV0 is
             dependencyDetails[_dependencyType].scriptBytecodeAddresses[_index];
     }
 
+    /**
+     * @notice Returns the storage library version for
+     *         dependency `_dependencyTypes` at script index `_index`.
+     * @param _dependencyType Name of dependency type (i.e. "type@version") used to identify dependency.
+     * @param _index Index of script to be queried in the array of dependency script chunks.
+     * @return The storage library version for the script at the given index, if it can be determined.
+     * @dev Note that we only expect this to be determinable if the script was written using a version
+     *      of the Art Blocks `BytecodeStorage` library, and in other cases the fallback will be the
+     *      unknown version string, as defined by the `BytecodeStorage` UNKNOWN_VERSION_STRING – this
+     *      is inclusive of the in the case of `SSTORE2` written data blobs, which are an unknown version
+     *      that can be fallback-read optimistically.
+     */
+    function getDependencyScriptBytecodeStorageVersionAtIndex(
+        bytes32 _dependencyType,
+        uint256 _index
+    ) external view returns (bytes32) {
+        return
+            BytecodeStorageReader.getLibraryVersionForBytecode(
+                dependencyDetails[_dependencyType].scriptBytecodeAddresses[
+                    _index
+                ]
+            );
+    }
+
     /**
      * @notice Returns script for dependency `_dependencyType` at script index `_index`.
-     * @param _dependencyType dependency to be queried.
+     * @param _dependencyType Name of dependency type (i.e. "type@version") used to identify dependency.
      * @param _index Index of script to be queried.
+     * @return A string containing the script content at the given script chunk index for a given dependency.
+     * @dev This method attempts to introspectively determine which library version of
+     *      `BytecodeStorage` was used to write the stored script string that is being
+     *      read back, in order to use the proper read approach. If the version is
+     *      non-determinate, a fall-back to reading using the assumption that the bytes
+     *      were written with `SSTORE2` is used.
      */
     function getDependencyScriptAtIndex(
         bytes32 _dependencyType,
@@ -742,7 +821,20 @@ contract DependencyRegistryV0 is
             return "";
         }
 
-        return _readFromBytecode(dependency.scriptBytecodeAddresses[_index]);
+        address scriptAddress = dependency.scriptBytecodeAddresses[_index];
+        bytes32 storageVersion = BytecodeStorageReader
+            .getLibraryVersionForBytecode(scriptAddress);
+
+        if (storageVersion == BytecodeStorageReader.UNKNOWN_VERSION_STRING) {
+            return
+                string(
+                    BytecodeStorageReader.readBytesFromSSTORE2Bytecode(
+                        scriptAddress
+                    )
+                );
+        } else {
+            return BytecodeStorageReader.readFromBytecode(scriptAddress);
+        }
     }
 
     /**
@@ -753,7 +845,7 @@ contract DependencyRegistryV0 is
      * an override set, this will revert.
      * @param _contractAddress Core contract address.
      * @param _projectId Project to return dependency type for.
-     * @return dependencyType Dependency type used by project.
+     * @return dependencyType Identifier for the dependency (i.e. "type@version") used by project.
      */
     function getDependencyTypeForProject(
         address _contractAddress,
@@ -836,14 +928,4 @@ contract DependencyRegistryV0 is
         OwnableUpgradeable._transferOwnership(newOwner);
         adminACLContract = IAdminACLV0(newOwner);
     }
-
-    /**
-     * Helper for calling `BytecodeStorageReader` external library reader method,
-     * added for bytecode size reduction purposes.
-     */
-    function _readFromBytecode(
-        address _address
-    ) internal view returns (string memory) {
-        return BytecodeStorageReader.readFromBytecode(_address);
-    }
 }