Citrea Binary Executable

We've compiled an executable for you to run a Citrea Full Node directly on macOS / Linux. For the following steps, we assume that you have a Bitcoin Testnet4 node running. If not, please visit here.

Step 0: Make a separate folder and move in

To tidy things up, you can run the following and make a separate folder:

mkdir citrea

cd citrea

Step 1: Download the binary executable

We're hosting our binary in the Citrea repository. Please download the suitable executable for your configuration.

Step 2: Download genesis & testnet config

To sync correctly, config & genesis files should be provided correctly. You can download & extract them using the following:

curl https://raw.githubusercontent.com/chainwayxyz/citrea/nightly/resources/configs/testnet/rollup_config.toml --output rollup_config.toml

curl https://static.testnet.citrea.xyz/genesis.tar.gz --output genesis.tar.gz
tar -xzvf genesis.tar.gz

Step 2.1: Use snapshots (Optional)

A database snapshot is a point-in-time copy of a database's state. In our case it is a copy of a full node's database from a very recent time. You can get a full node database snapshot before running your node to get it to sync a lot quicker. Go to snapshots section and follow the steps, then come back here to run your node!

Step 3: Run!

First, let's grant running permission to our executable (may require sudo):

chmod u+x ./citrea-v1.1.0-osx-arm64

chmod u+x ./citrea-v1.1.0-linux-amd64

Then, based on your operating system, run one of the following:

Mac:

./citrea-v1.1.0-osx-arm64 --da-layer bitcoin --rollup-config-path ./rollup_config.toml --genesis-paths ./genesis --network testnet

Linux:

./citrea-v1.1.0-linux-amd64 --da-layer bitcoin --rollup-config-path ./rollup_config.toml --genesis-paths ./genesis --network testnet

If the paths are correct, the full node will start to sync. 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
      }
    }
  }
}

---

If you do not want to use the provided binary executable to setup a Citrea node, you can also build it from the source code here.