Skip to content

Commit 8d1cab1

Browse files
typfelcoriolinus
andcommitted
chore(book): add section on key packages in the migration guide
Co-authored-by: Peter Goodspeed-Niklaus <coriolinus@users.noreply.github.com>
1 parent d1a8c18 commit 8d1cab1

File tree

2 files changed

+8
-2
lines changed

2 files changed

+8
-2
lines changed

CHANGELOG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -265,7 +265,7 @@
265265

266266
Affected platforms: all
267267

268-
Migration: to create key packages after initializing MLS, call `clientKeypackages()` in a transaction.
268+
Migration: to create key packages after initializing MLS, call `generateKeypackage()` in a transaction.
269269

270270
- `proteusErrorCode` field was removed from the root error type. Affected platforms: web
271271

cc-book/modules/ROOT/partials/cc10-migration.adoc

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,11 +22,17 @@ endif::[]
2222
== MLS Initialization
2323

2424
. `mlsInit()` was decoupled from key package creation.
25-
To create key packages after initializing MLS, call `clientKeypackages()` in a transaction.
25+
To create key packages after initializing MLS, call `CoreCryptoContext.generateKeypackage()` in a transaction.
2626

2727
. removed `CoreCrypto.provideTransport()`, added `transport` parameter to `CoreCryptoContext.mlsInit()`
2828
Instead of providing transport separately from MLS initialization provide it when calling `mlsInit()`.
2929

30+
== Key Packages
31+
32+
. We *removed* `CoreCryptoContext.clientKeypackages()`. To generate a desired amount of key packages, make repeated calls to `CoreCryptoContext.generateKeypackage()`.
33+
34+
. We *removed* `CoreCryptoContext.clientValidKeypackagesCount()`. To count remaining key packages, call `CoreCryptoContext.getKeypackages()`, and filter the results as desired, and count the remaining items.
35+
3036
== Logging
3137

3238
. We *removed* `CoreCrypto.setLogger(logger: CoreCryptoLogger, level: CoreCryptoLogLevel)`

0 commit comments

Comments
 (0)