# How to Run PoS Node
With Enecuum, it is possible to use the Trinity protocol (a combination of PoA, PoS and PoW) as well as functionality such as ETM (Enecuum Token Machine), delegation to PoS nodes (delegated smart staking), issuing of different types of tokens - mining, NFT and other.
# Staking and PoS Contracts
General idea of staking is depositing (or "delegating" as we call it below) your funds to PoS-nodes to increase their stake power to remain in top 100 wallets (as only the richest wallets are allowed to perform PoS work) for a share from PoS mining rewards. To guarantee it, this share is calculated thoroughly, and in time, PoS contracts are introduced. These contracts control delegated funds in a way that they can be used only for PoS mining and a delegator can always return coins.
So if you want to run a PoS node you should create a PoS contract first (make a special transaction). Then, you can run a node - a piece of software associated with the PoS contract.
Think of it this way: when you create a PoS contact, you establish a bank. When you delegate your funds to a PoS contract, you open a bank deposit.
# Create a PoS Contract
To create a PoS contract, use a web-wallet interface.
There two input fields. PoS contract name, which can be left blank, and a PoS contract fee. Contract fee determines the "salary" PoS owner receives for running a server. Choose it wisely, as if you set it too small, you can loose money paying for your sever; but if you set it too high, nobody will delegate funds to you and you can be out of top 100 with no earning at all. This commission percent will be adjustable in the future but with first release it cannot be changed after creation.
After confirming PoS contract transaction and paying a transaction fee, please wait a bit. You will see a new record in the blockchain. Please find you contract at PoS contracts page. If your PoS name is blank, you can find your contract by owner address. It should be the wallet you used to send PoS contract creation transaction.
Click Hash value of your contract to copy your PoS contract hash (address). In this test case, it is 17d0b43aafb141dbc4e36ae0abefc2b28b3979f96a84cdecf7e26dc25bd1c042, as can be seen in the figure above, marked with red. The hash will be used in the next step.
In order for the contact to become active, you need to fulfill these requirements:
- delegate 25001 ENQ to the created contract from the same wallet (the one used for the contract creation);
- be in the top 100 rating of PoS contracts;
- run the PoS node.
# Delegate to Your PoS Contract
In order for the contract to become active, you need to delegate to it. The minimum self-delegated stake is 25001 ENQ.
To find out how to delegate your funds, refer to the according guide.
# Add Description to Your PoS Contract
If you want, you can add description in different languages and social media links to your PoS contract.
- Fork Enecuum's Blockchain Explorer repository.
- Add PoS contract description in the
assets/info/pos-info-storage-enq.jsfile. Use the existing data as an example.
- Do a pull request. You can use Genesis Lab pull request as a reference.
- In web wallet, go to "My POS Contracts" tab. Select "Manage" next to your PoS contract.
- In the "Message" field, type in the pull request number and confirm the transaction.
- Wait until the transaction is processed. Navigate to the "History" tab and search for the transaction that was done in the previous step. You may need to reload the page a few times.
- Copy the transaction hash.
- In the pull request, leave a comment with the transaction hash. Wait until the team reviews your pull request.
# Run a PoS Node
Note that PoW and Fullnode can only work with public IP addresses. The IP address can be static or dynamic.
Minimal hardware requirements are 1 CPU, 2 GB of RAM, 20 GB of disk. These are like of a small VPS server offered by the majority of hosting providers. Disk requirements will rise with the size of the blockchain and are estimated as 1 TB in 1-2 years. Please note this minimal hardware may not let your node to achieve maximum performance (and rewards). Recommended hardware requirements will be published after PoS software updates bringing planned optimizations.
Current build nodes work stable only on Linux OS. There are network issues running nodes on Windows and Mac.
components are deployed through Docker, a platform meant for building, sharing, and running applications with containers. So first of all, download Docker for your OS using official guides. For Windows users, we recommend Docker Toolbox. Linux users can follow Docker guide for Ubuntu.
After installing Docker, download the database that will be used in your Fullnode, PoW or PoS. This is a mandatory step.
docker run -d --name pulse_db -e MYSQL_ROOT_PASSWORD=<your_db_password> enecuum/pulse_db
Working with Docker is easy. The following list of commands should be enough for basic use:
- stop the container:
docker stop <container-name>;
- show stopped containers:
docker ps -a;
- start the container:
docker start <container-name>;
- show active containers:
- show logs:
docker logs <container-name>;
- show Docker disk usage:
docker system df -v.
- stop the container:
You can stop/restart the container without worrying; no data will be lost.
# How to Run PoS
Carefully read the prerequisites above. Check that you have the database installed:
A container named pulse_db should appear:
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES 0f59855cf0ea enecuum/pulse_db "docker-entrypoint.s…" 6 seconds ago Up 5 seconds 33060/tcp pulse_db
If you don't see the container in the list, please follow the instructions provided in the prerequisites.
Generate public and private keys using Enecuum App or Web Wallet. Do a backup copy. You can use the same key pair for PoA, PoS and PoW.
If you have not done it yet, create a PoS contract using the instructions above.
Download and run PoS container:
docker run -ti --name pulse_pos --link pulse_db:dbhost -p8000:8000 -e POS_ID=<your_pos_id> -e PORT=8000 -e DB_PASS='<your_db_password>' -e PEER='126.96.36.199:8000' -e DB_PORT=3306 -e LAG_INTERVAL=300 -e SYNC_INTERVAL=258 -d enecuum/pulse_pos
<your_pos_id>parameter value to the PoS contract hash without brackets <>. You can use the hash from the previous step as the POS_ID parameter. Type your database password in
The command above starts PoS in a fast sync mode, if you want to download full blockchain history please remove "-e LAG_INTERVAL=300 -e SYNC_INTERVAL=258" from the command.
Check if your container is running:
A list with pulse_db and pulse_pos containers should appear.
Wait for synchronization to be completed. After that your PoS contract will be displayed as "Active" and its performance will rise with each published s-block. You can compare current block number from the Blockchain Explorer with your nodes current block with
docker logs pulse_pos | grep n: | tailcommand.
# Update the PoS Node
Periodically, the Enecuum team releases PoS node updates. When it happens, your node may stop running. To update your node, please follow the steps.
Stop the node:
docker stop pulse_pos
Remove the PoS node container:
docker rm pulse_pos
Remove the PoS node image:
docker rmi enecuum/pulse_pos
Restart the PoS node. Please remember to change the
<your_pos_id>parameter value to the PoS contract hash and the
<your_db_password>to your database password:
docker run -ti --name pulse_pos --link pulse_db:dbhost -p8000:8000 -e POS_ID=<your_pos_id> -e PORT=8000 -e DB_PASS='<your_db_password>' -e PEER='188.8.131.52:8000' -e DB_PORT=3306 -d enecuum/pulse_pos
You can check your PoS node page in the Blockchain Explorer to see if it is running. It might take a few minutes. If the node is not operating, contact the support.
# Additional Commands
# Erase logs
You might need to erase your PoS logs if you want to free up disk space.
Empty logs of the PoS node:
docker exec pulse_pos pm2 flush
Empty docker logs. Note that this will empty logs for ALL docker containers of you server, not only PoS node:
truncate -s 0 /var/lib/docker/containers/*/*-json.log;
# Save logs
If there are problems with running the node, you might need to save your docker logs and share them with the Enecuum team. No personal information will be saved.
Upload your log file:
docker logs pulse_pos > pulse.log && curl -F "[email protected]" https://file.io
You should see the following message:
If the team asks you for the logs, send the link to the file.
# View Your Delegators and Rewards
At the PoS contract page (list of all contracts is here), you can find the amount of delegated coins and rewards that your contract receives. Please note that rewards shown in the Blockchain Explorer are split between PoS owner and its delegators according to your PoS fee value.