Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 7 additions & 3 deletions CLAUDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,17 @@

This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.

## Terminology

Audius runs on the **Open Audio Protocol**, which uses a single canonical node type: the **Open Audio Validator Node**. The earlier split between *Discovery Nodes* and *Content Nodes* is deprecated — both roles are now served by validator nodes. When writing docs, comments, commit messages, or user-facing strings, use "Open Audio Validator Node" (or just "validator node"). Do not introduce new references to "Discovery Node", "Content Node", "Creator Node", or "Discovery Provider". Directory names like `packages/discovery-provider` and `mediorum` are retained for compatibility but no longer reflect the architecture.

## Project Overview

Audius is a decentralized, community-owned music-sharing protocol. This is a monorepo containing:

- Web and desktop applications (React + Vite)
- Mobile applications (React Native)
- Backend services (Discovery Provider, Content Node)
- Backend services that together make up the Open Audio Validator Node software (indexer + media storage; see `packages/discovery-provider` and `mediorum` directories — names retained from earlier architecture)
- Blockchain smart contracts (Ethereum and Solana)
- SDK and common libraries

Expand Down Expand Up @@ -76,7 +80,7 @@ audius-cmd stream
- **packages/sdk**: JavaScript SDK for interacting with Audius protocol
- **packages/harmony**: Design system components and tokens
- **packages/discovery-provider**: Python backend that indexes blockchain data
- **mediorum**: Content node for storing/serving audio files
- **mediorum**: Media storage component of the Open Audio Validator Node — stores and serves audio files (directory name retained from earlier "content node" architecture)

### State Management

Expand Down Expand Up @@ -130,7 +134,7 @@ audius-cmd stream
- Protocol must be running for local development
- Mobile requires proper native environment setup
- Some features require blockchain interaction
- Audio processing happens on content nodes
- Audio processing happens on Open Audio Validator Nodes (the role formerly called "content node" — deprecated terminology)

## Code Style and Best Practices

Expand Down
2 changes: 1 addition & 1 deletion packages/eth/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ const signature = await walletClient.signTypedData({
| `EthRewardsManager` | Transfers AUDIO rewards from Ethereum to Solana via Wormhole. |
| `Governance` | On-chain governance: proposals, stake-weighted voting, execution. |
| `Registry` | Central directory mapping contract names to addresses. |
| `ServiceProviderFactory` | Registration and staking for discovery nodes and content nodes. |
| `ServiceProviderFactory` | Registration and staking for Open Audio Validator Nodes (the unified node type that replaces the legacy *discovery node* / *content node* split — contract and service-type names are retained from the earlier architecture). |
| `ServiceTypeManager` | Registry of valid service types and their versions. |
| `Staking` | Core staking contract holding all staked AUDIO with checkpointing. |
| `TrustedNotifierManager` | Registry of trusted notifier entities. |
4 changes: 2 additions & 2 deletions packages/protocol-dashboard/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Audius Service Provider Dashboard

## Summary
Audius Service Provider Dashboard allows users to register content nodes and discovery providers,
view their registered services & which ones are out date, and explore all audius services.
Audius Service Provider Dashboard allows operators to register Open Audio Validator Nodes (the unified node type that replaces the deprecated *content node* / *discovery provider* split),
view their registered services and which ones are out of date, and explore all Audius services.

## Running the Application
The application requires ethereum contracts.
Expand Down
Loading