From c7dabfc7638ae6ae13b356ec7380b5fb4a94eddc Mon Sep 17 00:00:00 2001 From: Jennifer Hasegawa <5481259+jhaaaa@users.noreply.github.com> Date: Fri, 17 May 2024 14:14:33 -0700 Subject: [PATCH] add xip-28 in stagnant status --- ...stagnant_xip-28-universal-consent-layer.md | 89 +++++++++++++++++++ 1 file changed, 89 insertions(+) create mode 100644 XIPs/z-stagnant_xip-28-universal-consent-layer.md diff --git a/XIPs/z-stagnant_xip-28-universal-consent-layer.md b/XIPs/z-stagnant_xip-28-universal-consent-layer.md new file mode 100644 index 0000000..0e6d27e --- /dev/null +++ b/XIPs/z-stagnant_xip-28-universal-consent-layer.md @@ -0,0 +1,89 @@ +--- +xip: 28 +title: Universal Consent Layer for XMTP +description: Proposes adding a universal consent layer to the XMTP protocol to prevent spam +author: Pol Maire (pol@getconverse.app) +status: Stagnant +type: Standards +category: XRC +created: 2024-01-26 +--- + +**Important**: This XIP inspired [XIP-42: Universal allow and block preferences](https://github.com/xmtp/XIPs/blob/main/XIPs/xip-42-universal-allow-block-preferences.md). For the original pull request that proposed this XIP-28, see [https://github.com/xmtp/XIPs/pull/28](https://github.com/xmtp/XIPs/pull/28). + +## Abstract + +This XIP proposes adding a universal consent layer to the XMTP protocol to prevent spam and allow users to maintain their communication preferences across applications. + +## Motivation + +Currently, the XMTP network allows anyone to write to anyone without the option to opt-in or opt-out of conversations with other users. Implementing a universal consent layer will provide users with more control over their communication preferences, reduce spam, and enhance privacy. + +## Specification + +### Consent layers + +- **Opted-in**: The user has explicitly accepted talking with the other user. + +- **Opted-out**: The user has explicitly blocked the other user by clicking on a button in the interface of an XMTP client. Every conversation with the opted-out user is also considered opted-out. + +- **Neither opted-in nor opted-out**: The user received a message from another user but did not send anything nor click on any consent button. + +### User interface + +- Clients should create a "requests" section in their user interface containing all conversations with users in the "Neither opted-in nor opted-out" category. + +- Clients can add an additional layer of consent, "Implicitly opted-in": + - This is not at the protocol level but only a UX guideline at the client level; hence will not be synced between clients. + - The condition for implicit opt-in of a conversation could be that: + - The user has sent at least one message in the conversation (the client will need to keep syncing messages in the conversation until it reaches the beginning of the conversation or the first message sent by the user). + - There is a good chance of a positive interaction (e.g., having an on-chain transaction with the peer or following the peer on Lens or Farcaster). + +### User settings + +- We need "protocol-level user settings" (= user preferences) to store these consent settings. + - It could be a specific protected topic `settings-0x.....` that clients can write to using the XMTP Key to store encrypted settings. We could either post the whole settings to the topic every time the settings change or have some way to store incremental data. + - This would enable sharing preferences between multiple clients and help clients provide a consistent experience rather than building their preferences outside of the XMTP protocol (where switching to another client would make the user lose their preferences). + - We could all agree on specific "keys" and a format to store some data, including consent data. +- The SDKs would have a simple way to retrieve the settings (like `await client.retrieveUserSettings()`) in a JSON format. +- We would have a specific key called `consent` in the settings, with a format that could look like: + + ```json + { + "consent": { + "version": "1.0.0", + "peers": { + "0xa.....": "OPTED_IN", + "0xb.....": "OPTED_OUT" + } + } + } + ``` + +- It means that we trust the clients to not write malicious data to those settings (i.e., automatically Opt-In to partners, etc.) But we already trust clients with our XMTP keys to not send malicious messages from our accounts, so this is probably OK. + +### Compliance requirement + +This XIP is a requirement for compliant clients. Any contact MUST be tagged with one of the three consent statuses. + +## Rationale + +Introducing a universal consent layer will provide users with more control over their communication preferences, allowing them to avoid unwanted messages and reduce the amount of spam on the XMTP network. + +Additionally, creating a "requests" section in the UI will help users manage their communication requests more effectively. Allowing clients to add an "Implicitly opted-in" layer at the client level will enable seamless communication with trusted users while maintaining user privacy and control. + +## Backward compatibility + +This XIP does not introduce any significant backward compatibility issues. Clients that have previously introduced the ability to "block" users locally can migrate to this protocol-level opt-out mechanism. + +## Implementation + +XMTP clients can start implementing the universal consent layer by incorporating the three consent levels into their existing application logic. + +Clients should update their user interfaces to include the "requests" section and the additional "Implicitly opted-in" layer at the client level, as suggested in this proposal. + +The list of opted-out users should be added to the user settings at the protocol level once they are implemented. + +## Copyright + +This XIP is released under the [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0.html).