CIP-0102 | Reference Implementation

[SamDelaney]

A reference implementation for CIP-0102 royalties, written in Lucid (offchain) and Aiken (onchain).

In this reference implementation you'll find examples of:

• Minting a CIP 102 compliant NFT with royalties
• Validators for storing royalty metadata
  • Always Fails (royalty cannot be modified)
  • Reducible (royalty cannot be increased, but can be decreased)
• Reading a CIP 102 NFT’s royalties off chain
• Reading and validating against CIP 102 NFT royalties on chain

This code has not been audited and is NOT INTENDED FOR PRODUCTION, but to provide code examples of expected behavior.

[SamDelaney]

I still have some cleanup for clarity and consistency to be done here, and may dabble in some optimizations; however, it's now fully featured & ready for review by interested parties who don't mind digging through some sub-optimal code. Feedback is very welcome :)

I will mark as ready for merge when I'm satisfied with my sanitization.

[rphair]

thanks @SamDelaney for keeping this standard moving along & bringing your progress into the CIP process. 🙏

We have a long held standard of not including representative code in CIPs: this was an editorial decision made about 3 years ago & upheld in several instances since then. Beyond maintaining a proper focus on CIPs as documentation, mainly this is because any changes to the code should not be made subject to editorial approval or even involvement.

This matter has always been resolved by keeping CIP reference implementations in a different repository. I think that would work well for this case, and therefore that this PR should be redrafted to simply characterise your reference implementation (and of course updating your Path to Active) with links to that code repository as necessary.

If you would like to me to find links GitHub discussions where this process was mandated by consensus, please let me know and I'll try to dig them up. As with all of the CIP process this is always subject to review so @Ryun1 @Crypto2099 @KtorZ would also be welcome to confirm or contradict this recommendation.

[SamDelaney]

@rphair I was not aware of that decision, thanks for letting me know! No links necessary, I trust you 😄

I'll move my code to another repo & update this PR accordingly.

[SamDelaney]

Moved the code I had here to a new repo as requested. I can include my disclaimers about production readiness & general lack of polish in that repo, so I see no reason to delay this PR. Marking as ready for review & merge.

[rphair]

@SamDelaney #848 (comment): @rphair I was not aware of that decision, thanks for letting me know! No links necessary, I trust you 😄

Thanks for your trust but I thought [recalling incorrectly] that one of the outcomes of that past deliberation was to update CIP-0001 (and now that I think about it, CIP-9999) with this reservation. I'll submit a change request in the near future which would have the additional advantage of the 3 currently active editors unanimously confirming both this policy & the language used to express it. cc @Crypto2099 @Ryun1

[rphair]

Will be happy to approve this because it just updates the Path to Active along with the link to the completed reference implementation. It looks like it's getting very close to Active status now (but not there yet; please anyone correct me if this appears incorrect).

Will sign off on this once the empty file & directory are removed under ref_impl.

[SamDelaney]

@rphair I think you may have misread the files changed. TODO.md was already included in the last PR so I'm just removing it here.

Here's the current state of the CIP-102 subdirectory, and here's what I'm updating it to with this PR.

[rphair]

thanks @SamDelaney, I didn't misread the files changed... I just temporarily forgot how git works 🤪

[Ryun1]

LGTM!

thanks for the update @SamDelaney

[rphair]

Marked Last Check so we can merge at Tuesday's meeting (or before then) once @Crypto2099 can also give it a look: https://hackmd.io/@cip-editors/92

[Crypto2099]

These changes make sense and it's good to see the external links to the reference implementation so that can be iterated on asynchronously from the CIP Editors workflow.

[rphair]

taking off agenda & merging then, since unanimous 🚀