feat(excubiae): add trait mechanism

Author: 0xjei

packages/excubiae/contracts/Excubia.sol

@@ -21,6 +21,9 @@ abstract contract Excubia is IExcubia, Ownable(msg.sender) {
         _;
     }
 
+    /// @inheritdoc IExcubia
+    function trait() external pure virtual returns (string memory) {}
+
     /// @inheritdoc IExcubia
     function setGate(address _gate) public virtual onlyOwner {
         if (_gate == address(0)) revert ZeroAddress();

packages/excubiae/contracts/IExcubia.sol

@@ -28,6 +28,10 @@ interface IExcubia {
     /// @notice Error thrown when the passerby has already passed the gate.
     error AlreadyPassed();
 
+    /// @notice Gets the trait of the Excubia contract.
+    /// @return The specific trait of the Excubia contract (e.g., SemaphoreExcubia has trait `Semaphore`).
+    function trait() external pure returns (string memory);
+
     /// @notice Sets the gate address.
     /// @dev Only the owner can set the destination gate address.
     /// @param _gate The address of the contract to be set as the gate.

packages/excubiae/contracts/extensions/EASExcubia.sol

@@ -46,6 +46,11 @@ contract EASExcubia is Excubia {
         SCHEMA = _schema;
     }
 
+    /// @notice The trait of the Excubia contract.
+    function trait() external pure override returns (string memory) {
+        return "EAS";
+    }
+
     /// @notice Internal function to handle the passing logic with check.
     /// @dev Calls the parent `_pass` function and stores the attestation to avoid pass the gate twice.
     /// @param passerby The address of the entity attempting to pass the gate.

packages/excubiae/contracts/extensions/ERC721Excubia.sol

@@ -27,6 +27,11 @@ contract ERC721Excubia is Excubia {
         NFT = IERC721(_erc721);
     }
 
+    /// @notice The trait of the Excubia contract.
+    function trait() external pure override returns (string memory) {
+        return "ERC721";
+    }
+
     /// @notice Internal function to handle the passing logic with check.
     /// @dev Calls the parent `_pass` function and stores the NFT ID to avoid passing the gate twice.
     /// @param passerby The address of the entity attempting to pass the gate.

packages/excubiae/contracts/extensions/FreeForAllExcubia.sol

@@ -14,6 +14,11 @@ contract FreeForAllExcubia is Excubia {
     /// @notice Mapping to track already passed passersby.
     mapping(address => bool) public passedPassersby;
 
+    /// @notice The trait of the Excubia contract.
+    function trait() external pure override returns (string memory) {
+        return "FreeForAll";
+    }
+
     /// @notice Internal function to handle the gate passing logic.
     /// @dev This function calls the parent `_pass` function and then tracks the passerby.
     /// @param passerby The address of the entity passing the gate.

packages/excubiae/contracts/extensions/GitcoinPassportExcubia.sol

@@ -41,6 +41,11 @@ contract GitcoinPassportExcubia is Excubia {
         THRESHOLD_SCORE = _thresholdScore;
     }
 
+    /// @notice The trait of the Excubia contract.
+    function trait() external pure override returns (string memory) {
+        return "GitcoinPassport";
+    }
+
     /// @notice Internal function to handle the passing logic with check.
     /// @dev Calls the parent `_pass` function and stores the user to avoid passing the gate twice.
     /// @param passerby The address of the entity attempting to pass the gate.

packages/excubiae/contracts/extensions/HatsExcubia.sol

@@ -38,6 +38,11 @@ contract HatsExcubia is Excubia {
         }
     }
 
+    /// @notice The trait of the Excubia contract.
+    function trait() external pure override returns (string memory) {
+        return "Hats";
+    }
+
     /// @notice Internal function to handle the passing logic with check.
     /// @dev Calls the parent `_pass` function and stores the user to avoid passing the gate twice.
     /// @param passerby The address of the entity attempting to pass the gate.

packages/excubiae/contracts/extensions/SemaphoreExcubia.sol

@@ -44,6 +44,11 @@ contract SemaphoreExcubia is Excubia {
         GROUP_ID = _groupId;
     }
 
+    /// @notice The trait of the Excubia contract.
+    function trait() external pure override returns (string memory) {
+        return "Semaphore";
+    }
+
     /// @notice Internal function to handle the passing logic with check.
     /// @dev Calls the parent `_pass` function and stores the nullifier to avoid passing the gate twice.
     /// @param passerby The address of the entity attempting to pass the gate.

packages/excubiae/contracts/extensions/ZKEdDSAEventTicketPCDExcubia.sol

@@ -51,6 +51,11 @@ contract ZKEdDSAEventTicketPCDExcubia is Excubia {
         VALID_SIGNER_2 = _validSigner2;
     }
 
+    /// @notice The trait of the Excubia contract.
+    function trait() external pure override returns (string memory) {
+        return "ZKEdDSAEventTicketPCD";
+    }
+
     /// @notice Internal function to handle the passing logic with check.
     /// @dev Calls the parent `_pass` function and stores the ticket ID to avoid passing the gate twice.
     /// @param passerby The address of the entity attempting to pass the gate.

packages/excubiae/test/EASExcubia.test.ts

@@ -60,6 +60,12 @@ describe("EASExcubia", function () {
         })
     })
 
+    describe("trait()", function () {
+        it("should return the trait of the Excubia contract", async () => {
+            expect(await easExcubia.trait()).to.be.equal("EAS")
+        })
+    })
+
     describe("setGate()", function () {
         it("should fail to set the gate when the caller is not the owner", async () => {
             const [, notOwnerSigner] = await ethers.getSigners()

packages/excubiae/test/ERC721Excubia.test.ts

@@ -61,6 +61,12 @@ describe("ERC721Excubia", function () {
         })
     })
 
+    describe("trait()", function () {
+        it("should return the trait of the Excubia contract", async () => {
+            expect(await erc721Excubia.trait()).to.be.equal("ERC721")
+        })
+    })
+
     describe("setGate()", function () {
         it("should fail to set the gate when the caller is not the owner", async () => {
             const [, notOwnerSigner] = await ethers.getSigners()

packages/excubiae/test/FreeForAllExcubia.test.ts

@@ -28,6 +28,12 @@ describe("FreeForAllExcubia", function () {
         })
     })
 
+    describe("trait()", function () {
+        it("should return the trait of the Excubia contract", async () => {
+            expect(await freeForAllExcubia.trait()).to.be.equal("FreeForAll")
+        })
+    })
+
     describe("setGate()", function () {
         it("should fail to set the gate when the caller is not the owner", async () => {
             const [, notOwnerSigner] = await ethers.getSigners()

packages/excubiae/test/GitcoinPassportExcubia.test.ts

@@ -76,6 +76,12 @@ describe("GitcoinPassportExcubia", function () {
         })
     })
 
+    describe("trait()", function () {
+        it("should return the trait of the Excubia contract", async () => {
+            expect(await gitcoinPassportExcubia.trait()).to.be.equal("GitcoinPassport")
+        })
+    })
+
     describe("setGate()", function () {
         it("should fail to set the gate when the caller is not the owner", async () => {
             const [, notOwnerSigner] = await ethers.getSigners()

packages/excubiae/test/HatsExcubia.test.ts

@@ -64,6 +64,12 @@ describe("HatsExcubia", function () {
         })
     })
 
+    describe("trait()", function () {
+        it("should return the trait of the Excubia contract", async () => {
+            expect(await hatsExcubia.trait()).to.be.equal("Hats")
+        })
+    })
+
     describe("setGate()", function () {
         it("should fail to set the gate when the caller is not the owner", async () => {
             const [, notOwnerSigner] = await ethers.getSigners()

packages/excubiae/test/SemaphoreExcubia.test.ts

@@ -113,6 +113,12 @@ describe("SemaphoreExcubia", function () {
         })
     })
 
+    describe("trait()", function () {
+        it("should return the trait of the Excubia contract", async () => {
+            expect(await semaphoreExcubia.trait()).to.be.equal("Semaphore")
+        })
+    })
+
     describe("setGate()", function () {
         it("should fail to set the gate when the caller is not the owner", async () => {
             const [, notOwnerSigner] = await ethers.getSigners()

packages/excubiae/test/ZKEdDSAEventTicketPCD.test.ts

@@ -116,6 +116,12 @@ describe("ZKEdDSAEventTicketPCDExcubia", function () {
         })
     })
 
+    describe("trait()", function () {
+        it("should return the trait of the Excubia contract", async () => {
+            expect(await zkEdDSAEventTicketPCDExcubia.trait()).to.be.equal("ZKEdDSAEventTicketPCD")
+        })
+    })
+
     describe("setGate()", function () {
         it("should fail to set the gate when the caller is not the owner", async () => {
             const [, notOwnerSigner] = await ethers.getSigners()