chore: update openzeppelin-contracts-upgradeable to release-v5.2

Author: AdamMomen

.vscode/settings.json

@@ -10,7 +10,29 @@
     "[solidity]": {
         "editor.defaultFormatter": "JuanBlanco.solidity",
         "editor.codeActionsOnSave": {
-            "source.fixAll": "always"
+            "source.fixAll": "always",
+            "source.fixAll.solhint": "always"
+        },
+        "editor.formatOnSave": true,
+        "editor.formatOnPaste": true
+    },
+    "solidity.solhintRules": {
+        "extends": "solhint:recommended",
+        "rules": {
+            "compiler-version": ["error", "^0.8.0"],
+            "func-visibility": ["error", { "ignoreConstructors": true }],
+            "not-rely-on-time": "off",
+            "no-empty-blocks": "warn",
+            "max-line-length": ["warn", 145],
+            "reason-string": ["warn", { "maxLength": 145 }],
+            "state-visibility": "error",
+            "var-name-mixedcase": "warn",
+            "func-name-mixedcase": "warn",
+            "private-vars-leading-underscore": ["warn", { "strict": false }],
+            "ordering": "warn",
+            "reentrancy": "error",
+            "avoid-low-level-calls": "warn",
+            "operator-whitespace": "off"
         }
     }
 }

chain/lib/forge-std

@@ -103,7 +103,7 @@ contract AccessControlFacet is AccessControlUpgradeable, IAccessControlFacet {
     }
 
     /// @dev Override _grantRole to use diamond storage
-    function _grantRole(bytes32 role, address account) internal virtual override {
+    function _grantRole(bytes32 role, address account) internal virtual override returns (bool) {
         Storage storage ds = StorageLib.get();
         if (!ds.roles[role][account]) {
             ds.roles[role][account] = true;
@@ -120,16 +120,20 @@ contract AccessControlFacet is AccessControlUpgradeable, IAccessControlFacet {
                     emit RoleGranted(INVESTOR_ROLE, account, msg.sender);
                 }
             }
+            return true;
         }
+        return false;
     }
 
     /// @dev Override _revokeRole to use diamond storage
-    function _revokeRole(bytes32 role, address account) internal virtual override {
+    function _revokeRole(bytes32 role, address account) internal virtual override returns (bool) {
         Storage storage ds = StorageLib.get();
         if (ds.roles[role][account]) {
             ds.roles[role][account] = false;
             emit RoleRevoked(role, account, msg.sender);
+            return true;
         }
+        return false;
     }
 
     /// @dev Override _setRoleAdmin to use diamond storage

chain/lib/openzeppelin-contracts

@@ -10,14 +10,9 @@ import {
     StakeholderPositions
 } from "@libraries/Structs.sol";
 import { AccessControl } from "@libraries/AccessControl.sol";
+import { IStakeholderFacet } from "@interfaces/IStakeholderFacet.sol";
 
-contract StakeholderFacet {
-    event StakeholderCreated(bytes16 indexed id);
-    event StakeholderAddressLinked(bytes16 indexed stakeholder_id, address indexed wallet_address);
-
-    error StakeholderAlreadyExists(bytes16 stakeholder_id);
-    error AddressAlreadyLinked(address wallet_address);
-
+contract StakeholderFacet is IStakeholderFacet {
     /// @notice Create a new stakeholder
     /// @dev Only OPERATOR_ROLE can create stakeholders
     function createStakeholder(bytes16 _id) external {
@@ -56,6 +51,23 @@ contract StakeholderFacet {
 
         emit StakeholderAddressLinked(stakeholder_id, wallet_address);
     }
+    /// @notice Get stakeholder id for a given address
+
+    function getStakeholderId(address wallet_address, bool ensure_exists) external view returns (bytes16) {
+        Storage storage ds = StorageLib.get();
+
+        // Check if address is linked to a stakeholder
+        bytes16 stakeholder_id = ds.addressToStakeholderId[wallet_address];
+        if (ensure_exists && stakeholder_id == bytes16(0)) {
+            revert NoStakeholder();
+        }
+        return stakeholder_id;
+    }
+
+    /// @notice Get stakeholder idx for a stakeholder id
+    function getStakeholderIndex(bytes16 stakeholder_id) external view returns (uint256) {
+        return StorageLib.get().stakeholderIndex[stakeholder_id];
+    }
 
     /// @notice Get all positions for a stakeholder
     /// @dev INVESTOR_ROLE can only view their own positions, OPERATOR_ROLE and above can view any

chain/src/facets/AccessControlFacet.sol

@@ -1,8 +1,8 @@
 // SPDX-License-Identifier: MIT
 pragma solidity ^0.8.0;
 
-import "openzeppelin-contracts/contracts/token/ERC721/ERC721.sol";
-import "openzeppelin-contracts/contracts/utils/Base64.sol";
+import { ERC721 } from "openzeppelin-contracts/contracts/token/ERC721/ERC721.sol";
+import { Base64 } from "openzeppelin-contracts/contracts/utils/Base64.sol";
 import { StorageLib, Storage } from "@core/Storage.sol";
 import {
     StakeholderPositions,
@@ -14,14 +14,18 @@ import {
 import { ValidationLib } from "@libraries/ValidationLib.sol";
 import { StakeholderFacet } from "@facets/StakeholderFacet.sol";
 import { AccessControl } from "@libraries/AccessControl.sol";
+import { IStakeholderNFTFacet } from "@interfaces/IStakeholderNFTFacet.sol";
 
-contract StakeholderNFTFacet is ERC721 {
-    error NotStakeholder();
-    error AlreadyMinted();
-    error URIQueryForNonexistentToken();
-
+contract StakeholderNFTFacet is ERC721, IStakeholderNFTFacet {
     constructor() ERC721("Stakeholder Position", "STKPOS") { }
 
+    // Internal function to check if a token exists by checking if the stakeholder ID exists
+    function _exists(uint256 tokenId) internal view override returns (bool) {
+        Storage storage ds = StorageLib.get();
+        bytes16 stakeholderId = bytes16(uint128(tokenId));
+        return ds.stakeholderIndex[stakeholderId] != 0;
+    }
+
     /// @notice Mint an NFT representing a stakeholder's position
     /// @dev Only stakeholders with INVESTOR_ROLE can mint their own NFT
     function mint() external {
@@ -45,12 +49,18 @@ contract StakeholderNFTFacet is ERC721 {
             revert AlreadyMinted();
         }
 
-        _mint(msg.sender, tokenId);
+        _safeMint(msg.sender, tokenId);
     }
 
     /// @notice Get the URI for a token, containing metadata about stakeholder positions
     /// @dev Only OPERATOR_ROLE or the token owner can view the token URI
-    function tokenURI(uint256 tokenId) public view override returns (string memory) {
+    function tokenURI(uint256 tokenId)
+        public
+        view
+        virtual
+        override(ERC721, IStakeholderNFTFacet)
+        returns (string memory)
+    {
         if (!_exists(tokenId)) revert URIQueryForNonexistentToken();
 
         // Allow operators and admins to view any token URI
@@ -71,7 +81,7 @@ contract StakeholderNFTFacet is ERC721 {
                     bytes(
                         abi.encodePacked(
                             '{"name":"Stakeholder Position #',
-                            toString(tokenId),
+                            _toString(tokenId),
                             '","description":"This NFT represents all active positions for this stakeholder.",',
                             '"attributes":',
                             _getAttributesJson(positions),
@@ -105,14 +115,15 @@ contract StakeholderNFTFacet is ERC721 {
         if (positions.length == 0) return '{"trait_type": "Stock Positions", "value": "0"}';
 
         return
-            string(abi.encodePacked('{"trait_type": "Stock Positions", "value": "', toString(positions.length), '"}'));
+            string(abi.encodePacked('{"trait_type": "Stock Positions", "value": "', _toString(positions.length), '"}'));
     }
 
     function _getWarrantPositionsJson(WarrantActivePosition[] memory positions) internal pure returns (string memory) {
         if (positions.length == 0) return '{"trait_type": "Warrant Positions", "value": "0"}';
 
-        return
-            string(abi.encodePacked('{"trait_type": "Warrant Positions", "value": "', toString(positions.length), '"}'));
+        return string(
+            abi.encodePacked('{"trait_type": "Warrant Positions", "value": "', _toString(positions.length), '"}')
+        );
     }
 
     function _getConvertiblePositionsJson(ConvertibleActivePosition[] memory positions)
@@ -123,7 +134,7 @@ contract StakeholderNFTFacet is ERC721 {
         if (positions.length == 0) return '{"trait_type": "Convertible Positions", "value": "0"}';
 
         return string(
-            abi.encodePacked('{"trait_type": "Convertible Positions", "value": "', toString(positions.length), '"}')
+            abi.encodePacked('{"trait_type": "Convertible Positions", "value": "', _toString(positions.length), '"}')
         );
     }
 
@@ -136,12 +147,12 @@ contract StakeholderNFTFacet is ERC721 {
 
         return string(
             abi.encodePacked(
-                '{"trait_type": "Equity Compensation Positions", "value": "', toString(positions.length), '"}'
+                '{"trait_type": "Equity Compensation Positions", "value": "', _toString(positions.length), '"}'
             )
         );
     }
 
-    function toString(uint256 value) internal pure returns (string memory) {
+    function _toString(uint256 value) internal pure returns (string memory) {
         // Convert uint to string
         if (value == 0) {
             return "0";

chain/src/facets/StakeholderFacet.sol

@@ -6,17 +6,9 @@ import { StockClass } from "@libraries/Structs.sol";
 import { TxHelper, TxType } from "@libraries/TxHelper.sol";
 import { LibDiamond } from "diamond-3-hardhat/libraries/LibDiamond.sol";
 import { AccessControl } from "@libraries/AccessControl.sol";
+import { IStockClassFacet } from "@interfaces/IStockClassFacet.sol";
 
-contract StockClassFacet {
-    event StockClassCreated(
-        bytes16 indexed id, string indexed classType, uint256 indexed pricePerShare, uint256 initialSharesAuthorized
-    );
-    event StockClassAuthorizedSharesAdjusted(bytes16 indexed stockClassId, uint256 newSharesAuthorized);
-
-    error StockClassAlreadyExists(bytes16 stock_class_id);
-    error StockClassNotFound(bytes16 stock_class_id);
-    error InvalidSharesAuthorized();
-
+contract StockClassFacet is IStockClassFacet {
     /// @notice Create a new stock class
     /// @dev Only DEFAULT_ADMIN_ROLE can create stock classes
     function createStockClass(

chain/src/facets/StakeholderNFTFacet.sol

@@ -14,19 +14,9 @@ import {
 import { TxHelper, TxType } from "@libraries/TxHelper.sol";
 import { ValidationLib } from "@libraries/ValidationLib.sol";
 import { AccessControl } from "@libraries/AccessControl.sol";
+import { IStockFacet } from "@interfaces/IStockFacet.sol";
 
-contract StockFacet {
-    /// @notice Issue new stock to a stakeholder
-    /// @dev Only OPERATOR_ROLE can issue stock
-    error InvalidSecurityId(bytes16 security_id);
-
-    /// @dev Add these custom errors at the contract level
-    error NoPositionsToConsolidate();
-    error StockClassMismatch(bytes16 expected, bytes16 actual);
-    error ZeroQuantityPosition(bytes16 security_id);
-    error InsufficientSharesForCancellation(bytes16 security_id, uint256 requested, uint256 available);
-    error InvalidCancellationQuantity(bytes16 security_id, uint256 quantity);
-
+contract StockFacet is IStockFacet {
     function issueStock(IssueStockParams calldata params) external {
         Storage storage ds = StorageLib.get();
 

chain/src/facets/StockClassFacet.sol

@@ -32,10 +32,12 @@ interface IAccessControlFacet is IAccessControl {
 
     /// @notice Role definitions
     /// @return The OPERATOR_ROLE hash
+    // solhint-disable func-name-mixedcase
     function OPERATOR_ROLE() external view returns (bytes32);
 
     /// @notice Role definitions
     /// @return The INVESTOR_ROLE hash
+    // solhint-disable func-name-mixedcase
     function INVESTOR_ROLE() external view returns (bytes32);
 
     /// @notice Returns whether an account has a role

chain/src/facets/StockFacet.sol

@@ -22,6 +22,9 @@ interface IStakeholderFacet {
     /// @notice Thrown when attempting to link an address that's already linked
     error AddressAlreadyLinked(address wallet_address);
 
+    /// @notice Thrown when no stakeholder exists
+    error NoStakeholder();
+
     /// @notice Create a new stakeholder
     /// @dev Only OPERATOR_ROLE can create stakeholders
     /// @param _id The unique identifier for the stakeholder
@@ -33,6 +36,14 @@ interface IStakeholderFacet {
     /// @param wallet_address The address to link
     function linkStakeholderAddress(bytes16 stakeholder_id, address wallet_address) external;
 
+    /// @notice Get the stakeholder ID for a given address
+    /// @param wallet_address The address to get the stakeholder ID for
+    /// @param ensure_exists If true, will revert if the address is not linked to a stakeholder
+    function getStakeholderId(address wallet_address, bool ensure_exists) external view returns (bytes16);
+
+    /// @notice Get stakeholder idx for a stakeholder id
+    function getStakeholderIndex(bytes16 stakeholder_id) external view returns (uint256);
+
     /// @notice Get all positions for a stakeholder
     /// @dev INVESTOR_ROLE can only view their own positions, OPERATOR_ROLE and above can view any
     /// @param stakeholder_id The stakeholder to get positions for