Comments & Ratings (WIP)

[trentmc]

This for Ocean Market, a community market, or other.

Key ref:

• "Spec: Data NFT-based Comments & Credentials" GDoc. Includes extensive user stories, analysis of where to store, and schema.

Other refs:

• OceanDAO R14 project Comments & Ratings Integration. Status: the project team is working at this, in a way that reconciles with V4 Ocean Market timing. Discussions in several channels including comments in port, emails, etc
• contracts #509 "Goal: single tx to create NFT & publish metadata". This was implemented in early 2022 as part of Ocean V4. It provides the backend to cleanly support this issue.

Related issues (but not key anymore):

• multi-repo #2 "People who have consumed data can give a rating". Current status: very old, not really touched, this issue (1073) will supersede
• market #252 "Custom community signals". Current status: UTU is actively working on this, in a way that reconciles with V4 Ocean Market timing

[Jo-ravar]

Trello board:
https://trello.com/b/uXbDU5pf/ocean-comments-rating-project

Miro mindmap :
https://miro.com/app/board/uXjVOMyXR-c=/?invite_link_id=95432424396

Figma Design:

[Jo-ravar]

16/02/22 Meeting Feedback:

After getting the feedback on storing comments the end conclusions are:

1. Store comments as data assest/NFT (ERC721).

• Storing comments as dataNFT will make it GDPR compliant and will also comprise of owner info. Also dataNFT will not require dataTokens and service-asset details making comments access free.

2. Store actual comments & ratings within data NFT's metadata storing.

• Storing actual comment in metadata will help us to leverage the power of aquarius and elasticsearch to make complex query over the metadata to fetch all comments & comments of comments.

3. Use Aquarius to query over metadata of comment data-NFT. to load comments & comments of comments

[Jo-ravar]

@trentmc @AnaLoznianu

Here are the UI designs for the comments & ratings:

https://www.figma.com/proto/VMNg81myi0jqFYRI2KX0DH?node-id=0%3A1
https://www.figma.com/proto/J7k48vTPbIivAVBIR574Oi?node-id=0%3A1

Can you review this and let us know if there are any changes or addition is required?

[trentmc]

Hi @Jo-ravar, thanks for this design.

Feedback

• It needs to be shown in the context of Ocean Market (v4)
• Some places it has "comments", other places "reviews". "Comment" is more general than "review", I think it's better to use that everywhere.
• Comments might have ratings, and vice versa. The current prototype appears to have separate entry of one versus the other. Please reconcile.
• Please show how one might enter a comment that responds to another comment
• Please show what many nested comments might look like
• The prototype shows a name & profile pic for every commenter / rater. Ocean Market does not have information about profile pics. It's just eth addresses. Each eth address may or may not be tied to more info (eg 3box profile); but for a first cut of comments/ratings you don't need to look at that other info. Perhaps replace with some auto-generated image as a function of eth address, eg like we see in etherscan (see left of the address):
  

[Jo-ravar]

@trentmc We have updated the design based on the feedback. Can you check it out now:

https://www.figma.com/proto/VMNg81myi0jqFYRI2KX0DH/Om-Review-sect?page-id=0%3A1&node-id=58%3A58&viewport=302%2C48%2C0.23&scaling=contain&starting-point-node-id=2%3A3

Also you can view and try comments of comments and submit functionalities in the design itself. Let us know if there is any improvement there?

This is how it will look in context to ocean marketplace:

[trentmc]

Thanks for the update. First quick q: how can I submit both a comment andrating at once, where it gets stored in the same data nft? This will be a very common use case. More generally: this was one of my points of feedback last time. Please ensure you address it, and other points of feedback. Then ping me for review. Thanks!

[Jo-ravar]

@trentmc No comments and rating's wont be stored in same data-nft and we will create a separate data-nft for each dataset & algorithm.

So that comments and rating can be made separately and there will be no need to modify the data-NFT.

@trentmc Let us know if you have any further feedback on the design

[trentmc]

I agree, a given comment/rating from a person is separate from the data nft itself. That was always the way.

What I am saying is that if a person gives a comment and a rating at once, it should be on the same comment/rating nft. My concern by your prototype is that you don't make is possible to provide a comment and rating at once. Yet this should be the default way.

[Jo-ravar]

@trentmc Yes, with our current design it wont be possible to make comments and ratings at once and the reason for this as follows:

1. With the current design while a user can make multiple comments over the data-set but ratings can be provided only once.
2. If the ratings & comments are put together it will look more like rating of comments and not the rating of dataset.

Not only this make design more clean the rating calculation is more simplified. By keeping this two points in mind we completely separate them-out as individual entity but if we want to go with comments and ratings together my only concern is how to deal with multiple parent comments made by same user?

[trentmc]

In doing a rating that on Amazon or Google maps, it can have a comment attached. After the first comment, you can give additional comments but not additional ratings.

Perhaps that's what you can do here too: in the Gui, only allow the rating with the first comment. After that, comments only.

[Jo-ravar]

@trentmc Here are the design changes as per your suggestion:
https://www.figma.com/proto/wX8AOCOHfvYdfJ6e28Il3B/Om-Review-sect-(Original)?page-id=0%3A1&node-id=2%3A3&viewport=302%2C48%2C0.14&scaling=contain&starting-point-node-id=2%3A3

Parent comment will have the rating. You can try the above design:

Can you please check this out?

[trentmc]

It looks like it renders the combined comment + rating well, great. Looks good! (Read)

For the part where someone to post a comment, it doesn't seem to have an integrated way to post the rating. It should. (Write)

Also, the prototype should show:

• what a tree of comments looks like, and how the rating is only on the top comment
• the read and write when just a root comment (no rating) is given
• the read and write when just a rating (no comment) is given

If you would like further intuition, play around with reading & writing comments and ratings in Google Maps or in Amazon, you'll see what I mean.

[Jo-ravar]

@trentmc We have updated the design based on your suggestions. Can you review this now:
https://www.figma.com/proto/wX8AOCOHfvYdfJ6e28Il3B/Om-Review-sect-(Original)?page-id=0%3A1&node-id=2%3A3&viewport=302%2C48%2C0.12&scaling=min-zoom&starting-point-node-id=2%3A3

We have covered your mentioned points:

1. Tree of comments with parent comment rating

2. Read and write with just comment or rating

3. Comment and rating popup

[trentmc]

Thanks for updates. This looks good from my perspective.

[idiom-bytes]

@Jo-ravar I'm wondering if you have an update for this.

[Jo-ravar]

@idiom-bytes @trentmc After the launch V4 we started working on this.
But stuck at place and need some help in few question's on data-NFT.

Can we setup call for this?

[trentmc]

@Jo-ravar Sure. I'll DM you.

[kremalicious]

The important product design questions are: Who moderates the comments? How can comments be deleted?

[trentmc]

The important product design questions are: Who moderates the comments? How can comments be deleted?

Great Q's. Over the weekend I wrote down actual specs for a comments & ratings system. The specs include A's to those Q's.

I linked to them as the very first item of this issue. For convenience, here they are: https://docs.google.com/document/d/1EsriynHL3dJHzg9vCmq6mGfnN5uJs3I18QFTs6QWVjM/edit#

[mihaisc]

Not doing this in the near future, we can reopen if we shift focus on the market again