# Running a Storage Node

## Server Requirement

The recommended requirement of a storage server:

| Resource             | Specification            |
| -------------------- | ------------------------ |
| Recommended OS       | Linux 64-bit Intel / AMD |
| # of CPU Cores       | ≥ 4                      |
| Memory               | ≥ 8 GB                   |
| Bandwidth            | ≥ 20 Mbps                |
| Public Network IP    | required                 |
| Linux Kernel Version | 5.11 or higher           |

## Server Preparation

### Install Docker

Please refer to the [official documentation](https://docs.docker.com/engine/install/) for Docker installation.

### Firewall Configuration

{% hint style="info" %}
The following commands are executed with root privileges. If error messages of `permission denied` appear, switch to root privilege or add `sudo` at the beginning of these commands.
{% endhint %}

By default, the storage node uses port 15001 for network connections, please ensure that the firewall or security group is configured to allow incoming traffic on this port.

### Optional: Mount Additional Drive

{% hint style="info" %}
This step is required only if you are mounting another disk / storage device to your server.
{% endhint %}

Check the hard disk status using the `df -h` command:

```bash
df -h
```

If the disk is not mounted, the hard drive for storage mining cannot be used. Use the commands below to view unmounted hard disks:

```bash
fdisk -l

# Output result
Disk /dev/vdb: 200 GiB, 214748364800 bytes, 419430400 sectors
Units: sectors of 1 * 512 = 512 bytes
Sector size (logical/physical): 512 bytes / 512 bytes
I/O size (minimum/optimal): 512 bytes / 512 bytes
Disklabel type: dos
Disk identifier: 0x331195d1
```

From the above, we can see that the unmounted disk is `/dev/vdb`. We will be using `/dev/vdb` to demonstrate the mounting operation.

Allocate the `/dev/vdb` disk:

```bash
fdisk /dev/vdb

Enter and press Enter:
n
p
1
2048
the value after default
w
```

Format the newly divided disk into ext4 format:

```bash
mkfs.ext4 /dev/vdb
```

Enter "y" to continue if the system asks to proceed:

```bash
Proceed anyway? (y,N) y
```

Create `/cess` directory to mount the disk. Using `/cess` as an example:

```bash
sudo mkdir /cess
sudo echo "/dev/vdb /cess ext4 defaults 0 0" >> /etc/fstab
```

Replace `/dev/vdb` with your own disk name. /cess has to remain the same as created in the previous step. If you are not under root privileges, try:

```bash
echo "/dev/vdb /cess ext4 defaults 0 0" | sudo tee -a /etc/fstab
```

Mount `/cess`:

```bash
mount -a
```

Check the disk mounting status:

```bash
df -h
```

If `/cess` appears, the disk has been successfully mounted.

## Prepare CESS Accounts

Storage node need to create at least two wallet accounts.

* **Earning Account**: Used to receive mining rewards.
* **Staking Account**: Used to pay for staking TCESS.
* **Signature Account**: Used to sign blockchain transactions. If no staking account is specified, this account will also be used to pay staking TCESS.
* **Storage Deposit**: To keep the storage node in honoring its service commitment, the storage node account will have its native tokens locked for the storage amount pledged to offer. Currently in testnet, it is 4,000 TCESS per TB. The pledged space is **round up** to the closest TB unit and locked for that amount multiply with 4,000 TCESS. The minimum locked token is also 4,000 TCESS.

**Note：Each signature account can only be used by one storage node, otherwise an exception will occur.**

Please refer to [Creating CESS Accounts](https://doc.cess.network/user/cess-account) for creating a CESS account, goto [CESS faucet](https://cess.network/faucet.html) to get our testnet tokens, TCESS, or [contact us](https://doc.cess.network/readme/contact) to get assistance.

## Install CESS Client

1. Check for the latest version at: <https://github.com/CESSProject/cess-nodeadm/tags>
2. Download and install

   ```bash
   wget https://github.com/CESSProject/cess-nodeadm/archive/v0.6.1.tar.gz
   tar -xvzf v0.6.1.tar.gz
   cd cess-nodeadm-0.6.1/
   ./install.sh
   ```

   If a message `Install cess nodeadm success` shows up at the end, it means the installation is completed.

   If the installation fails, please check the [troubleshoot procedures](https://doc.cess.network/cess-miners/storage-miner/troubleshooting).
3. Stop and removing existing services

   Stop existing services:

   ```bash
   sudo cess stop
   # or
   sudo cess down
   ```

   Remove existing services：

   ```bash
   sudo cess purge
   ```

## Configure CESS Client

### Setup a Running Network

```bash


# Running the storage node on test network:
sudo cess profile premainnet

# or Running the storage node on local development network:
sudo cess profile devtnet
```

### Setup Configuration

```bash
sudo cess config set

Enter cess node mode from 'tee/storage/validator/rpcnode' (current: storage, press enter to skip): storage
Enter cess storage listener port (current: 15001, press enter to skip): 
Start configuring the endpoint to access Storage-Miner from the internet
  Do you need to automatically detect extranet address as endpoint? (y/n) y
  Try to get your extranet IP ...
  Your Storage-Miner endpoint is http://x.x.x.x:15001
Enter cess rpc ws-url (current: local-chain, to use an external chain, type WS-URL directly, or press enter to skip):
Enter cess storage earnings account: cXf5MAAmRm85fmZEJRBDVbwEWSfZmkHEGWgBsJBF5LstfKe2D
Enter cess storage signature account phrase: apple pen used tree divide popular force aunt actor text tourist abstract
Enter cess storage disk path (default: /opt/cess/storage/disk): /cess
Enter cess storage space, by GB unit (current: 300, press enter to skip):
Enter the number of CPU cores used for mining; Your CPU cores are 4
  (current: 0, 0 means all cores are used; press enter to skip):
Enter the staking account if you use one account to stake multiple nodes (if it is the same as the signature account, press enter to skip):
Enter the TEE worker endpoints if you have any (separate multiple values with commas, press enter to skip):
Set configurations successfully
```

* If a staker payment account is provided, for testnet, the pledged space (answer to the **Enter cess storage space**) is **round up** to the closest TB unit and that amount multiply with 4,000 amount of TCESS will be locked as a miner deposit.
* If a staker payment account is not provided, then the signature account will be used as the staking account. If the staking account different from signature account is provided, can only [increase stake in block browser manually](https://docs.cess.network/core/storage-miner/troubleshooting).
* Default TEE Node endpoints for the chain will be used if you don't provide any TEE Node endpoints. This doesn't affect your reward as a storage miner.

Start CESS storage node

```bash
sudo cess start

[+] Running 3/0
 ✔ Container chain       Running                                                0.0s
 ✔ Container miner       Running                                                0.0s
 ✔ Container watchtower  Running                                                0.0s
```

If you want to speed up your earnings, you can choose to deploy a Marker-type TEE Node to help storage nodes certify space and mark user service files. Please refer to the [TEE Node User Guide](https://doc.cess.network/cess-miners/tee-node/running).

## Common Operations

### Check CESS Chain Sync Status

```bash
docker logs -f -n 50 chain
```

As shown below, if we see that the height of the block corresponding to "best" is about the latest height in [CESS Explorer](https://testnet.cess.network/), it means the local chain node synchronization is completed.

![CESS Blockchain Synchronization Completed](https://2951078474-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FFWgzFJTgbmbm8iaxYNRS%2Fuploads%2Fgit-blob-8a024bc7df5ec43a1466f03b5d6c2e7806f179f1%2Fsync-status.png?alt=media)

Only when the chain synchronization is completed can you operate other functions such as increase the staking, view the status of the node, etc.

### Check Your Storage Node Status On-chain

You can check your storage node status on-chain.

1. Goto [**Polkadot-js Apps**: Developer > Chain state](https://polkadot.js.org/apps/#/chainstate)
2. On *selected state query*: select **sminer** pallet and **allMiner()** storage item
3. Click the button on the right to query the state
4. At the bottom of the returned list, you should find the storage node address that your mnemonic (with root path) generated from your answer to `sudo cess config set`. See below for an example.

   ![CESS query on all miners](https://2951078474-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FFWgzFJTgbmbm8iaxYNRS%2Fuploads%2Fgit-blob-f76a0bae7db24ea19ed57462b8eae5f67163f92b%2Fquery-allminer.png?alt=media)
5. You can also check your detail miner info with selecting **sminer** pallet and **minerItems(AccountId32)** storage item. In the *Option\<AccountId32>*, choose/input the storage node address. It will return your detail information on-chain. See below for an example.

   ![CESS query on my miner item](https://2951078474-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FFWgzFJTgbmbm8iaxYNRS%2Fuploads%2Fgit-blob-bb94dd2ea3f110da64988252cb2f3b9dd36989e0%2Fquery-miner-item.png?alt=media)
6. Go to [the **Accounts** page](https://polkadot.js.org/apps/#/accounts) and check your account details, you would see a certain amount of TCESS has been reserved as the storage deposit.

   ![Token is reserved as a storage miner](https://2951078474-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FFWgzFJTgbmbm8iaxYNRS%2Fuploads%2Fgit-blob-201b02684018af8472d1d0cd786c73c191fb1ea9%2Fstorage-miner-deposit.png?alt=media)

### View the Storage Node Log

```bash
docker logs -f -n 50 miner
```

As shown below, the storage node will sync the chain at first and then fetch key from tee node, finally start to generate idle files and start mining.

![Storage Node Log](https://2951078474-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FFWgzFJTgbmbm8iaxYNRS%2Fuploads%2Fgit-blob-39b296384c61a6dbb8ca03949c76976edd36f311%2Fstorage-node-starting.png?alt=media)

### View Storage Node Status

```bash
sudo cess miner stat
```

An example of the returned result is shown below：

![CESS Miner Stat](https://2951078474-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FFWgzFJTgbmbm8iaxYNRS%2Fuploads%2Fgit-blob-a5cf281b34ac3339aa79d513aea981a0f5d2364d%2Fbucket-stat.png?alt=media)

Refer to the [Glossary](https://doc.cess.network/glossary#storage-miner) on the names above.

At the beginning of the storage node synchronization, all your **validated space**, **used space**, and **locked space** are 0. It is only when the validated space been incremented above 0 that the storage miner start earning rewards.

Please wait for chain synchronization if you get the output like `you are not registered as a storage miner...`, otherwise, please config a public chain node to skip local chain synchronization.

### Increase Storage Node Staking

Make sure that the signatureAcc is the same as stakingAcc can use this command

```bash
sudo cess miner increase staking <deposit amount>
```

### Withdraw Storage Node Staking

After your node **has exited CESS Network** (see below), run

```bash
sudo cess miner withdraw
```

### Query Reward Information

```bash
sudo cess miner reward
```

### Claim Reward

```bash
sudo cess miner claim
```

### Update All Service Images

```bash
sudo cess pullimg
```

### Stop and Remove All Services

```bash
sudo cess down
```

### Update Earnings Account

```bash
sudo cess miner update earnings [earnings account]
```

### Exit CESS Network

```bash
sudo cess miner exit
```

## Upgrade CESS Client

### Stop and Remove All Services

```bash
sudo cess stop
sudo cess down
```

### Remove All Chain Data

{% hint style="warning" %}
Do not perform this operation unless the CESS network has been redeployed and it is confirmed that the data can be cleared.
{% endhint %}

```bash
sudo cess purge
```

### Update `cess-nodeadm`

```bash
wget https://github.com/CESSProject/cess-nodeadm/archive/vx.x.x.tar.gz
tar -xvf vx.x.x.tar.gz
cd cess-nodeadm-x.x.x
sudo ./install.sh --skip-dep
```

### Update All Service Images

```bash
sudo cess pullimg
```