Skip to content

Commit e3a6844

Browse files
chore: update terminology to Open Audio Validator Node (#14305)
## Summary - Adds a **Terminology** section near the top of \`CLAUDE.md\` instructing AI assistants to use **Open Audio Validator Node** and treat *Discovery Node* / *Content Node* / *Creator Node* / *Discovery Provider* as deprecated. - Updates the in-body references in \`CLAUDE.md\` (Project Overview, Monorepo Structure, Common Pitfalls) to canonical terminology while noting that the \`packages/discovery-provider\` and \`mediorum\` directory names are retained for compatibility. - Updates \`packages/protocol-dashboard/README.md\` and \`packages/eth/README.md\` (ServiceProviderFactory row) so the user-facing descriptions match. ## Motivation \`CLAUDE.md\` is a literal AI instruction file — keeping deprecated terminology in it shapes what every Claude session in this repo writes next. The two README updates are small but cover the most public surfaces (dashboard + \`@audius/eth\` consumers). No code, ABI, contract address, or behavior changes — documentation only. ## Test plan - [ ] No build impact; docs-only change Co-authored-by: Claude Opus 4.7 <noreply@anthropic.com>
1 parent d99bff5 commit e3a6844

3 files changed

Lines changed: 10 additions & 6 deletions

File tree

CLAUDE.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,17 @@
22

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

5+
## Terminology
6+
7+
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.
8+
59
## Project Overview
610

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

913
- Web and desktop applications (React + Vite)
1014
- Mobile applications (React Native)
11-
- Backend services (Discovery Provider, Content Node)
15+
- 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)
1216
- Blockchain smart contracts (Ethereum and Solana)
1317
- SDK and common libraries
1418

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

8185
### State Management
8286

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

135139
## Code Style and Best Practices
136140

packages/eth/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ const signature = await walletClient.signTypedData({
108108
| `EthRewardsManager` | Transfers AUDIO rewards from Ethereum to Solana via Wormhole. |
109109
| `Governance` | On-chain governance: proposals, stake-weighted voting, execution. |
110110
| `Registry` | Central directory mapping contract names to addresses. |
111-
| `ServiceProviderFactory` | Registration and staking for discovery nodes and content nodes. |
111+
| `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). |
112112
| `ServiceTypeManager` | Registry of valid service types and their versions. |
113113
| `Staking` | Core staking contract holding all staked AUDIO with checkpointing. |
114114
| `TrustedNotifierManager` | Registry of trusted notifier entities. |

packages/protocol-dashboard/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# Audius Service Provider Dashboard
22

33
## Summary
4-
Audius Service Provider Dashboard allows users to register content nodes and discovery providers,
5-
view their registered services & which ones are out date, and explore all audius services.
4+
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),
5+
view their registered services and which ones are out of date, and explore all Audius services.
66

77
## Running the Application
88
The application requires ethereum contracts.

0 commit comments

Comments
 (0)