🎃 Hacktoberfest Project Hub: dwn-sdk-js

[taniashiba]

📦 Project Hub

🚀 Project Goal

Improve the security and performance for handling protocol records and permissions. Let's add features and address bugs to improve testing frameworks, improve record handling, tighten cryptographic implementations and more.

🤝 Pick ONE of the following issues to contribute to this project

❗You must only assign yourself one task at a time to give everyone a chance to participate.❗

You may assign yourself your next task after your current task is reviewed & accepted.

🚫 You must not steal an issue assigned to another person. If you submit a PR for an issue not assigned to you, you will not receive points. 🚫

We've broken down all issues into smaller tasks. Feel free to take on any task that interests you. Every contribution counts!

Each subtask is detailed in its own issue. Please refer to the individual issues for specific requirements and acceptance criteria.

🔧 Features

• Allow indexing + filtering/querying by creator #800
• Add protocol-tagging index to RecordsDelete PermissionProtocol messages #768
• RecordsRead should not fail if multiple values exist #739
• Add lowS: false flag to secp256k1.ts verify #714
• Investigate adding an error for invalid PaginationCursor value type. #664
• Add a limit to protocol record level depth #585
• Add protocol rule to determine if records must, must not, or may make records published #295

🐛 Bug Fixes

• RecordDelete is not being received in a subscription when it is expected #759
• Revisit logic for deleting grant-authorized records when handling a permission revocation RecordsWrite #716
• Given author in non-owner query/subscribe filter is overwritten  #669
• Investigate if author is referenced correctly when latest state of a Records is not authored by the initial record author #630

🚧 Refactoring

• Consolidate HKDF implementation and usage with web5-js #742
• Replace built-in crypto library with @web5/crypto #672
• Replace silent failures with explicit failures in index-level.ts #633

🧪 Testing

• Investigate how descendent roles are handled regarding read #691
• Replace Karma with Web Test Runner #657
• Increase code coverage (even if just by a little bit) #136

📚 Documentation

• Export all types that are referenced by all exported types #686
• Fix Typo for Code of Conduct in Contributing.MD Getting Started Section #824

🌟 Resources

• Web5 Protocols Documentation
• Web5 JS source code
• DWN SDK JS source code
• JSON Schema

🎊 Hacktoberfest

This project is part of Hacktoberfest! We welcome contributions from technologists of all skill levels. Here's how you can get started:

1. Read the Contributing Guidelines
2. Read the Code of Conduct
3. Choose a subtask that interests you
4. Comment ".take" on the corresponding issue to get assigned the task. Please assign yourself to one task at a time.
5. Fork the repository and create a new branch for your task
6. Follow the instructions in the subtask
7. Submit a pull request with your changes
8. Respond to any feedback during the review process

Questions?

If you have any questions or need clarification, please comment on this issue or join our community channels.

Happy Hacktoberfest! 🎃👨‍💻👩‍💻