ENMC (Equilibrium Node Manage Console)
Learn how to use ENMC to manage the nodes of the blockchain network.
What is ENMC?
ENMC stands for Equilibrium Node Manage Console, a service that can manage the node infrastructure built through the EQ Hub. ENMC is a new management tool that presents through EQ Hub so that nodes that can only be managed through code can be managed with a simple GUI.
Through the ENMC service, you can inquire about the status and various information of nodes in operation, and send a request to update the node status.
Who uses this service?
- Users who want to check the status of operating nodes
- Users who want to update the version and status of the operating node
Requirements
To manage nodes using the ENMC service, node infrastructure built and operated through EQ Hub must exist.
Node infrastructure can be created/built through EQ Hub's Network service or Node service.
To enter ENMC to manage running nodes, you must use a VPN.
What is a VPN?
VPN stands for Virtual Private Network and means a private communication network used to communicate so that the contents communicated using the public network are not exposed to the outside world.
To access via VPN, you need a VPN key and a VPN client to use the VPN key.
Using ENMC Service
Activating VPN
To enter ENMC, download VPN Key and activate it using VPN Client.
There are 3 ways to activate using VPN Client:
- Use the AWS VPN Client.
- (For Mac OS) Use Tunnelblick
After downloading the app named ‘Tunnelblick’ through the web browser, run it.
Open the VPN key file downloaded from EQ Hub and prepare a file with the extension 'ovpn'.
Register the file with the extension ‘ovpn’ in the Tunnelblick app (just drag and drop the file).
Answer all security-related questions and you're done. - (For Windows OS) Use OpenVPN
Download and run the app named ‘OpenVPN’ through the web browser.
Open the VPN key file downloaded from EQ Hub and prepare a file with the extension 'ovpn'.
Register the file with the extension ‘ovpn’ in the OpenVPN app.
Complete the connection in the OpenVPN app.
Issuance of VPN keys
The VPN key can be downloaded from the Network tab of the Dashboard by the project owner who built the network infrastructure or node infrastructure.
Since you can access ENMC through the VPN key, be careful not to leak the VPN key.
Various services can be used as a VPN client, and you can use services such as Tunnelblick and OpenVPN.Since you have authority over node management through the VPN key file, be careful about keeping the VPN key file.
Entering the ENMC service
There are two ways to enter ENMC as follows.
- Click [ Network ] - [ Node ] to access the Node List page. After selecting the node, you want to manage and enter the Node Detail page, click the [ Manage Console ] button to enter ENMC.
- Go to the Network tab in the Dashboard. After selecting the network to which the Node you want to manage belongs, click the [ ENMC ] button in the Node Info area below to enter ENMC.
Signing in to ENMC
After entering ENMC, a sign in process is required to use ENMC features.
To sign in, you must enter the password for the keystore file that the node has.
Using ENMC
Checking the status of the Node
When you enter the ENMC service, you can get all the current status for the selected node.
Header
| Data | Description | Example |
|---|---|---|
Address of the node | It means the wallet address of the node. This is the address corresponding to the private key the node has. | - |
Dashboard page
| Data | Description | Example |
|---|---|---|
Node engine software version | This is the software version the currently running node has. When a node is built, it has the latest version and can be updated when a new version comes out. | - |
Node type (role) | There are 2 node types. 1. Consensus Node (Equalizer): A node that participates in consensus. In order to participate in consensus, you must have a private key, and a staking coin must exist. 2. Full node: A node that does not participate in consensus and plays a role in communication. | - |
Quantity of staked coins | A value that exists if the node is of type Equalizer. Indicates the amount of coins staked on that node. Depending on the staked coin amount, the probability that nodes that are equalizers can participate in consensus varies. | - |
Coin balance (amount of coins owned by the node) | It refers to the number of coins existing in the wallet address of the node. In the case of Equalizer, staked coin quantity is excluded. | - |
Estimated reward (reward the node will get) | If you are an Equalizer, this is the expected value of the reward you will get when participating in the next consensus. Rewards are paid at the time blocks are confirmed. | - |
Total number of issued coins | Indicates the total number of coins existing in the blockchain network in which the current node participates. | - |
Address of the node | It means the wallet address of the node. This is the address corresponding to the private key the node has. | - |
Docker container state | Indicates the state of the docker container in which the node is running. 1. On: Indicates that the Docker container is turned on. In this state, the node can operate normally. 2. Off: Indicates that the Docker container is off. Nodes are not functional in this state. | - |
Node page
| Data | Description | Example |
|---|---|---|
Node engine software version | This is the software version the currently running node has. When a node is built, it has the latest version and can be updated when a new version comes out. | - |
Docker container state | Indicates the state of the docker container in which the node is running. You can switch the On/Off state by clicking the toggle button on the right. 1. On: Indicates that the Docker container is turned on. In this state, the node can operate normally. 2. Off: Indicates that the Docker container is off. Nodes are not functional in this state. | - |
Log | You can check the logs stored in the node. Logs allow you to check node status and blockchain network status. | - |
Chain page
| Data | Description | Example |
|---|---|---|
Amount of staked coins | A value that exists if the node is of type Equalizer. Indicates the number of coins staked on that node. Depending on the staked coin amount, the probability that nodes that are equalizers can participate in consensus varies. | - |
Consensus participation status | You can check whether a node is currently participating in the consensus of the blockchain network. You can switch the On/Off state by clicking the toggle button on the right. 1. Off: This means that the node is not participating in consensus. 2. Ready: The node is ready to participate in consensus, but other nodes are not yet ready to come to an agreement. When other nodes are ready to participate in consensus, it automatically changes to the ‘Equalizing’ state. 3. Equalizing: It means participating in consensus with other nodes. | - |
Node type (role) | There are 2 node types. 1. Consensus Node (Equalizer): A node that participates in consensus. In order to participate in consensus, you must have a private key, and the coin has to be staked. 2. Full node: A node that does not participate in consensus and plays a role in communication. | - |
Block height | It refers to the number of blocks accumulated in the blockchain network in which the current node participates. | - |
Coin balance | It refers to the amount of coins existing in the wallet address of the node. In the case of Equalizer, staked coin amount is excluded. | - |
Estimated reward | If you are an Equalizer, this is the expected value of the reward you will get when participating in the next consensus. Rewards are paid at the time blocks are confirmed. | - |
Total amount of issued coins | It means the total amount of coins existing in the blockchain network in which the current node is participating. | - |
System page
| Data | Description | Example |
|---|---|---|
Disk capacity | It shows the disk capacity of the node and the disk capacity currently in use. When usage is high, a capacity shortage notification is sent, at which point you can upgrade the capacity. | - |
Memory capacity | It shows the amount of memory the node has and the amount of memory currently being used. When usage is high, a capacity shortage notification is sent, at which point you can upgrade the capacity. | - |
Sending a request for starting consensus
- Enter the Chain page in ENMC.
- Check the ‘Consensus participation status’ area.
- If the current consensus status is ‘Off’, you are not participating in the consensus, so you can send a ‘Start consensus’ request.
- After clicking the toggle button on the right, enter the password for the keystore file of the node.
- If the entered passwords match, the request has been sent successfully and the node is ready to participate in consensus.
Keystore file
The keystore file that the node has means the file that was uploaded when building the node.
You can verify that you are the node operator by entering the password of the key store file uploaded when building a blockchain network or building a node through EQ Hub.
Sending request to stop participating in consensus
- Enter ENMC's Chain page.
- Check the ‘Consensual Participation Status’ area.
- If the current agreement status is ‘Equalizing,’ you can send a request to ‘suspend the agreement’ as you are participating in the agreement.
- Click the toggle button on the right.
- The request is sent successfully, and the node no longer participates in consensus.
Caution
If you switch the node’s consensus participation status to Off, the node will no longer participate in consensus. This may affect the operation of the blockchain network in which the node participates and may affect the operation of various servers and services that communicate with the node.
Staking Coins
- Enter the Chain page in ENMC.
- Check the ‘Staking Coins’ area at the top of the screen.
- Click the ‘Stake’ button within that area.
- Enter the amount of coins you want to stake and send the request.
- If the request is successfully sent, coins equal to the input value are deducted from the ‘coin balance’ and reflected in the ‘staking coin amount’.
Coin balance
The number of coins you enter must exist on the node to send a coin staking request. To check the number of coins the node has, check the ‘Coin Balance’ value on the Chain page in ENMC.
Unstaking Coins
- Enter the Chain page in ENMC.
- Check the ‘Staking Coins’ area at the top of the screen.
- Click the ‘Unstake’ button within that area.
- Enter the amount of coins you want to unstake and send your request.
- If the request is successfully sent, the amount of coins equal to the input value is deducted from the ‘staking coin amount’ and reflected in the ‘coin balance’.
Caution
When unstaking, the amount of coins you enter is deducted from the staking amount of the node, which reduces the reward that the node gets by participating in the blockchain network. Also, when the number of staked coins reaches zero, it affects the operation of the blockchain network.
Turn on node instance
- Enter the Node page in ENMC.
- Check the ‘Docker Containers’ area.
- If the current Docker container state is ‘Off’, the instance is not turned on, so you can send a request to turn it on.
- Click the toggle button on the right.
- The request is sent successfully and the node instance is turned on.
- After that, if the node is an Equalizer, it can send a ‘Consensus Start Request’ to participate in the consensus of the blockchain network.
Turn off node instance
- Enter the Node page in ENMC.
- Check the ‘Docker Containers’ area.
- If the current Docker container state is ‘On’, the instance is on, so you can send a request to turn off the instance.
- Click the toggle button on the right.
- The request is sent successfully and the node instance is turned off.
Caution
If you switch the state of the docker container to Off, the corresponding node will be turned off. This may affect the operation of the blockchain network in which the node participates and may affect the operation of various servers and services that communicate with the node.
Updated 7 months ago