diff --git a/0000-template-protocol.md b/0000-template-protocol.md index 927f1a3c3..a18427487 100644 --- a/0000-template-protocol.md +++ b/0000-template-protocol.md @@ -1,6 +1,6 @@ # Aries RFC 0000: Your Protocol 0.9 -- Authors: [your name](you@github-email) -- email is optional +- Authors: [your name](mailto:you@github-email) -- email is optional - Status: [PROPOSED](/README.md#proposed) - Since: 2019-12-26 (date you submit your PR) - Status Note: (explanation of current status) @@ -31,7 +31,7 @@ Specify the official name of the protocol and its version, e.g., "My Protocol 0. Protocol names are often either lower_snake_case or kebob-case. The non-version components of the protocol named are matched exactly. -URI: https://didcomm.org/lets_do_lunch// +URI: `https://didcomm.org/lets_do_lunch//` Message types and protocols are identified with special URIs that match certain conventions. See [Message Type and Protocol Identifier URIs](https://github.com/hyperledger/aries-rfcs/blob/main/concepts/0003-protocols/README.md#message-type-and-protocol-identifier-uris) for more details. @@ -159,7 +159,7 @@ Adoption should be declared in an "Adopted" subsection of "Messages". When adoption is specified, it should include a __minimum adopted version__ of the adopted message type: "This protocol adopts `ack` with version >= 1.4". All versions of the adopted message that share -the same major number should be compatible, given the [semver rules](concepts/0003-protocols/semver.md) +the same major number should be compatible, given the [semver rules](https://github.com/hyperledger/aries-rfcs/blob/main/concepts/0003-protocols/README.md#semver-rules-for-protocols) that apply to protocols. ### Constraints diff --git a/0000-template.md b/0000-template.md index 707ba5ae2..f6608e2ef 100644 --- a/0000-template.md +++ b/0000-template.md @@ -1,5 +1,5 @@ # Title (Ex. 0000: RFC Topic) -- Authors: [your name](you@github-email) -- email is optional +- Authors: [your name](mailto:you@github-email) -- email is optional - Status: [PROPOSED](/README.md#proposed) - Since: 2019-12-26 (date you submit your PR) - Status Note: (explanation of current status) diff --git a/README.md b/README.md index 814631fb2..a89ea2b48 100644 --- a/README.md +++ b/README.md @@ -8,8 +8,8 @@ If you are here to learn about Aries, we recommend you use the [the RFC Index](i There are 2 types of Aries RFCs: -* RFCs that describe individual features (in the [features](./features) folder) -* RFCs that explain concepts underpinning many features (in the [concepts](./concepts) folder) +* RFCs that describe individual features (in the `./features` folder) +* RFCs that explain concepts underpinning many features (in the `./concepts` folder) RFCs are for developers *building on* Aries. They don't provide guidance on how Aries components implement features internally; individual Aries repos have design docs for that. Each @@ -44,7 +44,7 @@ exploring. __Demonstrated__ RFCs have one or more implementations available, listed in the "Implementations" section of the RFC document. As with the PROPOSED status, demonstrated RFCs haven't been endorsed by the community, but the ideas put forth have been more thoroughly explored through the implementation(s). The demonstrated status is an optional step in the lifecycle. For protocol-related RFCs, work on protocol tests SHOULD begin in the [test suite repo](https://github.com/hyperledger/aries-protocol-test-suite) by the time this status is assigned. #### ACCEPTED -To get an RFC __accepted__, [build consensus](contributing.md#how-to-get-an-RFC-accepted) for your RFC on [chat](https://chat.hyperledger.org/channel/aries) and in community meetings. If your RFC is a feature that's protocol- or decorator-related, it MUST have reasonable tests in the [test suite repo](https://github.com/hyperledger/aries-protocol-test-suite), it MUST list the test suite in the protocol RFC's [Implementations section](../0000-template.md#implementations), at least one other implementation must have passed the relevant portions of the test suite, and all implementations listed in this section of the RFC MUST hyperlink to their test results. An accepted RFC is incubating on a standards track; the community has decided to polish it and is exploring or pursuing implementation. +To get an RFC __accepted__, [build consensus](contributing.md#how-to-get-an-RFC-accepted) for your RFC on [chat](https://chat.hyperledger.org/channel/aries) and in community meetings. If your RFC is a feature that's protocol- or decorator-related, it MUST have reasonable tests in the [test suite repo](https://github.com/hyperledger/aries-agent-test-harness), it MUST list the test suite in the protocol RFC's [Implementations section](/0000-template.md#implementations), at least one other implementation must have passed the relevant portions of the test suite, and all implementations listed in this section of the RFC MUST hyperlink to their test results. An accepted RFC is incubating on a standards track; the community has decided to polish it and is exploring or pursuing implementation. #### ADOPTED To get an RFC __adopted__, [socialize and implement](contributing.md#how-to-get-an-rfc-adopted). An RFC gets this status once it has significant momentum--when implementations accumulate, or when the mental model it advocates has begun to permeate our discourse. In other words, adoption is acknowledgment of a _de facto_ standard. diff --git a/code/genSite.sh b/code/genSite.sh index fe81e9c6e..e56f2ee65 100755 --- a/code/genSite.sh +++ b/code/genSite.sh @@ -24,11 +24,30 @@ python code/aipUpdates.py -v 2.0 -l "./code/cpAIPs.sh" | \ source copy_aip.sh rm copy_aip.sh +# Cleanup a few things in README, contributing and 0000-templates +for i in docs/contributing.md docs/README.md docs/0000*.md; do + sed \ + -e 's#../../##g' \ + -e 's#index.md#RFCindex.md#' \ + -e 's#LICENSE)#LICENSE.md)#' \ + $i >$i.tmp + mv $i.tmp $i +done + + +# Cleanup missing mailtos -- will always be needed for aip2 folder, but will be cleaned up in files +for i in docs/features/*/README.md docs/concepts/*/README.md docs/aip2/*/README.md; do + sed -e '/Authors/s#](#](mailto:#g' -e 's#mailto:mailto:#mailto:#g' $i >$i.tmp; mv $i.tmp $i +done + # Cleanup the links in the RFCs for i in docs/features/*/README.md docs/concepts/*/README.md docs/aip2/*/README.md; do sed \ -e 's#(/#(../../#g' \ -e 's#index.md#RFCindex.md#' \ + -e 's#[\./]*\(concepts\)#../../\1#g' \ + -e 's#[\./]*\(features\)#../../\1#g' \ + -e 's#discover-../../#discover-#g' \ $i >$i.tmp mv $i.tmp $i done @@ -50,7 +69,7 @@ for i in docs/aip2/*/README.md ; do head -n 1 $i | sed -e "s/# / - /" -e "s/: # Navigation for all RFCs by Status python code/generate_mkdocs_index.py -cat ${MKDOCSIDX} | sed "s# : concepts/0799#0799 Long Term Support: concepts/0799#" >>${MKDOCSTMP} +cat ${MKDOCSIDX} >>${MKDOCSTMP} rm ${MKDOCSIDX} mv ${MKDOCSTMP} ${MKDOCS} diff --git a/concepts/0003-protocols/README.md b/concepts/0003-protocols/README.md index a4a9ebd0e..54e4af608 100644 --- a/concepts/0003-protocols/README.md +++ b/concepts/0003-protocols/README.md @@ -1,6 +1,6 @@ # Aries RFC 0003: Protocols -- Authors: [Daniel Hardman](daniel.hardman@gmail.com) +- Authors: [Daniel Hardman](mailto:daniel.hardman@gmail.com) - Status: [ADOPTED](/README.md#adopted) - Since: 2019-04-01 - Status Note: standards track and beginning to influence many mental models, but not yet [ADOPTED](/README.md#rfc-lifecycle). diff --git a/concepts/0004-agents/README.md b/concepts/0004-agents/README.md index dabe7e47c..0fb1e6d39 100644 --- a/concepts/0004-agents/README.md +++ b/concepts/0004-agents/README.md @@ -1,6 +1,6 @@ # Aries RFC 0004: Agents -- Authors: [Daniel Hardman](daniel.hardman@gmail.com) +- Authors: [Daniel Hardman](mailto:daniel.hardman@gmail.com) - Status: [ACCEPTED](/README.md#accepted) - Since: 2019-01-15 - Status Note: On a standards track and beginning to influence many mental models, but not yet [ADOPTED](/README.md#rfc-lifecycle). diff --git a/concepts/0005-didcomm/README.md b/concepts/0005-didcomm/README.md index c0009a96e..14ece200a 100644 --- a/concepts/0005-didcomm/README.md +++ b/concepts/0005-didcomm/README.md @@ -1,6 +1,6 @@ # Aries RFC 0005: DID Communication -- Authors: [Daniel Hardman](daniel.hardman@gmail.com) +- Authors: [Daniel Hardman](mailto:daniel.hardman@gmail.com) - Status: [ADOPTED](/README.md#adopted) - Since: 2019-11-21 - Status Note: Mature as concept, with multiple implementations. diff --git a/concepts/0008-message-id-and-threading/README.md b/concepts/0008-message-id-and-threading/README.md index 1e2b64d3d..bbd875dea 100644 --- a/concepts/0008-message-id-and-threading/README.md +++ b/concepts/0008-message-id-and-threading/README.md @@ -1,6 +1,6 @@ # Aries RFC 0008: Message ID and Threading -- Authors: [Daniel Bluhm](daniel.bluhm@sovrin.org), [Sam Curren](sam@sovin.org), [Daniel Hardman](daniel.hardman@gmail.com) +- Authors: [Daniel Bluhm](mailto:daniel.bluhm@sovrin.org), [Sam Curren](mailto:sam@sovin.org), [Daniel Hardman](mailto:daniel.hardman@gmail.com) - Status: [ADOPTED](/README.md#adopted) - Since: 2018-10-01 - Status Note: Implemented broadly in Indy, but not yet elsewhere. diff --git a/concepts/0017-attachments/README.md b/concepts/0017-attachments/README.md index b4d9af7f4..2e193e236 100644 --- a/concepts/0017-attachments/README.md +++ b/concepts/0017-attachments/README.md @@ -1,6 +1,6 @@ # Aries RFC 0017: Attachments -- Authors: [Daniel Hardman](daniel.hardman@gmail.com), Sam Curren, Andrew Whitehead +- Authors: [Daniel Hardman](mailto:daniel.hardman@gmail.com), Sam Curren, Andrew Whitehead - Status: [ADOPTED](/README.md#adopted) - Since: 2024-05-01 - Status Note: Used in a number of other RFCs. diff --git a/concepts/0021-didcomm-message-anatomy/README.md b/concepts/0021-didcomm-message-anatomy/README.md index f8d5bc820..6ee2b9606 100644 --- a/concepts/0021-didcomm-message-anatomy/README.md +++ b/concepts/0021-didcomm-message-anatomy/README.md @@ -1,6 +1,6 @@ # Aries RFC 0021: DIDComm Message Anatomy -- Authors: [Tobias Looker](tobias.looker@mattr.global), [Daniel Hardman](daniel.hardman@gmail.com) +- Authors: [Tobias Looker](mailto:tobias.looker@mattr.global), [Daniel Hardman](mailto:daniel.hardman@gmail.com) - Status: [ADOPTED](/README.md#adopted) - Since: 2019-05-25 - Start Date: 2019-05-25 diff --git a/concepts/0029-message-trust-contexts/README.md b/concepts/0029-message-trust-contexts/README.md index 83a7ed1b4..80af2bc8c 100644 --- a/concepts/0029-message-trust-contexts/README.md +++ b/concepts/0029-message-trust-contexts/README.md @@ -1,6 +1,6 @@ # Aries RFC 0029: Message Trust Contexts -- Authors: [Daniel Hardman](daniel.hardman@gmail.com) +- Authors: [Daniel Hardman](mailto:daniel.hardman@gmail.com) - Status: [STALLED](/README.md#stalled) - Since: 2024-04-03 - Status Note: Not practically applied. diff --git a/concepts/0046-mediators-and-relays/README.md b/concepts/0046-mediators-and-relays/README.md index c20572dd5..a24e82f0f 100644 --- a/concepts/0046-mediators-and-relays/README.md +++ b/concepts/0046-mediators-and-relays/README.md @@ -1,6 +1,6 @@ # Aries RFC 0046: Mediators and Relays -- Authors: [Daniel Hardman](daniel.hardman@gmail.com) +- Authors: [Daniel Hardman](mailto:daniel.hardman@gmail.com) - Status: [ACCEPTED](/README.md#accepted) - Since: 2019-02-01 - Status Note: Socialized and broadly understood in other conceptual RFCs about routing. diff --git a/concepts/0047-json-ld-compatibility/README.md b/concepts/0047-json-ld-compatibility/README.md index d6c2749a8..fdde98d7c 100644 --- a/concepts/0047-json-ld-compatibility/README.md +++ b/concepts/0047-json-ld-compatibility/README.md @@ -1,6 +1,6 @@ # Aries RFC 0047: JSON-LD Compatibility -- Authors: [Daniel Hardman](daniel.hardman@gmail.com) +- Authors: [Daniel Hardman](mailto:daniel.hardman@gmail.com) - Status: [ACCEPTED](/README.md#accepted) - Since: 2019-02-20 - Status Note: Has guided Indy design choices for several months. Not yet ratified by greater Aries community. diff --git a/concepts/0049-repudiation/README.md b/concepts/0049-repudiation/README.md index e75bf153b..217c49f23 100644 --- a/concepts/0049-repudiation/README.md +++ b/concepts/0049-repudiation/README.md @@ -1,6 +1,6 @@ # Aries RFC 0049: Repudiation -- Authors: [Daniel Hardman](daniel.hardman@gmail.com) +- Authors: [Daniel Hardman](mailto:daniel.hardman@gmail.com) - Status: [ACCEPTED](/README.md#accepted) - Since: 2019-03-01 - Status Note: Well understood and baked into various protocol designs and DIDComm processes--but not yet ratified by the larger Aries community. diff --git a/concepts/0051-dkms/README.md b/concepts/0051-dkms/README.md index bf049b5c8..d3a0a9539 100644 --- a/concepts/0051-dkms/README.md +++ b/concepts/0051-dkms/README.md @@ -1,6 +1,6 @@ # Aries RFC 0051: Decentralized Key Management -- Authors: [Drummond Reed](drummond@connect.me) et al. +- Authors: [Drummond Reed](mailto:drummond@connect.me) et al. - Status: [RETIRED](/README.md#retired) - Since: 2024-04-03 - Status Note: Covered elsewhere and not specific to Aries. diff --git a/concepts/0094-cross-domain-messaging/README.md b/concepts/0094-cross-domain-messaging/README.md index 61119cc76..604a0fba3 100644 --- a/concepts/0094-cross-domain-messaging/README.md +++ b/concepts/0094-cross-domain-messaging/README.md @@ -1,6 +1,6 @@ # Aries RFC 0094: Cross-Domain Messaging -- Authors: [Stephen Curran](swcurran@gmail.com) +- Authors: [Stephen Curran](mailto:swcurran@gmail.com) - Status: [ADOPTED](/README.md#adopted) - Since: 2024-05-01 - Status Note: Socialized and broadly understood in other conceptual RFCs about routing. diff --git a/concepts/0207-credential-fraud-threat-model/README.md b/concepts/0207-credential-fraud-threat-model/README.md index beb1569ad..200494607 100644 --- a/concepts/0207-credential-fraud-threat-model/README.md +++ b/concepts/0207-credential-fraud-threat-model/README.md @@ -1,5 +1,5 @@ # 0207: Credential Fraud Threat Model -- Authors: [Daniel Hardman](daniel.hardman@gmail.com) +- Authors: [Daniel Hardman](mailto:daniel.hardman@gmail.com) - Status: [STALLED](/README.md#stalled) - Since: 2024-04-03 - Status Note: No implementations have been created. Socialized on an informal credential fraud study group (https://groups.google.com/d/forum/credential-fraud-study) circa 2019. diff --git a/concepts/0217-linkable-message-paths/README.md b/concepts/0217-linkable-message-paths/README.md index 3b7f1bbcc..d2a5345d7 100644 --- a/concepts/0217-linkable-message-paths/README.md +++ b/concepts/0217-linkable-message-paths/README.md @@ -1,5 +1,5 @@ # Aries RFC 0217: Linkable Message Paths -- Authors: [Daniel Hardman](daniel.hardman@gmail.com) +- Authors: [Daniel Hardman](mailto:daniel.hardman@gmail.com) - Status: [STALLED](/README.md#stalled) - Since: 2024-04-03 - Status Note: No implementations have been created. diff --git a/concepts/0231-biometric-service-provider/README.md b/concepts/0231-biometric-service-provider/README.md index 14396c869..78b6caca1 100644 --- a/concepts/0231-biometric-service-provider/README.md +++ b/concepts/0231-biometric-service-provider/README.md @@ -1,6 +1,6 @@ # Aries RFC 0231: Biometric Service Provider -- Authors: [John Callahan](jcallahan@acm.org), [Daniel Hardman](daniel.hardman@gmail.com), [Asem Othman](aothman@veridiumid.com) +- Authors: [John Callahan](mailto:jcallahan@acm.org), [Daniel Hardman](mailto:daniel.hardman@gmail.com), [Asem Othman](mailto:aothman@veridiumid.com) - Status: [PROPOSED](/README.md#proposed) - Since: 2019-09-24 - Status Note: Proposed for now based on authors joint work diff --git a/concepts/0250-rich-schemas/README.md b/concepts/0250-rich-schemas/README.md index f0430400a..953ea67fa 100644 --- a/concepts/0250-rich-schemas/README.md +++ b/concepts/0250-rich-schemas/README.md @@ -1,5 +1,5 @@ # RFC 0250: Rich Schema Objects -- Author: [Ken Ebert](ken@sovrin.org), [Brent Zundel](brent.zundel@evernym.com) +- Author: [Ken Ebert](mailto:ken@sovrin.org), [Brent Zundel](mailto:brent.zundel@evernym.com) - Status: [STALLED](/README.md#stalled) - Since: 2024-04-03 - Status Note: No recent progress and no implementations have been created. @@ -341,7 +341,7 @@ Here is the paper that defines [Camenisch-Lysyanskaya signatures.][CL-signatures] They are the source for [Indy's AnonCreds protocol](https://github.com/hyperledger/indy-hipe/pull/109). -[CL-signatures]: (https://groups.csail.mit.edu/cis/pubs/lysyanskaya/cl02b.pdf) +[CL-signatures]: https://groups.csail.mit.edu/cis/pubs/lysyanskaya/cl02b.pdf ## Drawbacks diff --git a/concepts/0268-unified-didcomm-agent-deeplinking/README.md b/concepts/0268-unified-didcomm-agent-deeplinking/README.md index 30e394423..353d49a30 100644 --- a/concepts/0268-unified-didcomm-agent-deeplinking/README.md +++ b/concepts/0268-unified-didcomm-agent-deeplinking/README.md @@ -1,5 +1,5 @@ # Aries RFC 0268: Unified DIDCOMM Deeplinking -- Authors: [Dev Bharel](dev@spaceman.id), [Alexi Falquier](alexis@spaceman.id) +- Authors: [Dev Bharel](mailto:dev@spaceman.id), [Alexi Falquier](mailto:alexis@spaceman.id) - Status: [PROPOSED](/README.md#proposed) - Since: 2019-10-23 - Status Note: Proposed diff --git a/concepts/0270-interop-test-suite/README.md b/concepts/0270-interop-test-suite/README.md index 6a441493d..a4f350710 100644 --- a/concepts/0270-interop-test-suite/README.md +++ b/concepts/0270-interop-test-suite/README.md @@ -1,5 +1,5 @@ # 0270: Interop Test Suite -- Authors: [Daniel Hardman](daniel.hardman@gmail.com) +- Authors: [Daniel Hardman](mailto:daniel.hardman@gmail.com) - Status: [PROPOSED](/README.md#proposed) - Since: 2019-10-25 - Status Note: Codifies some thinking about scope and mental model that are already socialized. Provides some new thinking as well. diff --git a/concepts/0289-toip-stack/README.md b/concepts/0289-toip-stack/README.md index 40cfa0bb3..8d4b10332 100644 --- a/concepts/0289-toip-stack/README.md +++ b/concepts/0289-toip-stack/README.md @@ -1,5 +1,5 @@ # 0289: The Trust Over IP Stack -- Authors: Matthew Davie, [Dan Gisolfi](dan.gisolfi@gmail.com), [Daniel Hardman](daniel.hardman@evernym.com), [John Jordan](john.jordan@gov.bc.ca), Darrell O'Donnell, [Drummond Reed](drummond.reed@evernym.com), [Oskar van Deventer](oskar.vandeventer@tno.nl) +- Authors: Matthew Davie, [Dan Gisolfi](mailto:dan.gisolfi@gmail.com), [Daniel Hardman](mailto:daniel.hardman@evernym.com), [John Jordan](mailto:john.jordan@gov.bc.ca), Darrell O'Donnell, [Drummond Reed](mailto:drummond.reed@evernym.com), [Oskar van Deventer](mailto:oskar.vandeventer@tno.nl) - Status: [STALLED](/README.md#stalled) - Since: 2024-04-03 - Status Note: No recent progress and no implementations have been created. diff --git a/concepts/0345-community-coordinated-update/README.md b/concepts/0345-community-coordinated-update/README.md index 6669414e4..51f666d6c 100644 --- a/concepts/0345-community-coordinated-update/README.md +++ b/concepts/0345-community-coordinated-update/README.md @@ -1,5 +1,5 @@ # 0345: Community Coordinated Update -- Authors: [Sam Curren](telegramsam@gmail.com) +- Authors: [Sam Curren](mailto:telegramsam@gmail.com) - Status: [PROPOSED](/README.md#proposed) - Since: 2019-12-26 (date you submit your PR) - Status Note: Initial Draft diff --git a/concepts/0346-didcomm-between-two-mobile-agents/README.md b/concepts/0346-didcomm-between-two-mobile-agents/README.md index 56bf052d7..a5531134b 100644 --- a/concepts/0346-didcomm-between-two-mobile-agents/README.md +++ b/concepts/0346-didcomm-between-two-mobile-agents/README.md @@ -1,5 +1,5 @@ # 0346: DIDComm Between Two Mobile Agents Using Cloud Agent Mediator -- Author: [Sukalpo Mitra](sukalpomitra@gmail.com) +- Author: [Sukalpo Mitra](mailto:sukalpomitra@gmail.com) - Start Date: 2019-06-23 - Tags: [concept](/tags.md#concept) - Status: [PROPOSED](/README.md#proposed) diff --git a/concepts/0430-machine-readable-governance-frameworks/README.md b/concepts/0430-machine-readable-governance-frameworks/README.md index 47f2eabe1..1bd706926 100644 --- a/concepts/0430-machine-readable-governance-frameworks/README.md +++ b/concepts/0430-machine-readable-governance-frameworks/README.md @@ -1,5 +1,5 @@ # Aries RFC 0430: Machine-Readable Governance Frameworks -- Authors: [Daniel Hardman](daniel.hardman@gmail.com) +- Authors: [Daniel Hardman](mailto:daniel.hardman@gmail.com) - Status: [PROPOSED](/README.md#proposed) - Since: 2020-02-24 - Status Note: early proposal only diff --git a/concepts/0440-kms-architectures/README.md b/concepts/0440-kms-architectures/README.md index cb872cd9d..a9c6eeba6 100644 --- a/concepts/0440-kms-architectures/README.md +++ b/concepts/0440-kms-architectures/README.md @@ -1,5 +1,5 @@ # 0440: KMS Architectures -- Authors: [Michael Lodder](mike@sovrin.org) +- Authors: [Michael Lodder](mailto:mike@sovrin.org) - Status: [PROPOSED](/README.md#proposed) - Since: 2020-03-06 - Status Note: Proposed diff --git a/concepts/0441-present-proof-best-practices/README.md b/concepts/0441-present-proof-best-practices/README.md index c655c7836..97d864388 100644 --- a/concepts/0441-present-proof-best-practices/README.md +++ b/concepts/0441-present-proof-best-practices/README.md @@ -1,5 +1,5 @@ # 0441: Prover and Verifier Best Practices for Proof Presentation -- Authors: [Stephen Klump](stephen.klump@becker-carroll.com) +- Authors: [Stephen Klump](mailto:stephen.klump@becker-carroll.com) - Status: [ADOPTED](/README.md#adopted) - Since: 2024-05-01 - Status Note: Interoperability guidance when using AnonCreds Present Proof. An element of the AnonCreds subtarget for [AIP v2.0](../../concepts/0302-aries-interop-profile/README.md). diff --git a/concepts/0478-coprotocols/README.md b/concepts/0478-coprotocols/README.md index 8228f9dd9..5bfae4d9f 100644 --- a/concepts/0478-coprotocols/README.md +++ b/concepts/0478-coprotocols/README.md @@ -1,5 +1,5 @@ # Aries RFC 0478: Coprotocols -- Authors: [Daniel Hardman](daniel.hardman@gmail.com) +- Authors: [Daniel Hardman](mailto:daniel.hardman@gmail.com) - Status: [STALLED](/README.md#stalled) - Since: 2024-04-03 - Status Note: No recent progress and no implementations have been created. diff --git a/concepts/0519-goal-codes/README.md b/concepts/0519-goal-codes/README.md index eed2b9718..5a4bb89f8 100644 --- a/concepts/0519-goal-codes/README.md +++ b/concepts/0519-goal-codes/README.md @@ -1,5 +1,5 @@ # 0519: Goal Codes -- Authors: [Daniel Hardman](daniel.hardman@gmail.com) +- Authors: [Daniel Hardman](mailto:daniel.hardman@gmail.com) - Status: [ACCEPTED](/README.md#accepted) - Since: 2021-04-15 - Status Note: Used in several protocols that are part of [AIP 2.0](../0302-aries-interop-profile/README.md), such as the [Out-of-Band](../../features/0434-outofband/README.md) protocol. diff --git a/concepts/0559-pppu/README.md b/concepts/0559-pppu/README.md index 3256d526f..8ae7669e3 100644 --- a/concepts/0559-pppu/README.md +++ b/concepts/0559-pppu/README.md @@ -1,5 +1,5 @@ # Aries RFC 0559: Privacy-Preserving Proof of Uniqueness -- Authors: [Daniel Hardman](daniel.hardman@gmail.com), Drummond Reed, Lovesh Harchandani, Jason Law, Brent Zundel +- Authors: [Daniel Hardman](mailto:daniel.hardman@gmail.com), Drummond Reed, Lovesh Harchandani, Jason Law, Brent Zundel - Status: [PROPOSED](/README.md#proposed) - Since: 2020-10-21 - Status Note: documents ideas mentioned at RWOT 9 (Sep 2019) and in informal conversations before and since. This is a defensive publication by the Aries community, to prevent such ideas from being encumbered by patents. diff --git a/concepts/0566-issuer-hosted-custodidal-agents/README.md b/concepts/0566-issuer-hosted-custodidal-agents/README.md index bdf5b8515..3e3ad9a43 100644 --- a/concepts/0566-issuer-hosted-custodidal-agents/README.md +++ b/concepts/0566-issuer-hosted-custodidal-agents/README.md @@ -1,5 +1,5 @@ # 0566: Issuer-Hosted Custodial Agents -- Authors: [Sam Curren](telegramsam@gmail.com) +- Authors: [Sam Curren](mailto:telegramsam@gmail.com) - Status: [PROPOSED](/README.md#proposed) - Since: 2020-11-16 - Status Note: Draft diff --git a/concepts/0700-oob-through-redirect/README.md b/concepts/0700-oob-through-redirect/README.md index 0c0bbbcfc..14dfdd1bf 100644 --- a/concepts/0700-oob-through-redirect/README.md +++ b/concepts/0700-oob-through-redirect/README.md @@ -1,6 +1,6 @@ # Aries RFC 0700: Out-of-Band through redirect -- Authors: [Sudesh Shetty](sudesh.shetty@securekey.com) +- Authors: [Sudesh Shetty](mailto:sudesh.shetty@securekey.com) - Status: [PROPOSED](/README.md#proposed) - Since: 2021-10-08 - Status Note: implementation is being explored by SecureKey diff --git a/concepts/0757-push-notification/README.md b/concepts/0757-push-notification/README.md index 5ccb7448c..af4b219a0 100644 --- a/concepts/0757-push-notification/README.md +++ b/concepts/0757-push-notification/README.md @@ -1,5 +1,5 @@ # 0757: Push Notification -- Authors: [Sam Curren](telegramsam@gmail.com) +- Authors: [Sam Curren](mailto:telegramsam@gmail.com) - Status: [PROPOSED](/README.md#proposed) - Since: 2022-11-02 - Status Note: diff --git a/concepts/0799-long-term-support/README.md b/concepts/0799-long-term-support/README.md index bbb78ceb1..a02d4fedc 100644 --- a/concepts/0799-long-term-support/README.md +++ b/concepts/0799-long-term-support/README.md @@ -1,5 +1,5 @@ -# 0799 Aries Long Term Support Releases -- Authors: [Sam Curren](telegramsam@gmail.com) +# 0799: Aries Long Term Support Releases +- Authors: [Sam Curren](mailto:telegramsam@gmail.com) - Status: [PROPOSED](/README.md#proposed) - Since: 2023-11-07 - Start Date: 2023-11-07 diff --git a/contributing.md b/contributing.md index 1f124209e..936ee09c9 100644 --- a/contributing.md +++ b/contributing.md @@ -12,7 +12,7 @@ invisible to those consuming Aries, should be documented elsewhere. ### Preparation Before writing an RFC, consider exploring the idea on -[chat](https://chat.hyperledger.org/channel/aries), on community calls +[the aries chat channel](https://chat.hyperledger.org), on community calls (see the [Hyperledger Community Calendar]( https://wiki.hyperledger.org/community/calendar-public-meetings)), or on [aries@lists.hyperledger.org]( @@ -27,8 +27,8 @@ is a good sign that you're on the right track. for guidance. - Decide which parent folder is appropriate for your RFC. If it is about a specific protocol or decorator or feature, its parent - should be /features; if it is about a concept that will be used in many - different features, its parent should be /concepts. + should be `/features`; if it is about a concept that will be used in many + different features, its parent should be `/concepts`. - Create the folder and copy either `0000-template.md` or `0000-template-protocol.md` (if your RFC is for a protocol) to `//README.md`. - Fill in the RFC. [Use MUST and SHOULD per standard conventions](https://tools.ietf.org/html/rfc2119). Put care into the details: RFCs that do not present convincing motivation, demonstrate an understanding of the impact of the @@ -43,13 +43,8 @@ is a good sign that you're on the right track. this repo to figure out what the next PR number will be). Rename your folder from `` to `-`. At the top of your README.md, modify the title so it is in the form: `: Friendly Version of Your Title`. Commit your changes. - - In the root of the repo, run `python code/generate_index.py` to update the index - with your new RFC. - - In the root of your repo, run `pytest code` to see whether your RFC passes all - automated tests. The RFC tests are simple. They just check for things like - naming conventions and hyperlink correctness. - - Commit the updated version of /index.md and push your changes. + number>: Friendly Version of Your Title`. + - Commit and push your changes. - Submit a pull request. Make sure that all of your commits satisfy the [DCO requirements]( @@ -70,7 +65,7 @@ in the lifecycle, submit a PR with the following characteristics: - The title of the PR should include a deadline date for merging the PR and the referenced RFC. - Example: `Status to Accepted, deadline 2019.08.15, RFC 0095-basic-message` - The PR comment should document why the status is being changed. -- The deadline date should be 2 weeks after announcing the proposed status change on an Aries WG call. The PR should also be announced on the [#aries rocketchat channel](https://chat.hyperledger.org/channel/aries). +- The deadline date should be 2 weeks after announcing the proposed status change on an Aries WG call. The PR should also be announced on the [#aries channel](https://chat.hyperledger.org). - Barring negative feedback from the community, the repo's maintainers should merge the PR after the deadline. - The deadline should be moved by two weeks after addressing each substantive change to the RFC made during the status change review period. diff --git a/features/0015-acks/README.md b/features/0015-acks/README.md index c309d442b..bb272a6eb 100644 --- a/features/0015-acks/README.md +++ b/features/0015-acks/README.md @@ -1,6 +1,6 @@ # Aries RFC 0015: ACKs -- Authors: [Daniel Hardman](daniel.hardman@gmail.com) +- Authors: [Daniel Hardman](mailto:daniel.hardman@gmail.com) - Status: [ADOPTED](/README.md#adopted) - Since: 2024-05-01 - Status Note: Broadly implemented, adopted into many protocols and part of [AIP 1 and 2](../../concepts/0302-aries-interop-profile/README.md). diff --git a/features/0019-encryption-envelope/README.md b/features/0019-encryption-envelope/README.md index 8424415c4..08b8eaa9e 100644 --- a/features/0019-encryption-envelope/README.md +++ b/features/0019-encryption-envelope/README.md @@ -1,6 +1,6 @@ # Aries RFC 0019: Encryption Envelope -- Authors: [Kyle Den Hartog](kyle.denhartog@evernym.com), [Stephen Curran](swcurran@gmail.com), [Sam Curren](sam@sovrin.org), [Mike Lodder](mike@sovrin.org) +- Authors: [Kyle Den Hartog](mailto:kyle.denhartog@evernym.com), [Stephen Curran](mailto:swcurran@gmail.com), [Sam Curren](mailto:sam@sovrin.org), [Mike Lodder](mailto:mike@sovrin.org) - Status: [ADOPTED](/README.md#adopted) - Since: 2019-05-04 - Status Note: diff --git a/features/0024-didcomm-over-xmpp/README.md b/features/0024-didcomm-over-xmpp/README.md index 9c449a3fd..f6d8feb22 100644 --- a/features/0024-didcomm-over-xmpp/README.md +++ b/features/0024-didcomm-over-xmpp/README.md @@ -1,6 +1,6 @@ # Aries RFC 0024: DIDComm over XMPP -- Authors: [Oskar van Deventer](oskar.vandeventer@tno.nl), [Galit Rahim](galit.rahim@tno.nl), [Alexander Blom](alexander.blom@bloqzone.com) +- Authors: [Oskar van Deventer](mailto:oskar.vandeventer@tno.nl), [Galit Rahim](mailto:galit.rahim@tno.nl), [Alexander Blom](mailto:alexander.blom@bloqzone.com) - Status: [STALLED](/README.md#stalled) - Since: 2024-04-03 - Status Note: No implementations have been created. diff --git a/features/0025-didcomm-transports/README.md b/features/0025-didcomm-transports/README.md index add0c0749..c37883883 100644 --- a/features/0025-didcomm-transports/README.md +++ b/features/0025-didcomm-transports/README.md @@ -1,6 +1,6 @@ # Aries RFC 0025: DIDComm Transports -- Authors: [Sam Curren](sam@sovrin.org) +- Authors: [Sam Curren](mailto:sam@sovrin.org) - Status: [ADOPTED](/README.md#adopted) - Since: 2019-12-05 - Status Note: diff --git a/features/0030-sync-connection/README.md b/features/0030-sync-connection/README.md index 723bf843a..328d67c0c 100644 --- a/features/0030-sync-connection/README.md +++ b/features/0030-sync-connection/README.md @@ -1,6 +1,6 @@ # Aries RFC 0030: Sync Connection Protocol 1.0 -- Authors: [Daniel Hardman](daniel.hardman@gmail.com) +- Authors: [Daniel Hardman](mailto:daniel.hardman@gmail.com) - Status: [STALLED](/README.md#stalled) - Since: 2024-04-03 - Status Note: No implementations have been created. diff --git a/features/0032-message-timing/README.md b/features/0032-message-timing/README.md index 687bec12a..626a03df2 100644 --- a/features/0032-message-timing/README.md +++ b/features/0032-message-timing/README.md @@ -1,6 +1,6 @@ # Aries RFC 0032: Message Timing -- Authors: [Daniel Hardman](daniel.hardman@gmail.com) +- Authors: [Daniel Hardman](mailto:daniel.hardman@gmail.com) - Status: [DEMONSTRATED](/README.md#demonstrated) - Since: 2019-05-01 - Status Note: Broadly socialized but not yet implemented. diff --git a/features/0035-report-problem/README.md b/features/0035-report-problem/README.md index 137d9f94c..9e2b3ce91 100644 --- a/features/0035-report-problem/README.md +++ b/features/0035-report-problem/README.md @@ -1,6 +1,6 @@ # Aries RFC 0035: Report Problem Protocol 1.0 -- Authors: [Stephen Curran](swcurran@cloudcompass.ca), [Daniel Hardman](daniel.hardman@gmail.com) +- Authors: [Stephen Curran](mailto:swcurran@cloudcompass.ca), [Daniel Hardman](mailto:daniel.hardman@gmail.com) - Status: [ADOPTED](/README.md#adopted) - Since: 2024-05-01 - Status Note: Implemented in multiple codebases. diff --git a/features/0042-lox/README.md b/features/0042-lox/README.md index 39296d164..21e70d965 100644 --- a/features/0042-lox/README.md +++ b/features/0042-lox/README.md @@ -1,6 +1,6 @@ # Aries RFC 0042: LOX -- A more secure pluggable framework for protecting wallet keys -- Authors: [Michael Lodder](mike@sovrin.org) +- Authors: [Michael Lodder](mailto:mike@sovrin.org) - Status: [DEMONSTRATED](/README.md#demonstrated) - Since: 2019-05-30 - Start Date: 2019-05-30 diff --git a/features/0048-trust-ping/README.md b/features/0048-trust-ping/README.md index 25aba87a8..e15cd6790 100644 --- a/features/0048-trust-ping/README.md +++ b/features/0048-trust-ping/README.md @@ -1,6 +1,6 @@ # Aries RFC 0048: Trust Ping Protocol 1.0 -- Authors: [Daniel Hardman](daniel.hardman@gmail.com) +- Authors: [Daniel Hardman](mailto:daniel.hardman@gmail.com) - Status: [ADOPTED](/README.md#adopted) - Since: 2019-02-01 - Status Note: Numerous implementations. diff --git a/features/0056-service-decorator/README.md b/features/0056-service-decorator/README.md index 3b56fc44a..04727a7ee 100644 --- a/features/0056-service-decorator/README.md +++ b/features/0056-service-decorator/README.md @@ -1,6 +1,6 @@ # Aries RFC 0056: Service Decorator -- Authors: [Sam Curren](sam@sovrin.org), Tobias Looker +- Authors: [Sam Curren](mailto:sam@sovrin.org), Tobias Looker - Status: [PROPOSED](/README.md#proposed) - Since: 2019-06-03 - Status Note: Needs refinement and validation, will be useful in any connectionless communication. diff --git a/features/0066-non-repudiable-cryptographic-envelope/README.md b/features/0066-non-repudiable-cryptographic-envelope/README.md index 92e98e2d9..4d1cab72e 100644 --- a/features/0066-non-repudiable-cryptographic-envelope/README.md +++ b/features/0066-non-repudiable-cryptographic-envelope/README.md @@ -1,6 +1,6 @@ # Aries RFC 0066: Non-Repudiable Signature for Cryptographic Envelope -- Authors: [Kyle Den Hartog](indy@kyledenhartog.com) +- Authors: [Kyle Den Hartog](mailto:indy@kyledenhartog.com) - Status: [PROPOSED](/README.md#proposed) - Since: 2019-04-15 - Status Note: This is a second attempt to integrate non-repudiable digital signatures based on learnings and discussions over the past few months. This focuses only on the signing of entire messages. Signature Decorators will be handled seperately. diff --git a/features/0067-didcomm-diddoc-conventions/README.md b/features/0067-didcomm-diddoc-conventions/README.md index 28cb17a5b..42872fef3 100644 --- a/features/0067-didcomm-diddoc-conventions/README.md +++ b/features/0067-didcomm-diddoc-conventions/README.md @@ -1,6 +1,6 @@ # Aries RFC 0067: DIDComm DID document conventions -- Authors: [Tobias Looker](tobias.looker@mattr.global), [Stephen Curran](swcurran@gmail.com) +- Authors: [Tobias Looker](mailto:tobias.looker@mattr.global), [Stephen Curran](mailto:swcurran@gmail.com) - Status: [PROPOSED](/README.md#proposed) - Since: 2019-06-10 - Status Note: This revises the former [INDY HIPE](https://github.com/hyperledger/indy-hipe/pull/92) diff --git a/features/0075-payment-decorators/README.md b/features/0075-payment-decorators/README.md index 4c5642172..6c2ff22ac 100644 --- a/features/0075-payment-decorators/README.md +++ b/features/0075-payment-decorators/README.md @@ -1,6 +1,6 @@ # Aries RFC 0075: Payment Decorators -- Authors: [Sam Curren](sam@sovrin.org), [Daniel Hardman](daniel.hardman@gmail.com), Tomislav Markovski +- Authors: [Sam Curren](mailto:sam@sovrin.org), [Daniel Hardman](mailto:daniel.hardman@gmail.com), Tomislav Markovski - Status: [STALLED](/README.md#stalled) - Since: 2024-04-03 - Status Note: No implementations have been created. diff --git a/features/0092-transport-return-route/README.md b/features/0092-transport-return-route/README.md index 5a63f53b0..7018151ea 100644 --- a/features/0092-transport-return-route/README.md +++ b/features/0092-transport-return-route/README.md @@ -1,6 +1,6 @@ # Aries RFC 0092: Transports Return Route -- Authors: [Sam Curren](sam@sovrin.org) +- Authors: [Sam Curren](mailto:sam@sovrin.org) - Status: [ADOPTED](/README.md#adopted) - Since: 2024-05-01 - Status Note: diff --git a/features/0113-question-answer/README.md b/features/0113-question-answer/README.md index b0cb93e03..249eb339d 100644 --- a/features/0113-question-answer/README.md +++ b/features/0113-question-answer/README.md @@ -1,6 +1,6 @@ # Aries RFC 0113: Question Answer Protocol 0.9 -- Authors: [Douglas Wightman](douglas.wightman@evernym.com) +- Authors: [Douglas Wightman](mailto:douglas.wightman@evernym.com) - Status: [DEMONSTRATED](/README.md#demonstrated) - Since: 2019-07-05 - Start Date: 2019-02-07 diff --git a/features/0124-did-resolution-protocol/README.md b/features/0124-did-resolution-protocol/README.md index bfb98b9cd..77bf03ec7 100644 --- a/features/0124-did-resolution-protocol/README.md +++ b/features/0124-did-resolution-protocol/README.md @@ -1,7 +1,6 @@ # Aries RFC 0124: DID Resolution Protocol 0.9 -- Authors: [Markus Sabadello](markus@danubetech.com), - [Luis Gómez Alonso](luis.gomezalonso@sicpa.com) +- Authors: [Markus Sabadello](mailto:markus@danubetech.com), [Luis Gómez Alonso](mailto:luis.gomezalonso@sicpa.com) - Status: [PROPOSED](/README.md#proposed) - Since: 2019-07-13 - Status Note: Not implemented, but has been discussed as part of the [Aries DID Resolution](https://github.com/hyperledger/aries-rfcs/issues/101) work. diff --git a/features/0160-connection-protocol/README.md b/features/0160-connection-protocol/README.md index 50b086c08..b73e32de5 100644 --- a/features/0160-connection-protocol/README.md +++ b/features/0160-connection-protocol/README.md @@ -1,5 +1,5 @@ # 0160: Connection Protocol -- Authors: [Ryan West](ryan.west@sovrin.org), [Daniel Bluhm](daniel.bluhm@sovrin.org), Matthew Hailstone, Stephen Curran, [Sam Curren](sam@sovrin.org) +- Authors: [Ryan West](mailto:ryan.west@sovrin.org), [Daniel Bluhm](mailto:daniel.bluhm@sovrin.org), Matthew Hailstone, Stephen Curran, [Sam Curren](mailto:sam@sovrin.org) - Status: [ADOPTED](/README.md#adopted) (But should move to deprecated) - Since: 2019-08-06 - Status Note: This is the protocol with existing uses. It is expected that [RFC 0023 DID Exchange](../../features/0023-did-exchange/README.md) will replace this protocol. diff --git a/features/0183-revocation-notification/README.md b/features/0183-revocation-notification/README.md index 1abcb4158..dab004c3b 100644 --- a/features/0183-revocation-notification/README.md +++ b/features/0183-revocation-notification/README.md @@ -1,5 +1,5 @@ # Aries RFC 0183: Revocation Notification 1.0 -- Authors: [Keith Smith] +- Authors: Keith Smith - Status: [ACCEPTED](/README.md#accepted) - Since: 2024-05-01 - Status Note: Initial proposal after discussion on rocketchat diff --git a/features/0193-coin-flip/README.md b/features/0193-coin-flip/README.md index d399f86f1..ebe7ea29f 100644 --- a/features/0193-coin-flip/README.md +++ b/features/0193-coin-flip/README.md @@ -1,6 +1,6 @@ # Aries RFC 0193: Coin Flip Protocol 1.0 -- Authors: [Daniel Hardman](daniel.hardman@gmail.com), [Patrick Stürmlinger](patrick@mindf.org) +- Authors: [Daniel Hardman](mailto:daniel.hardman@gmail.com), [Patrick Stürmlinger](mailto:patrick@mindf.org) - Status: [STALLED](/README.md#stalled) - Since: 2024-04-03 - Status Note: No implementations have been created. diff --git a/features/0211-route-coordination/README.md b/features/0211-route-coordination/README.md index 5952982d9..d4dc29dca 100644 --- a/features/0211-route-coordination/README.md +++ b/features/0211-route-coordination/README.md @@ -1,5 +1,5 @@ # 0211: Mediator Coordination Protocol -- Authors: [Sam Curren](telegramsam@gmail.com), [Daniel Bluhm](daniel@indicio.tech), [Adam Burdett](burdettadam@gmail.com) +- Authors: [Sam Curren](mailto:telegramsam@gmail.com), [Daniel Bluhm](mailto:daniel@indicio.tech), [Adam Burdett](mailto:burdettadam@gmail.com) - Status: [ADOPTED](/README.md#adopted) - Since: 2024-05-01 - Status Note: Discussed and implemented and part of AIP 2.0. diff --git a/features/0212-pickup/README.md b/features/0212-pickup/README.md index 63f753fd6..eccaa3308 100644 --- a/features/0212-pickup/README.md +++ b/features/0212-pickup/README.md @@ -1,5 +1,5 @@ # 0212: Pickup Protocol -- Authors: [Sam Curren](telegramsam@gmail.com) +- Authors: [Sam Curren](mailto:telegramsam@gmail.com) - Status: [PROPOSED](/README.md#proposed) - Since: 2019-09-03 - Status Note: Initial version diff --git a/features/0213-transfer-policy/README.md b/features/0213-transfer-policy/README.md index 562894275..2e36dd944 100644 --- a/features/0213-transfer-policy/README.md +++ b/features/0213-transfer-policy/README.md @@ -1,5 +1,5 @@ # 0213: Transfer Policy Protocol -- Authors: [Sam Curren](telegramsam@gmail.com) +- Authors: [Sam Curren](mailto:telegramsam@gmail.com) - Status: [PROPOSED](/README.md#proposed) - Since: 2019-09-03 - Status Note: Initial version diff --git a/features/0214-help-me-discover/README.md b/features/0214-help-me-discover/README.md index d08a878e9..322e39bee 100644 --- a/features/0214-help-me-discover/README.md +++ b/features/0214-help-me-discover/README.md @@ -1,5 +1,5 @@ # Aries RFC 0214: "Help Me Discover" Protocol -- Authors: [George Aristy](george.aristy@securekey.com), [Daniel Hardman](daniel.hardman@gmail.com) +- Authors: [George Aristy](mailto:george.aristy@securekey.com), [Daniel Hardman](mailto:daniel.hardman@gmail.com) - Status: [PROPOSED](/README.md#proposed) - Since: 2019-09-10 - Status Note: implementation is being explored by SecureKey diff --git a/features/0234-signature-decorator/README.md b/features/0234-signature-decorator/README.md index 0a3e4ce7c..6c8345ab3 100644 --- a/features/0234-signature-decorator/README.md +++ b/features/0234-signature-decorator/README.md @@ -1,5 +1,5 @@ # Aries RFC 0234: Signature Decorator -- Authors: [Kyle Den Hartog](kyle.denhartog@evernym.com) +- Authors: [Kyle Den Hartog](mailto:kyle.denhartog@evernym.com) - Status: [RETIRED](/README.md#retired) - Since: 2020-10-14 - Status Note: This decorator is retired, replaced with the use of the signed form of the attachment decorator diff --git a/features/0309-didauthz/README.md b/features/0309-didauthz/README.md index 34ae5f281..86a981c60 100644 --- a/features/0309-didauthz/README.md +++ b/features/0309-didauthz/README.md @@ -1,5 +1,5 @@ # Aries RFC 0309: DIDAuthZ -- Authors: [George Aristy](george.aristy@gmail.com) SecureKey Technologies +- Authors: [George Aristy](mailto:george.aristy@gmail.com) SecureKey Technologies - Status: [STALLED](/README.md#stalled) - Since: 2024-04-03 - Status Note: No implementations have been created. diff --git a/features/0335-http-over-didcomm/README.md b/features/0335-http-over-didcomm/README.md index d086d3c0e..61928ddac 100644 --- a/features/0335-http-over-didcomm/README.md +++ b/features/0335-http-over-didcomm/README.md @@ -1,5 +1,5 @@ # 0335: HTTP Over DIDComm -- Authors: [Filip Burlacu](filip.burlacu@securekey.com) (SecureKey) +- Authors: [Filip Burlacu](mailto:filip.burlacu@securekey.com) (SecureKey) - Status: [STALLED](/README.md#stalled) - Since: 2024-04-03 - Status Note: No implementations have been created. diff --git a/features/0347-proof-negotiation/README.md b/features/0347-proof-negotiation/README.md index 5bca2e518..575e9ce3d 100644 --- a/features/0347-proof-negotiation/README.md +++ b/features/0347-proof-negotiation/README.md @@ -1,6 +1,6 @@ # Aries RFC 0347: Proof Negotiation -- Authors: [Philipp Rieblinger](p.rieblinger@esatus.com), [Sebastian Weidenbach](s.weidenbach@esatus.com) +- Authors: [Philipp Rieblinger](mailto:p.rieblinger@esatus.com), [Sebastian Weidenbach](mailto:s.weidenbach@esatus.com) - Status: [PROPOSED](/README.md#proposed) - Since: 2019-12-13 - Status Note: Initial proposal after discussion on rocketchat diff --git a/features/0351-purpose-decorator/README.md b/features/0351-purpose-decorator/README.md index 501b4fea2..30e647976 100644 --- a/features/0351-purpose-decorator/README.md +++ b/features/0351-purpose-decorator/README.md @@ -1,5 +1,5 @@ # Aries RFC 0351: Purpose Decorator -- Authors: [Filip Burlacu](filip.burlacu@securekey.com) +- Authors: [Filip Burlacu](mailto:filip.burlacu@securekey.com) - Status: [STALLED](/README.md#stalled) - Since: 2024-04-03 - Status Note: No implementations have been created. diff --git a/features/0360-use-did-key/README.md b/features/0360-use-did-key/README.md index c2d76b633..b7fac14ca 100644 --- a/features/0360-use-did-key/README.md +++ b/features/0360-use-did-key/README.md @@ -1,6 +1,6 @@ # Aries RFC 0360: did:key Usage -- Authors: [Tobias Looker](tobias.looker@mattr.global), [Stephen Curran](mailto:swcurran@cloudcompass.ca) +- Authors: [Tobias Looker](mailto:tobias.looker@mattr.global), [Stephen Curran](mailto:swcurran@cloudcompass.ca) - Status: [ADOPTED](/README.md#adopted) - Since: 2024-05-01 - Status Note: Referenced in a number of Aries RFCs and formalized as part of [AIP 2.0](../../concepts/0302-aries-interop-profile/README.md) did:key method is a [W3C CCG work item](https://w3c-ccg.github.io/community/work_items.html) diff --git a/features/0428-prepare-issue-rich-credential/README.md b/features/0428-prepare-issue-rich-credential/README.md index 6fa471c25..472dda37d 100644 --- a/features/0428-prepare-issue-rich-credential/README.md +++ b/features/0428-prepare-issue-rich-credential/README.md @@ -1,5 +1,5 @@ # 0428: Prerequisites to Issue Rich Credential -- Authors: [Brent Zundel](), [Ken Ebert]() +- Authors: [Brent Zundel](mailto:brent.zundel@evernym.com), [Ken Ebert](mailto:ken@sovrin.org) - Status: [STALLED](/README.md#stalled) - Since: 2024-04-03 - Status Note: No implementations have been created. diff --git a/features/0429-prepare-req-rich-pres/README.md b/features/0429-prepare-req-rich-pres/README.md index 30645b7cf..6c22f6b39 100644 --- a/features/0429-prepare-req-rich-pres/README.md +++ b/features/0429-prepare-req-rich-pres/README.md @@ -1,5 +1,5 @@ # 0429: Prerequisites to Request Rich Presentation -- Authors: [Brent Zundel](), [Ken Ebert]() +- Authors: [Brent Zundel](mailto:brent.zundel@evernym.com), [Ken Ebert](mailto:ken@sovrin.org) - Status: [STALLED](/README.md#stalled) - Since: 2024-04-03 - Status Note: No implementations have been created. diff --git a/features/0434-outofband/README.md b/features/0434-outofband/README.md index 3914a7e1e..66a271b21 100644 --- a/features/0434-outofband/README.md +++ b/features/0434-outofband/README.md @@ -1,6 +1,6 @@ # Aries RFC 0434: Out-of-Band Protocol 1.1 -- Authors: [Ryan West](ryan.west@sovrin.org), [Daniel Bluhm](daniel.bluhm@sovrin.org), Matthew Hailstone, [Stephen Curran](swcurran@cloudcompass.ca), [Sam Curren](sam@sovrin.org), [George Aristy](george.aristy@securekey.com) +- Authors: [Ryan West](mailto:ryan.west@sovrin.org), [Daniel Bluhm](mailto:daniel.bluhm@sovrin.org), Matthew Hailstone, [Stephen Curran](mailto:swcurran@cloudcompass.ca), [Sam Curren](mailto:sam@sovrin.org), [George Aristy](mailto:george.aristy@securekey.com) - Status: [ADOPTED](/README.md#adopted) - Since: 2020-03-01 - Status Note: This RFC extracts the `invitation` messages from the [DID Exchange](../../features/0023-did-exchange/README.md) protocol (and perhaps [Connection](../../features/0160-connection-protocol/README.md)), and replaces the combined `present_proof/1.0/request` combined with the `~service` decorator to define an ephemeral (connection-less) challenge. diff --git a/features/0482-coprotocol-protocol/README.md b/features/0482-coprotocol-protocol/README.md index 1674f4140..17810775a 100644 --- a/features/0482-coprotocol-protocol/README.md +++ b/features/0482-coprotocol-protocol/README.md @@ -1,5 +1,5 @@ # Aries RFC 0482: Coprotocol Protocol 0.5 -- Authors: [Daniel Hardman](daniel.hardman@gmail.com) +- Authors: [Daniel Hardman](mailto:daniel.hardman@gmail.com) - Status: [STALLED](/README.md#stalled) - Since: 2024-04-03 - Status Note: No implementations have been created. diff --git a/features/0627-static-peer-dids/README.md b/features/0627-static-peer-dids/README.md index 8d6131de7..aea840735 100644 --- a/features/0627-static-peer-dids/README.md +++ b/features/0627-static-peer-dids/README.md @@ -1,5 +1,5 @@ # Aries RFC 0627: Static Peer DIDs -- Authors: [Daniel Hardman](daniel.hardman@gmail.com) +- Authors: [Daniel Hardman](mailto:daniel.hardman@gmail.com) - Status: [RETIRED](/README.md#retired) - Since: 2021-04-07 - Status Note: formally freezes a set of features that have been relatively stable for about 18 months diff --git a/features/0685-pickup-v2/README.md b/features/0685-pickup-v2/README.md index baddef7a8..58912b2bb 100644 --- a/features/0685-pickup-v2/README.md +++ b/features/0685-pickup-v2/README.md @@ -1,6 +1,6 @@ -# 0212: Pickup Protocol 2.0 +# 0685: Pickup Protocol 2.0 -- Authors: [Sam Curren](telegramsam@gmail.com), [James Ebert](james.ebert@indicio.tech) +- Authors: [Sam Curren](mailto:telegramsam@gmail.com), [James Ebert](mailto:james.ebert@indicio.tech) - Status: [ACCEPTED](/README.md#accepted) - Since: 2024-05-01 - Status Note: Initial version diff --git a/features/0734-push-notifications-fcm/README.md b/features/0734-push-notifications-fcm/README.md index 0f8a86868..4d4380e89 100644 --- a/features/0734-push-notifications-fcm/README.md +++ b/features/0734-push-notifications-fcm/README.md @@ -76,7 +76,7 @@ Message to set the device info using the fcm device token and device platform fo Description of the fields: - `device_token` -- The token that is required by the notification provider (string, null) -- `device_platform` -- The platform used by the sender, e.g. Android / iOS / Linux / etc. ([string](string), null) +- `device_platform` -- The platform used by the sender, e.g. Android / iOS / Linux / etc. (string, null) It is important to note that the set device info message can be used to set, update and remove the device info. To set, and update, these values the normal messages as stated above can be used. To remove yourself from receiving push notifications, you can send the same message where all values MUST be `null`. If either value is `null`, a `problem-report` MAY be sent back with `missing-value`. diff --git a/features/0748-n-wise-did-exchange/README.md b/features/0748-n-wise-did-exchange/README.md index ee3f1f5c8..f5ecafb9f 100644 --- a/features/0748-n-wise-did-exchange/README.md +++ b/features/0748-n-wise-did-exchange/README.md @@ -1,6 +1,6 @@ # Aries RFC 0748: N-wise DID Exchange Protocol 1.0 -- Authors: [Mikhail Lytaev](mikelytaev@gmail.com), [Pavel Minenkov](minikspb@gmail.com) +- Authors: [Mikhail Lytaev](mailto:mikelytaev@gmail.com), [Pavel Minenkov](mailto:minikspb@gmail.com) - Status: [DEMONSTRATED](/README.md#demonstrated) - Since: 2022-08-03 - Status Note: Under research diff --git a/features/0755-oca-for-aries/README.md b/features/0755-oca-for-aries/README.md index 5b2f2f8ea..9b2cbc0e6 100644 --- a/features/0755-oca-for-aries/README.md +++ b/features/0755-oca-for-aries/README.md @@ -1,6 +1,6 @@ # 0755: Overlays Capture Architecture (OCA) For Aries -- Authors: [Stephen Curran](swcurran@gmail.com) +- Authors: [Stephen Curran](mailto:swcurran@gmail.com) - Status: [DEMONSTRATED](/README.md#demonstrated) - Since: 2024-03-02 - Status Note: Implemented in the [Bifold Wallet](https://github.com/openwallet-foundation/bifold-wallet) @@ -30,7 +30,7 @@ differences in the latter two screenshots from the first come from issuer-supplied OCA data. [OCA Specification]: https://oca.colossi.network/specification/ -[RFC0756 OCA for Aries Style Guide]: ../0756-oca-for-aries-style-guide/README.md +[RFC0756 OCA for Aries Style Guide]: ../../features/0756-oca-for-aries-style-guide/README.md ![Example: Using OCA in Aries Bifold](assets/bifold-oca-example.jpg) @@ -417,7 +417,7 @@ as the tooling evolves. - "credential_help_text" - "credential_support_url" - "watermark" - - The "watermark" is used to mark non-production credentials, as described in the ["non-production watermark" section of RFC0756 OCA for Aries Style Guide](../0756-oca-for-aries-style-guide#non-production-watermark) + - The "watermark" is used to mark non-production credentials, as described in the ["non-production watermark" section of RFC0756 OCA for Aries Style Guide](../../features/0756-oca-for-aries-style-guide/README.md#non-production-watermark) - Complete column B (`OL-MV: Meta [Attribute Value]`) as appropriate for each column A name (listed above). - Duplicate and rename the initial language tab for each language or language-country that as an issuer, you want to support. - Update each additional language tab. diff --git a/features/0756-oca-for-aries-style-guide/README.md b/features/0756-oca-for-aries-style-guide/README.md index 8ad079a6e..dc1dc2e07 100644 --- a/features/0756-oca-for-aries-style-guide/README.md +++ b/features/0756-oca-for-aries-style-guide/README.md @@ -1,6 +1,6 @@ # 0756: OCA for Aries Style Guide -- Authors: [Stephen Curran](swcurran@cloudcompass.ca) +- Authors: [Stephen Curran](mailto:swcurran@cloudcompass.ca) - Status: [DEMONSTRATED](/README.md#demonstrated) - Since: 2023-01-05 - Status Note: Implemented in the [Bifold Wallet](https://github.com/openwallet-foundation/bifold-wallet) diff --git a/features/0780-data-urls-images/README.md b/features/0780-data-urls-images/README.md index 53c273153..b0d307528 100644 --- a/features/0780-data-urls-images/README.md +++ b/features/0780-data-urls-images/README.md @@ -1,6 +1,6 @@ # RFC 0780: Use Data URLs for Images and More in Credential Attributes -- Authors: [Stephen Curran](swcurran@cloudcompass.ca), [Clecio Varjao](clecio.varjao@gov.bc.ca) +- Authors: [Stephen Curran](mailto:swcurran@cloudcompass.ca), [Clecio Varjao](mailto:clecio.varjao@gov.bc.ca) - Status: [DEMONSTRATED](/README.md#demonstrated) - Since: 2024-03-02 - Status Note: Implemented in the [Bifold Wallet](https://github.com/openwallet-foundation/bifold-wallet) diff --git a/features/0794-did-rotate/README.md b/features/0794-did-rotate/README.md index a02afd0d9..0218fdae2 100644 --- a/features/0794-did-rotate/README.md +++ b/features/0794-did-rotate/README.md @@ -1,6 +1,6 @@ # Aries RFC 0794: DID Rotate 1.0 -- Authors: [Sam Curren](telegramsam@gmail.com) +- Authors: [Sam Curren](mailto:telegramsam@gmail.com) - Status: [ACCEPTED](/README.md#accepted) - Since: 2024-03-02 - Status Note: Implemented in the [Aries Cloud Agent Python](https://github.com/hyperledger/aries-cloudagent-python) diff --git a/features/0804-didcomm-rpc/README.md b/features/0804-didcomm-rpc/README.md index bb997cc28..ea9ed8388 100644 --- a/features/0804-didcomm-rpc/README.md +++ b/features/0804-didcomm-rpc/README.md @@ -1,6 +1,6 @@ # 0804: DIDComm Remote Procedure Call (DRPC) -- Authors: [Clecio Varjao](clecio.varjao@gov.bc.ca) (BC Gov), [Stephen Curran](swcurran@cloudcompass.ca) (BC Gov), [Akiff Manji](amanji@petridish.dev) (BC Gov) +- Authors: [Clecio Varjao](mailto:clecio.varjao@gov.bc.ca) (BC Gov), [Stephen Curran](mailto:swcurran@cloudcompass.ca) (BC Gov), [Akiff Manji](mailto:amanji@petridish.dev) (BC Gov) - Status: [DEMONSTRATED](/README.md#demonstrated) - Since: 2024-03-02 - Status Note: Implemented in an [Aries Cloud Agent Python plugin](https://github.com/hyperledger/aries-acapy-plugins), and [Credo TS](https://github.com/openwallet-foundation/credo-ts) @@ -202,7 +202,7 @@ this protocol in the event that a `request` is not recognizable as a [JSON-RPC] message and as such, a [JSON-RPC] response message cannot be created. See the details below in the [Problem Report Message](#problem-report-message) section. -[RFC 0015 ACKs]: ../features/0015-acks/README.md) +[RFC 0015 ACKs]: ../features/0015-acks/README.md [RFC 0035 Report Problem]: ../features/0035-report-problem/README.md #### Request Message diff --git a/index.md b/index.md index 1436eb3f5..feff6a829 100644 --- a/index.md +++ b/index.md @@ -42,11 +42,11 @@ * [0049: Repudiation](concepts/0049-repudiation/README.md) (2019-03-01 — [`concept`](/tags.md#concept)) * [0050: Wallets](concepts/0050-wallets/README.md) (2018-07-01, [1 impl](concepts/0050-wallets/README.md#implementations) — [`concept`](/tags.md#concept)) * [0183: Revocation Notification 1.0](features/0183-revocation-notification/README.md) (2024-05-01 — [`feature`](/tags.md#feature) [`protocol`](/tags.md#protocol)) -* [0212: Pickup Protocol 2.0](features/0685-pickup-v2/README.md) (2024-05-01 — [`feature`](/tags.md#feature) [`protocol`](/tags.md#protocol)) * [0496: Transition to the Out of Band and DID Exchange Protocols](features/0496-transition-to-oob-and-did-exchange/README.md) (2021-11-24 — [`feature`](/tags.md#feature) [`community-update`](/tags.md#community-update) [`test-anomaly`](/tags.md#test-anomaly)) * [0519: Goal Codes](concepts/0519-goal-codes/README.md) (2021-04-15 — [`concept`](/tags.md#concept)) * [0587: Encryption Envelope v2](features/0587-encryption-envelope-v2/README.md) (2021-04-15 — [`feature`](/tags.md#feature)) * [0646: W3C Credential Exchange using BBS+ Signatures](features/0646-bbs-credentials/README.md) (2021-04-28 — [`feature`](/tags.md#feature)) +* [0685: Pickup Protocol 2.0](features/0685-pickup-v2/README.md) (2024-05-01 — [`feature`](/tags.md#feature) [`protocol`](/tags.md#protocol)) * [0721: Revocation Notification 2.0](features/0721-revocation-notification-v2/README.md) (2024-05-01 — [`feature`](/tags.md#feature) [`protocol`](/tags.md#protocol)) * [0793: Unqualified DID Transition](features/0793-unqualfied-dids-transition/README.md) (2023-07-11, [12 impls](features/0793-unqualfied-dids-transition/README.md#implementations) — [`feature`](/tags.md#feature) [`community-update`](/tags.md#community-update)) * [0794: DID Rotate 1.0](features/0794-did-rotate/README.md) (2024-03-02 — [`feature`](/tags.md#feature) [`protocol`](/tags.md#protocol)) @@ -65,7 +65,6 @@ * [0809: W3C Verifiable Credential Data Integrity Attachment format for requesting and issuing credentials](features/0809-w3c-data-integrity-credential-attachment/README.md) (2024-01-10 — [`feature`](/tags.md#feature) [`protocol`](/tags.md#protocol) [`credentials`](/tags.md#credentials) [`test-anomaly`](/tags.md#test-anomaly)) ## [PROPOSED](README.md#proposed) -* [: ](concepts/0799-long-term-support/README.md) (2023-11-07 — [`concept`](/tags.md#concept)) * [0028: Introduce Protocol 1.0](features/0028-introduce/README.md) (2019-04-15 — [`feature`](/tags.md#feature) [`protocol`](/tags.md#protocol)) * [0034: Message Tracing](features/0034-message-tracing/README.md) (2018-10-24 — [`feature`](/tags.md#feature) [`decorator`](/tags.md#decorator)) * [0056: Service Decorator](features/0056-service-decorator/README.md) (2019-06-03 — [`feature`](/tags.md#feature) [`decorator`](/tags.md#decorator)) @@ -98,6 +97,7 @@ * [0734: Push Notifications fcm Protocol 1.0](features/0734-push-notifications-fcm/README.md) (2022-05-12 — [`feature`](/tags.md#feature) [`protocol`](/tags.md#protocol)) * [0757: Push Notification](concepts/0757-push-notification/README.md) (2022-11-02 — [`concept`](/tags.md#concept)) * [0771: AnonCreds Attachment Formats for Requesting and Presenting Credentials](features/0771-anoncreds-attachments/README.md) (2023-02-24 — [`feature`](/tags.md#feature) [`protocol`](/tags.md#protocol) [`credentials`](/tags.md#credentials) [`test-anomaly`](/tags.md#test-anomaly)) +* [0799: Aries Long Term Support Releases](concepts/0799-long-term-support/README.md) (2023-11-07 — [`concept`](/tags.md#concept)) ## [STALLED](README.md#stalled) * [0024: DIDComm over XMPP](features/0024-didcomm-over-xmpp/README.md) (2024-04-03 — [`feature`](/tags.md#feature)) diff --git a/mkdocs.yml b/mkdocs.yml index 053f7d71f..473541be2 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -162,11 +162,11 @@ nav: - 0049 Repudiation: concepts/0049-repudiation/README.md - 0050 Wallets: concepts/0050-wallets/README.md - 0183 Revocation Notification 1.0: features/0183-revocation-notification/README.md - - 0212 Pickup Protocol 2.0: features/0685-pickup-v2/README.md - 0496 Transition to the Out of Band and DID Exchange Protocols: features/0496-transition-to-oob-and-did-exchange/README.md - 0519 Goal Codes: concepts/0519-goal-codes/README.md - 0587 Encryption Envelope v2: features/0587-encryption-envelope-v2/README.md - 0646 W3C Credential Exchange using BBS+ Signatures: features/0646-bbs-credentials/README.md + - 0685 Pickup Protocol 2.0: features/0685-pickup-v2/README.md - 0721 Revocation Notification 2.0: features/0721-revocation-notification-v2/README.md - 0793 Unqualified DID Transition: features/0793-unqualfied-dids-transition/README.md - 0794 DID Rotate 1.0: features/0794-did-rotate/README.md @@ -183,7 +183,6 @@ nav: - 0804 DIDComm Remote Procedure Call (DRPC): features/0804-didcomm-rpc/README.md - 0809 W3C Verifiable Credential Data Integrity Attachment format for requesting and issuing credentials: features/0809-w3c-data-integrity-credential-attachment/README.md - PROPOSED: - - 0799 Long Term Support: concepts/0799-long-term-support/README.md - 0028 Introduce Protocol 1.0: features/0028-introduce/README.md - 0034 Message Tracing: features/0034-message-tracing/README.md - 0056 Service Decorator: features/0056-service-decorator/README.md @@ -216,6 +215,7 @@ nav: - 0734 Push Notifications fcm Protocol 1.0: features/0734-push-notifications-fcm/README.md - 0757 Push Notification: concepts/0757-push-notification/README.md - 0771 AnonCreds Attachment Formats for Requesting and Presenting Credentials: features/0771-anoncreds-attachments/README.md + - 0799 Aries Long Term Support Releases: concepts/0799-long-term-support/README.md - STALLED: - 0024 DIDComm over XMPP: features/0024-didcomm-over-xmpp/README.md - 0029 Message Trust Contexts: concepts/0029-message-trust-contexts/README.md diff --git a/tags.md b/tags.md index 6ad75f24d..a146fa01e 100644 --- a/tags.md +++ b/tags.md @@ -15,8 +15,7 @@ Defines a specific, concrete feature that [agents](concepts/0004-agents/README.m Defines a general aspect of the Aries mental model, or a pattern that manifests in many different features. ### `community-update` -An RFC that tracks a community-coordinated update, as described in [RFC -0345](../../concepts/0345-community-coordinated-update/README.md). Such updates +An RFC that tracks a community-coordinated update, as described in [RFC 0345](concepts/0345-community-coordinated-update/README.md). Such updates enable independently deployed, interoperable agents to remain interoperable throughout the transition. @@ -24,7 +23,7 @@ throughout the transition. Relates to [verifiable credentials](https://www.w3.org/TR/vc-data-model/). ### `rich-schemas` -Relates to next-generation schemas, such as those used by [https://schema.org](schema.org), as used in verifiable credentials. +Relates to next-generation schemas, such as those used by [https://schema.org](https://schema.org), as used in verifiable credentials. ### `test-anomaly` Violates some aspect of our [policy on writing tests for protocols before allowing their status to progress beyond DEMONSTRATED](/README.md#accepted). RFCs should only carry this tag temporarily, to grandfather something where test improvements are happening in the background. When this tag is applied to an RFC, unit tests run by our CI/CD pipeline will emit a warning rather than an error about missing tests, IFF each implementation that lacks tests formats its notes about test results like this: