Last updated
Last updated
Inherits: ContextUpgradeable, HubOwnableUUPSUpgradeable, IDocumentRegistry
Author: Daniel Yamagata & Jerry Qi
A registry that keeps track of documents for departments and treasuries
ContextUpgradeable's _msgSender() is used instead of msg.sender to support gas relayers in the future if needed Document indices and versions are indexed at zero
Adds a document to the registry for the caller
This function is not access controlled: any account can add a document to the registry if desired
Returns
Updates the document associated with 'documentIndex' in the registry for the caller
This function will revert if the 'documentIndex' is invalid
Parameters
Returns
Returns all of the latest documents associated with an 'owner'
Parameters
Returns
Returns the latest document given an 'owner' and 'documentIndex'
Returns a document given an 'owner', 'documentIndex', and 'documentVersion'
This function will revert if the document does not exist
Parameters
Returns
Validates that the document exists, reverts if it does not
<none>
uint256
The document index, which is incremented sequentially for the caller
documentIndex
uint256
The index of the document to update
updatedDocumentName
string
The updated name of the document
updatedDocumentUri
string
The updated URI of the document
<none>
uint256
The version of the document, which is incremented sequentially upon each update
owner
address
The owner of the documents
<none>
DataTypes.Document[]
A list of documents as a 'DataTypes.Document' array
owner
address
The owner of the document
documentIndex
uint256
The index of the document
documentVersion
uint256
The version of the document
<none>
DataTypes.Document
The document as a 'DataTypes.Document' struct