-
Notifications
You must be signed in to change notification settings - Fork 30
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
47 additions
and
67 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,125 +1,105 @@ | ||
| # POCM Tutorial | ||
|
|
||
| The SCO platform allows projects to use smart-contract based POCM (Proof of Credit Mining) to create a SCO (Staked Coin Output) node. NULS holders can stake into the projects' SCO nodes and receive the newly-generated project tokens, instead of their usual NULS staking rewards. The SCO project node continuously earns the NULS staking rewards that would otherwise be rewarded to the NULS stakers, and projects can use the rewards to bootstrap and help fund development. The SCO platform and POCM allow this same functionality to be used with any public chain or assets in any blockchain ecosystem | ||
| The SCO platform facilitates the use of smart-contract-based POCM (Proof of Credit Mining) to establish a SCO (Staked Coin Output) node. NULS holders can stake in the projects' SCO nodes and receive the newly-generated project tokens, foregoing their usual NULS staking rewards. The SCO project node continuously earns the NULS staking rewards that would typically go to NULS stakers, allowing projects to bootstrap and fund development. The SCO platform and POCM extend this functionality to any public chain or assets in any blockchain ecosystem. | ||
|
|
||
| ## Test environment | ||
| POCM is a decentralized product based on smart contracts. Users (especially project issuers) can familiarize it with the operational process in the test environment, avoiding misuse and causing asset losses. | ||
| ## Test Environment | ||
| POCM is a decentralized product based on smart contracts. Users, especially project issuers, should familiarize themselves with the operational process in the test environment to avoid misuse and potential asset losses. | ||
|
|
||
| - POCM test environment：[http://beta.pocm.nuls.io/](http://beta.pocm.nuls.io/) | ||
| - Light wallet test environment：[https://beta.wallet.nuls.io](https://beta.wallet.nuls.io) | ||
| - Explorer test environment:[http://beta.nulscan.io/](http://beta.nulscan.io/) | ||
| - POCM Test Environment: [http://beta.pocm.nuls.io/](http://beta.pocm.nuls.io/) | ||
| - Explorer Test Environment: [http://beta.nulscan.io/](http://beta.nulscan.io/) | ||
|
|
||
| ## NULS holders | ||
| ## NULS Holders | ||
|
|
||
| You can stake your NULS to the project you like, and then you can get Token from the project, and the NULS used for staking will not be lost. The steps of NULS holder participation on the POCM platform are as follows: | ||
| NULS holders can stake their NULS in the projects they support and receive project tokens. The staked NULS remains safe, and the participation steps are as follows: | ||
|
|
||
| ### Participate POCM | ||
|
|
||
| On the [pocm platform](https://pocm.nuls.io/), click the [Select Item] menu, enter the page and select the approved item, click to enter the item details page. | ||
| 1. Visit the [POCM platform](https://pocm.nuls.io/) and click the **Select Item** menu. | ||
| 2. Enter the page, select the approved item, and click to view item details. | ||
|
|
||
|  | ||
|
|
||
| On the project details page, enter the number of NULS you want to stake (the amount of staking cannot be lower than the minimum value set by the project team, the value can be viewed in the project details), click [Participate POCM] | ||
| 3. On the project details page, enter the staking amount (must meet the project's minimum requirement) and click **Participate POCM**. | ||
|
|
||
|  | ||
|
|
||
| ### Receiving rewards | ||
| ### Receive Rewards | ||
|
|
||
| The contract will be awarded once every 5 blocks.After the reward is issued, the user needs to click the [Receive reward] on the right side of the [User Center] page. After the successful receiving, the contract will transfer the rewards to the participating address in real time. After the lockout time is over, the Token can be used (the specific unlock time can be viewed in Project details) | ||
|
|
||
| > Receiving a reward is an operation that calls a contract, so you need to consume a small amount of NULS | ||
| 1. Rewards are issued every 5 blocks. | ||
| 2. Click **Receive Reward** on the right side of the **User Center** page. | ||
| 3. After successful receipt, the contract transfers rewards to the participating address in real-time. | ||
| 4. Tokens become usable after the lockout time (viewable in project details). | ||
|
|
||
|  | ||
|
|
||
| ### Add rewards | ||
| ### Add Rewards | ||
|
|
||
| The user can continue to participate in the pocm of a certain item in the project details, or add it via the [ Add ] button on the right side of the participating item list on the [User Center] page. | ||
| Users can continue participating in the POCM of a specific item or add rewards via the **Add** button on the **User Center** page. | ||
|
|
||
| ## Project team | ||
| ## Project Team | ||
|
|
||
| You can use [POCM (SCO distribution platform) ](https://pocm.nuls.io/) to attract NULS community members as the first group of supporters, continue to obtain NULS consensus reward as the project development fund, and get full empowerment of NULS community and ecology.The steps to participate are as follows: | ||
| Project teams can use POCM to attract NULS community members as initial supporters. The process involves obtaining NULS consensus rewards as the project development fund. The steps are outlined below: | ||
|
|
||
| ### Submit basic information | ||
| ### Submit Basic Information | ||
|
|
||
| Click the [Select Project] menu on the pocm platform, enter the page, click the [Issue Project] button and fill in the basic information and submit | ||
| 1. Click the **Select Project** menu on the POCM platform. | ||
| 2. Enter the page, click **Issue Project**, and submit basic information. | ||
|
|
||
|  | ||
|
|
||
| ### Issue Token | ||
|
|
||
| ### Issued Token | ||
|
|
||
| Click the [Issue Token] menu on the POCM platform and click on the NRC-20 token issued by yourself in the form to fill in the entry information (please pay attention to re-fill the token name and symbol completely and accurately, and need to be the same as the previous step) Token information be consistent) | ||
| 1. Click the **Issue Token** menu on the POCM platform. | ||
| 2. Fill in the NRC-20 token information. | ||
| 3. Ensure token details match the submitted basic information. | ||
|
|
||
|  | ||
|
|
||
| ### Issue pocm contract | ||
| After the basic information is submitted, the project team needs to send an email to the email address: pen@nuls.io. The content of the email is as follows: | ||
|
|
||
| - project name | ||
| - Provide an account address (please keep the private key of the address by yourself) for subsequent release of POCM contracts | ||
| ### Issue POCM Contract | ||
|
|
||
| After receiving confirmation from NULS that their project has been approved, users can import their POCM account to the POCM platform and enter the [user center] page to issue POCM contracts. | ||
| 1. After submitting basic information, send an email to pen@nuls.io with project details and a provided account address for subsequent POCM contract releases. | ||
| 2. Once approved, import the POCM account to the POCM platform and issue POCM contracts in the **User Center**. | ||
|
|
||
|  | ||
|
|
||
| Fill the form and publish the contract according to the project team's own POCM distribution rules. | ||
| 3. Fill the form and publish the contract following the project team's POCM distribution rules. | ||
|
|
||
|  | ||
|
|
||
| ### Transfer the token to the contract | ||
| ### Transfer Token to the Contract | ||
|
|
||
| Import the address holding the token into the [wallet](https://wallet.nuls.io/), go to the [ Contract ] page, find the token and click [ call ] | ||
| 1. Import the token-holding address into the [wallet](https://wallet.nuls.io/). | ||
| 2. Go to the **Contract** page, find the token, and click **Call**. | ||
|
|
||
|  | ||
|
|
||
| Go to the calling page and select the `transfer` method of the token contract. | ||
| 3. Select the `transfer` method of the token contract. | ||
|
|
||
|  | ||
|
|
||
| Fill in the POCM contract address that has been successfully issued, and then fill in the number of Tokens transferred (because of the calculation unit, you need to add n zero after the actual number,n = the decimal of the token you issued ） and finally click [ call ] | ||
| 4. Fill in the POCM contract address, the number of tokens (considering decimals), and click **Call**. | ||
|
|
||
|  | ||
|
|
||
| At this point, the user can already see the project information on the pocm platform and stake NULS for new tokens | ||
|
|
||
| ### Add node | ||
|
|
||
| **On the NULS network, the reward generated by staking NULS to the consensus node will be split into two parts:** | ||
| - Consensus node commission (consensus rewards generated by the commission * consensus node commission ratio), this part is directly assigned to the reward address of the consensus node | ||
| - Staking rewards (consensus rewards generated by staking - Consensus awards generated by staing * Consensus node commission ratio), which is directly assigned to the staking address | ||
|
|
||
| On the POCM platform, the POCM contract will stake the NULS that the user delegate to the contract to the consensus node that you added. The contract address will receive the staking rewards generated by staking. The creation address of the contract has the authority to transfer the staking reward.You can invokes the `transferConsensusRewardByOwner ` method in [contracts] page for Reward transfering. | ||
| 5. Stake NULS for new tokens on the POCM platform. | ||
|
|
||
|  | ||
| ### Add Node | ||
|
|
||
| **There are two ways to get a node:** | ||
| - [Create Node](https://docs.nuls.io/zh/Guide/g_pocm.html)by yourself. With this method, you can receive both the consensus node commission and the staking reward. | ||
| - Use the consensus node already on the NULS network. With this method, you can only receive the staking reward. | ||
|
|
||
| **How to add nodes:** | ||
|
|
||
| On the POCM platform, click [User Center], enter the page and click [Add Node] to enter the ID of the node. | ||
| On the POCM platform, click **User Center**, enter the page, and click **Add Node** to input the node's ID. | ||
|
|
||
|  | ||
|
|
||
| After the node is successfully added, the POCM contract will stake the NULS of the user delegated to the added nodes in turn. If there are multiple nodes, the order of staking is the order of adding the nodes. | ||
|
|
||
| ### Remove a node | ||
|
|
||
| If you need to delete an added node, you need to enter the [Contract] page of the wallet (the operation address should be which creates the POCM contract), find the POCM contract, click [call] | ||
|  | ||
|
|
||
| Select the contract's `removeAgent` method, enter the node's hash value, click [call].The node will be deleted successfully after the contract is successfully called | ||
|
|
||
|  | ||
| After adding the node, the POCM contract will sequentially stake user-delegated NULS to the added nodes. | ||
|
|
||
| On the next version of the POCM product, you will be able to delete nodes directly on the [User Center] page. Please wait patiently. | ||
| ### Remove a Node | ||
|
|
||
| ## Consensus node | ||
| To delete an added node, enter the [Contract] page, find the POCM contract, click **Call**, select the `removeAgent` method, enter the node's hash value, and click **Call**. | ||
|
|
||
| As a consensus node On the NULS network, you can work with the project team. The way is: Project team can can add your node as the running node of the project on POCM platform, so that the NULS delegate by the users into the project contract will be automatically stake to your node. Node can obtain the following two parts of rewards | ||
| ## Consensus Node | ||
|
|
||
| - the node's staking will increase, so the node will receive more NULS commissions | ||
| - node [create address] will receive tokens from the project, the number of tokens is directly proportional to the deposit of the node, the detailed formula is: the number of tokens obtained by the node = your node deposit/(the total number of NULS delegate to the project by the user * 0.9 + the total amount of deposits of all nodes running on the project) * the total number of tokens distributed by the project | ||
| As a consensus node on the NULS network, collaboration with project teams involves adding the node as the running node on the POCM platform. This enables users to delegate NULS to the project contract, automatically staking to the node and obtaining rewards. | ||
|
|
||
| **receive tokens distributed by the project:** import the create address of the node on POCM platform, then enter [user center] and click [receive rewards] on the right side of the list,then you can see tokens on your wallet asset page | ||
| 1. **Receive Tokens Distributed by the Project:** | ||
| - Import the create address of the node on the POCM platform. | ||
| - Enter [User Center], click **Receive Rewards** on the right side of the list. | ||
| - Tokens are visible on the wallet asset page. |