Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Deprecate the Composite Codec: XIP-9 #37

Merged
merged 5 commits into from
Jan 29, 2024
Merged

Deprecate the Composite Codec: XIP-9 #37

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
803aaae
draft
jhaaaa Jan 10, 2024
8a9151d
Merge branch 'main' of github.com:xmtp/XIPs into deprecate-cc
jhaaaa Jan 10, 2024
50da8ed
Merge branch 'main' of github.com:xmtp/XIPs into deprecate-cc
jhaaaa Jan 10, 2024
66401a7
add disc link, update status to review
jhaaaa Jan 10, 2024
ee94dc2
to last call status
jhaaaa Jan 27, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 48 additions & 0 deletions XIPs/xip-19-deprecate-comp-codec.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
---
xip: 19
title: Deprecate the Composite Codec
description: Proposal to deprecate the Composite Codec
author: Naomi Plasterer (@nplasterer)
discussions-to: https://community.xmtp.org/t/deprecate-the-composite-codec/525
status: Last Call
type: Standards Track
category: XRC
created: 2024-01-09
replaces: XIP-9
---

## Abstract

This is a proposal to deprecate the Composite Codec defined by [XIP-9 Composite Content Type](https://github.com/xmtp/XIPs/blob/main/XIPs/xip-9-composite-content-type.md).

This content type was meant to be used for multi-part messages where the parts can be of any content type, and the composite parts can be arbitrarily nested.

## Motivation

Despite its original intent, the Composite Codec’s sole impact on XMTP has been to introduce unnecessary complications for developers.

## Specification

The keywords “MUST”, “MUST NOT”, “REQUIRED”, “SHALL”, “SHALL NOT”, “SHOULD”, “SHOULD NOT”, “RECOMMENDED”, “MAY”, and “OPTIONAL” in this document are to be interpreted as described in [RFC 2119](https://www.ietf.org/rfc/rfc2119.txt).

To deprecate the Composite Codec, it must be removed as a supported standard content type from the XMTP SDKs (iOS, Android, JS, and Flutter).

## Rationale

To date, the XMTP developer community has not seen a standard and compelling use case for using the Composite Codec. People using it have found it confusing and hard to use because it's difficult to provide clear fallback text, given the complexity of the content. For any use that the XMTP Labs core developer team has seen, we recommend using a custom content type instead.

Considering the confusion the content type introduces and the lack of adoption, this proposal recommends deprecation.

## Backward Compatibility

Once the Composite Codec has been deprecated, you can still use it by adding it to your project as a custom content type.

However, we recommend that you check in with the [XMTP Community Forums](https://community.xmtp.org/c/development/ideas/54) first, as the developer community may have since developed a better custom content type or standard to handle your use case.

## Security Considerations

There are no known negative security implications introduced by deprecating the Composite Codec.

## Copyright

Copyright and related rights waived via [CC0](https://creativecommons.org/publicdomain/zero/1.0/)
Loading