From 70eeffbbb082453bd171e33ed14be052bcc844b1 Mon Sep 17 00:00:00 2001 From: Ivan Enderlin Date: Mon, 12 Sep 2022 09:47:33 +0200 Subject: [PATCH] doc(qrcode): Update documentation. Since we have switched to Vodozemac, those values don't need to be unpadded base64 anymore. --- crates/matrix-sdk-qrcode/src/types.rs | 22 +++++++--------------- 1 file changed, 7 insertions(+), 15 deletions(-) diff --git a/crates/matrix-sdk-qrcode/src/types.rs b/crates/matrix-sdk-qrcode/src/types.rs index 0697df898..2332261c1 100644 --- a/crates/matrix-sdk-qrcode/src/types.rs +++ b/crates/matrix-sdk-qrcode/src/types.rs @@ -389,9 +389,7 @@ impl VerificationData { /// `m.key.verification.request` event that initiated the /// verification flow this QR code should be part of. /// - /// * `first_master_key` - Our own cross signing master key. Needs to be - /// encoded as - /// unpadded base64 + /// * `first_master_key` - Our own cross signing master key. /// /// * `second_master_key` - The cross signing master key of the other user. /// @@ -491,14 +489,11 @@ impl SelfVerificationData { /// transaction id was sent by the `m.key.verification.request` event /// that initiated the verification flow this QR code should be part of. /// - /// * `master_key` - Our own cross signing master key. Needs to be encoded - /// as - /// unpadded base64 + /// * `master_key` - Our own cross signing master key. /// - /// * `device_key` - The ed25519 key of the other device, encoded as - /// unpadded base64. + /// * `device_key` - The ed25519 key of the other device. /// - /// * ` shared_secret` - A random bytestring encoded as unpadded base64, + /// * `shared_secret` - A random bytestring encoded as unpadded base64, /// needs to be at least 8 bytes long. pub fn new( transaction_id: String, @@ -594,14 +589,11 @@ impl SelfVerificationNoMasterKey { /// transaction id was sent by the `m.key.verification.request` event /// that initiated the verification flow this QR code should be part of. /// - /// * `device_key` - The ed25519 key of our own device, encoded as unpadded - /// base64. + /// * `device_key` - The ed25519 key of our own device. /// - /// * `master_key` - Our own cross signing master key. Needs to be encoded - /// as - /// unpadded base64 + /// * `master_key` - Our own cross signing master key. /// - /// * ` shared_secret` - A random bytestring encoded as unpadded base64, + /// * `shared_secret` - A random bytestring encoded as unpadded base64, /// needs to be at least 8 bytes long. pub fn new( transaction_id: String,