Skip to content

Maxwell CC2 User Guide

Kun edited this page Sep 10, 2020 · 4 revisions

中文

Maxwell 1.0 is now live. Maxwell is the public TestNet of Crust Network. Users can apply for Maxwell TestNet tokens and conduct operations like transfer, staking and storage. Users can also run TestNet nodes, and become different roles like candidate, validator, and storage provider. Welcome to Maxwell.

What is Maxwell?

Maxwell is a test version of Crust Network. It is open to the public for testing. The purpose is to find and fix possible problems before the Crust Network MainNet goes live, and to continuously optimize based on TestNet feedbacks. The Maxwell TestNet is completely open for everyone to access and join. The core code repos have been open source, users can build and install according to this guide.

Notice

  1. Crust Network protocol implementation has not yet been fully stabilized and completed, so it may stop running unexpectedly.
  2. Crust Maxwell 1.0 test tokens (CRU) has no value except to test. Users can be rewarded by submitting bugs and suggestions.

Feature Overview

1. Token Transfer

1. Crust Apps →「Transfer」

2. Crust Cloud →「Wallet」

2. Staking(GPoS)

The staking function in the Crust Network is completed through "guarantee" operation. Accounts with CRU tokens can become guarantors. Guarantors can use their CRUs to provide guarantees for a selected set of nodes, and get corresponding staking reward.

1. Crust Apps →「Staking」

2. Crust Cloud →「Staking」module

3. Storage

Storage users refer to users who use storage resources in the Crust network. Currently, storage users need to use CRU tokens to purchase storage services.

Crust Cloud →「Storage」module

4. Run nodes

Users who have storage resources can run two kinds of nodes: validators and candidates.

Validators are nodes responsible for packaging and generating blocks in Crust network. They maintain the consensus of the entire blockchain. A validator node needs to stake a certain amount of CRU tokens according to its storage resources, and needs to stay online. Therefore, a validator node also provides storage resources. Validators can obtain block packaging rewards and the reward share of each era, and also bear the risk of being slashed.

Candidates are nodes that participate in competition to become validators, but have not been qualified yet. The difference between candidates and validators is that the candidate nodes do not participate in the block generation, and cannot obtain the reward of block generation. They can get reward share of each era though.

Both validator and candidate nodes can obtain income by selling storage services in the storage market.

This document mainly explains how different roles participate in Crust Maxwell 1.0, and provides detailed introductions.

Join Maxwell 1.0

4 major ways to join

NOTES: Before you start, you need to get some TestNet tokens.

  1. To be a Validator/Candidate, please refer to the Node Instructions section.
  2. To be a Storage Provider, please refer to the Node Instructions section.
  3. To be a Guarantor, please refer to the User Instructions section, to understand the concept of "guarantee" and operate accordingly.
  4. To be a Storage User, please refer to the User Instructions section, to try out the file upload and download functions.

Node Instructions

Overview

The Crust Network is composed of nodes that provide storage resources. This section describes how to run a node, act as different roles and get rewards accordingly.

How to run a node

Please refer to the Node Setup Manual.

Roles and Instructions

1. Validator/Candidate

Follow the Node Setup Manual to setup and launch a node. Once the storage work report is uploaded to chain successfully, the node's staking limit can be seen through Crust Apps. Next, you can perform functions like Bond, Stake, Set Guarantee Fee.

  • Bond
    You can bond the controller and stash accounts through Crust Apps. Note that all the initial bonding amount will be staked automatically.

  • Guarantee Fee

    Please refer to Crust's economic white paper for more details. Briefly, at each era once staking reward is received, a node will give certain amount of staking reward to its guarantors according to the ratio that Guarantee Fee defines. For example, 100% Guarantee Fee means that the guarantors receive all the staking reward, and 80% means that the guarantors can get 80% (corresponding to the guarantee amount).

  • Staking Limit
    During Crust Maxwell 1.0, the staking limit is calculated as: 1TB storage space is mapped to 88,000 CRU.

  • Reward

    • Block reward(Validator Only)
      At the beginning of each era, new Validators will be selected. In Crust Maxwell 1.0, the block reward is 5.073 CRU per era.

    • Staking Reward
      All Candidates can get Stake rewards, which will be distributed according to the ratio of their own staking to the total staking. In Crust Maxwell 1.0, the staking reward is 285.192 CRU per era.

  • Slash
    Maxwell's slash mechanism is similar to Kusama. Generally speaking, each session monitors whether the Validator (block-producing node only, Candidate is not affected) is online to decide the slash. The upper limit of the slash is 7% of the staking amount. If in one session, the validator offline rate is less than 10%, slash will not be triggered.

2.Storage Provider

Follow the Node Setup Manual to setup and launch a node. Once the storage work report is uploaded to chain successfully, you need to complete 2 steps to become a Storage Provider:

  • Pledge
    The pledge determines the upper limit of storage orders that the node can accept. Every time an order is received, the pledge will be consumed. The consumption ratio is 1:1 in Maxwell 1.0. For example, when a node pays a pledge of 100 CRU, it can only accept storage orders with a total price of 100 CRU.

  • Register
    Please refer to the corresponding steps of the Node Setup Manual to complete the storage provider registration steps. After completing the registration, storage users can view the registration information of the node on the chain, and then place storage orders and store files to the node.

  • Reward
    Storage Providers can obtain income from the storage orders paid by users.

  • Punishment
    In Crust Maxwell 1.0, a node can be punished if it lost files of storage orders, according to following punishment conditions. In 300 eras:

    • 15 work reports lost (SLA more than 95%): no punishment;
    • 15 to 30 work reports lost (SLA from 90% to 95%): The pledge of the order is deducted by half;
    • 30+ work reports lost, (SLA < 90%): all the pledge of the order will be deducted, the order is terminated, and the remaining unlocked amount of the order will be returned to the storage user;

User Instructions

Users can participate in the Crust network in multiple roles. As a guarantor, a user can perform a guarantee operation to complete the staking, get the staking reward, and meanwhile contribute on the stability and security of the entire network; as a storage user, a user can place storage orders and obtain storage services. This section describes the detailed user instructions

Guarantor

Guarantor is one of the core concepts in GPoS. Guarantors use their CRUs to provide guarantees for a selected set of nodes (both Validator and Candidate nodes), and get staking reward accordingly.

1. Create accounts

  • Create stash account

Select "Accounts" in the left navigation bar, then click "Add account".

Enter the account name and the password to protect the account, click "Save", the account will be backed up on your device by default.

We use the first newly created account TESTACCOUNT as the Stash account. The Stash account is the user's main account, used to manage the user's assets. Some CRUs are required in the account for subsequent operations such as various transactions and asset mortgages.

  • Create controller account

Repeat the steps of creating account, to create the controller account.

You can name the new account as “TEST_CONTROLLER” to remark that this account will be used as a Controller to manipulate assets. Some CRUs are required in the account to pay transaction fees for various actions.

2. Transfer CRUs in

Transfer some CRU tokens to your stash account and controller account. Please keep most of your CRU tokens in stash account for guarantee, the tokens in controller account are mostly for transaction fees.

3. Establish a bond relationship

Click "Staking" in the left navigation bar, and click "Account actions".

Click "Bond" in the upper right corner, and select Stash and Controller accounts accordingly in the pop-up page, fill in the amount of Bond required (the amount here represents the amount allowed to operate on the Controller account), and then click "Bond".

Since the Bond action involves on-chain operations, it is necessary to unlock the Stash account and consume some fee.

Finally, Bond is successful, and you can see a new Bond relationship has been created in the page.

4. Select Validator or Candidate

Go to "Staking"->"Staking overview", you can view the current status of all validators. Among them, the staking limit is calculated by the storage space provided by the node, which represents the upper limit of stake that the node can accept; total stake represents the amount of the node's own stake plus the sum of the amount guaranteed by all guarantors to the node, and if the total stake reaches Stake limit, the node cannot receive more stakes and guarantees; the own stake represents the amount that the node stakes to itself; the guarantee fee represents the node guarantee fee ratio, the higher the guarantee fee ratio, the higher the income guarantor obtained by guaranteeing the node; points represent the score obtained by the current era node, which will affect the reward at the end of era.

5. Guarantee

In “Account actions” page, Click the function button under the“Bond”butto, click “Set guarantee”.

Select one account from “candidate accounts”, it will move to “guaranteed accounts”list, enter amount to guarantee and click “Guarantee”.

After the end of current era, you can find your guarantee listed in “Staking”-> “Staking overview”page, under the “other stake”list of corresponding validator.

The guaranteed income will go to the Stash account by default. But if the node you guarantee is offline or encountered some other mistake, there will be certain penalties impact your guarantee fee.

Storage User

The storage function is one of the key functions of Crust network. Storage users can pay a certain amount of CRUs to store files through storage service provided by Storage Providers. For detailed instructions, please refer to the user manual of the cloud storage application Crust Cloud (Coming in the early September).