-
Notifications
You must be signed in to change notification settings - Fork 0
docs: add attestation service documentation and diagram #105
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
Conversation
Reviewer's Guide by SourceryThis PR adds comprehensive documentation for the Ethereum Attestation Service (EAS), including detailed guides for setup, implementation, and usage. The documentation is implemented as a Markdown file with embedded code examples, diagrams, and interactive tabs. Class diagram for Ethereum Attestation Service (EAS) componentsclassDiagram
class SchemaRegistry {
+register(string schema, address resolver, bool revocable) returns (bytes32)
+event Registered(bytes32 uid, address owner, string schema, address resolver, bool revocable)
}
class EAS {
+attest(schema, data)
+getAttestation(bytes32 attestationUID)
}
class CustomResolver {
+validate(bytes32 attestationUID, address attester, bytes data) returns (bool)
+mapping(address => bool) trustedAttesters
}
SchemaRegistry --> EAS : uses
EAS --> CustomResolver : optional validation
note for SchemaRegistry "Manages schemas for attestations"
note for EAS "Handles creation and management of attestations"
note for CustomResolver "Provides additional validation logic"
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hey @SaeeDawod - I've reviewed your changes - here's some feedback:
Overall Comments:
- Consider adding a security best practices section that covers proper handling of private keys and API endpoints. The current examples show these values directly in code which could encourage unsafe practices.
- The error handling examples could be expanded to show more comprehensive error cases and recovery strategies, particularly in the verification section.
Here's what I looked at during the review
- 🟡 General issues: 1 issue found
- 🟢 Security: all looks good
- 🟢 Review instructions: all looks good
- 🟢 Testing: all looks good
- 🟢 Complexity: all looks good
- 🟢 Documentation: all looks good
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>
Summary by Sourcery
Documentation: