Skip to content

kamalzaman/helpdesk

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

186 Commits
 
 
 
 
 
 

Repository files navigation

Guides to get started on our current testnet in links below

Table of Contents

Overview

This repo contains detailed guides and help for users to interact with our current testnet.

Contribute

If you find something that is wrong or missing, please make an Issue, or better yet, fork the repo and make a PR to help us improve! It might even qualify for a reward. For more information on this, please see the bounties repo.

Get Paid to Participate

Some of the roles will be compensated in Monero. Our philosophy behind the choice of paying for participation is outlined in this blog post. Information about the current incentive structure can be found in the list of Active Roles below.

How it Works

Note After introducing Memberships to the platform, we found it to be confusing to have a concept of both Accounts and Memberships. We are in the process of renaming the Accounts to the Keys, but there are still traces of Accounts showing up.

In order for us to know what address to pay, you must tie your Joystream address to your monero address. The easiest way to do this is in the My memo tab under the My Keys sidebar.

# Only the part in the line below goes in the memo:
"4or8YourXmrAddressInDoubleQuotesAndNothingElse"

For our convenience, we ask you to use a regular address or sub-address (95 char) instead of the (106 char) payment-ID style address. The latter will not be paid out automatically, but if you ask nicely, you might get away with it once.

Get Started

To get started and participate on the Joystream testnets, you must first generate Key(s), and sign up for a Membership. This requires no software or downloads, and can be done in your browser here.

Generate Keys

Click My Keys in the sidebar, and then select the Create Keys tab. The choices you make from here, depends a little on how you want to participate. If you just want to play around, you can just follow the defaults. If you have a specific role in mind, you might want to follow the links to the instructions in the header, or access them via Active Roles.

In any event, the Keys will be stored in your browser for your convenience, but it's safest to save your Raw seed (you need it for certain roles) and save the .json file. The Mnemonic can also be used to restore your Keys, but will not do you any good if you want to become a Validator.

Get a Membership

To become a Member of the platform, you need some tokens. Either click the Free Tokens link, or click here. After you solved the captcha, your tokens should be on their way.

Note All transactions (extrinsics) cost 1 Joy token, so you should always keep a little in reserve, as this also applies to such actions as voting, unstaking, and posting in the new forum.

Now, click Members in the sidebar, and select the Register tab. Choose a Handle/nickname. Optionally, provide a link to an image file for your avatar, and fill in the markdown enabled About field.

Active Roles

The list below shows the currently active roles available at our current testnet.

Validators

Description

In proof of stake systems, block producers, or Validators, are typically paid a fixed amount for each block produced. Validators must run a full node.

A detailed guide to setting up the Validator node and settings can be found here.

Incentives

We want to encourage more people on our network to become Validators. Because of this, we are increasing the payout pool from $50 to $100 per week.

blocktime = 6
weekly_reward = 10000
seconds_in_week = 60*60*24*7

blockreward = (weekly_reward * blocktime)/seconds_in_week
print(blockreward)

----

0.10

The number - 0.10 cents per block - seems a bit underwhelming, but validation requires little effort for the user after setup, and blocks come in every 6 seconds. With armv7 binaries or low-end VPS nodes, it should be cheap to run!

Payouts

Validators must include their XMR address in the memo of their stash key.

Payouts will be made every Monday at ~11:00GMT.

Council Members

Description

Council Members are elected by the stakeholders in the system to act in the interest of their constituency. Currently, Council Members can only vote on proposals to upgrade the runtime. In the future, the council will also allocate the platform's resources, and hire executive personnel to run the day-to-day operations.

A detailed explanation of the election cycle and responsibilities can be found here.

Incentives

We are looking at how to best incentivize them to act in the platform's long term interest. The payout for one term as a council member will remain at $10.

If during your term a proposal to upgrade the runtime is submitted by the sudo key, anyone that votes yes will receive a bonus worth $10.

Payouts

During the Announcement and Voting stage, you should include some information about yourself, and why you should get elected in your memo field. If you do get elected, make sure to change the memo field to your monero address in order to get your reward.

Payouts will be made at ~11:00GMT the day after the election/vote.

Storage Providers

Description

You can't have a video platform without videos, so someone has to take the role of storing the data. In the future, this will be a highly specialized role, focusing on what is implied by the name of the role. For Rome, it will in practice also entail the future Bandwidth Provider role.

Unlike Validators that can come and go without too much friction (at least for now), a new Storage Provider will currently need to replicate the entire content directory. As a consequence, the platform needs some stability for this role to avoid providing a poor user experience, or worse, loss of data.

Incentives

Up to eight Storage Providers that keep a full copy of the content directory and provide continuous service for at least 24h will compete for $120 per week. In addition, you will earn $0.03/GB/week (of data in the content directory) calculated on an average basis. You will also need a domain to point to your node, so unless you already own one (that you don't mind using), you will need to buy one.

We will be closely monitoring Storage Providers for Rome (more so than we did for Acropolis) so make sure your node is performing optimally to avoid being booted. Storage Providers should also be aware that the variable part of the compensation structure is likely to be reviewed after launch (up or down) to make sure that providers are fairly compensated for their efforts.

A detailed guide to setting up the node can be found here.

Payouts

Storage Providers must include their XMR address in the memo of their membership key, or their storage key to qualify for rewards. The former is "better", but requires a little more work...

Payouts will be made every Monday at ~11:00GMT.

Content Creators

Description

When the Joystream mainnet is live, Content Creators will be responsible for creating and uploading the enormous variety of different content types and genres which we believe will allow Joystream to grow into a successful decentralized media platform.

Incentives

For the Rome testnet, we will pay a flat-rate Monero reward for every piece of content uploaded by Content Creators up to a weekly limit. We will also pay a $5 bonus on top of this rate for each of the 10 best pieces of content that are uploaded every week to encourage higher quality uploads.

A separate $10 bonus will be paid for up to 10 items of quality "original"* content every week. The maximum weekly incentive pool of $250 will be divided between these two categories of incentive.

*Original here means creative work that you created yourself and own exclusive the rights to.

Prospective Content Creators should also be aware that we will only pay the item reward for content with complete metadata and which follows the set-out requirements for each content type (to be released at a later date).

Uploading illegal or copyrighted content will result in a disqualification from payouts. It will also result in the takedown of content, potentially slashing of funds, and the deletion of your channel. Multiple spam uploads which represent a burden to moderate for the Content Curators may even be penalized and result in deductions on payouts due for qualifying content uploads on your content creator profile.

We will provide Content Creators with a list of sources for safe and non-copyrighted material which can be uploaded as part of this testnet and will qualify for the payments discussed above and laid out in the table below.

Rewards based on content type

CONTENT TYPE MAXIMUM PAYMENT PER ITEM MAXIMUM QUALIFYING UPLOADS MAXIMUM PAYOUT POOL
Video (Standard) $0.50 per video 200 $100
Best Content (Bonus) $5 per video 10 $50
Original Content (Bonus) $10 per video 10 $100

Payouts

Content Creators must include their XMR address in the memo of their membership key.

Payouts will be made every Monday at ~11:00GMT.

Content Curators

Description

Content Curators will one day be essential for ensuring that the petabytes of media items uploaded to Joystream are formatted correctly and comprehensively monitored and moderated. Our upcoming testnet allows this content monitoring to take place by giving users who are selected for the role administrative access to the Joystream content directory to make changes where necessary.

We will have five slots available for Content Curators when Rome is launched, but this may be modified depending on demand and activity. They will need to apply to the Content Curator Lead (a working group lead role operated by Jsgenesis) and will have their application assessed by this lead before being added as a curator for a default term of one week. As the network matures, the Content Curator Lead role will be delegated to a community member.

Incentives

If successful in their application, curators will be rewarded with a flat reward of $30 per week, resulting in a maximum pool of $150 if all five content curators are signed up, and stays in the role the entire week.

There will also be two bonuses of $20 and $10 per week for the two most active curators respectively in terms of monitoring the items in the content directory for compliance with our metadata, category and content rules. These bonuses will be awarded by the Content Curator Lead. In total, during a typical week, Content Curators will be competing for their share of $180 in XMR.

Inactive and/or malicious curators will be booted, and potentially slashed by the Content Curator Lead.

Payouts

Content Curators must include their XMR address in the memo of their membership key.

Payouts will be made every Monday at ~11:00GMT.

Builders and Bug Reporters

Description

Unlike the Validators and Council Members, the bug bounty payments will be somewhat subjective. Long term, such decisions will be resolved by the platform, so in future testnets these payouts will at least partially be made by the Council.

We have recently made a bounties repo where you can find specific tasks and their rewards, and we will add more bounties and evolve the system as we grow. In addition to the bounties we propose, we are always looking for suggestions for bounties from the community.

Incentives

If you find a bug, potential improvement, or just an idea, there are a couple of ways to earn your reward:

Report a software bug

Go to the applicable technical repo(s), e.g. node repo, Pioneer repo, storage node repo, runtime-repo, etc. and make an Issue. You will be compensated based on the importance and "quality", the latter of which is measured from the level of details in general, like how to reproduce, pasted log outputs, etc.

Errors in the helpdesk guides (or a non-code repo)

If you find something missing, inaccurate or poorly described, either report an Issue, or even better, make a Pull request.

This applies equally to this repo as well as the other non-code repos, e.g. landing repo, communications repo, bounties repo, etc. it will most likely be covered by this bounty. Note that the bar here is quite low (grammar, dead links, etc.) so more significant findings can lead to significantly larger payouts.

Fix a software bug, or add/improve a feature

If you want, you can just make a PR directly, and your contribution will be compensated. If it's an extensive job though, it would be best for all parties if you propose a bounty yourself as outlined here. We could then agree on terms in advance, so no one will be left disappointed.

Payouts

The contributor must include either their Joystream or monero address when submitting the issue/PR. If you choose the former, you must then make sure to add your monero address to the memo field of your Joystream address.

Other Features and Future Roles

This section covers other things you can do after getting started, that isn't a paid role as of now.

On-Chain Forum

This is the first step in providing users, infrastructure role participants, Council Members and future stakeholders a way to communicate and coordinate. Hopefully, this method of interaction will further help develop a strong community around Joystream. Note that you have to be a member to post, and only the forum moderator (forum sudo) can create categories.

Glossary

TODO

About

Helpdesk - not sure where to ask? ask here!

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors