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

Document Thawing & Redeeming in Escrow.sol to Clarify Expectations of Indexer #60

Closed
ColePBryan opened this issue Aug 23, 2023 · 0 comments · Fixed by #61
Closed

Document Thawing & Redeeming in Escrow.sol to Clarify Expectations of Indexer #60

ColePBryan opened this issue Aug 23, 2023 · 0 comments · Fixed by #61
Assignees
Labels
audit issue Issue found in audit documentation Improvements or additions to documentation

Comments

@ColePBryan
Copy link
Contributor

Enhance the inline documentation in Escrow.sol to clarify:

Thawing Process: Describe the role and implications of thawing funds from the escrow account before withdrawals.
Indexer Actions: Outline expected actions during a thaw that might reduce the escrow balance below the owed amount.
Transparency & Control: Highlight event emissions, account checks, and controls like redeem() and withdraw().
Potential Edge Cases: Touch on possible challenges or unusual behaviors indexers might encounter.
Let's ensure clarity and succinctness in our natdoc comments.

related #32

@ColePBryan ColePBryan self-assigned this Aug 23, 2023
@ColePBryan ColePBryan added documentation Improvements or additions to documentation audit issue Issue found in audit labels Aug 31, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
audit issue Issue found in audit documentation Improvements or additions to documentation
Projects
None yet
1 participant