refactor: clean up legacy stuff (#148)

* refactor: streamline issue and revoke function names

* refactor: remove legacy functions

* refactor: clean up imports

* refactor: zero address owner custom error

* chore: remove legacy files

src/BaseDocumentStore.sol

@@ -2,15 +2,14 @@
 
 pragma solidity ^0.8.0;
 
-import "@openzeppelin/contracts/access/Ownable.sol";
 import "@openzeppelin/contracts-upgradeable/proxy/utils/Initializable.sol";
 import {IDocumentStore} from "./interfaces/IDocumentStore.sol";
 
 /**
  * @title BaseDocumentStore
  * @notice A base contract for storing and revoking documents
  */
-contract BaseDocumentStore is Initializable, IDocumentStore {
+abstract contract BaseDocumentStore is Initializable, IDocumentStore {
   /**
    * @notice The name of the contract
    */
@@ -40,16 +39,6 @@ contract BaseDocumentStore is Initializable, IDocumentStore {
    */
   function _issue(bytes32 document) internal {
     documentIssued[document] = block.number;
-    // emit DocumentIssued(document);
-  }
-
-  /**
-   * @notice Gets the block number at which a document was issued
-   * @param document The hash of the issued document
-   * @return The block number at which the document was issued
-   */
-  function getIssuedBlock(bytes32 document) public view onlyIssued(document) returns (uint256) {
-    return documentIssued[document];
   }
 
   /**
@@ -61,16 +50,6 @@ contract BaseDocumentStore is Initializable, IDocumentStore {
     return (documentIssued[document] != 0);
   }
 
-  /**
-   * @notice Checks if a document was issued before a specific block number (inclusive)
-   * @param document The hash of the document to check
-   * @param blockNumber The block number to check against
-   * @return A boolean indicating whether the document was issued before the specified block number
-   */
-  function isIssuedBefore(bytes32 document, uint256 blockNumber) public view returns (bool) {
-    return documentIssued[document] != 0 && documentIssued[document] <= blockNumber;
-  }
-
   /**
    * @notice Revokes a document
    * @param document The hash of the document to revoke
@@ -87,23 +66,4 @@ contract BaseDocumentStore is Initializable, IDocumentStore {
   function _isRevoked(bytes32 document) internal view returns (bool) {
     return documentRevoked[document] != 0;
   }
-
-  /**
-   * @notice Checks if a document was revoked before a specific block number (inclusive)
-   * @param document The hash of the document to check
-   * @param blockNumber The block number to check against
-   * @return A boolean indicating whether the document was revoked before the specified block number
-   */
-  function isRevokedBefore(bytes32 document, uint256 blockNumber) public view returns (bool) {
-    return documentRevoked[document] <= blockNumber && documentRevoked[document] != 0;
-  }
-
-  /**
-   * @dev Checks if a document has been issued
-   * @param document The hash of the document to check
-   */
-  modifier onlyIssued(bytes32 document) {
-    require(_isIssued(document), "Error: Only issued document hashes can be revoked");
-    _;
-  }
 }

src/DocumentStore.sol

@@ -2,10 +2,7 @@
 
 pragma solidity ^0.8.0;
 
-import "@openzeppelin/contracts-upgradeable/access/OwnableUpgradeable.sol";
-import "@openzeppelin/contracts-upgradeable/proxy/utils/Initializable.sol";
 import "@openzeppelin/contracts/utils/cryptography/MerkleProof.sol";
-
 import "./BaseDocumentStore.sol";
 import "./base/DocumentStoreAccessControl.sol";
 
@@ -40,7 +37,7 @@ contract DocumentStore is DocumentStoreAccessControl, BaseDocumentStore {
    * @param documentRoot The hash of the document to issue
    */
   function issue(bytes32 documentRoot) public onlyRole(ISSUER_ROLE) {
-    if (isRootIssued(documentRoot)) {
+    if (isIssued(documentRoot)) {
       revert DocumentExists(documentRoot);
     }
 
@@ -63,7 +60,7 @@ contract DocumentStore is DocumentStoreAccessControl, BaseDocumentStore {
    * @notice Revokes a document
    * @param documentRoot The hash of the document to revoke
    */
-  function revokeRoot(bytes32 documentRoot) public onlyRole(REVOKER_ROLE) {
+  function revoke(bytes32 documentRoot) public onlyRole(REVOKER_ROLE) {
     revoke(documentRoot, documentRoot, new bytes32[](0));
   }
 
@@ -101,7 +98,7 @@ contract DocumentStore is DocumentStoreAccessControl, BaseDocumentStore {
     return _isIssued(documentRoot);
   }
 
-  function isRootIssued(bytes32 documentRoot) public view returns (bool) {
+  function isIssued(bytes32 documentRoot) public view returns (bool) {
     return isIssued(documentRoot, documentRoot, new bytes32[](0));
   }
 
@@ -113,14 +110,10 @@ contract DocumentStore is DocumentStoreAccessControl, BaseDocumentStore {
     if (!isIssued(documentRoot, document, proof)) {
       revert InvalidDocument(documentRoot, document);
     }
-    return _isRevokedInternal(documentRoot, document, proof);
+    return _isRevoked(documentRoot, document, proof);
   }
 
-  function _isRevokedInternal(
-    bytes32 documentRoot,
-    bytes32 document,
-    bytes32[] memory proof
-  ) internal view returns (bool) {
+  function _isRevoked(bytes32 documentRoot, bytes32 document, bytes32[] memory proof) internal view returns (bool) {
     if (documentRoot == document && proof.length == 0) {
       return _isRevoked(document);
     }
@@ -132,15 +125,15 @@ contract DocumentStore is DocumentStoreAccessControl, BaseDocumentStore {
    * @param documentRoot The hash of the document to check
    * @return A boolean indicating whether the document has been revoked
    */
-  function isRootRevoked(bytes32 documentRoot) public view returns (bool) {
+  function isRevoked(bytes32 documentRoot) public view returns (bool) {
     return isRevoked(documentRoot, documentRoot, new bytes32[](0));
   }
 
   function isActive(bytes32 documentRoot, bytes32 document, bytes32[] memory proof) public view returns (bool) {
     if (!isIssued(documentRoot, document, proof)) {
       revert InvalidDocument(documentRoot, document);
     }
-    return !_isRevokedInternal(documentRoot, document, proof);
+    return !_isRevoked(documentRoot, document, proof);
   }
 
   modifier onlyValidDocument(

src/base/DocumentStoreAccessControl.sol

@@ -9,6 +9,8 @@ import "@openzeppelin/contracts-upgradeable/access/AccessControlUpgradeable.sol"
  * @notice Base contract for managing access control roles for a DocumentStore
  */
 contract DocumentStoreAccessControl is AccessControlUpgradeable {
+  error ZeroOwner();
+
   bytes32 public constant ISSUER_ROLE = keccak256("ISSUER_ROLE");
   bytes32 public constant REVOKER_ROLE = keccak256("REVOKER_ROLE");
 
@@ -17,7 +19,9 @@ contract DocumentStoreAccessControl is AccessControlUpgradeable {
    * @param owner The owner of the contract
    */
   function __DocumentStoreAccessControl_init(address owner) internal onlyInitializing {
-    require(owner != address(0), "Owner is zero");
+    if (owner == address(0)) {
+      revert ZeroOwner();
+    }
     _grantRole(DEFAULT_ADMIN_ROLE, owner);
     _grantRole(ISSUER_ROLE, owner);
     _grantRole(REVOKER_ROLE, owner);