Skip to content

Install


Latest Version Tag

Install dependencies

Update system and install build tools
Terminal window
sudo apt -q update
sudo apt -qy install curl git jq lz4 build-essential
sudo apt -qy upgrade

First, ensure that the following are installed globally on your machine:

RPC endpoints for Ethereum and Optimism Mainnet (use Alchemy, Infura, or QuickNode). See tutorials for instructions on how to set up cloud providers to run Hubble.

Open the desired ports

Terminal window
export HTTP_API_PORT=2281
export GOSSIP_PORT=2282
export RPC_PORT=2283
# Set this to your L1 Mainnet ETH RPC URL
export ETH_MAINNET_RPC_URL=[your-ETH-mainnet-RPC-URL]
# Set this to your L2 Optimism Mainnet RPC URL
export OPTIMISM_L2_RPC_URL=[your-L2-optimism-RPC-URL]
# Set this to your Farcaster FID
export HUB_OPERATOR_FID=[your-fid]

Installing from source

Terminal window
# Clone project repository
git _repo_path_
cd _repo_name_
_project_name_ install
_project_name_ build

Navigate to the hubble folder: cd apps/hubble Create an .env file (if you don’t have one), or tear it out and write the data:

Terminal window
BOOTSTRAP_NODE=/dns/nemes.farcaster.xyz/tcp/[YOUR_GOSSIP_PORT]
Terminal window
_project_name_ test

Running Hubble

To run the Hubble commands, go to the Hubble app (cd apps/hubble) and run the _project_name_ commands.

  1. Create a ID
Terminal window
_project_name_ identity create
  1. Follow the instructions to set connect to a network

  2. Run

Terminal window
_project_name_ start \
--hub-operator-fid ${HUB_OPERATOR_FID} \
--eth-mainnet-rpc-url ${ETH_MAINNET_RPC_URL} \
--l2-rpc-url ${OPTIMISM_L2_RPC_URL} \
--http-api-port ${HTTP_API_PORT} \
--gossip-port ${GOSSIP_PORT} \
--rpc-port ${RPC_PORT}

Upgrading Hubble

To upgrade hubble, find the latest release tag and checkout that version and build.

Terminal window
# to fetch the latest tags
git fetch --tags
# Or use a specific version.
git checkout @farcaster/hubble@latest
# in the root folder
_project_name_ install && _project_name_ build

comming soon…