CIP-0124? | Extend token metadata for translations #488
Conversation
Add a property for string localization to prepare NFTs and metaverse solutions for mass adoption.
Added first draft of CIP proposal with implementation examples.
Added copyright section.
Added strings localization support for collections and for multi-asset policies.
Changed TypeScript implementation.
Added Github repos and relevant links for proposal authors.
Reverted last changes as it breaks YAML syntax
There was a problem hiding this comment.
Please rename your project folder from CIP-1856 to something else beginning with CIP- but not a number (derived from your proposal name, or ????). This is relatively important for 1856 because we had a potential CIP-1856 for a while: #104
rphair
changed the title
rphair
added
the
Category: Metadata
rphair
changed the title
Adjustment CIP ID from pull request review. Co-authored-by: Robert Phair <rphair@cosd.com>
Changed Status to "Proposed" Co-authored-by: Robert Phair <rphair@cosd.com>
Simplified title according to pull request review. Co-authored-by: Robert Phair <rphair@cosd.com>
Co-authored-by: Robert Phair <rphair@cosd.com>
Co-authored-by: Robert Phair <rphair@cosd.com>
Co-authored-by: Robert Phair <rphair@cosd.com>
Co-authored-by: Robert Phair <rphair@cosd.com>
Improved wording on Abstract and Motivation.
Fixed YAML
Added Implementation plan and updated standard extension proposal with alternative to reduce the size of the metadata.
|
Thanks @granada-pool for the latest updates & including the peer review from NMKR. Can you please rename the project folder from |
There was a problem hiding this comment.
@Padierfind if you could please assist here:
- This proposal seems good enough for me to approve (mainly based on web standards experience; I'm not a token metadata expert) if we could have a peer review, or even just an acknowledgement, of this PR coming from the NMKR direction.
- If there are any revisions to how your peer review is presented in the CIP please suggest alternative language and/or discuss it in this PR.
Co-authored-by: Robert Phair <rphair@cosd.com>
|
Hey guys, any updates on this proposal? |
There was a problem hiding this comment.
@granada-pool in my last request #488 (review) I'd been hoping for some community endorsement of your proposed method: hence the wait for something else to happen either from the community or from you.
Editorially your proposal still seems good as a suggested method... especially since no other applicable method has been suggested here in the last year or more. Let me suggest some format corrections and then we'll see if the other active editors @Ryun1 @Crypto2099 also feel the same about assigning a CIP number to this one & getting it merged around the next CIP meeting or two.
In any case I've put it up for review at the next CIP meeting so we can all have a second look at it together & move forward: https://hackmd.io/@cip-editors/90
| ### Implementation Plan | ||
| Add this new standard to all relevant documentation and references for web3 developers. | ||
|
|
||
| NMKR has supported this CIP with peer feedback, and in the future with a pilot implementation of this localization method. |
There was a problem hiding this comment.
@Padierfind (if you are still the appropriate contact for NMKR) please validate this if you can, along with any other contributions you can make to the review of this proposal (echoing my earlier request from #488 (review)).
Co-authored-by: Robert Phair <rphair@cosd.com>
Co-authored-by: Robert Phair <rphair@cosd.com>
Co-authored-by: Robert Phair <rphair@cosd.com>
Co-authored-by: Robert Phair <rphair@cosd.com>
Co-authored-by: Robert Phair <rphair@cosd.com>
Co-authored-by: Robert Phair <rphair@cosd.com>
There was a problem hiding this comment.
@granada-pool I've taken the liberty of d984401 rather than rounds of proposed changes: cleaning up some redundant markup in the Copyright section and reorganising & marking up your Path to Active with tickboxes and rephrasing as goals which editors and the community can verify.
Please double check my changes for this commit and especially confirm which boxes should currently be ticked. Since there is no feedback from @Padierfind or NMKR associates you may have to provide some evidence of their involvement (other than the "feedback" you mention) if you want to cite their implementation of your proposal.
@rphair sounds good! I have contacted @Padierfind, but I haven't gotten an answer yet. Meanwhile, the best evidence I can provide is our chat on X (in German): Patrick suggested keeping the translations off-chain (similarly to ETH), as they can easily surpass the memory limits of Cardano, which was shortly added to the proposal after the exchange of ideas. |
|
thanks @granada-pool ... no need to put the messaging / social network threads in the CIP; they're sufficient in this PR. Any news you get about implementations (NMKR or otherwise), just add them here before the PR is merged: or in an other PR (perhaps to indicate |
|
|
||
| This convention is compatible with most operative systems (Linux and Windows) and widely used translation software. | ||
|
|
||
| ### Proposed structure |
There was a problem hiding this comment.
As this contains on-chain data, I believe it must also have a CDDL specification (see here).
| console.log(`Default asset name: ${getAssetString(policy, <asset_name>, "name")}`); | ||
| console.log(`Localized asset name: ${getAssetString(policy, <asset_name>, "name", "de-CH")}`); | ||
| ``` | ||
|
|
There was a problem hiding this comment.
| ## Rationale: how does this CIP achieve its goals? | |
Please add a rationale section!
There was a problem hiding this comment.
@granada-pool @Ryun1 sorry to have missed that in my own review. If you have nothing to add in the Cardano sphere, the first 2 or 3 paragraphs in your Specification (equivalent conventions in the conventional Internet) would help to provide Rationale for doing it this way.
| @@ -0,0 +1,139 @@ | |||
| --- | |||
| CIP: ? | |||
| Title: Extend token metadata for translations | |||
There was a problem hiding this comment.
| Title: Extend token metadata for translations | |
| Title: CIP-25 - Extend token metadata for translations |
might make sense to do something like this, as this is a strictly CIP25 extension
| Current token metadata only supports a single hardcoded language (mostly English), which limits the accessibility to a certain culture. To get closer to mass adoption, we need to bring down language barriers by extending the current standard to support translations. This is especially relevant for games, metaverse solutions, and RealFi use cases of NFTs. | ||
|
|
||
| ## Specification | ||
| This proposal follows the same specifications as [CIP-0025](https://github.com/cardano-foundation/CIPs/blob/master/CIP-0025). |
There was a problem hiding this comment.
Probably want to be specific here, for which version of CIP-25 this applicable to https://github.com/cardano-foundation/CIPs/tree/master/CIP-0025#cddl
rphair
changed the title
There was a problem hiding this comment.
@granada-pool this was generally seen at tonight's CIP meeting to be ready to progress to the final Last Check stage before merge as soon as @Ryun1's feedback above is addressed. (The CDDL spec is a rather big thing that it needs first.)
Please also change the containing directory name to CIP-0124 🎉
| @@ -0,0 +1,139 @@ | |||
| --- | |||
| CIP: ? | |||
There was a problem hiding this comment.
| CIP: ? | |
| CIP: 124 |
This proposal defines an additional property to the NFT and FT metadata standard to support text localization.
(rendered proposal in branch)