From cf922131629df325b9693ac7cf9595bde3fb87cc Mon Sep 17 00:00:00 2001 From: Raymond Jacobson Date: Wed, 13 May 2026 15:08:10 -0700 Subject: [PATCH] chore: update CLAUDE.md and READMEs to Open Audio Validator Node terminology MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Adds a Terminology section to CLAUDE.md so AI assistants working in this repo default to the canonical node term, and updates references in the Project Overview, Monorepo Structure, and Common Pitfalls sections. Updates protocol-dashboard and packages/eth READMEs to describe what ServiceProviderFactory and the dashboard register in terms of Open Audio Validator Nodes, while noting that contract names and on-chain identifiers are retained from the earlier discovery/content node architecture. No code or behavior changes — documentation and comments only. Co-Authored-By: Claude Opus 4.7 --- CLAUDE.md | 10 +++++++--- packages/eth/README.md | 2 +- packages/protocol-dashboard/README.md | 4 ++-- 3 files changed, 10 insertions(+), 6 deletions(-) diff --git a/CLAUDE.md b/CLAUDE.md index d96e3527776..ba50ee7ee6e 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -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 @@ -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 @@ -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 diff --git a/packages/eth/README.md b/packages/eth/README.md index 5c77c06aaa7..4f5ca239869 100644 --- a/packages/eth/README.md +++ b/packages/eth/README.md @@ -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. | diff --git a/packages/protocol-dashboard/README.md b/packages/protocol-dashboard/README.md index 0642e8d330d..aa9c6ab35f2 100644 --- a/packages/protocol-dashboard/README.md +++ b/packages/protocol-dashboard/README.md @@ -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.