Skip to content

Commit 3ee6472

Browse files
hughnst3chguy
andauthored
Add note about MSC3886, MSC3903 and MSC3906 being closed (#4189)
* Add note about MSC3886, MSC3903 and MSC3906 being closed * Move comments in to jsdoc --------- Co-authored-by: Michael Telatynski <7t3chguy@gmail.com>
1 parent 909caab commit 3ee6472

File tree

3 files changed

+9
-0
lines changed

3 files changed

+9
-0
lines changed

src/rendezvous/MSC3906Rendezvous.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,9 @@ const LOGIN_TOKEN_PROTOCOL = new UnstableValue("login_token", "org.matrix.msc390
5959
* Implements MSC3906 to allow a user to sign in on a new device using QR code.
6060
* This implementation only supports generating a QR code on a device that is already signed in.
6161
* Note that this is UNSTABLE and may have breaking changes without notice.
62+
* MSC3886/MSC3903/MSC3906 are now closed and so this functionality will be removed in future.
63+
* However, we want to keep this implementation around for some time.
64+
* TODO: define an end-of-life date for this implementation.
6265
*/
6366
export class MSC3906Rendezvous {
6467
private newDeviceId?: string;

src/rendezvous/channels/MSC3903ECDHv2RendezvousChannel.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,9 @@ async function importKey(key: Uint8Array): Promise<CryptoKey> {
6969
* Implementation of the unstable [MSC3903](https://github.com/matrix-org/matrix-spec-proposals/pull/3903)
7070
* X25519/ECDH key agreement based secure rendezvous channel.
7171
* Note that this is UNSTABLE and may have breaking changes without notice.
72+
* MSC3886/MSC3903/MSC3906 are now closed and so this functionality will be removed in future.
73+
* However, we want to keep this implementation around for some time.
74+
* TODO: define an end-of-life date for this implementation.
7275
*/
7376
export class MSC3903ECDHv2RendezvousChannel<T> implements RendezvousChannel<T> {
7477
private olmSAS?: SAS;

src/rendezvous/transports/MSC3886SimpleHttpRendezvousTransport.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,9 @@ export interface MSC3886SimpleHttpRendezvousTransportDetails extends RendezvousT
3737
* Implementation of the unstable [MSC3886](https://github.com/matrix-org/matrix-spec-proposals/pull/3886)
3838
* simple HTTP rendezvous protocol.
3939
* Note that this is UNSTABLE and may have breaking changes without notice.
40+
* MSC3886/MSC3903/MSC3906 are now closed and so this functionality will be removed in future.
41+
* However, we want to keep this implementation around for some time.
42+
* TODO: define an end-of-life date for this implementation.
4043
*/
4144
export class MSC3886SimpleHttpRendezvousTransport<T extends {}> implements RendezvousTransport<T> {
4245
private uri?: string;

0 commit comments

Comments
 (0)