:root {
  --gray-10: #f7f7f8;
  --gray-90: #02000a;
  --gray-20: #959499;
  --gray-60: #1d1b24;
  --dark-gray: #131313;
  --green-main: #82e4a3;
  --purple-main: #8c84f7;
}

#topbar-cta-button {
  background-color: var(--gray-10) !important;
  color: var(--gray-90) !important;
  border: 1px solid var(--gray-90);
  border-radius: 200px;
  height: 40px;
  transition: all 0.3s ease;
}

#topbar-cta-button span,
#topbar-cta-button svg {
  color: var(--gray-90) !important;
  border: none;
  transition: all 0.3s ease;
}

#topbar-cta-button:hover {
  background-color: var(--gray-60) !important;
}

#topbar-cta-button:hover span,
#topbar-cta-button:hover svg {
  color: var(--gray-10) !important;
  border: none;
}

h1,
h2,
h3,
h4,
h5,
h6 {
  color: var(--gray-10) !important;
}

.prose {
  color: var(--gray-20) !important;
}

code {
  color: var(--gray-10) !important;
  /* background-color: var(--dark-gray) !important; */
}

.prose :where(a):not(:where([class~="not-prose"] *)) {
  border-bottom: 1px solid var(--green-main) !important;
}

.token.comment {
  color: var(--gray-20) !important;
}

.token.string,
.token.boolean,
.token.constant,
.token.inserted,
.token.number,
.token.property,
.token.symbol,
.token.tag,
.token.unit {
  color: var(--green-main) !important;
}

.token.function,
.token.constant,
.token.variable,
.token.function .token.maybe-class-name {
  color: var(--purple-main) !important;
}

/* hack to hide the powered by mintlify */
footer > div[class*="sm:flex"] {
  display: none !important;
}


Imports

Definition

sync

streamId

Parameters

Return Type

getRoom

Towns

Introduction

Overview

Space Ownership

Space Membership

Pricing Modules

Roles and Entitlements

Smart Contract Upgradeability: The Diamond Pattern with Facets

Upgradeability

Smart Contracts

Node Operators

Governance Framework

Stakeholders

Proposals

Governance Stages

Utility

Economics

Mechanics

Staking

Claiming Rewards

Build the future of blockchain communication

Towns Protocol Grants Program

The Towns Protocol is powered by a network of Stream Nodes that are registered on chain and run by Node Operators. This guide is intended as an introduction to getting started as an operator and running a node in the Towns network.

The following guide describes system requirements, dependencies, and installation details recommended for running a Towns Stream Node. This guide applies to nodes running in either Testnet or Mainnet.

System Requirements & Installation

The following guide describes steps and best practices for configuring a Towns Stream Node after meeting the [system requirements](/run/node-operator/system-requirements-installation).

System Configuration

The following guide describes high level best practices for running a Stream Node as a node operator.

Best Practices

The following guide illustrates how to register a new Node Operator to begin onboarding nodes. This guide uses Testnet as an example. The Mainnet guide follows from this guide with modifications to contract addresses and rpc url for Towns Chain.

Register Operator

The following guide illustrates how to register a new Stream Node instance on Towns Chain. This guide uses Testnet as an example. The Mainnet guide follows from this guide with modifications to contract addresses and rpc url for Towns Chain.

Register Node

The following guide illustrates how to upgrade a Towns Stream Node on Towns Chain in Testnet. The Mainnet guide follows from this guide with modifications to contract addresses and rpc url for Towns Chain.

Upgrade Node

The following guide describes the observability capabilities of Towns Stream Nodes and how to monitor and manage them.

Node Observability

Towns Stream Nodes can run remotely or locally depending on the operator's preferences. The following guide illustrates how to build and run a Towns Stream Node locally for development purposes. Diagnostic tools to gauge the health of local and remote nodes are also discussed here. It is assumed that the node is free standing and therefore not connected to the Towns protocol remote node registry on Base.

Local Towns Stream Node

Smart Contracts powering the Towns Protocol are deployed to Ethereum L2 networks for testnet and mainnet. This page provides a list of deployed contracts needed for running nodes and their network coordinates.

Learn

Run

Build

React SDK

getRoom

Imports

Definition

Parameters

sync

streamId

Return Type

Learn

Run

Build

React SDK

​Imports

​Definition

​Parameters

​sync

​streamId

​Return Type

Imports

Definition

Parameters

sync

streamId

Return Type