Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Consider renaming namespace ID to namespace #206

Open
rootulp opened this issue Jun 15, 2023 · 3 comments
Open

Consider renaming namespace ID to namespace #206

rootulp opened this issue Jun 15, 2023 · 3 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@rootulp
Copy link
Collaborator

rootulp commented Jun 15, 2023

Context

This library is used in celestia-app. After celestia-app/adr-014 and celestia-app/adr-015 were introduced, the namespaced data that gets pushed to an NMT consists of: namespace version (1 byte) | namespace ID (28 bytes) = namespace (29 bytes).

Problem

It is a bit confusing that this repo refers to them as namespace IDs when celestia-app refers to them as namespaces.

Proposal

Rename namespace ID to namespace in this repo

@staheri14
Copy link
Contributor

A relevant comment #209 (comment)

staheri14 added a commit that referenced this issue Jun 28, 2023
## Overview

Closes #205 
Additionally, in line with
[this](#206), to ensure
consistency with how **namespace ID** and **namespace** (i.e., a
combination of namespace ID and version) are utilized in the core-app, I
have replaced all instances of words that refer to or imply **namespace
ID** with the more accurate term "**namespace**".

## Checklist

- [x] New and updated code has appropriate documentation
- [x] New and updated code has new and/or updated testing
- [x] Required CI checks are passing
- [x] Visual proof for any user facing features like CLI or
documentation updates
- [x] Linked issues closed with keywords
@staheri14 staheri14 self-assigned this Jul 10, 2023
@vgonkivs
Copy link
Member

It would be really nice if we will rename a json representation too, bc in celestia-node we've already had a request to make pb and json definitions consistent

@staheri14
Copy link
Contributor

I am unassigning myself from this issue due to other ongoing high-priority big block issues.

@staheri14 staheri14 removed their assignment Apr 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants