Skip to main content

​
State Sync

Learn about Tendermint Core state sync and support offered by the Cosmos SDK. :::tip Note: Only curious about how to sync a node with the network? Skip to this section. :::

​
Tendermint Core State Sync

State sync allows a new node to join a network by fetching a snapshot of the network state at a recent height, instead of fetching and replaying all historical blocks. Since application state is smaller than the combination of all blocks, and restoring state is faster than replaying blocks, this reduces the time to sync with the network from days to minutes. This section of the document provides a brief overview of the Tendermint state sync protocol, and how to sync a node. For more details, refer to the ABCI Application Guide and the ABCI Reference Documentation.

​
State Sync Snapshots

A guiding principle when designing Tendermint state sync was to give applications as much flexibility as possible. Therefore, Tendermint does not care what snapshots contain, how they are taken, or how they are restored. It is only concerned with discovering existing snapshots in the network, fetching them, and passing them to applications via ABCI. Tendermint uses light client verification to check the final app hash of a restored application against the chain app hash, but any further verification must be done by the application itself during restoration. Snapshots consist of binary chunks in an arbitrary format. Chunks cannot be larger than 16 MB, but otherwise there are no restrictions. Snapshot metadata, exchanged via ABCI and P2P, contains the following fields:
  • height (uint64): height at which the snapshot was taken
  • format (uint32): arbitrary application-specific format identifier (eg. version)
  • chunks (uint32): number of binary chunks in the snapshot
  • hash (bytes): arbitrary snapshot hash for comparing snapshots across nodes
  • metadata (bytes): arbitrary binary snapshot metadata for use by applications
The format field allows applications to change their snapshot format in a backwards-compatible manner, by providing snapshots in multiple formats, and choosing which formats to accept during restoration. This is useful when, for example, changing serialization or compression formats: as nodes may be able to provide snapshots to peers running older verions, or make use of old snapshots when starting up with a newer version. The hash field contains an arbitrary snapshot hash. Snapshots that have identical metadata fields (including hash) across nodes are considered identical, and chunks will be fetched from any of these nodes. The hash cannot be trusted, and is not verified by Tendermint itself, which guards against inadvertent nondeterminism in snapshot generation. The hash may be verified by the application instead. The metadata field can contain any arbitrary metadata needed by the application. For example, the application may want to include chunk checksums to discard damaged chunks, or Merkle proofs to verify each chunk individually against the chain app hash. In Protobuf-encoded form, snapshot metadata messages cannot exceed 4 MB.

​
Taking, Serving Snapshots

To enable state sync, some nodes in the network must take and serve snapshots. When a peer is attempting to state sync, an existing Tendermint node will call the following ABCI methods on the application to provide snapshot data to this peer: Snapshots should typically be generated at regular intervals rather than on-demand: this improves state sync performance, since snapshot generation can be slow, and avoids a denial-of-service vector where an adversary floods a node with such requests. Older snapshots can usually be removed, but it may be useful to keep at least the two most recent to avoid deleting the previous snapshot while a node is restoring it. It is entirely up to the application to decide how to take snapshots, but it should strive to satisfy the following guarantees:
  • Asynchronous: snapshotting should not halt block processing, and it should therefore happen asynchronously, eg. in a separate thread
  • Consistent: snapshots should be taken at isolated heights, and should not be affected by concurrent writes, eg. due to block processing in the main thread
  • Deterministic: snapshot chunks and metadata should be identical (at the byte level) across all nodes for a given height and format, to ensure good availability of chunks
As an example, this can be implemented as follows:
  1. Use a data store that supports transactions with snapshot isolation, such as RocksDB or BadgerDB.
  2. Start a read-only database transaction in the main thread after committing a block.
  3. Pass the database transaction handle into a newly spawned thread.
  4. Iterate over all data items in a deterministic order (eg. sorted by key)
  5. Serialize data items (eg. using Protobuf), and write them to a byte stream.
  6. Hash the byte stream, and split it into fixed-size chunks (eg. of 10 MB)
  7. Store the chunks in the file system as separate files.
  8. Write the snapshot metadata to a database or file, including the byte stream hash.
  9. Close the database transaction and exit the thread.
Applications may want to take additional steps as well, such as compressing the data, checksumming chunks, generating proofs for incremental verification, and removing old snapshots.

​
Restoring Snapshots

When Tendermint starts, it will check whether the local node has any state (ie. whether LastBlockHeight == 0), and if it doesn’t, it will begin discovering snapshots via the P2P network. These snapshots will be provided to the local application via the following ABCI calls: Discovered snapshots are offered to the application and it can respond by accepting the snapshot, rejecting it, rejecting the format, rejecting the senders, aborting state sync, and so on. Once a snapshot is accepted, Tendermint will fetch chunks from across available peers, and apply them sequentially to the application, which can choose to accept the chunk, refetch it, reject the snapshot, reject the sender, abort state sync, and so on. Once all chunks have been applied, Tendermint will call the Info ABCI method on the application, and check that the app hash and height correspond to the trusted values from the chain. It will then switch to fast sync to fetch any remaining blocks (if enabled), before finally joining normal consensus operation. How snapshots are actually restored is entirely up to the application, but will generally be the inverse of how they are generated. Note, however, that Tendermint only verifies snapshots after all chunks have been restored, and does not reject any P2P peers on its own. As long as the trusted hash and application code are correct, it is not possible for an adversary to cause a state synced node to have incorrect state when joining consensus, but it is up to the application to counteract state sync denial-of-service (eg. by implementing incremental verification, rejecting invalid peers). Note that state synced nodes will have a truncated block history starting at the height of the restored snapshot, and there is currently no backfill of all block data. Networks should consider broader implications of this, and may want to ensure at least a few archive nodes retain a complete block history, for both auditability and backup.

​
Cosmos SDK State Sync

Cosmos SDK v0.40+ includes automatic support for state sync, so application developers only need to enable it to take advantage. They will not need to implement the state sync protocol described in the above section on Tendermint themselves.

​
State Sync Snapshots

Tendermint Core handles most of the grunt work of discovering, exchanging, and verifying state data for state sync, but the application must take snapshots of its state at regular intervals, and make these available to Tendermint via ABCI calls, and be able to restore these when syncing a new node. The Cosmos SDK stores application state in a data store called IAVL, and each module can set up its own IAVL stores. At regular height intervals (which are configurable), the Cosmos SDK will export the contents of each store at that height, Protobuf-encode and compress it, and save it to a snapshot store in the local filesystem. Since IAVL keeps historical versions of data, these snapshots can be generated simultaneously with new blocks being executed. These snapshots will then be fetched by Tendermint via ABCI when a new node is state syncing. Note that only IAVL stores that are managed by the Cosmos SDK can be snapshotted. If the application stores additional data in external data stores, there is currently no mechanism to include these in state sync snapshots, so the application therefore cannot make use of automatic state sync via the SDK. However, it is free to implement the state sync protocol itself as described in the ABCI Documentation. When a new node is state synced, Tendermint will fetch a snapshot from peers in the network and provide it to the local (empty) application, which will import it into its IAVL stores. Tendermint then verifies the application’s app hash against the main blockchain using light client verification, and proceeds to execute blocks as usual. Note that a state synced node will only restore the application state for the height the snapshot was taken at, and will not contain historical data nor historical blocks.

​
Enabling State Sync Snapshots

To enable state sync snapshots, an application using the CosmosSDK BaseApp needs to set up a snapshot store (with a database and filesystem directory) and configure the snapshotting interval and the number of historical snapshots to keep. A minimal exmaple of this follows: 
snapshotDir := filepath.Join(
  cast.ToString(appOpts.Get(flags.FlagHome)), "data", "snapshots")
snapshotDB, err := sdk.NewLevelDB("metadata", snapshotDir)
if err != nil {
  panic(err)
}
snapshotStore, err := snapshots.NewStore(snapshotDB, snapshotDir)
if err != nil {
  panic(err)
}
app := baseapp.NewBaseApp(
  "app", logger, db, txDecoder,
  baseapp.SetSnapshotStore(snapshotStore),
  baseapp.SetSnapshotInterval(cast.ToUint64(appOpts.Get(
    server.FlagStateSyncSnapshotInterval))),
  baseapp.SetSnapshotKeepRecent(cast.ToUint32(appOpts.Get(
    server.FlagStateSyncSnapshotKeepRecent))),
)
When starting the application with the appropriate flags, (eg. --state-sync.snapshot-interval 1000 --state-sync.snapshot-keep-recent 2) it should generate snapshots and output log messages: 
Creating state snapshot    module=main height=3000
Completed state snapshot   module=main height=3000 format=1
Note that the snapshot interval must currently be a multiple of the pruning-keep-every (defaults to 100), to prevent heights from being pruned while taking snapshots. It’s also usually a good idea to keep at least 2 recent snapshots, such that the previous snapshot isn’t removed while a node is attempting to state sync using it.

​
State Syncing a Node

:::tip Looking for snapshots or archive nodes to sync your node with? Check out this page. ::: Once a few nodes in a network have taken state sync snapshots, new nodes can join the network using state sync. To do this, the node should first be configured as usual, and the following pieces of information must be obtained for light client verification:
  • Two available RPC servers (at least)
  • Trusted height
  • Block ID hash of trusted height
The trusted hash must be obtained from a trusted source (eg. a block explorer), but the RPC servers do not need to be trusted. Tendermint will use the hash to obtain trusted app hashes from the blockchain in order to verify restored application snapshots. The app hash and corresponding height are the only pieces of information that can be trusted when restoring snapshots. Everything else can be forged by adversaries. In this guide we use Ubuntu 20.04

​
Prepare system

Update system 
sudo apt update -y
Upgrade system 
sudo apt upgrade -y
Install dependencies 
sudo apt-get install ca-certificates curl gnupg lsb-release make gcc git jq wget -y
Install Go 
wget -q -O - https://raw.githubusercontent.com/canha/golang-tools-install-script/master/goinstall.sh | bash
source ~/.bashrc
Set the node name 
moniker="NODE_NAME"

​
Use commands below for Testnet setup

SNAP_RPC1="http://bd-Paxeer Network-testnet-state-sync-node-01.bdnodes.net:26657"
SNAP_RPC="http://bd-Paxeer Network-testnet-state-sync-node-02.bdnodes.net:26657"
CHAIN_ID="hyperpax_125-4"
PEER="3a6b22e1569d9f85e9e97d1d204a1c457d860926@bd-Paxeer Network-testnet-seed-node-01.bdnodes.net:26656"
wget -O $HOME/genesis.json https://archive.hyperpaxd.dev/hyperpax_125-4/genesis.json

​
Use commands below for Mainnet setup

SNAP_RPC1="http://bd-Paxeer Network-mainnet-state-sync-us-01.bdnodes.net:26657"
SNAP_RPC="http://bd-Paxeer Network-mainnet-state-sync-eu-01.bdnodes.net:26657"
CHAIN_ID="Paxeer Network_9001-2"
PEER="96557e26aabf3b23e8ff5282d03196892a7776fc@bd-Paxeer Network-mainnet-state-sync-us-01.bdnodes.net:26656,dec587d55ff38827ebc6312cedda6085c59683b6@bd-Paxeer Network-mainnet-state-sync-eu-01.bdnodes.net:26656"
wget -O $HOME/genesis.json https://archive.hyperpaxd.org/mainnet/genesis.json

​
Install hyperpaxd

git clone https://github.com/Paxeer-Network/Paxeer-Network.git && \ 
cd Paxeer Network && \ 
make install

​
Configuration

Node init 
hyperpaxd init $moniker --chain-id $CHAIN_ID
Move genesis file to .hyperpaxd/config folder 
mv $HOME/genesis.json ~/.hyperpaxd/config/
Reset the node 
hyperpaxd tendermint unsafe-reset-all --home $HOME/.hyperpaxd
Change config files (set the node name, add persistent peers, set indexer = “null”) 
sed -i -e "s%^moniker *=.*%moniker = \"$moniker\"%; " $HOME/.hyperpaxd/config/config.toml
sed -i -e "s%^indexer *=.*%indexer = \"null\"%; " $HOME/.hyperpaxd/config/config.toml
sed -i -e "s%^persistent_peers *=.*%persistent_peers = \"$PEER\"%; " $HOME/.hyperpaxd/config/config.toml
Set the variables for start from snapshot :::tip Note: Usually, on other cosmos chains, the user is instructed to use as trusted height the latest height minus 2000 by default. However, snapshots of the Paxeer Network chain take a long time to generate, which makes the gap between the snapshot height and the current latest height be more than 2000. This results in a context timeout error: 
5:33PM ERR error on light block request from witness, removing... error="post failed: Post \"http://bd-Paxeer Network-mainnet-state-sync-us-01.bdnodes.net:26657\": context deadline exceeded" module=light primary={} server=node
To avoid this issue, simply pick a trusted height close to snapshot height. For example, if you know there’s a snapshot at height 13286000, consider a trust hash from block 13284000. You can get the latest snapshot height from Polkachu here.. Otherwise, your node will find the available snapshots. You will see logs similar to this: 
5:48PM INF Discovered new snapshot format=2 hash="�z���Մ��^��Q\x1a\\I_�\x0f�OT!�(jM�$!��" height=13286000 module=statesync server=node
::: 
LATEST_HEIGHT=$(curl -s $SNAP_RPC/block | jq -r .result.block.header.height); \
BLOCK_HEIGHT=$((LATEST_HEIGHT - 40000)); \
TRUST_HASH=$(curl -s "$SNAP_RPC/block?height=$BLOCK_HEIGHT" | jq -r .result.block_id.hash)
Check 
echo $LATEST_HEIGHT $BLOCK_HEIGHT $TRUST_HASH
Output example (numbers will be different): 
376080 374080 F0C78FD4AE4DB5E76A298206AE3C602FF30668C521D753BB7C435771AEA47189
If output is OK do next 
sed -i.bak -E "s|^(enable[[:space:]]+=[[:space:]]+).*$|\1true| ; \

s|^(rpc_servers[[:space:]]+=[[:space:]]+).*$|\1\"$SNAP_RPC,$SNAP_RPC1\"| ; \

s|^(trust_height[[:space:]]+=[[:space:]]+).*$|\1$BLOCK_HEIGHT| ; \

s|^(trust_hash[[:space:]]+=[[:space:]]+).*$|\1\"$TRUST_HASH\"| ; \

s|^(seeds[[:space:]]+=[[:space:]]+).*$|\1\"\"|" ~/.hyperpaxd/config/config.toml

​
Create hyperpaxd service

echo "[Unit]
Description=hyperpaxd Node
After=network.target
#
[Service]
User=$USER
Type=simple
ExecStart=$(which hyperpaxd) start
Restart=on-failure
LimitNOFILE=65535
#
[Install]
WantedBy=multi-user.target" > $HOME/hyperpaxd.service; sudo mv $HOME/hyperpaxd.service /etc/systemd/system/

sudo systemctl enable hyperpaxd.service && sudo systemctl daemon-reload

​
Run hyperpaxd

systemctl start hyperpaxd

​
Check logs

journalctl -u hyperpaxd -f
When the node is started it will then attempt to find a state sync snapshot in the network, and restore it: 
Started node                   module=main nodeInfo="..."
Discovering snapshots for 20s
Discovered new snapshot        height=3000 format=1 hash=0F14A473
Discovered new snapshot        height=2000 format=1 hash=C6209AF7
Offering snapshot to ABCI app  height=3000 format=1 hash=0F14A473
Snapshot accepted, restoring   height=3000 format=1 hash=0F14A473
Fetching snapshot chunk        height=3000 format=1 chunk=0 total=3
Fetching snapshot chunk        height=3000 format=1 chunk=1 total=3
Fetching snapshot chunk        height=3000 format=1 chunk=2 total=3
Applied snapshot chunk         height=3000 format=1 chunk=0 total=3
Applied snapshot chunk         height=3000 format=1 chunk=1 total=3
Applied snapshot chunk         height=3000 format=1 chunk=2 total=3
Verified ABCI app              height=3000 appHash=F7D66BC9
Snapshot restored              height=3000 format=1 hash=0F14A473
Executed block                 height=3001 validTxs=16 invalidTxs=0
Committed state                height=3001 txs=16 appHash=0FDBB0D5F
Executed block                 height=3002 validTxs=25 invalidTxs=0
Committed state                height=3002 txs=25 appHash=40D12E4B3
The node is now state synced, having joined the network in seconds

​
Use this command to switch off your State Sync mode, after node fully synced to avoid problems in future node restarts!

sed -i.bak -E "s|^(enable[[:space:]]+=[[:space:]]+).*$|\1false|" $HOME/.hyperpaxd/config/config.toml
:::tip Note: Information included in this document is sourced from Erik Grinaker, specifically his state sync guides for Tendermint Core and the Cosmos SDK. :::