Kleros Curate Tutorial
How to create Token Curated Lists using Kleros Curate
Upon landing on Curate, you will be greeted with a screen similar to the above. Initially, you will see a list of cards which are each lists of their own. This is the top level (a list of lists if you will) which can be related to the top level ‘Music’ category in the Amazon example. Below music, we had a tree-like structure of subgenres each pertaining to their own list.
The first thing we’re going to do is create a list ourselves. This involves deploying two smart contracts (these are the inner logic and workings of the platform) to the Ethereum blockchain.
Click ‘Create a List’ in the header which will direct you to the initial creation page
Reasonably self explanatory, the title of your list. To illustrate in the simplest form, I chose something reasonably straightforward in Hiphop Legends.
A short write up of what your list is about.
- Acceptance Criteria
This field is a critical piece of information for the smooth operation of your list. The Primary Document (or acceptance criteria) is the document specifying what can and can't be accepted to the list.
For our example Hip Hop Legends list, the criteria document is as follows:
- Accept if Gold or Platinum record selling artist
- Accept if famous before 2016
- Accept if > 100k YouTube view on at least one song
- Reject if trap artist
- Reject if grime artist
- Reject if parody artist
- Reject if PG friendly lyrics
- Item name
This is the field in which you would choose the overall name for the items submitted to your list. In our case, an item (or submission) is ‘Hip Hop Legend’ which will be listed in the ‘Hip Hop Legends’ list.
The item could be Eminem, Tupac, Snoop Dogg, etc.
The slider is the easiest way to set the parameters for your list. If you’re an advanced user, you can follow the instructions below.
The cheaper the ETH submission price, the more likely you will see submissions made as it’s less risky to do so. However, it’s also more likely to see malicious submissions due to the cheaper cost of doing so. The opposite is also true for high ETH deposit submissions. The higher they are, the less likely you will receive malicious entries, but fewer submitters may want to take the risk of submissions.
- Court & Jurors
Here, you will select which court the challenged submissions from your list will go to be resolved. Each court has differing arbitration costs which are correlated to the difficulty of the case in question.
If your list is of high value (see the slider) you may want to choose a higher cost court. If however, it’s a low cost list, you would probably want to use a far cheaper court. For most lists, we recommend using the ‘Curate’ court however, if your list is more complicated, feel free to contact us here to ask.
The advanced parameters are for power users looking to tweak deeper settings within the List builder. If you need more information on these variables, click here for a detailed overview from our Research Lead, William George.
For now, here's a quick overview.
- Item Name
What are the items you are submitting to this list? The example will pertain to certain high performance cars meeting the policy but it could also be a list of decentralized exchanges, the most valuable sneakers or highest valued (in the eyes of the community) crypto projects.
- Submission Deposit
This is the cost for a user to submit an item to your list in ETH. Remember, it’s a deposit stake so they will get it back if the submission is accepted.
- Removal Deposit
It’s possible that submissions make it on that may be subjective, somewhat borderline or adhering to an earlier set of criteria. If that’s the case, users can make an ETH deposit to remove a registered item on the list. Note, the item still has to go through a ‘challenge period’ and is not delisted immediately. It’s possible that jurors will rule that the removal request was not valid meaning the initial user who made it, would lose their deposit.
- Challenge Submission Deposit.
If a user makes a submission to a list that another user doesn’t believe meets the policy criteria, it can be challenged. A high challenge cost could make it less likely that items will be challenged however, a lower challenge cost could mean an increase in ‘bad challenges’. I.e, items that do merit acceptance to the list but are challenged otherwise.
- Challenge Removal Deposit
It is in fact possible to challenge a removal request which can be tweaked in this parameter. As an example:
An item that has previously been accepted to the list was subsequently challenged for removal by user A. User B doesn’t think it should be removed from the list and challenges User A.
Fill in all the parameters as you want and click next.
Add Your Items
This screen lets you define your items, or fields that will be used on the list. You can add as many as you need.
Here, we can see only two separate fields were necessary for our simple Hip Hop Legends list.
We’ve called the first one ‘Name’, selected it as a text field and set ‘Index’ to on. The index button makes it possible for users to search based on that field. For example: If we submitted a Hip Hop Legend with the name ‘ Eminem’, users can search throughout the whole list just by searching for Eminem.
The second field is a simple image field allowing users to add a picture of their legend.
Badges allow your list to specify even more parameters which add ‘badges’ to certain submissions. This can create a tiered system in which an original submission is later ‘upgraded’ in its submission weight with further qualities.
As an example, we could add a ‘Grammy’ badge to our Hip Hop Legends list which specifies only submissions (Hiphop Legends) that have Grammy’s can apply for that badge.
Another example could be that of a ‘Platinum’ badge which specifies only submissions to list that have platinum selling records are allowed that badge.
Once you’ve made it to the final screen, you’re now ready to deploy. You can also go back to previous screens and make sure all the information is correct.
If you’re happy with it, click Deploy!
On doing so, you’ll be asked to pay the contract deployment fees (both for the list and the badges. If you don’t need badges, that list is still available for use at a later date).
Once you accept the Metamask transactions and pay the fees, your list will be deployed.
The List of Lists homepage. When you click 'Browse' you will instantly be directed to this page.
Once you've created your list it isn't automatically added to our Browser Registry. Your list is still fully usable but won't show up for users visiting the homepage of the Curate site.
Submitting your list to the list of lists requires similar actions as submitting an item did earlier.
Add your list to the 'List of lists' by clicking on the 'Submit List' button. You'll need to make a deposit confirming your list fits the criteria in the above image.
If accepted, your list will remain in The Registry indefinitely unless it is challenged at a later date. This may be due to the list going off topic or spammy for example. If a large amount of the listings no longer conform to the policy, that would be a reasonable challenge in this case.The current Curate homescreen showing The Registry (List of Lists) and some pending submissions.
Once your list has been deployed, you are ready to submit items. As you can see in the image above, our list has two submissions.
The first is not yet registered and the second has been challenged which replaces the original card with a ‘potentially offensive content’ placeholder which can be revealed by the user.
Click ‘Submit Hiphop Legend’ (Remember that ‘Item Name’ field from the list creator? Here it is).
A Hip Hop Legend item ready to submit. Notice the deposit required is 0.075ETH. If the listing is accepted, you’ll get that back.
If it’s challenged, this deposit is used as part of the collateral used to pay jurors for the arbitration. You win, it’s returned, if you don’t, it’s lost.
Select the listing you want to challenge and write a description of why you think it doesn’t belong on the list. This information will be sent to Kleros jurors who will make a decision on whether it makes it onto the list or not.