-
Notifications
You must be signed in to change notification settings - Fork 1.1k
Open
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationenhancementNew feature or requestNew feature or requestexternalIssues created by non node team membersIssues created by non node team membersgood first issueGood for newcomersGood for newcomers
Description
Implementation ideas
Problem Description
The Celestia node repository currently exports two distinct Go client packages that are both commonly referred to as the "Celestia Go client," creating significant confusion for developers and hindering adoption:
api/client- A high-level, application-focused client for blob submission and simplified DA operationsapi/rpc/client- A low-level RPC client providing direct access to all node APIs
This naming ambiguity leads to:
- Developer confusion when choosing the right client for their use case
- Documentation fragmentation with unclear guidance on which client to use
- Confusing search results when developers look for client documentation
- Adoption barriers as developers struggle to understand the ecosystem
- Support overhead with repeated questions about client differences
- Poor developer experience during onboarding
- Unclear integration guides when referencing "the Celestia Go client"
Proposed Solution
We propose renaming the client packages to have distinct, descriptive names that clearly indicate their intended purpose:
Suggested Renamings
- Rename
api/client→celestia-sdk,celestia-app-client, or similar descriptive name - Rename
api/rpc/client→celestia-rpc-client,celestia-node-client, or similar descriptive name - Add a README.md file to
api/rpc/clientexplaining its purpose and use cases
Developer Relations Follow-up
Once renamed, we will:
- Update all documentation to use the new distinct names
- Create guides explaining when to use each client
- Ensure consistent naming across all tutorials and examples
The goal is not to deprecate either client, but to make their distinct purposes crystal clear to developers at all levels.
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationenhancementNew feature or requestNew feature or requestexternalIssues created by non node team membersIssues created by non node team membersgood first issueGood for newcomersGood for newcomers