Citrea
WebsiteBlogJoin The Community
  • 👋Welcome
    • Getting started
  • ⛓️Technical Specs
    • TL;DR
    • Technical Introduction
    • Characteristics
      • Execution Environment
      • Block Production
        • Pre-Confirmations
        • Decentralized Sequencer Network
      • Proof Generation
      • Nodes
      • Bitcoin Settlement: Trust-minimized BTC Bridge
        • BitVM
        • Optimistic Verification
    • Security Properties
      • Validity
      • Data Availability
      • Re-org Resistance
      • Censorship Resistance and Force Transactions
        • Escape Hatch
  • 👤User Guide
    • Run Citrea Full Node
      • Bitcoin Testnet4
        • Testnet4 Docker Setup
        • Build Testnet4 from Source
      • Citrea Full Node
        • Citrea Binary Executable
        • Build Citrea from Source
    • Use Citrea Testnet Faucet
    • Installing an EVM Wallet
    • Taproot Recovery Address
  • 📖Developer Documentation
    • Kickstart
    • Deployment Guide
      • Deploy a Smart Contract Using Remix
      • Deploy a Token
      • Configure Hardhat
    • System Contracts
      • Bitcoin Light Client
      • Bridge
      • Fee Vaults
    • Chain Information
    • RPC Documentation
    • Deploy a Bitcoin Appchain (L3)
  • 🔎Future Research
    • Decentralized Sequencer Network
    • Lightning Integration
    • Multi Prover
    • Multi VM Approach
    • Trustless Atomic Swaps
    • Trustless Settlement
    • Volition Model
  • 🌐Community
    • Citrea Meetups
      • Meetup Guide
      • Resources
      • Code of Conduct
Powered by GitBook
On this page
  • Step 1: Install Docker
  • Step 2: Run using Docker Compose
  • Step 3: Check the sync status
  • Hardware Requirements for running a node

Was this helpful?

  1. User Guide

Run Citrea Full Node

PreviousEscape HatchNextBitcoin Testnet4

Last updated 2 months ago

Was this helpful?

Running a Citrea node is permissionless - anyone can run a full node for development & security purposes.

The easiest way to run a Citrea Full Node is to use the docker-compose.yml that we prepared for you:

Step 1: Install Docker

Follow instructions to install Docker .

Step 2: Run using Docker Compose

curl https://raw.githubusercontent.com/chainwayxyz/citrea/nightly/docker/docker-compose.yml --output docker-compose.yml
docker compose -f docker-compose.yml up

This spins up a Bitcoin Testnet4 and Citrea Full Node for you to use quickly.

Please note that there are no financial incentives to run a Citrea Full Node. It's for your own development setup and security practices.


We've combined these two methods using a Docker Compose file above. However, if you do not want to use Docker Compose & do your own modifications, please proceed with the rest of this section.

To sync with Citrea Testnet, you essentially need to:

Step 3: Check the sync status

You can check the status with the following command (you may need to arrange the URL at the end based on your setup):

curl -X POST --header "Content-Type: application/json" --data '{"jsonrpc":"2.0","method":"citrea_syncStatus","params":[], "id":31}' http://0.0.0.0:8080

A sample response (fields may vary based on the sync status):

{
  "jsonrpc": "2.0",
  "id": 31,
  "result": {
    "l1Status": {
      "Synced": 46916
    },
    "l2Status": {
      "Syncing": {
        "headBlockNumber": 252441,
        "syncedBlockNumber": 123425
      }
    }
  }
}

Hardware Requirements for running a node

A Linux/Mac/Windows system with a configuration of

  • 8 GB Ram

  • 512 GB SSD (NVMe recommended)

  • 4 core CPU (if you're using cloud)

  • 25+ Mbps network connection

should satisfy the minimum requirements to run a Citrea node.


If you encounter any problems during the node running even though you have a system that fits the requirements, please visit our and let us now by opening a ticket.

👤
here
Run a Bitcoin Testnet4 Node
Run a Citrea Full Node
Discord