renamed getSources to get, added contract version and name to the return parameters

Author: peersky

.changeset/eleven-falcons-study.md

@@ -0,0 +1,5 @@
+---
+"@peeramid-labs/eds": minor
+---
+
+renamed getSources to get, added contract version and name to the return parameters

src/abstracts/CloneDistribution.sol

@@ -6,10 +6,12 @@ import "../interfaces/IDistribution.sol";
 import "./CodeIndexer.sol";
 
 abstract contract CloneDistribution is IDistribution, CodeIndexer {
-    function sources() internal view virtual returns (address[] memory);
+
+
+    function sources() internal view virtual returns (address[] memory, bytes32 name, uint256 version);
 
     function instantiate() public virtual returns (address[] memory instances) {
-        address[] memory _sources = sources();
+        (address[] memory _sources,,) = sources();
         instances = new address[](_sources.length);
         for (uint256 i = 0; i < _sources.length; i++) {
             address clone = Clones.clone(_sources[i]);
@@ -19,7 +21,7 @@ abstract contract CloneDistribution is IDistribution, CodeIndexer {
         return instances;
     }
 
-    function getSources() public view virtual returns (address[] memory) {
+    function get() public view virtual returns (address[] memory src, bytes32 name, uint256 version) {
         return sources();
     }
 

src/abstracts/Repository.sol

@@ -5,6 +5,8 @@ import "../libraries/LibSemver.sol";
 import "../interfaces/IRepository.sol";
 
 abstract contract Repository is IRepository {
+
+    bytes32 immutable public repositoryName;
     struct Uint64WithMetadata {
         uint64 value;
         bytes metadata;
@@ -24,6 +26,9 @@ abstract contract Repository is IRepository {
     uint64 internal majorReleases;
     uint256 internal latestVersion;
 
+    constructor(bytes32 _repositoryName) {
+        repositoryName = _repositoryName;
+    }
     // error VersionHashDoesNotExist(uint256 version);
     // error ReleaseZeroNotAllowed();
     // error AlreadyInPreviousRelease(uint256 version, bytes32 source);

src/distributions/CodeHashDistribution.sol

@@ -6,8 +6,12 @@ import "../abstracts/CloneDistribution.sol";
 contract CodeHashDistribution is CloneDistribution {
     bytes32 immutable metadata;
     address immutable _reference;
+    bytes32 immutable public distributionName;
+    uint256 immutable  public distributionVersion;
 
-    constructor(bytes32 codeHash, bytes32 _metadata) {
+    constructor(bytes32 codeHash, bytes32 _metadata, bytes32 name, uint256 version) {
+        distributionName = name;
+        distributionVersion = version;
         metadata = _metadata;
         ICodeIndex index = getContractsIndex();
         _reference = index.get(codeHash);
@@ -16,10 +20,10 @@ contract CodeHashDistribution is CloneDistribution {
         }
     }
 
-    function sources() internal view virtual override returns (address[] memory) {
+    function sources() internal view virtual override returns (address[] memory, bytes32 name, uint256 version) {
         address[] memory _sources = new address[](1);
         _sources[0] = _reference;
-        return _sources;
+        return (_sources, distributionName, distributionVersion);
     }
 
     function getMetadata() public view virtual override returns (string memory) {

src/distributions/LatestVersionDistribution.sol

@@ -3,6 +3,7 @@ pragma solidity =0.8.20;
 
 import "../abstracts/CloneDistribution.sol";
 import "../interfaces/IRepository.sol";
+import "../libraries/LibSemver.sol";
 
 contract LatestVersionDistribution is CloneDistribution {
     bytes32 immutable metadata;
@@ -13,11 +14,11 @@ contract LatestVersionDistribution is CloneDistribution {
         repository = _repository;
     }
 
-    function sources() internal view virtual override returns (address[] memory) {
+    function sources() internal view virtual override returns (address[] memory srcs, bytes32 name, uint256 version) {
         address[] memory _sources = new address[](1);
-
-        _sources[0] = getContractsIndex().get(repository.getLatest().sourceId);
-        return _sources;
+        IRepository.Source memory latest = repository.getLatest();
+        _sources[0] = getContractsIndex().get(latest.sourceId);
+        return (_sources, repository.repositoryName(),LibSemver.toUint256(latest.version));
     }
 
     function getMetadata() public view virtual override returns (string memory) {

src/interfaces/IDistribution.sol

@@ -6,7 +6,7 @@ interface IDistribution {
 
     function instantiate() external returns (address[] memory instances);
 
-    function getSources() external view returns (address[] memory);
+    function get() external view returns (address[] memory sources, bytes32 distributionName, uint256 distributionVersion);
 
     function getMetadata() external view returns (string memory);
 }

src/interfaces/IInitializer.sol

@@ -5,5 +5,5 @@ interface IInitializer {
     event Initialized(address indexed container, bytes32 indexed codeHash);
     error initializationFailed(bytes32 id, string reason);
 
-    function initialize(bytes32 id, address[] memory instances, bytes calldata args) external;
+    function initialize(bytes32 distributionId, address[] memory instances, string memory distributionName, string memory distributionVersion, bytes calldata args) external;
 }

src/interfaces/IRepository.sol

@@ -20,6 +20,7 @@ interface IRepository is IERC165 {
     event ReleaseMetadataUpdated(uint256 indexed version, bytes releaseMetadata);
 
     function updateReleaseMetadata(LibSemver.Version memory version, bytes calldata releaseMetadata) external;
+    function repositoryName() external view returns (bytes32);
     function newRelease(bytes32 sourceId, bytes memory metadata, LibSemver.Version memory version) external;
     function getLatest() external view returns (Source memory);
     function get(

src/mocks/MockCloneDistribution.sol

@@ -8,9 +8,9 @@ contract MockCloneDistribution is CloneDistribution {
         return "MockCloneDistribution";
     }
 
-    function sources() internal view override returns (address[] memory) {
+    function sources() internal view override returns (address[] memory, bytes32, uint256) {
         address[] memory source = new address[](1);
         source[0] = address(this);
-        return source;
+        return (source, bytes32(abi.encodePacked("MockCloneDistribution")), 1);
     }
 }

src/repositories/OwnableRepository.sol

@@ -5,7 +5,7 @@ import "../abstracts/Repository.sol";
 import "@openzeppelin/contracts/utils/introspection/ERC165.sol";
 import "../interfaces/IRepository.sol";
 contract OwnableRepository is Repository, Ownable, ERC165 {
-    constructor(address owner) Ownable(owner) {}
+    constructor(address owner, bytes32 name) Ownable(owner) Repository(name) {}
 
     function updateReleaseMetadata(LibSemver.Version memory version, bytes calldata releaseMetadata) public onlyOwner {
         super._updateReleaseMetadata(version, releaseMetadata);

test/eds/CloneDistribution.ts

@@ -1,26 +1,39 @@
-import { ethers } from 'hardhat';
-import { Signer } from 'ethers';
-import { expect } from 'chai';
+import { ethers } from "hardhat";
+import { Signer } from "ethers";
+import { expect } from "chai";
 
-describe('CloneDistribution', function () {
+describe("CloneDistribution", function () {
   let cloneDistribution: any;
   let owner: Signer;
   let addr1: Signer;
   let addr2: Signer;
 
   beforeEach(async function () {
-    const CloneDistribution = await ethers.getContractFactory('MockCloneDistribution');
+    const CloneDistribution = await ethers.getContractFactory(
+      "MockCloneDistribution"
+    );
     [owner, addr1, addr2] = await ethers.getSigners();
     cloneDistribution = await CloneDistribution.deploy();
     await cloneDistribution.deployed();
   });
 
-  it('should emit Distributed event', async function () {
-    expect(await cloneDistribution.instantiate()).to.emit(cloneDistribution, 'Distributed');
+  it("should emit Distributed event", async function () {
+    expect(await cloneDistribution.instantiate()).to.emit(
+      cloneDistribution,
+      "Distributed"
+    );
   });
 
-  it('Should read metadata', async function () {
+  it("Should read metadata", async function () {
     const metadata = await cloneDistribution.getMetadata();
-    expect(metadata).to.equal('MockCloneDistribution');
+    expect(metadata).to.equal("MockCloneDistribution");
+  });
+
+  it("returns contract name and version", async function () {
+    const { name, version } = await cloneDistribution.get();
+    expect(ethers.utils.parseBytes32String(name)).to.be.equal(
+      "MockCloneDistribution"
+    );
+    expect(version).to.be.equal(1);
   });
 });

test/eds/CodeHashDistribution.ts

@@ -1,12 +1,11 @@
 import { ethers } from "hardhat";
-import { Signer } from "ethers";
 import { expect } from "chai";
 import {
   CodeHashDistribution,
   CodeHashDistribution__factory,
   CodeIndex,
 } from "../../types";
-import hre, { deployments } from "hardhat";
+import { deployments } from "hardhat";
 import { SignerWithAddress } from "@nomiclabs/hardhat-ethers/signers";
 import utils from "../utils";
 
@@ -36,7 +35,9 @@ describe("CloneHashDistribution", function () {
     const codeHash = ethers.utils.keccak256(code);
     const codeHashDistribution = (await CodeHashDistribution.deploy(
       codeHash,
-      ethers.utils.formatBytes32String("DiamondProxy")
+      ethers.utils.formatBytes32String("DiamondProxy"),
+      ethers.utils.formatBytes32String("testDistribution"),
+      0
     )) as CodeHashDistribution;
     expect(await codeHashDistribution.instantiate()).to.emit(
       codeHashDistribution,
@@ -54,7 +55,9 @@ describe("CloneHashDistribution", function () {
     const codeHash = ethers.utils.keccak256(code);
     const codeHashDistribution = (await CodeHashDistribution.deploy(
       codeHash,
-      ethers.utils.formatBytes32String("DiamondProxy")
+      ethers.utils.formatBytes32String("DiamondProxy"),
+      ethers.utils.formatBytes32String("testDistribution"),
+      0
     )) as CodeHashDistribution;
     const receipt = await (await codeHashDistribution.instantiate()).wait();
 
@@ -70,4 +73,26 @@ describe("CloneHashDistribution", function () {
       testFacet.address.slice(2).toLowerCase()
     );
   });
+  it("returns contract name and version", async function () {
+    const TestFacet = await ethers.getContractFactory("TestFacet");
+    const testFacet = await TestFacet.deploy();
+    codeIndex.register(testFacet.address);
+    const CodeHashDistribution = (await ethers.getContractFactory(
+      "CodeHashDistribution"
+    )) as CodeHashDistribution__factory;
+    const code = await testFacet.provider.getCode(testFacet.address);
+    const codeHash = ethers.utils.keccak256(code);
+    const codeHashDistribution = (await CodeHashDistribution.deploy(
+      codeHash,
+      ethers.utils.formatBytes32String("DiamondProxy"),
+      ethers.utils.formatBytes32String("testDistribution"),
+      0
+    )) as CodeHashDistribution;
+
+    const { src, name, version } = await codeHashDistribution.get();
+    expect(ethers.utils.parseBytes32String(name)).to.be.equal(
+      "testDistribution"
+    );
+    expect(version).to.be.equal(0);
+  });
 });

test/eds/CodeIndex.ts

@@ -1,5 +1,4 @@
 import { ethers } from "hardhat";
-import { Signer } from "ethers";
 import { expect } from "chai";
 import { CodeIndex, TestFacet } from "../../types";
 import hre, { deployments } from "hardhat";

test/eds/Distributor.ts

@@ -1,18 +1,11 @@
 import { ethers } from "hardhat";
-import { Signer } from "ethers";
 import { expect } from "chai";
 import {
-  CodeHashDistribution,
-  CodeHashDistribution__factory,
-  CodeIndex,
-  Distributor,
-  Distributor__factory,
-  MockCloneDistribution__factory,
-  OwnableDistributor__factory,
-  TestFacet,
-  TestFacet__factory,
+    CodeIndex,
+    Distributor, MockCloneDistribution__factory,
+    OwnableDistributor__factory, TestFacet__factory
 } from "../../types";
-import hre, { deployments } from "hardhat";
+import { deployments } from "hardhat";
 import { SignerWithAddress } from "@nomiclabs/hardhat-ethers/signers";
 import utils from "../utils";
 

test/eds/Installer.ts

@@ -1,23 +1,15 @@
 import { ethers } from "hardhat";
-import { Signer } from "ethers";
 import { expect } from "chai";
 import {
-  CodeHashDistribution,
-  CodeHashDistribution__factory,
-  CodeIndex,
-  Distributor,
-  Distributor__factory,
-  MockCloneDistribution,
-  MockCloneDistribution__factory,
-  MockInstaller,
-  MockInstaller__factory,
-  OwnableDistributor__factory,
-  TestFacet,
-  TestFacet__factory,
+    CodeIndex,
+    Distributor, MockCloneDistribution,
+    MockCloneDistribution__factory,
+    MockInstaller,
+    MockInstaller__factory,
+    OwnableDistributor__factory
 } from "../../types";
-import hre, { deployments } from "hardhat";
+import { deployments } from "hardhat";
 import { SignerWithAddress } from "@nomiclabs/hardhat-ethers/signers";
-import utils from "../utils";
 
 describe("Installer", function () {
   let codeIndex: CodeIndex;
@@ -118,7 +110,7 @@ describe("Installer", function () {
       "MockCloneDistribution",
       instanceAddress
     )) as MockCloneDistribution;
-    const src = await instance.getSources();
+    const { src } = await instance.get();
     expect(src[0]).to.be.equal(instance.address);
   });
 

test/eds/Repository.ts

@@ -48,7 +48,10 @@ describe("Installer", function () {
     const Repository = (await ethers.getContractFactory(
       "OwnableRepository"
     )) as OwnableRepository__factory;
-    repository = await Repository.deploy(owner.address);
+    repository = await Repository.deploy(
+      owner.address,
+      ethers.utils.formatBytes32String("testRepository")
+    );
     const repositoryCode = await repository.provider.getCode(
       repository.address
     );

test/eds/VersionDistributor.ts

@@ -42,7 +42,10 @@ describe("Version Distributor", function () {
     const Repository = (await ethers.getContractFactory(
       "OwnableRepository"
     )) as OwnableRepository__factory;
-    repository = await Repository.deploy(owner.address);
+    repository = await Repository.deploy(
+      owner.address,
+      ethers.utils.formatBytes32String("testRepository")
+    );
     const repositoryCode = await repository.provider.getCode(
       repository.address
     );