hyperledger / identus-edge-agent-sdk-ts

Apache License 2.0
24 stars 13 forks source link

feat(backup): introduce new schema to minimize backup length #333

Open jeyem opened 1 week ago

jeyem commented 1 week ago

Enhance Backup Efficiency and Flexibility issue 322 This PR introduces several key improvements to the backup functionality:

Compact Backup Schema:

Added a new backup schema (version 0.0.2) designed to minimize the size of backups. This schema reduces storage requirements while maintaining data integrity and compatibility. Enhanced createJWE Options:

Added support for specifying a master encoding key via options, enabling greater flexibility in the encryption process. Integrated optional compression, further optimizing the storage and transfer of backups. Testing and Documentation:

Comprehensive tests were added to validate the new schema and updated createJWE functionality. Inline comments and JSDoc annotations have been included to clarify the implementation details. The package was built manually and tested within the wallet application, confirming successful integration and functionality. Feel free to review, and I’m happy to address any change requests promptly.

Checklist:

elribonazo commented 1 week ago

@jeyem Very nice PR! we are going to need some time to digest, understand and validate this but great work really!

If you need some help setting up the DCO signatures on github commits please follow this link

We'll be reviewing this at some point soon, thank you!

jeyem commented 1 week ago

@jeyem Very nice PR! we are going to need some time to digest, understand and validate this but great work really!

If you need some help setting up the DCO signatures on github commits please follow this link

We'll be reviewing this at some point soon, thank you!

@elribonazo Thank you man, I'll check the signatures issue, my work is not done yet I'll add more functions to agent like Agent.backup.createJwe to cover our backup and restore flow it was just early stage of my work I made this PR Draft for now