Skip to content

Commit 70a8cb3

Browse files
rphairRyun1
andauthoredJan 6, 2024
CIP-0020 | Adjust preamble and structure w.r.t CIP-0001 (cardano-foundation#647)
* first draft remediation of CIP-0020 * fixing grammatically mangled Abstract * more readable with colon * language with less puctuation Co-authored-by: Ryan Williams <44342099+Ryun1@users.noreply.github.com> --------- Co-authored-by: Ryan Williams <44342099+Ryun1@users.noreply.github.com>
1 parent 31f64c9 commit 70a8cb3

File tree

1 file changed

+15
-6
lines changed

1 file changed

+15
-6
lines changed
 

‎CIP-0020/README.md

+15-6
Original file line numberDiff line numberDiff line change
@@ -33,10 +33,10 @@ License: CC-BY-4.0
3333

3434
## Abstract
3535

36-
This CIP describes a basic JSON schema to add messages/comments/memos as transaction metadata by using the metadatum label **674**.
37-
Adding **informational text, invoice-numbers or similar** to a transaction on the cardano blockchain.
36+
This describes a basic JSON schema to add messages/comments/memos as transaction metadata by using the metadatum label **674**:
37+
allowing informational, commerical, or any other text to be included in a transaction on the Cardano blockchain.
3838

39-
## Motivation
39+
## Motivation: why is this CIP necessary?
4040

4141
We have the utilities on the cardano blockchain now since the introduction of the "allegra-era". A simple consens about adding messages, comments or memos to transactions is still missing.
4242
So the CIP authors came together to form a first implementation of this. It is straight and simple, additional keys and content can be added later.
@@ -132,8 +132,7 @@ The number of theses **message-strings** must be at least one for a single messa
132132
**CNTools**:<br>
133133
![image](https://user-images.githubusercontent.com/47434720/130353491-fc0f3a69-1937-4e72-b680-c04cc069b5c4.png)
134134

135-
136-
## Rationale
135+
## Rationale: how does this CIP achieve its goals?
137136

138137
This design is simple, so many tools on the cardano blockchain can implement it easily. The array type was choosen to have consistency, no need to switch between a string or
139138
an array format, or testing against a string or array format. Updates in the future are possible, like adding a versioning key `"ver":`, adding a key `"utxo":` to provide specific data for every tx-out#idx in the transaction, adding the `"enc":` key like for encrypted messages, making subarrays in the message-strings, etc. But for now, we need a common agreement to provide general messages/comments/memos with this CIP. The starting design war choosen as simple as possible to keep the additional transaction fees as low as possible.
@@ -163,7 +162,17 @@ _Optional to consider for the implementer:_
163162
* For message creation both single-line and multi-line input should be considered valid. The wallet/tool isn't required to support multi-line input.
164163
* Message display in explorers/wallets should however preferably support multi-line messages even if it only supports single-line on creation. Not a requirement but should at least indicate that there are more data if only the first line is displayed. Maybe a link to explorer etc in the case it's not possible to solve in UI in a good way.
165164

166-
The implementation format in this CIP should be the ground base for transaction messages/comments/memos and should be respected by creator-/sender-implementations as well as in wallet-/receiver-/display-implementations.
165+
## Path to Active
166+
167+
### Acceptance Criteria
168+
169+
- [x] There exist a variety of wallet-based, dApp, and CLI implementations of this standard, developed by a a wide variety of providers, and is in regular use.
170+
171+
### Implementation Plan
172+
173+
As per the first two Discussion links:
174+
- [x] The format in this CIP has been the ground base for supporting transaction messages / comments / memos.
175+
- [x] The format and its interpretation have been considered and implemented by both creator/sender implementations and wallet/receiver/display implementations.
167176

168177
## Copyright
169178

0 commit comments

Comments
 (0)
Please sign in to comment.