docs: update event invariant docs

farcasterxyz / contracts

Implementation of the Farcaster contracts

https://www.farcaster.xyz/

MIT License

340 stars 122 forks source link

Closed varunsrin closed 1 year ago

varunsrin commented 1 year ago

Update docs that explain how Hubs rely on events.

Update docs

[x] The PR title adheres to the conventional commits standard
[x] The PR has been tagged with change type label(s) (i.e. documentation, feature, bugfix, or chore)
[x] The PR's changes adhere to all the requirements in the contribution guidelines
[x] This PR does not require changes to the Farcaster protocol

github-actions[bot] commented 1 year ago

Coverage after merging varunsrin/update-event-invariant-docs into main will be

98.70%

Coverage Report

File	Stmts	Branches	Funcs	Lines	Uncovered Lines
src
Bundler.sol	100%	100%	100%	100%
FnameResolver.sol	100%	100%	100%	100%
IdRegistry.sol	100%	100%	100%	100%
KeyRegistry.sol	100%	100%	100%	100%
StorageRegistry.sol	100%	100%	100%	100%
src/lib
Signatures.sol	100%	100%	100%	100%
TransferHelper.sol	0%	0%	0%	0%	15, 15, 15, 25–26, 26, 26
TrustedCaller.sol	100%	100%	100%	100%