Smart Contract Interfaces

River

X (Ex. Twitter)

Github

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

River tokens follow the [ERC20Votes](https://docs.openzeppelin.com/contracts/4.x/api/token/erc20#ERC20Votes) standard and can be delegated to Node Operators on Base or Ethereum Mainnet to participate in rewards [distribution](distribution).

Delegation

Token reward distribution is a key component of the River Network to align incentives between Node Operators and the goals of the network.

Distribution

Claiming Rewards

Frequently Asked Questions

The River 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 River network.

The following guide describes system requirements, dependencies, and installation details recommended for running a River 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 River 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 River Chain.

Register Operator

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

Register Node

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

Upgrade Node

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

Node Observability

River Stream Nodes can run remotely or locally depending on the operator's preferences. The following guide illustrates how to build and run a River 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 River protocol remote node registry on Base.

Local River Stream Node

Smart Contracts powering the River 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.

Contracts

River protocol releases process and guidelines for node operators.

Release Process

Messaging Data Structures

Delegate Key Signing

How the River encryption and decryption protocol works.

River Encryption Protocol

Adding Events to River Stream

Getting Started

connectRiver

connectRiverWithBearerToken

getRoom

RiverSyncProvider

signAndConnect

useAdminRedact

useAgentConnection

useChannel

useCreateChannel

useCreateDm

useCreateGdm

useCreateSpace

useDm

useGdm

useJoinSpace

useMember

useMemberList

useMyMember

useObservable

useReactions

useRedact

useRiver

useRiverAuthStatus

useScrollback

useSendMessage

useSendReaction

useSetDisplayName

useSetEnsAddress

useSetNft

useSetUsername

useSpace

useSyncAgent

useThreads

useTimeline

useUserDms

useUserGdms

useUserSpaces

Learn

Run

Build

React SDK

Smart Contract Interfaces