Pruning

To prune a Etn-sc node at least 40 GB of free disk space is recommended. This means pruning cannot be used to save a hard drive that has been completely filled. A good rule of thumb is to prune before the node fills ~80% of the available disk space.

Pruning rules

1. Do not try to prune an archive node. Archive nodes need to maintain ALL historic data by definition.

2. Ensure there is at least 40 GB of storage space still available on the disk that will be pruned. Failures have been reported with ~25GB of free space.

3. Etn-sc is fully sync'd

4. Etn-sc has finished creating a snapshot that is at least 128 blocks old. This is true when "state snapshot generation" is no longer reported in the logs.

With these rules satisfied, Etn-sc's database can be pruned.

How pruning works

Pruning uses snapshots of the state database as an indicator to determine which nodes in the state trie can be kept and which ones are stale and can be discarded. Etn-sc identifies the target state trie based on a stored snapshot layer which has at least 128 block confirmations on top (for surviving reorgs) data that isn't part of the target state trie or genesis state.

Etn-sc prunes the database in three stages:

1. Iterating state snapshot: Etn-sc iterates the bottom-most snapshot layer and constructs a bloom filter set for identifying the target trie nodes.

2. Pruning state data: Etn-sc deletes stale trie nodes from the database which are not in the bloom filter set.

3. Compacting database: Etn-sc tidies up the new database to reclaim free space.

There may be a period of >1 hour during the Compacting Database stage with no log messages at all. This is normal, and the pruning should be left to run until finally a log message containing the phrase State pruning successful appears (i.e. do not restart Etn-sc yet!). That message indicates that the pruning is complete and Etn-sc can be started.

Pruning command

For a normal Etn-sc node, Etn-sc should be stopped and the following command executed to start a offline state prune:

etn-sc snapshot prune-state

For a Etn-sc node run using systemd:

sudo systemctl stop etn-sc # stop etn-sc, wait >3mins to ensure clean shutdown
tmux # tmux enables pruning to keep running even if you disconnect
sudo -u <user> etn-sc --datadir <path> snapshot prune-state # wait for pruning to finish
sudo systemctl start etn-sc # restart etn-sc

The pruning could take 4-5 hours to complete. Once finished, restart Etn-sc.

Troubleshooting

Messages about "state snapshot generation" indicate that a snapshot is not fully generated. This suggests either the --datadir is not correct or Etn-sc ran out of time to complete the snapshot generation and the pruning began before the snapshot was completed. In either case, the best course of action is to stop Etn-sc, run it normally again (no pruning) until the snapshot is definitely complete and at least 128 blocks exist on top of it, then try pruning again.