docs: update event invariant docs for KeyRegistry, StorageRegistry #304
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Coverage after merging varunsrin/storage-events-docs-invariants into main will be
Coverage Report
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
sanjayprabhu
approved these changes
Aug 1, 2023
Hmac512
pushed a commit
to Hmac512/farcaster-contracts
that referenced
this pull request
Aug 2, 2023
…arcasterxyz#304) * docs: update invariants for KeyRegistry, StorageRegistry * docs: address comments
Hmac512
pushed a commit
to Hmac512/farcaster-contracts
that referenced
this pull request
Aug 2, 2023
…arcasterxyz#304) * docs: update invariants for KeyRegistry, StorageRegistry * docs: address comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation
Update documentation based on feedback.
Change Summary
Updated event invariant documentation
Merge Checklist
PR-Codex overview
Focus of this PR:
This PR focuses on updating the documentation in three contracts:
IdRegistry.sol,StorageRegistry.sol, andKeyRegistry.sol.Detailed summary:
IdRegistry.sol, the documentation for an eventRecoveryAddressChangedhas been updated to mention that the event can emit multiple times with the same recovery address.StorageRegistry.sol, the documentation for an eventStorageRentPaidhas been updated to clarify that storage is credited to unregistered fids and will be assigned when the fid is registered.StorageRegistry.sol, the documentation for an eventSetDeprecationTimestamphas been updated to mention that hubs will track this timestamp to determine when the contract is deprecated.KeyRegistry.sol, the documentation for an eventRemovehas been updated to clarify the invariants that hubs assume regarding the order and existence of events.KeyRegistry.sol, the documentation for an eventAdminResethas been updated to clarify the invariants that hubs assume regarding the order and existence of events.