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.

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

Update AIP 2.0 to clarified commits, remove some RFCs, retire Please Ack #814

Merged
merged 7 commits into from
Mar 13, 2024
Merged

Update AIP 2.0 to clarified commits, remove some RFCs, retire Please Ack #814

merged 7 commits into from
Mar 13, 2024

Conversation

swcurran
Copy link
Member

@swcurran swcurran commented Feb 16, 2024

This PR updates the definition of AIP 2.0 to update the commits of included RFCs to the latest clarified versions of the RFC, and removes three of the RFCs from the definition of AIP 2.0. Further, the status of one of the removed RFCs (please_ack) is updated to RETIRED, with the background on why it was retired. We'll discuss at a future Aries Working Group call the unchanged "AIP 2.0" in the face of removed RFCs from the Profile. I think, given the state of the AIP, it is acceptable that we do this, given that no one has implemented the removed RFCs.

The full list of categorized changes made are included here, with DISCUSS annotations on specific ones to be talked about at an upcoming Aries Working Group call.

Updated Commits to AIP 2.0 RFCs -- Status Change to Adopted Only

Updated Commits to AIP 2.0 -- Clarifications

  • RFC 0003 Protocols
    • Status update to Adopted, Clarifications and additional guidance about the handling of minor differences in protocols by implementations.
  • RFC 0008 Message ID and Threading
    • Status update to Adopted, clarification on having an empty ~thread on a first message.
  • DISCUSS RFC 0627 Static Peer DIDs
    • Status was recently updated to Retired -- so it makes sense to remove it from the AIP 2.0 list.
    • Update the status line in the RFC to reflect it has been retired.
  • DISCUSSED - Good RFC 0519 Goal Codes
    • Added some commonly used Goal Codes
  • DISCUSSED - Good RFC 0015 Acks
    • Clarification that an "Ack" value should not be "Fail" and Acks relationship with RFC 0035 Problem Report
  • DISCUSS RFC 0023 DID Exchange
    • Status update to Adopted, added to example the use of a DID Rotate attachment to include a signature on the the DID
    • Title of the RFC is 1.0, and the version does not seem to have been changed, but there is a reference to a 1.1 version with the DID Rotate.
  • DISCUSSED - Good RFC 0035 Report Problem
    • Clarification that a description.code is required, clarification on conventions for warnings
  • RFC 0044 DIDComm File and MIME Types
    • Clarifications on fallbacks for the mime types and why, and on using JWEs.
  • RFC 0211 Route Coordination
    • Adds a comma to the example, correcting a typo.
  • RFC 0434 Out of Band
    • Status update to Adopted, clarification that did:peer:2 can be used for reuse.
  • RFC 0592 Indy Attachments
    • Status update to Adopted, clarification on handling "unrevealed attributes" and clarification on encoding integer strings as numbers (e.g. encoding both "1" vs. 1 as integers)
  • RFC 0510 DIF Presentation Exchange Attachment
    • Status update to Adopted, correction of reference into the DIF spec that there is an "s" on "definitions" in dif/presentation-exchange/[email protected]

Not Updated

Removed from AIP 2.0

  • DISCUSSED - Good RFC 0587 Encryption Envelope V2
    • Remove from AIP 2.0 as not needed until we are transitioning to DIDComm V2.
  • DISCUSSED - Good RFC 0317 Please ACK
    • Remove from AIP 2.0 as overly complicated and not helpful. Better to be implemented on a per protocol basis as needed.
    • PR also marks the RFC as "RETIRED" and provides the details about why it was retired, with pointers to the details about a design and code that attempted to implement the functionality, and illustrates why the attempt do not meet the intention of the RFC.

I think leaving the name "AIP 2.0" is acceptable because:

  • No one (AFAWK) had implemented the RFCs to be removed.
  • Bumping the version would cause more confusion than it is worth.

@swcurran swcurran requested a review from TelegramSam February 16, 2024 17:56
@swcurran
Copy link
Member Author

swcurran commented Feb 21, 2024

Updates made after community discussion at the 20240221 Aries Working Group Meeting. Updates:

  • Looked again at 0211 Route Coordination and my interpretation of what had changed was way off -- it was just the addition of a missing comma. Put back to the "Clarified" list and updated the commit in the AIP 2.0 list.
  • Moved 0023 DID Exchange to the "not updated' category and reverted the link as the recent changes to DID Exchange are beyond AIP 2.0.
  • Put 0627 back into the list of clarified, and added a comment about it remains, but implementers should use DID Peer 2 and 4.

Further updates to 0627 may be needed.

Signed-off-by: Stephen Curran <[email protected]>
Copy link
Contributor

@TelegramSam TelegramSam left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Discussed WG 20240313. Approved for merge by WG. Will need several subsequent PRs to clarify smaller sections as other PRs are merged and discussions occur.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants