[mkdocs] docs: add namespace concept#844
[mkdocs] docs: add namespace concept#844zero4862 wants to merge 3 commits intoNemProject:new-docsfrom
Conversation
|
|
||
| Subnamespace | ||
| : A namespace that belongs to a parent namespace, either the root or another subnamespace. | ||
| Subnamespaces expire when the root namespace expires (see [Duration](#duration)). |
There was a problem hiding this comment.
In Symbol, we say:
A namespace that belongs to a parent root namespace. Subnamespaces expire when the parent namespace expires (see Duration)
What's marked in bold seems not accurate:
- parent root -> parent: A subnamespace could be defined under another subnamespace, not necessarily the parent root.
- parent namespace -> *root namespace: Since the parent subnamespace could be another subnamepace, we might want to say root namespace instead.
There was a problem hiding this comment.
Agreed, can you add this to the Symbol PR too?
|
|
||
| Namespaces let an account group related mosaics under a meaningful prefix like `mycompany.tokens`. | ||
|
|
||
| The account that registers a root namespace is called its _owner_. |
There was a problem hiding this comment.
To review in Symbol:
-
creator vs owner: We define the concept of "owner" here, while Symbol it uses "creator" and "owner". We should standardize this terminology (guides already use "owner"). "Creator" can be interpreted as the account that originally registered the namespace, whereas "owner" I think it reflects more accurately the account that has leased the namespace.
-
create namespace vs register namespace: Replaced "create namespace" with "register namespace" for the same reason.
There was a problem hiding this comment.
Good thinking, yes. Can you create the PR for Symbol?
There was a problem hiding this comment.
Yes, I can tackle this after completing all the textbook concepts, so I can evaluate the effort of updating Symbol all at once.
| "Grace Period" -> Registered [label="\nRenewal" constraint=false]; | ||
| "Grace Period" -> "Available Again" [label="Release"]; |
There was a problem hiding this comment.
To review in Symbol:
Changed here "Deletion" for "Release". It matches better "Register". "Delete" matches better "Create".
There was a problem hiding this comment.
Agreed. Can you add it to the Symbol PR?
| Registering or renewing any kind of namespace requires announcing a transaction, which also has an associated fee. | ||
| However, this transaction fee is typically negligible compared to the lease fee. | ||
|
|
||
| ## Reserved Names |
There was a problem hiding this comment.
Added this new section (reserved names), we could add a similar one in Symbol.
4b2e104 to
c33a002
Compare
segfaultxavi
left a comment
There was a problem hiding this comment.
Minor changes only.
|
|
||
| Namespaces let an account group related mosaics under a meaningful prefix like `mycompany.tokens`. | ||
|
|
||
| The account that registers a root namespace is called its _owner_. |
There was a problem hiding this comment.
Good thinking, yes. Can you create the PR for Symbol?
|
|
||
| Subnamespace | ||
| : A namespace that belongs to a parent namespace, either the root or another subnamespace. | ||
| Subnamespaces expire when the root namespace expires (see [Duration](#duration)). |
There was a problem hiding this comment.
Agreed, can you add this to the Symbol PR too?
|
|
||
| `nem`, `user`, `account`, `org`, `com`, `biz`, `net`, `edu`, `mil`, `gov`, `info`. | ||
|
|
||
| The `nem` namespace, in particular, is used by the system to host the native currency `nem:xem`. |
There was a problem hiding this comment.
There's a colon to separate namespaces here, but previously you said it was periods. Which one is it?
There was a problem hiding this comment.
NEM namespaces are not used to name mosaics (like in Symbol), but to organize them. Mosaics have their own name. In nem:xem, nem is the namespace name and xem is the mosaic name, separated by a colon.
Subnamespaces are separated by a dot. Example: company.tokens:gold, where company is the namespace, tokens the subnamespace and gold the mosaic name.
There was a problem hiding this comment.
Got it. I had not idea.
Then definitely you cannot use this example here without explaining what the colon means.
I understand you will probably explain it in the Mosaics page, but you need to provide at least a minimal explanation here and a link to where the colon is fully explained.
Something like:
| The `nem` namespace, in particular, is used by the system to host the native currency `nem:xem`. | |
| The `nem` namespace, in particular, is used by the system to host the native currency `nem:xem` | |
| (note that the colon separates the namespace from the [currency name](./mosaics.md#fully-qualified-name)). |
| "Grace Period" -> Registered [label="\nRenewal" constraint=false]; | ||
| "Grace Period" -> "Available Again" [label="Release"]; |
There was a problem hiding this comment.
Agreed. Can you add it to the Symbol PR?
| Registering or renewing any kind of namespace requires announcing a transaction, which also has an associated fee. | ||
| However, this transaction fee is typically negligible compared to the lease fee. | ||
|
|
||
| ## Reserved Names |
12f78fe to
765f950
Compare
|
|
||
| `nem`, `user`, `account`, `org`, `com`, `biz`, `net`, `edu`, `mil`, `gov`, `info`. | ||
|
|
||
| The `nem` namespace, in particular, is used by the system to host the native currency `nem:xem`. |
There was a problem hiding this comment.
Got it. I had not idea.
Then definitely you cannot use this example here without explaining what the colon means.
I understand you will probably explain it in the Mosaics page, but you need to provide at least a minimal explanation here and a link to where the colon is fully explained.
Something like:
| The `nem` namespace, in particular, is used by the system to host the native currency `nem:xem`. | |
| The `nem` namespace, in particular, is used by the system to host the native currency `nem:xem` | |
| (note that the colon separates the namespace from the [currency name](./mosaics.md#fully-qualified-name)). |
Adapts Namespace concept to NEM technology.
Differences with Symbol: