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.

Sign up for GitHub

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

feat(dehydration): support for dehydration key and storage #179

Merged
merged 1 commit into from
Dec 20, 2024
+234 −120
Merged

feat(dehydration): support for dehydration key and storage #179

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,13 @@
# UNRELEASED

**BREAKING CHANGES**

- Update matrix-rusk-sdk to `0.9.0`.
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@andybalaam Should I use a git hash here too? even it is this actual tag, or link the tag?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think what you have is sufficient.

- Expose new API `DehydratedDevices.getDehydratedDeviceKey`, `DehydratedDevices.saveDehydratedDeviceKey`
and `DehydratedDevices.deleteDehydratedDeviceKey` to store/load the dehydrated device pickle key.
`DehydratedDevices.keysForUpload` and `DehydratedDevices.rehydrate` now use the `DehydratedDeviceKey` as parameter
instead of a raw UInt8Array.Use `DehydratedDeviceKey::createKeyFromArray` to migrate.
Comment on lines +8 to +9
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry, a belated review:

  • I think this point about keysForUpload and rehydrate should be a separate bullet point
  • The other points ("Update matrix-rusk-sdk to 0.9.0" and "Expose new API") aren't breaking changes so should be above the "BREAKING CHANGES" header (see matrix-sdk-crypto-wasm v12.0.0, for example)
  • It would be good to link to this pr for the changes (see lots of other entries in the changelog, for example)
  • There are a number of typos on line 9. It should be: 
        instead of a raw `UInt8Array`. Use `DehydratedDeviceKey.createKeyFromArray` to migrate.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[suggest fixing these as part of #187]


# matrix-sdk-crypto-wasm v12.1.0

- Update matrix-rusk-sdk to `37c17cf854a70f` for the fix for
Expand Down
Loading
Loading