instantiation to return version and name

Author: peersky

.changeset/beige-sloths-learn.md

@@ -0,0 +1,5 @@
+---
+"@peeramid-labs/eds": minor
+---
+
+instantiation now returns version and name

src/abstracts/CloneDistribution.sol

@@ -10,15 +10,15 @@ abstract contract CloneDistribution is IDistribution, CodeIndexer {
 
     function sources() internal view virtual returns (address[] memory, bytes32 name, uint256 version);
 
-    function instantiate() public virtual returns (address[] memory instances) {
-        (address[] memory _sources,,) = sources();
+    function instantiate() public virtual returns (address[] memory instances, bytes32 distributionName, uint256 distributionVersion) {
+        (address[] memory _sources,bytes32 _distributionName,uint256 _distributionVersion) = sources();
         instances = new address[](_sources.length);
         for (uint256 i = 0; i < _sources.length; i++) {
             address clone = Clones.clone(_sources[i]);
             instances[i] = clone;
         }
         emit Distributed(msg.sender, instances);
-        return instances;
+        return (instances, _distributionName, _distributionVersion);
     }
 
     function get() public view virtual returns (address[] memory src, bytes32 name, uint256 version) {

src/abstracts/Distributor.sol

@@ -39,10 +39,10 @@ abstract contract Distributor is IDistributor, CodeIndexer {
         emit DistributionRemoved(id);
     }
 
-    function _instantiate(bytes32 id, bytes calldata args) internal virtual returns (address[] memory instances) {
+    function _instantiate(bytes32 id, bytes calldata args) internal virtual returns (address[] memory instances, bytes32 distributionName, uint256 distributionVersion) {
         ICodeIndex codeIndex = getContractsIndex();
         if (!distirbutionsSet.contains(id)) revert DistributionNotFound(id);
-        instances = IDistribution(codeIndex.get(id)).instantiate();
+        (instances, distributionName, distributionVersion) = IDistribution(codeIndex.get(id)).instantiate();
         bytes4 selector = IInitializer.initialize.selector;
         // This ensures instance owner (distributor) performs initialization.
         // It is distirbutor responsibility to make sure calldata and initializer are safe to execute
@@ -54,7 +54,7 @@ abstract contract Distributor is IDistributor, CodeIndexer {
             require(success, string(result));
         }
         emit Instantiated(id, args);
-        return instances;
+        return (instances, distributionName, distributionVersion);
     }
 
     function beforeCall(

src/abstracts/Installer.sol

@@ -40,7 +40,7 @@ abstract contract Installer is IInstaller {
         if (!isDistributor(distributor)) {
             revert InvalidDistributor(distributor);
         }
-        address[] memory installation = distributor.instantiate(distributionId, args);
+        (address[] memory installation,,) = distributor.instantiate(distributionId, args);
         instancesNum++;
         _instanceEnum[instancesNum] = installation;
         for (uint i = 0; i < installation.length; i++) {

src/abstracts/VersionDistributor.sol

@@ -51,30 +51,37 @@ abstract contract VersionDistributor is IVersionDistributor, CodeIndexer {
         if (oldRequirement != requirement) emit RequirementChanged(repository, oldRequirement, requirement);
     }
 
-    function _instantiate(IRepository repository, bytes calldata args) internal returns (address[] memory) {
+    function _instantiate(
+        IRepository repository,
+        bytes calldata args
+    ) internal returns (address[] memory, bytes32, uint256) {
         if (!_repositories.contains(address(repository))) {
             revert InvalidRepository(repository);
         }
         IRepository.Source memory src = repository.get(
             versions[address(repository)],
             requirements[address(repository)]
         );
-        address source = getContractsIndex().get(src.sourceId);
-        address[] memory instances = IDistribution(source).instantiate();
+
+        (address[] memory instances, bytes32 _distributionName, uint256 _distributionVersion) = IDistribution(
+            getContractsIndex().get(src.sourceId)
+        ).instantiate();
         bytes4 selector = IInitializer.initialize.selector;
+
         address initializer = address(initializers[address(repository)]);
         if (initializer != address(0)) {
             (bool success, bytes memory result) = initializer.delegatecall(
                 abi.encodeWithSelector(selector, instances, args)
             );
             require(success, string(result));
         }
+
         for (uint256 i = 0; i < instances.length; i++) {
             instancesDistribution[instances[i]] = address(repository);
             instancesVersions[instances[i]] = src.version;
         }
         emit Instantiated(address(repository), args);
-        return instances;
+        return (instances, _distributionName, _distributionVersion);
     }
 
     function getVersionedDistributions() public view returns (address[] memory repositories) {

src/distributors/OwnableDistributor.sol

@@ -11,7 +11,7 @@ import "../abstracts/Distributor.sol";
 contract OwnableDistributor is Distributor, Ownable {
     constructor(address _owner) Ownable(_owner) {}
 
-    function instantiate(bytes32 id, bytes calldata args) public returns (address[] memory) {
+    function instantiate(bytes32 id, bytes calldata args) public returns (address[] memory, bytes32, uint256 ) {
         return super._instantiate(id, args);
     }
 

src/distributors/OwnableVersionDistributor.sol

@@ -11,7 +11,7 @@ import "../abstracts/VersionDistributor.sol";
 contract OwnableVersionDistributor is VersionDistributor, Ownable {
     constructor(address _owner) Ownable(_owner) {}
 
-    function instantiate(IRepository repository, bytes calldata args) public returns (address[] memory) {
+    function instantiate(IRepository repository, bytes calldata args) public returns (address[] memory, bytes32, uint256) {
         return super._instantiate(repository, args);
     }
 

src/interfaces/IDistribution.sol

@@ -4,7 +4,7 @@ pragma solidity =0.8.20;
 interface IDistribution {
     event Distributed(address indexed distributor, address[] instances);
 
-    function instantiate() external returns (address[] memory instances);
+    function instantiate() external returns (address[] memory instances, bytes32 distributionName, uint256 distributionVersion);
 
     function get() external view returns (address[] memory sources, bytes32 distributionName, uint256 distributionVersion);
 

src/interfaces/IDistributor.sol

@@ -18,7 +18,7 @@ interface IDistributor is ILayer {
 
     function getDistributionURI(bytes32 id) external view returns (string memory);
 
-    function instantiate(bytes32 id, bytes calldata args) external returns (address[] memory);
+    function instantiate(bytes32 id, bytes calldata args) external returns (address[] memory, bytes32 distributionName, uint256 distributionVersion);
 
     function addDistribution(bytes32 id, bytes32 initializer) external;
 

src/interfaces/IVersionDistributor.sol

@@ -39,6 +39,6 @@ interface IVersionDistributor is ILayer {
 
     function getVersionedDistributions() external view returns (address[] memory repositories);
     function getVersionedDistributionURI(IRepository repository) external view returns (string memory);
-    function instantiate(IRepository repository, bytes calldata args) external returns (address[] memory);
+    function instantiate(IRepository repository, bytes calldata args) external returns (address[] memory, bytes32, uint256);
     function removeVersionedDistribution(IRepository repository) external;
 }