Skip to content

Run a Block-Producing Collator

Block-producing collators are the backbone of system parachain operations. Unlike RPC or archive nodes, which maintain state, collators actively produce blocks and submit them to relay chain validators for inclusion. They ensure network liveness, censorship resistance, and cross-chain message processing.

Collators maintain fully synced relay chain and parachain nodes, aggregate transactions into blocks, create parachain block candidates, generate state transition proofs (Proof-of-Validity), and send block candidates to relay chain validators. They also enable cross-chain message handling via XCM. While critical for liveness, collators do not secure the network—security is provided by relay chain validators through the ELVES protocol.

This guide explains how to set up a collator for Polkadot system parachains, covering all key requirements, setting up and registering session keys, and meeting governance approval or invulnerables-list criteria (required for system parachains; non-system parachains may be more permissionless).

Block-producing collators require robust hardware for reliable operation, including the following:

  • CPU: 4+ cores (8+ cores recommended for optimal performance)
  • Memory: 32 GB RAM minimum (64 GB recommended)
  • Storage:
    • 200+ GB NVMe SSD (with pruning enabled for both parachain and relay chain)
    • Fast disk I/O is critical for block production performance
  • Network:
    • Public IP address
    • 100+ Mbps connection; a stable connection is critical
    • Open ports:
      • 30333: Parachain P2P
      • 30334: Relay chain P2P

Required software:

  • Operating system: Ubuntu 22.04 LTS (recommended) or similar Linux distribution
  • Docker: Required for obtaining binaries and running containers
Need to create an account?

You can generate an account by taking the following steps:

  1. Generate an account key with the sr25519 scheme using the following command:

    Terminal window
    docker run -it parity/subkey:latest generate --scheme sr25519

    The output will be similar to the following:

    docker run -it parity/subkey:latest generate --scheme sr25519
    Secret phrase:       embody rail hour peanut .... badge syrup luggage canvas
        Network ID:        substrate
        Secret seed:       0x6498dd3416c491406e2c8283c76760ce4ca018478888b42315e7718778f2c2e1
        Public key (hex):  0x2202210357e49390d4f8d868da983940fe220a0a0e00bc6feaeda462aa031810
        Account ID:        0x2202210357e49390d4f8d868da983940fe220a0a0e00bc6feaeda462aa031810
        Public key (SS58): 5CqJ7n72GvvF5ZzUT2HMj83KyDje4n8sXR8kuiK8HWtfDktF
        SS58 Address:      5CqJ7n72GvvF5ZzUT2HMj83KyDje4n8sXR8kuiK8HWtfDktF
    
  2. Save the following items displayed in the output:

    • Secret phrase (seed) - Keep this secure!
    • Public key (hex)
    • Account ID
    • SS58 Address

Your account must meet the following requirements:

  • Funded account: Free balance on the target chain must cover transaction fees, the session key deposit (session.keyDeposit), and the existential deposit (ED), plus the CandidacyBond for on-chain selection.

You will also need the following, which are generated or configured later in this guide:

  • Session keys: For collator identification (generated after node setup)
  • Node key: For stable P2P peer ID (recommended)

This guide provides two deployment options. Select the option that best fits your needs:

  • Docker: Best for simpler setup and maintenance
  • systemd: Best for production environments requiring more control
  1. Pull the Polkadot Parachain Docker image using the latest stable tag on Docker Hub:

    Terminal window
    docker pull parity/polkadot-parachain:stable2609-1
  2. Verify the installation:

    Terminal window
    docker run --rm parity/polkadot-parachain:stable2609-1 --version

Validators and collators on Polkadot need a static network key (also known as the node key) to maintain a stable node identity. This key ensures that your node can maintain a consistent peer ID, even across restarts, which is crucial for maintaining reliable network connections.

Follow these steps to generate a node key:

  1. Generate your node key using one of the following options:

    Terminal window
    docker run --rm parity/subkey:latest generate-node-key > node.key
  2. Locate your peer ID in the displayed output. The peer ID is similar to this example:

    12D3KooWExcVYu7Mvjd4kxPVLwN2ZPnZ5NyLZ5ft477wqzfP2q6E

Be sure to save the peer ID for future reference.

Obtain the chain specification for your target system parachain using one of the following options:

Download the chain specification directly using curl. For example, to download the Asset Hub Polkadot chain spec:

Terminal window
curl -sL -o chain-spec.json \
https://paritytech.github.io/chainspecs/polkadot/parachain/asset-hub/chainspec.json

For other system parachains, find the correct URL in the Chainspec Collection under the List of Chainspecs.

For non-system parachains, check the parachain's documentation for official chain specification files.

Using your preferred deployment method, take the following steps to set up and run your collator:

  1. Create a directory for collator data and copy the chain spec and node key:

    Terminal window
    mkdir -p collator-data
    cp chain-spec.json collator-data/
    cp node.key collator-data/
  2. Launch the collator using Docker:

    Terminal window
    docker run -d --name polkadot-collator --restart unless-stopped \
    -p 30333:30333 \
    -p 30334:30334 \
    -p 9944:9944 \
    -p 9615:9615 \
    -v $(pwd)/collator-data:/data \
    parity/polkadot-parachain:stable2609-1 \
    --collator \
    --chain=/data/chain-spec.json \
    --base-path=/data \
    --port=30333 \
    --rpc-port=9944 \
    --prometheus-port=9615 \
    --prometheus-external \
    --node-key-file=/data/node.key \
    --name="INSERT_YOUR_COLLATOR_NAME" \
    --blocks-pruning=256 \
    --state-pruning=256 \
    --database=paritydb \
    -- \
    --chain=polkadot \
    --port=30334 \
    --sync=fast \
    --blocks-pruning=256 \
    --state-pruning=256 \
    --database=paritydb \
    --pool-limit=0 \
    --rpc-port=0
  3. View logs to monitor sync progress:

    Terminal window
    docker logs -f polkadot-collator
Configuration Arguments
  • --collator: Enables block production mode.
  • --node-key-file: Uses the generated node key for stable peer ID.
  • --name: Your collator name (visible in telemetry).
  • --blocks-pruning=256: Keeps the last 256 blocks.
  • --state-pruning=256: Keeps the state history of the last 256 blocks.
  • --database=paritydb: Uses ParityDB for better performance.
  • --sync=fast: Fast sync mode for the relay chain.
  • --pool-limit=0: Disables transaction pool on relay chain (not needed for collators).
  • --rpc-port=0 (relay chain): Disables RPC on the embedded relay chain node (not needed for collators).

Your collator must sync both the relay chain and parachain before producing blocks. The relay chain uses fast sync to speed up synchronization. Overall sync time depends on:

  • Network bandwidth
  • Disk I/O speed
  • Current chain size

Session keys are cryptographic keys used by your collator node to sign authorship information when producing blocks. They uniquely identify your collator on the network and must be registered on-chain before your collator can participate in block production.

Generate session keys by running the following command on your node, replacing INSERT_STASH_ACCOUNT_ID with your stash account ID:

Terminal window
curl -H "Content-Type: application/json" \
-d '{"id":1, "jsonrpc":"2.0", "method": "author_rotateKeysWithOwner", "params":["INSERT_STASH_ACCOUNT_ID"]}' \
http://localhost:9944

This command returns a JSON object with two fields in the result: keys (the hex-encoded session keys) and proof (the ownership proof). Save both values for later use.

{
"jsonrpc": "2.0",
"result": {
"keys": "0xda3861a45e0197f3ca145c2c209f9126e5053fas503e459af4255cf8011d51010",
"proof": "0x1a2b3c4d5e6f..."
},
"id": 1
}

System parachains use different mechanisms for selecting collators. A quick breakdown of each mechanism is as follows:

MethodHow it WorksRequirements
Invulnerables listFixed list defined through governance. Most common for system parachains.Permissioned via governance
On-chain selectionRuntime automatically selects eligible collators. Some parachains use pallet-collator-selection.Semi-permissionless (criteria-based; may require bonding tokens)
Fellowship decisionsTechnical fellowship may manage some system parachain collators.Permissioned via Fellowship

Collator registration authorizes your node to produce blocks on the network. The parachain's collator selection mechanism uses this on-chain registration to determine which nodes are eligible to author blocks.

The registration process varies by system parachain. General steps include the following:

  1. Check the existing collators for your target parachain:

    1. Navigate to Polkadot.js Apps and connect to your system parachain.
    2. Locate Developer > Chain State.
    3. Query collatorSelection.invulnerables().

  2. Prepare a governance proposal for invulnerables-based selection, including the following information:

    • Draft proposal: Explain why you should be added as a collator.
    • Technical details: Provide your session keys and account ID.
    • Infrastructure: Describe your hardware and monitoring setup.
    • Experience: Detail your relevant experience.

    Submit the proposal to the relevant governance channels.

  3. Once approved (or if using on-chain selection), follow these steps to register session keys using Polkadot.js Apps:

    1. Locate Developer > Extrinsics.
    2. Select your account.
    3. Choose the session.setKeys extrinsic.
    4. Enter the values returned by Generate Session Keys:
      • keys
      • proof
    5. Click Submit Transaction and sign the transaction.

  4. (Optional - primarily for non-system parachains) If the parachain uses on-chain bonding for collator selection, register as a candidate using Polkadot.js Apps:

    1. Locate Developer > Extrinsics.
    2. Select your account.
    3. Select collatorSelection.registerAsCandidate.
    4. Click Submit Transaction and sign the transaction. The required bond amount will be automatically reserved from your account based on the pallet's configured CandidacyBond.

  5. For system parachains using invulnerables lists, await governance approval for your proposal. Once approved, your collator is added to the invulnerables list and will begin producing blocks in the next session or era.

  6. Verify your collator is active by monitoring logs for block production messages like "Prepared block for proposing" and "Imported #123". See the Log Management section for commands for log viewing.

Use the following commands to manage your node:

  • Stop container:

    Terminal window
    docker stop polkadot-collator
  • Start container:

    Terminal window
    docker start polkadot-collator
  • Remove container:

    Terminal window
    docker rm polkadot-collator

Efficient log management is essential to ensure collator performance and uptime. Use the following commands to help you manage logs to monitor and maintain your collator:

  • View logs:

    Terminal window
    docker logs -f polkadot-collator
  • View recent logs (last 100 lines):

    Terminal window
    docker logs --tail 100 polkadot-collator
  • Filter for errors:

    Terminal window
    docker logs polkadot-collator 2>&1 | grep -i error
  • Filter for block production:

    Terminal window
    docker logs polkadot-collator 2>&1 | grep -i "imported"

Check database size periodically using the commands for your selected setup:

Terminal window
# Replace with your mounted data directory path
du -sh ./collator-data

The collator node automatically prunes based on configuration.

Updates or upgrades can happen on either the runtime or client. Runtime upgrades are automatically applied via on-chain governance and do not require any manual action on your part. Client upgrades do require a manual binary update process performed via terminal commands as follows:

  1. Stop the service:

    Terminal window
    sudo systemctl stop polkadot-collator
  2. Backup data (recommended):

    Terminal window
    sudo cp -r /var/lib/polkadot-collator /var/lib/polkadot-collator.backup
  3. Pull the new Docker image:

    Terminal window
    docker pull parity/polkadot-parachain:<NEW_TAG>
  4. Update the image tag in your systemd service file:

    Terminal window
    sudo nano /etc/systemd/system/polkadot-collator.service
  5. Reload systemd and restart the service:

    Terminal window
    sudo systemctl daemon-reload
    sudo systemctl start polkadot-collator
  6. Verify the service is running:

    Terminal window
    sudo systemctl status polkadot-collator

Running a collator node is essential for parachain operation and network security. By following this guide, you have set up a production-ready collator that:

  • Produces blocks for your parachain and maintains network consensus.
  • Implements comprehensive security measures to protect keys and operations.
  • Supports robust monitoring and alerting for reliable performance.
  • Follows best practices for both Docker and systemd deployments.

As a collator operator, you play a vital role in your parachain's infrastructure. Regular maintenance, security updates, and monitoring will ensure your collator continues to perform reliably. Stay engaged with your parachain community and keep up with updates to maintain optimal performance and security.

Last updated: