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

Community: CIP for Transactions and Reports on chain data #147

Open
matiwinnetou opened this issue Feb 10, 2025 · 2 comments
Open

Community: CIP for Transactions and Reports on chain data #147

matiwinnetou opened this issue Feb 10, 2025 · 2 comments
Labels
documentation Improvements or additions to documentation

Comments

@matiwinnetou
Copy link
Collaborator

matiwinnetou commented Feb 10, 2025

A community member: @Crypto2099 is requesting that not only on-chain format specification / documentation would be available from main Reeve website (https://www.cardanofoundation.org/reeve) but also that we put CIP regarding's reeve metadata format regarding Transaction and Reports with explanation of all fields.

This ticket is a placeholder for both items:

Learnings and insights:

  • @Crypto2099 is not intrested in Reeve itself yet (e.g. because it is java, they don't want to operate it, they think it may be over complicated) but they are intersted to write their own software and manage the process to put on chain data
  • @Crypto2099 and others maybe missing deep accounting knowledge so would like to piggy back on existing CF's format with explanation (very well understandable)
  • @Crypto2099 expressed they wouldn't like the on chain format to change (there are no such plans but additive changes are unavoidable)

CC: @cleanerm5 @Kammerlo @M4rc0Russ0

@matiwinnetou matiwinnetou added the documentation Improvements or additions to documentation label Feb 10, 2025
@matiwinnetou matiwinnetou changed the title Community Request: CIP for Transactions and Reports on chain data Community: CIP for Transactions and Reports on chain data Feb 10, 2025
@Crypto2099
Copy link

Thanks for creating the issue @matiwinnetou :)

I know enough Java that I can read the code and understand what it's doing if I have to, I just don't like to 😄

There were a few blog posts and other pieces of documentation that have been published so far around the Reeve project and would like for this to be discoverable from the main Reeve page https://cardanofoundation.org/reeve rather than simply a "Contact Us" page that led to me making the Twitter/X post in the first place.

I understand that sometimes on-chain formats need to adapt and change but this is what versioning is for, the CF has already begun publishing some transactions on-chain as a proof of concept and things like this must be supported forever (ideally) which is why a versioning scheme should be a first order priority in such situations where the schema may be actively being manipulated and changed as new learnings arise during the development process.

@Kammerlo
Copy link
Member

Kammerlo commented Feb 10, 2025

@Crypto2099 I followed the X Thread and thanks also from my side for your feedback, we will take this into account!
I'm currently working on improving the documentation and the on-chain formats are one crucial part.

Besides that there will also be other explanation of e.g. modules, data flow and a demo app. We hope that this will increase the transparency and reusability. When I'm done, I'm happy to hear your feedback :)

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

No branches or pull requests

3 participants