Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add assumptions made by off-chain services #303

Merged
merged 2 commits into from
Aug 1, 2023

Conversation

varunsrin
Copy link
Member

@varunsrin varunsrin commented Aug 1, 2023

Motivation

Add docs clarifying the assumptions that off-chain services make on the contracts

Change Summary

See above

Merge Checklist


PR-Codex overview

Detailed summary

  • Added documentation for the L2 contracts: Id Registry, Storage Registry, Key Registry, and Bundler.
  • Added documentation for the L1 contract: Fname Resolver.
  • Added documentation for the off-chain systems: Fname Registry and Hubs.

✨ Ask PR-Codex anything about this PR by commenting with /codex {your question}

@varunsrin varunsrin added the docs Improvements or additions to documentation label Aug 1, 2023
@varunsrin varunsrin self-assigned this Aug 1, 2023
@varunsrin varunsrin force-pushed the varunsrin/document-offchain-assumptions branch from 70a251f to f3362ab Compare August 1, 2023 05:40
docs/docs.md Outdated Show resolved Hide resolved
@github-actions
Copy link

github-actions bot commented Aug 1, 2023

Coverage after merging varunsrin/document-offchain-assumptions into main will be

98.70%

Coverage Report
FileStmtsBranchesFuncsLinesUncovered Lines
src
   Bundler.sol100%100%100%100%
   FnameResolver.sol100%100%100%100%
   IdRegistry.sol100%100%100%100%
   KeyRegistry.sol100%100%100%100%
   StorageRegistry.sol100%100%100%100%
src/lib
   Signatures.sol100%100%100%100%
   TransferHelper.sol0%0%0%0%15, 15, 15, 25–26, 26, 26
   TrustedCaller.sol100%100%100%100%

@varunsrin varunsrin merged commit 3d36634 into main Aug 1, 2023
2 checks passed
@varunsrin varunsrin deleted the varunsrin/document-offchain-assumptions branch August 1, 2023 13:08
Hmac512 pushed a commit to Hmac512/farcaster-contracts that referenced this pull request Aug 2, 2023
* docs: add assumptions made by off-chain services

* docs: update confirmation threshold
Hmac512 pushed a commit to Hmac512/farcaster-contracts that referenced this pull request Aug 2, 2023
* docs: add assumptions made by off-chain services

* docs: update confirmation threshold
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants