Skip to content

Commit fa3a014

Browse files
committed
added requested info to readme
1 parent 2348ffa commit fa3a014

File tree

1 file changed

+23
-2
lines changed

1 file changed

+23
-2
lines changed

packages/toplevel-alias/README.md

+23-2
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,32 @@
22

33
## Overview
44

5-
The top-level alias registry is a `dm3` protocol extension to provide a decentralized register of names/domains that are mapped (via CCIP) to an ENS subdomain. The registry provides a mapping of top-level domains to their aliases in ENS.
5+
The top-level alias registry is a `dm3` protocol extension to provide a decentralized register of names/domains that are mapped (via CCIP) to an ENS subdomain. The registry provides a mapping of top-level domains to their aliases in ENS. (example: **gno** to **gnosis.eth** which means **name.gno** is linked to **name.gnosis.eth**).
6+
The **top-level alias registry** is the `dm3` internal mapping between registered top-level domains and their respective ENS subdomains.
7+
This registry is used if a **dm3**-user wants to send a message to another user using a "non"-ENS name (like **name.gno**). The registered Toplevel-Domain is then replaced by the alias to access the name (and its **dm3** profile) by reading ENS values.
8+
9+
The top-level alias registry is part of the **dm3** cross-chain approach. Name services of other chains or services are integrated by linking this registry to a subdomain of ENS (via CCIP) and publishing the alias information in the top-level alias registry.
10+
11+
The address of the current top-level alias registry is published at the text record "network.dm3.alias" of the ENS domain "toplevel.dm3.eth". Future versions can be updated by setting this entry.
12+
13+
In version 1 (current version) the contract is administrated by **dm3**. The governance will be extended/change to a more decentralized way in future versions.
14+
15+
## Definitions
16+
17+
**Top-level domain** A top-level domain is the domain ending of a name service. On the one hand, top-level domains are administered by ICANN, which also ensures a corresponding level of collision-free domains. In web3, TLDs are not regulated in some cases. This means that anyone could define a TLD that collides with other web3 domains or even web2 domains. However, the top-level alias registry is used in the dm3 network to ensure uniqueness and freedom from collisions. TLD must be unique.
18+
19+
**Alias** An alias is the ENS subdomain to which a TLD is linked. With CCIP, the content of the connected ecosystem can be accessed via ENS.
20+
21+
## Administration
22+
23+
The **top-level alias** registry is part of the **dm3** network and is needed to allow users to address receivers by their non-ENS names directly without the need to know to what ENS subdomain this registry is linked.
24+
This registry is deployed and managed by **dm3** (in the current version). In future versions, the governance will be extended to administrate this registry based on community decisions.
25+
26+
In version 1 (current version), the contract is owned and administrated by the **dm3** multisig.
627

728
## Project Overview
829

9-
`TopLevelAliasRegistry` is a Solidity smart contract designed for managing a registry of aliases mapped to names. The contract is built to ensure that aliases follow a specific format and are managed by an owner, providing a secure and efficient way to handle alias registration.
30+
`TopLevelAliasRegistry` is a Solidity smart contract designed for managing a registry of aliases mapped to names. The contract is built to ensure that aliases follow a specific format and are managed by an owner, providing a secure and efficient way to handle the **alias** registration.
1031

1132
### Key Features
1233

0 commit comments

Comments
 (0)