added named distributions (#33)

* added named distributions * happy linter - happy life
peeramid-labs · Dec 5, 2024 · 3ca5234 · 3ca5234
1 parent d050103
commit 3ca5234
Show file tree

Hide file tree

Showing 7 changed files with 87 additions and 3 deletions.
diff --git a/.changeset/violet-emus-lie.md b/.changeset/violet-emus-lie.md
@@ -0,0 +1,5 @@
+---
+"@peeramid-labs/eds": minor
+---
+
+added interface to add named distributions
diff --git a/src/abstracts/Distributor.sol b/src/abstracts/Distributor.sol
@@ -93,6 +93,18 @@ abstract contract Distributor is IDistributor, CodeIndexer, ERC165 {
         _newDistributionRecord(distributorId, distributionLocation, initializerAddress);
     }
 
+    function _addDistribution(
+        bytes32 readableName,
+        bytes32 id,
+        address initializerAddress
+    ) internal virtual returns (bytes32 distributorId) {
+        ICodeIndex codeIndex = getContractsIndex();
+        address distributionLocation = codeIndex.get(id);
+        if (distributionLocation == address(0)) revert DistributionNotFound(id);
+        distributorId = readableName;
+        _newDistributionRecord(distributorId, distributionLocation, initializerAddress);
+    }
+
     function _removeDistribution(bytes32 distributorsId) internal virtual {
         if (!distributionsSet.contains(distributorsId)) revert DistributionNotFound(distributorsId);
         distributionsSet.remove(distributorsId);

diff --git a/src/abstracts/TokenizedDistributor.sol b/src/abstracts/TokenizedDistributor.sol
@@ -39,6 +39,24 @@ abstract contract TokenizedDistributor is Distributor {
         _setInstantiationCost(distributorsId, defaultInstantiationCost);
     }
 
+    function _addDistribution(
+        bytes32 readableName,
+        bytes32 id,
+        address initializerAddress
+    ) internal override returns (bytes32 distributorsId) {
+        distributorsId = super._addDistribution(readableName, id, initializerAddress);
+        _setInstantiationCost(distributorsId, defaultInstantiationCost);
+    }
+
+    function _addDistribution(
+        address repository,
+        address initializer,
+        LibSemver.VersionRequirement memory requirement
+    ) internal override returns (bytes32 distributorsId) {
+        distributorsId = super._addDistribution(repository, initializer, requirement);
+        _setInstantiationCost(distributorsId, defaultInstantiationCost);
+    }
+
     /**
      * @inheritdoc Distributor
      */

diff --git a/src/distributors/OwnableDistributor.sol b/src/distributors/OwnableDistributor.sol
@@ -22,6 +22,10 @@ contract OwnableDistributor is Distributor, Ownable {
         super._addDistribution(address(repository), initializer, requirement);
     }
 
+    function addNamedDistribution(bytes32 name, bytes32 distributorId, address initializer) external onlyOwner {
+        super._addDistribution(name, distributorId, initializer);
+    }
+
     function changeVersion(
         bytes32 distributionId,
         LibSemver.VersionRequirement memory newRequirement

diff --git a/src/interfaces/IDistributor.sol b/src/interfaces/IDistributor.sol
@@ -153,4 +153,12 @@ interface IDistributor is IERC7746, IERC165 {
      * @param newRequirement The new version requirement to be set for the distribution.
      */
     function changeVersion(bytes32 distributionId, LibSemver.VersionRequirement memory newRequirement) external;
+
+    /**
+     * @notice Adds a new versioned distribution to the repository.
+     * @param name The name of the distribution.
+     * @param distributorId The unique identifier of the distributor.
+     * @param initializer The address that initializes the distribution.
+     */
+    function addNamedDistribution(bytes32 name, bytes32 distributorId, address initializer) external;
 }
diff --git a/src/mocks/MockTokenizedDistributor.sol b/src/mocks/MockTokenizedDistributor.sol
@@ -23,7 +23,6 @@ contract MockTokenizedDistributor is TokenizedDistributor, AccessControlDefaultA
      */
     function addDistribution(bytes32 id, address initializer) external onlyRole(DEFAULT_ADMIN_ROLE) {
         super._addDistribution(id, initializer);
-        instantiationCosts[keccak256(abi.encode(id, initializer))] = defaultInstantiationCost;
     }
 
     /**
@@ -87,8 +86,14 @@ contract MockTokenizedDistributor is TokenizedDistributor, AccessControlDefaultA
         address initializer,
         LibSemver.VersionRequirement memory requirement
     ) external override onlyRole(DEFAULT_ADMIN_ROLE) {
-        bytes32 distributorId = keccak256(abi.encode(repository, initializer));
-        instantiationCosts[distributorId] = defaultInstantiationCost;
         super._addDistribution(address(repository), initializer, requirement);
     }
+
+    function addNamedDistribution(
+        bytes32 name,
+        bytes32 distributorId,
+        address initializer
+    ) external onlyRole(DEFAULT_ADMIN_ROLE) {
+        super._addDistribution(name, distributorId, initializer);
+    }
 }
diff --git a/test/eds/Distributor.ts b/test/eds/Distributor.ts
@@ -78,6 +78,38 @@ describe("Distributor", function () {
     ).to.be.revertedWithCustomError(distributor, "DistributionNotFound");
   });
 
+  describe("addNamedDistribution", function () {
+    it("should allow owner to add a named distribution", async function () {
+      const name = ethers.utils.formatBytes32String("test-distribution");
+      const initializer = ethers.constants.AddressZero;
+
+      await expect(
+        distributor.connect(owner).addNamedDistribution(name, cloneDistributionId, initializer)
+      )
+        .to.emit(distributor, "DistributionAdded")
+        .withArgs(name, await codeIndex.get(cloneDistributionId), initializer);
+    });
+
+    it("should revert when non-owner tries to add a named distribution", async function () {
+      const name = ethers.utils.formatBytes32String("test-distribution");
+      const initializer = ethers.constants.AddressZero;
+
+      await expect(
+        distributor.connect(deployer).addNamedDistribution(name, cloneDistributionId, initializer)
+      ).to.be.revertedWithCustomError(distributor, "OwnableUnauthorizedAccount");
+    });
+
+    it("should revert when distribution ID does not exist", async function () {
+      const name = ethers.utils.formatBytes32String("test-distribution");
+      const initializer = ethers.constants.AddressZero;
+      const nonExistentId = ethers.utils.formatBytes32String("non-existent");
+
+      await expect(
+        distributor.connect(owner).addNamedDistribution(name, nonExistentId, initializer)
+      ).to.be.revertedWithCustomError(distributor, "DistributionNotFound");
+    });
+  });
+
   describe("when distribution is added", function () {
     beforeEach(async function () {
       await distributor