-
Notifications
You must be signed in to change notification settings - Fork 11
Open
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationenhancementNew feature or requestNew feature or requestgood first issueGood for newcomersGood for newcomershacktoberfest
Description
The concept of 'context' in Reclaim Protocol is crucial but could be explained more clearly and comprehensively in both the frontend.mdx and backend.mdx files.
Tasks:
- In both files, expand the section on context to include:
- A clear definition of what 'context' means in Reclaim Protocol
- The importance of context in securing proofs and preventing misuse
- Detailed explanation of the 'address' and 'message' components of context
- Add more diverse examples of how context can be used effectively:
- Example for a blockchain application using the address field
- Example for a web application using the message field for freshness
- Example combining both address and message for maximum security
- Include best practices for generating and verifying context
- Add a section on common pitfalls or misunderstandings about context
- Provide code snippets demonstrating how to add, retrieve, and verify context in both frontend and backend implementations
- Include a troubleshooting section for context-related issues
Enhancing this explanation will help developers better understand and utilize the context feature, improving the security and specificity of their Reclaim Protocol implementations.
Contributors: Please note that by submitting a pull request, you are agreeing to accept and sign the Contributor License Agreement (CLA) found at https://github.com/reclaimprotocol/.github/blob/main/CLA.md
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationenhancementNew feature or requestNew feature or requestgood first issueGood for newcomersGood for newcomershacktoberfest