feat: add events for contracts (#9)

* feat: events for filesystem

* feat: add events for social connections

* feat: add events for user verification

* refactor: update create2 salt, redeploy contracts

Author: IgorShadurin

README.md

@@ -19,8 +19,8 @@ The following contracts are available in the repository:
 ### Superchain (CREATE2) Addresses
 | Contract                         | Superchain Address                                                                                                     |
 |----------------------------------|------------------------------------------------------------------------------------------------------------------------|
-| SocialConnections.sol            | [0xB7C1C10A71d3C90f42351bec7E4BCd647C992743](https://blockscan.com/address/0xB7C1C10A71d3C90f42351bec7E4BCd647C992743)                                                                                 |
-| FilesystemChanges.sol            | [0x55043C8f3e8Ec55D2d60Acef83024F3b6da5AAf0](https://blockscan.com/address/0x55043C8f3e8Ec55D2d60Acef83024F3b6da5AAf0) |
+| SocialConnections.sol            | [0x99583220489a0e4217911ECf50680918F6a8B958](https://blockscan.com/address/0x99583220489a0e4217911ECf50680918F6a8B958)                                                                                 |
+| FilesystemChanges.sol            | [0x30C974bE6581e3a00595d0b7C1ba7A8A91413e1f](https://blockscan.com/address/0x30C974bE6581e3a00595d0b7C1ba7A8A91413e1f) |
 
 ### Addresses
 | Contract                         | Address                      |
@@ -31,12 +31,23 @@ The following contracts are available in the repository:
 
 [Old contracts](/docs/OLD_CONTRACTS.md).
 
+## Testing smart contracts
+
+```shell
+# install dependencies
+npm ci
+
+# test the contracts
+npx hardhat test
+```
+
 ## Deploy contracts
 
 ### With Create2 (preferable)
 
 ```shell
 # localhost
+npx hardhat node # start a local node
 npm run deploy-all-localhost
 
 # OP Sepolia
@@ -88,16 +99,6 @@ npx hardhat verify --network mainnet DEPLOYED_CONTRACT_ADDRESS
 # the deployed addresses will be saved in `./deployed-contracts.json`
 ```
 
-## Testing smart contracts
-
-```shell
-# install dependencies
-npm ci
-
-# test the contracts
-npx hardhat test
-```
-
 ## Other
 
 [Superchain Chains](https://www.superchain.eco/chains)

contracts/FilesystemChanges.sol

@@ -6,6 +6,15 @@ pragma solidity ^0.8.20;
  * @dev Store and manage filesystem changes (in form of Multihash) for users and services.
  */
 contract FilesystemChanges {
+    // Event for setting a service connection
+    event ServiceConnectionSet(address indexed serviceAddress, bytes32 hash, uint8 hashFunction, uint8 size);
+
+    // Event for setting a user connection
+    event UserConnectionSet(address indexed userAddress, bytes32 hash, uint8 hashFunction, uint8 size);
+
+    // Event for removing a connection
+    event ConnectionRemoved(address indexed accountAddress, bool isService);
+
     struct Multihash {
         bytes32 hash;
         uint8 hashFunction;
@@ -24,6 +33,7 @@ contract FilesystemChanges {
      */
     function setServiceChange(Multihash memory multihash) public {
         serviceChanges[msg.sender] = multihash;
+        emit ServiceConnectionSet(msg.sender, multihash.hash, multihash.hashFunction, multihash.size);
     }
 
     /**
@@ -32,6 +42,7 @@ contract FilesystemChanges {
      */
     function setUserChange(Multihash memory multihash) public {
         userChanges[msg.sender] = multihash;
+        emit UserConnectionSet(msg.sender, multihash.hash, multihash.hashFunction, multihash.size);
     }
 
     /**
@@ -44,5 +55,7 @@ contract FilesystemChanges {
         } else {
             delete userChanges[msg.sender];
         }
+
+        emit ConnectionRemoved(msg.sender, isService);
     }
 }

contracts/SocialConnections.sol

@@ -6,6 +6,15 @@ pragma solidity ^0.8.20;
  * @dev Store and manage social connections (in form of Multihash) for users and services.
  */
 contract SocialConnections {
+    // Event for setting a service connection
+    event ServiceConnectionSet(address indexed serviceAddress, bytes32 hash, uint8 hashFunction, uint8 size);
+
+    // Event for setting a user connection
+    event UserConnectionSet(address indexed userAddress, bytes32 hash, uint8 hashFunction, uint8 size);
+
+    // Event for removing a connection
+    event ConnectionRemoved(address indexed accountAddress, bool isService);
+
     struct Multihash {
         bytes32 hash;
         uint8 hashFunction;
@@ -24,6 +33,7 @@ contract SocialConnections {
      */
     function setServiceConnection(Multihash memory multihash) public {
         serviceConnections[msg.sender] = multihash;
+        emit ServiceConnectionSet(msg.sender, multihash.hash, multihash.hashFunction, multihash.size);
     }
 
     /**
@@ -32,17 +42,20 @@ contract SocialConnections {
      */
     function setUserConnection(Multihash memory multihash) public {
         userConnections[msg.sender] = multihash;
+        emit UserConnectionSet(msg.sender, multihash.hash, multihash.hashFunction, multihash.size);
     }
 
     /**
-     * @dev Delete the Multihash associated with the sender's smart account.
+     * @dev Remove the Multihash associated with the sender's smart account.
      * @param isService Indicates whether the sender's account is a service account.
      */
-    function deleteConnection(bool isService) public {
+    function removeConnection(bool isService) public {
         if (isService) {
             delete serviceConnections[msg.sender];
         } else {
             delete userConnections[msg.sender];
         }
+
+        emit ConnectionRemoved(msg.sender, isService);
     }
 }

contracts/UserVerification.sol

@@ -14,6 +14,21 @@ import "@openzeppelin/contracts-upgradeable/proxy/utils/UUPSUpgradeable.sol";
  * revocation, and reissuance of tokens, as well as checking their validity and expiration status.
  */
 contract UserVerification is Initializable, ERC721Upgradeable, ERC721BurnableUpgradeable, OwnableUpgradeable, UUPSUpgradeable {
+    /// @notice Emitted when a manager is set or unset
+    event ManagerSet(address manager, bool flag);
+
+    /// @notice Emitted when the default expiry duration is changed
+    event DefaultExpiryDurationChanged(uint256 newDuration);
+
+    /// @notice Emitted when a token is issued
+    event TokenIssued(address user, uint256 tokenId);
+
+    /// @notice Emitted when a token is revoked
+    event TokenRevoked(address user, uint256 tokenId);
+
+    /// @notice Emitted when a token's expiry is extended
+    event TokenExpiryExtended(address user, uint256 tokenId);
+
     /// @notice Indicates if an address is a manager
     mapping(address => bool) public isManager;
 
@@ -33,12 +48,6 @@ contract UserVerification is Initializable, ERC721Upgradeable, ERC721BurnableUpg
         _;
     }
 
-    /// @notice Emitted when a manager is set or unset
-    event ManagerSet(address manager, bool flag);
-
-    /// @notice Emitted when the default expiry duration is changed
-    event DefaultExpiryDurationChanged(uint256 newDuration);
-
     /**
      * @dev Initializes the contract with the given name, symbol, and default expiry duration.
      * @param initialOwner The address of the initial owner.
@@ -115,6 +124,7 @@ contract UserVerification is Initializable, ERC721Upgradeable, ERC721BurnableUpg
         _safeMint(user, tokenId);
         _userTokens[user] = tokenId;
         _setTokenExpiry(tokenId, block.timestamp + defaultExpiryDuration);
+        emit TokenIssued(user, tokenId);
     }
 
     /**
@@ -128,6 +138,7 @@ contract UserVerification is Initializable, ERC721Upgradeable, ERC721BurnableUpg
         _burn(tokenId);
         delete _userTokens[tokenOwner];
         delete _tokenExpiryTimes[tokenId];
+        emit TokenRevoked(tokenOwner, tokenId);
     }
 
     /**
@@ -138,6 +149,7 @@ contract UserVerification is Initializable, ERC721Upgradeable, ERC721BurnableUpg
     function extendTokenExpiry(uint256 tokenId) external onlyManagers {
         require(_ownerOf(tokenId) != address(0), "Token does not exist");
         _setTokenExpiry(tokenId, block.timestamp + defaultExpiryDuration);
+        emit TokenExpiryExtended(_ownerOf(tokenId), tokenId);
     }
 
     /**

hardhat.config.ts

@@ -63,7 +63,7 @@ const config: HardhatUserConfig = {
   ignition: {
     strategyConfig: {
       create2: {
-        salt: '0x0000000000000000000000000000000000000000000000000000000000000000',
+        salt: '0x0000000000000000000000000000000000000000000000000000000000000001',
       },
     },
   },