Add PlaintextEnvelope

[neekolas]

Summary

Adds a new PlainTextEnvelope that wraps both the EncodedContent and the idempotency_key fields.

It's important to clearly differentiate where this envelope is used, and where we want to break things apart.

Data going over the wire to the API: A serialized MlsEnvelope is the result of decrypting the data field of a V1 GroupMessage
Data stored in the DB: content and idempotency_key stored separately
Messages returned to callers of list or stream methods: content is only returned

Generally I don't think the idempotency key should ever make its way over the FFI boundary to integrators. WDYT about that?

Other names considered

• Envelope. We already have a V1 Envelope, which has unencrypted fields. Seems confusing
• EncryptedEnvelope. Feels unclear whether the contents are encrypted or whether this message is meant to be encrypted
• InnerEnvelope. I don't hate this, although it's probably more accurate to say that it's in the middle. EncodedContent lives inside of it.

Issue

xmtp/libxmtp#529

[richardhuaaa]

Data stored in the DB: content and idempotency_key stored separately

Do you mean the libxmtp DB here? Could we just use the key to derive and store the message_id, and then throw the key away?

Generally I don't think the idempotency key should ever make its way over the FFI boundary to integrators. WDYT about that?

That makes a lot of sense!

[richardhuaaa]

There's 7k lines removed here - do you need to add the code-genned stuff back?

[neekolas]

Do you mean the libxmtp DB here? Could we just use the key to derive and store the message_id, and then throw the key away?

I'd be fine with that. Just need to make sure it works for all retry scenarios (I think it should). I'll leave that up to @tuddman

[tuddman]

Normally I love a PR that reduces LoC + increases functionality, but: Is this intentional & correct?

[richardhuaaa]

Other names considered

Maybe DecryptedMessageEnvelope, or DecryptedEnvelope or PlaintextEnvelope? MlsEnvelope is fine too

[neekolas]

Something must have gone haywire in the go generator. Re-ran it and it added the code back

[neekolas]

@richardhuaaa I don't mind PlaintextEnvelope

[tuddman]

@richardhuaaa I don't mind PlaintextEnvelope

👍 That's the clearest by my reading in describing what this is.

[github-actions]

🎉 This PR is included in version 3.44.0 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀