fix: update election to include department

Author: Ayeni-yeniyan

README.md

@@ -91,14 +91,14 @@ forge build
 The VotsEngine contract is currently deployed and live on multiple testnets:
 
 ### Sepolia Testnet
-**VotsEngine Contract**: `0xda115D0e2F8e24c2F4E487bd9590AC56Fb750D06`
+**VotsEngine Contract**: `0x95935ceb316E5585E493602a1c2ADCEf832848c7`
 
-**NFT Contract**: `0x9e1dbfAD78De1ef5BCbF8fA912BdA4B581663921`
+**NFT Contract**: `0x34bc2AbA1C4A49e22E83D99e36602FC332aD56C1`
 
 **Network**: Sepolia Testnet
 - **Chain ID**: 11155111
-- **VotsEngine Block Explorer**: https://sepolia.etherscan.io/address/0xda115D0e2F8e24c2F4E487bd9590AC56Fb750D06
-- **NFT Contract Block Explorer**: https://sepolia.etherscan.io/address/0x9e1dbfAD78De1ef5BCbF8fA912BdA4B581663921
+- **VotsEngine Block Explorer**: https://sepolia.etherscan.io/address/0x95935ceb316E5585E493602a1c2ADCEf832848c7
+- **NFT Contract Block Explorer**: https://sepolia.etherscan.io/address/0x34bc2AbA1C4A49e22E83D99e36602FC332aD56C1
 
 ### Fuji Testnet (Avalanche)
 **VotsEngine Contract**: `0xed7eA5221041A1982d9d257c9617B1448032838d`
@@ -120,7 +120,7 @@ You can interact with the deployed contract using:
 
 ```javascript
 // Example using ethers.js with Sepolia
-const sepoliaContractAddress = "0xda115D0e2F8e24c2F4E487bd9590AC56Fb750D06....";
+const sepoliaContractAddress = "0x95935ceb316E5585E493602a1c2ADCEf832848c7....";
 const VotsEngineSepoliaClient = new ethers.Contract(sepoliaContractAddress, abi, sepoliaProvider);
 
 // Example using ethers.js with Fuji
@@ -146,7 +146,7 @@ The VotsEngine system requires a **hybrid physical-digital infrastructure**:
 ### Deploying the System
 
 The VotsEngine is already deployed on multiple testnets:
-- **Sepolia**: `0xda115D0e2F8e24c2F4E487bd9590AC56Fb750D06....`
+- **Sepolia**: `0x95935ceb316E5585E493602a1c2ADCEf832848c7....`
 - **Fuji (Avalanche)**: `0xed7eA5221041A1982d9d257c9617B1448032838d`
 
 For local development or custom deployments:
@@ -161,7 +161,7 @@ Or connect to the existing deployments:
 ```javascript
 // Connect to Sepolia deployment
 const VotsEngineSepoliaClient = new ethers.Contract(
-    "0xda115D0e2F8e24c2F4E487bd9590AC56Fb750D06....", 
+    "0x95935ceb316E5585E493602a1c2ADCEf832848c7....", 
     VotsEngineABI, 
     sepoliaProvider
 );

broadcast/DeployVotsEngine.s.sol/11155111/run-1752135320.json

@@ -279,17 +279,18 @@ contract Election is IElection, Ownable {
     /**
      * @dev Returns Returns a list of all voters
      */
-    function getAllVoters()
-        public
-        view
-        onElectionEnded
-        returns (ElectionVoter[] memory)
-    {
+    function getAllVoters() public view returns (ElectionVoter[] memory) {
         ElectionVoter[] memory all = new ElectionVoter[](
             _registeredVotersList.length
         );
         for (uint256 i = 0; i < _registeredVotersList.length; i++) {
-            all[i] = _votersMap[_registeredVotersList[i]];
+            ElectionVoter memory voter = _votersMap[_registeredVotersList[i]];
+            all[i] = ElectionVoter({
+                name: voter.name,
+                level: voter.level,
+                department: voter.department,
+                voterState: VoterState.REGISTERED
+            });
         }
         return all;
     }
@@ -818,6 +819,7 @@ contract Election is IElection, Ownable {
             ElectionVoter memory registeredVoter = ElectionVoter({
                 name: voter.name,
                 level: voter.level,
+                department: voter.department,
                 voterState: VoterState.REGISTERED
             });
             // add to votersList if the state is unknown

broadcast/DeployVotsEngine.s.sol/11155111/run-1752136100.json

@@ -14,7 +14,12 @@ import {IVotsElectionNft} from "./interfaces/IVotsElectionNft.sol";
  * @notice NFT contract that mints tokens to election creators as proof of election creation
  * @dev This contract creates unique NFTs for each election created through the VotsEngine
  */
-contract VotsElectionNft is IVotsElectionNft, ERC721, ERC721URIStorage, Ownable {
+contract VotsElectionNft is
+    IVotsElectionNft,
+    ERC721,
+    ERC721URIStorage,
+    Ownable
+{
     using Strings for uint256;
 
     // ====================================================================
@@ -36,7 +41,8 @@ contract VotsElectionNft is IVotsElectionNft, ERC721, ERC721URIStorage, Ownable
     mapping(uint256 => uint256) public electionTokenToNftToken;
 
     // Mapping from NFT token ID to election data
-    mapping(uint256 => IVotsElectionNft.ElectionNftData) public nftTokenToElectionData;
+    mapping(uint256 => IVotsElectionNft.ElectionNftData)
+        public nftTokenToElectionData;
 
     // ====================================================================
     // Constructor
@@ -80,15 +86,16 @@ contract VotsElectionNft is IVotsElectionNft, ERC721, ERC721URIStorage, Ownable
         nftTokenId = _tokenIdCounter;
 
         // Store election data
-        IVotsElectionNft.ElectionNftData memory nftData = IVotsElectionNft.ElectionNftData({
-            electionTokenId: electionTokenId,
-            electionName: electionName,
-            creator: creator,
-            creationTimestamp: block.timestamp,
-            electionDescription: electionDescription,
-            startTime: startTime,
-            endTime: endTime
-        });
+        IVotsElectionNft.ElectionNftData memory nftData = IVotsElectionNft
+            .ElectionNftData({
+                electionTokenId: electionTokenId,
+                electionName: electionName,
+                creator: creator,
+                creationTimestamp: block.timestamp,
+                electionDescription: electionDescription,
+                startTime: startTime,
+                endTime: endTime
+            });
 
         nftTokenToElectionData[nftTokenId] = nftData;
         electionTokenToNftToken[electionTokenId] = nftTokenId;
@@ -97,10 +104,18 @@ contract VotsElectionNft is IVotsElectionNft, ERC721, ERC721URIStorage, Ownable
         _safeMint(creator, nftTokenId);
 
         // Set token URI
-        string memory generatedTokenURI = _generateTokenURI(nftTokenId, nftData);
+        string memory generatedTokenURI = _generateTokenURI(
+            nftTokenId,
+            nftData
+        );
         _setTokenURI(nftTokenId, generatedTokenURI);
 
-        emit IVotsElectionNft.ElectionNftMinted(nftTokenId, electionTokenId, creator, electionName);
+        emit IVotsElectionNft.ElectionNftMinted(
+            nftTokenId,
+            electionTokenId,
+            creator,
+            electionName
+        );
 
         return nftTokenId;
     }
@@ -111,11 +126,10 @@ contract VotsElectionNft is IVotsElectionNft, ERC721, ERC721URIStorage, Ownable
      * @param nftData The election data for this NFT
      * @return The complete token URI with embedded metadata
      */
-    function _generateTokenURI(uint256 nftTokenId, IVotsElectionNft.ElectionNftData memory nftData)
-        internal
-        pure
-        returns (string memory)
-    {
+    function _generateTokenURI(
+        uint256 nftTokenId,
+        IVotsElectionNft.ElectionNftData memory nftData
+    ) internal pure returns (string memory) {
         // Create SVG image
         string memory svg = _generateSVG(nftData);
 
@@ -163,46 +177,52 @@ contract VotsElectionNft is IVotsElectionNft, ERC721, ERC721URIStorage, Ownable
      * @param nftData The election data
      * @return SVG string
      */
-    function _generateSVG(IVotsElectionNft.ElectionNftData memory nftData) internal pure returns (string memory) {
-        return string(
-            abi.encodePacked(
-                '<svg width="400" height="400" xmlns="http://www.w3.org/2000/svg">',
-                "<defs>",
-                '<linearGradient id="grad1" x1="0%" y1="0%" x2="100%" y2="100%">',
-                '<stop offset="0%" style="stop-color:#667eea;stop-opacity:1" />',
-                '<stop offset="100%" style="stop-color:#764ba2;stop-opacity:1" />',
-                "</linearGradient>",
-                "</defs>",
-                '<rect width="400" height="400" fill="url(#grad1)" rx="20"/>',
-                '<rect x="20" y="20" width="360" height="360" fill="none" stroke="white" stroke-width="2" rx="15"/>',
-                '<text x="200" y="60" font-family="Arial, sans-serif" font-size="24" font-weight="bold" text-anchor="middle" fill="white">ELECTION CERTIFICATE</text>',
-                '<text x="200" y="100" font-family="Arial, sans-serif" font-size="14" text-anchor="middle" fill="white">VotsEngine Creation Proof</text>',
-                '<text x="50" y="140" font-family="Arial, sans-serif" font-size="14" fill="white">Election:</text>',
-                '<text x="50" y="165" font-family="Arial, sans-serif" font-size="16" font-weight="bold" fill="white">',
-                _truncateString(nftData.electionName, 25),
-                "</text>",
-                '<text x="50" y="200" font-family="Arial, sans-serif" font-size="14" fill="white">Type:</text>',
-                '<text x="50" y="225" font-family="Arial, sans-serif" font-size="16" font-weight="bold" fill="white">',
-                nftData.electionDescription,
-                "</text>",
-                '<text x="50" y="260" font-family="Arial, sans-serif" font-size="14" fill="white">Token ID:</text>',
-                '<text x="50" y="285" font-family="Arial, sans-serif" font-size="16" font-weight="bold" fill="white">#',
-                nftData.electionTokenId.toString(),
-                "</text>",
-                '<text x="50" y="320" font-family="Arial, sans-serif" font-size="14" fill="white">Creator:</text>',
-                '<text x="50" y="345" font-family="Arial, sans-serif" font-size="16" font-weight="bold" fill="white">',
-                _truncateAddress(nftData.creator),
-                "</text>",
-                '<text x="200" y="375" font-family="Arial, sans-serif" font-size="12" text-anchor="middle" fill="white">powered by YENIYAN-Group</text>',
-                "</svg>"
-            )
-        );
+    function _generateSVG(
+        IVotsElectionNft.ElectionNftData memory nftData
+    ) internal pure returns (string memory) {
+        return
+            string(
+                abi.encodePacked(
+                    '<svg width="400" height="400" xmlns="http://www.w3.org/2000/svg">',
+                    "<defs>",
+                    '<linearGradient id="grad1" x1="0%" y1="0%" x2="100%" y2="100%">',
+                    '<stop offset="0%" style="stop-color:#667eea;stop-opacity:1" />',
+                    '<stop offset="100%" style="stop-color:#764ba2;stop-opacity:1" />',
+                    "</linearGradient>",
+                    "</defs>",
+                    '<rect width="400" height="400" fill="url(#grad1)" rx="20"/>',
+                    '<rect x="20" y="20" width="360" height="360" fill="none" stroke="white" stroke-width="2" rx="15"/>',
+                    '<text x="200" y="60" font-family="Arial, sans-serif" font-size="24" font-weight="bold" text-anchor="middle" fill="white">ELECTION CERTIFICATE</text>',
+                    '<text x="200" y="100" font-family="Arial, sans-serif" font-size="14" text-anchor="middle" fill="white">VotsEngine Creation Proof</text>',
+                    '<text x="50" y="140" font-family="Arial, sans-serif" font-size="14" fill="white">Election:</text>',
+                    '<text x="50" y="165" font-family="Arial, sans-serif" font-size="16" font-weight="bold" fill="white">',
+                    _truncateString(nftData.electionName, 25),
+                    "</text>",
+                    '<text x="50" y="200" font-family="Arial, sans-serif" font-size="14" fill="white">Description:</text>',
+                    '<text x="50" y="225" font-family="Arial, sans-serif" font-size="16" font-weight="bold" fill="white">',
+                    _truncateString(nftData.electionDescription, 30),
+                    "</text>",
+                    '<text x="50" y="260" font-family="Arial, sans-serif" font-size="14" fill="white">Token ID:</text>',
+                    '<text x="50" y="285" font-family="Arial, sans-serif" font-size="16" font-weight="bold" fill="white">#',
+                    nftData.electionTokenId.toString(),
+                    "</text>",
+                    '<text x="50" y="320" font-family="Arial, sans-serif" font-size="14" fill="white">Creator:</text>',
+                    '<text x="50" y="345" font-family="Arial, sans-serif" font-size="16" font-weight="bold" fill="white">',
+                    _truncateAddress(nftData.creator),
+                    "</text>",
+                    '<text x="200" y="375" font-family="Arial, sans-serif" font-size="12" text-anchor="middle" fill="white">powered by YENIYAN-Group</text>',
+                    "</svg>"
+                )
+            );
     }
 
     /**
      * @dev Truncates a string to specified length with ellipsis
      */
-    function _truncateString(string memory str, uint256 maxLength) internal pure returns (string memory) {
+    function _truncateString(
+        string memory str,
+        uint256 maxLength
+    ) internal pure returns (string memory) {
         bytes memory strBytes = bytes(str);
         if (strBytes.length <= maxLength) {
             return str;
@@ -219,7 +239,9 @@ contract VotsElectionNft is IVotsElectionNft, ERC721, ERC721URIStorage, Ownable
     /**
      * @dev Truncates an address for display
      */
-    function _truncateAddress(address addr) internal pure returns (string memory) {
+    function _truncateAddress(
+        address addr
+    ) internal pure returns (string memory) {
         string memory addrStr = Strings.toHexString(uint160(addr), 20);
         bytes memory addrBytes = bytes(addrStr);
 
@@ -251,7 +273,9 @@ contract VotsElectionNft is IVotsElectionNft, ERC721, ERC721URIStorage, Ownable
      * @dev Returns election data for a given NFT token ID
      * @param nftTokenId The NFT token ID
      */
-    function getElectionData(uint256 nftTokenId) external view returns (IVotsElectionNft.ElectionNftData memory) {
+    function getElectionData(
+        uint256 nftTokenId
+    ) external view returns (IVotsElectionNft.ElectionNftData memory) {
         if (!_exists(nftTokenId)) {
             revert VotsElectionNft__TokenDoesNotExist();
         }
@@ -262,15 +286,19 @@ contract VotsElectionNft is IVotsElectionNft, ERC721, ERC721URIStorage, Ownable
      * @dev Returns NFT token ID for a given election token ID
      * @param electionTokenId The election token ID
      */
-    function getNftTokenByElectionId(uint256 electionTokenId) external view returns (uint256) {
+    function getNftTokenByElectionId(
+        uint256 electionTokenId
+    ) external view returns (uint256) {
         return electionTokenToNftToken[electionTokenId];
     }
 
     /**
      * @dev Returns all NFTs owned by an address
      * @param owner The owner address
      */
-    function getOwnedTokens(address owner) external view returns (uint256[] memory) {
+    function getOwnedTokens(
+        address owner
+    ) external view returns (uint256[] memory) {
         uint256 balance = balanceOf(owner);
         uint256[] memory tokens = new uint256[](balance);
         uint256 currentIndex = 0;
@@ -291,7 +319,9 @@ contract VotsElectionNft is IVotsElectionNft, ERC721, ERC721URIStorage, Ownable
      * @dev Checks if an NFT exists for a given election
      * @param electionTokenId The election token ID
      */
-    function electionNftExists(uint256 electionTokenId) external view returns (bool) {
+    function electionNftExists(
+        uint256 electionTokenId
+    ) external view returns (bool) {
         return electionTokenToNftToken[electionTokenId] != 0;
     }
 
@@ -303,11 +333,15 @@ contract VotsElectionNft is IVotsElectionNft, ERC721, ERC721URIStorage, Ownable
     // Override Functions
     // ====================================================================
 
-    function tokenURI(uint256 tokenId) public view override(ERC721, ERC721URIStorage) returns (string memory) {
+    function tokenURI(
+        uint256 tokenId
+    ) public view override(ERC721, ERC721URIStorage) returns (string memory) {
         return super.tokenURI(tokenId);
     }
 
-    function supportsInterface(bytes4 interfaceId) public view override(ERC721, ERC721URIStorage) returns (bool) {
+    function supportsInterface(
+        bytes4 interfaceId
+    ) public view override(ERC721, ERC721URIStorage) returns (bool) {
         return super.supportsInterface(interfaceId);
     }
 }

broadcast/DeployVotsEngine.s.sol/11155111/run-latest.json

@@ -62,6 +62,7 @@ interface IElection {
     struct VoterInfoDTO {
         string name;
         string matricNo;
+        string department;
         uint256 level;
     }
 
@@ -70,6 +71,7 @@ interface IElection {
      */
     struct ElectionVoter {
         string name;
+        string department;
         uint256 level;
         VoterState voterState;
     }

src/Election.sol

@@ -68,36 +68,42 @@ contract ElectionTest is Test {
         IElection.VoterInfoDTO({
             name: "Voter1",
             matricNo: "VOT001",
+            department: "Computer Science",
             level: 100
         });
     IElection.VoterInfoDTO voterTwo =
         IElection.VoterInfoDTO({
             name: "Voter2",
             matricNo: "VOT002",
+            department: "Computer Science",
             level: 100
         });
     IElection.VoterInfoDTO voterThree =
         IElection.VoterInfoDTO({
             name: "Voter3",
             matricNo: "VOT003",
+            department: "Computer Science",
             level: 100
         });
     IElection.VoterInfoDTO voterFour =
         IElection.VoterInfoDTO({
             name: "Voter4",
             matricNo: "VOT004",
+            department: "Computer Science",
             level: 100
         });
     IElection.VoterInfoDTO voterFive =
         IElection.VoterInfoDTO({
             name: "Voter5",
             matricNo: "VOT005",
+            department: "Computer Science",
             level: 100
         });
     IElection.VoterInfoDTO unknownVoter =
         IElection.VoterInfoDTO({
             name: "This Unknown",
             matricNo: "VOT007",
+            department: "Computer Science",
             level: 100
         });