* switch to eipv * fix * fix * 1153 remove trailing whitespace * remove file name checks * 615 remo whitespace before comma * 884 remove extra single-quotes * 1337 remove whitespace before comma * 1057 remove extra spaces after comma * 2470 update created date to Y/M/D format * 1078 update required eips to be in ascending order * 2477 update required eips to be in ascending order * 1271 remove extra whitespace * 2767 required eipupdated to be in ascending order * 2525 update created date to Y/M/D format * 2458 remove trailing whitespace * 1884 remove trailing whitespace * 712 authors should be on a single line * 601 remove extra whitespace * 1485 remove unneeded parentheses * 634 remove trailing whitespace * 2657 update discussions-to to correct spelling * 2009 remove trailing whitespace * 998 required eips updated to be in ascending order * 1186 remove trailing whitespace * 1470 remove extra whitespace * 1895 update created date to Y/M/D format * 2747 remove extra whitespace * 1613 remove leading whitespace * 1571 can'have both handle and email in author field * 1191 remove trailing whitespace * 1973 remove trailing whitespace * 196 don't wrap title field * 1679 required eips must be in ascending order * 1620 author can't have both handle and email * 197 don't line wrap title field * 2378 remove extra newline * 1355 author can't have both handle and email * 698 update created date to Y/M/D format * 2193 required eips must be in ascending order * 214 remove extra info after author email * use v0.0.3 of eipv * 1 remove malformed field * bump eipv to v0.0.4 * cache eipv build * 1485 remove extra author info * 2771 removing extra whitespaces
2.4 KiB
eip | title | author | type | discussions-to | category | status | created |
---|---|---|---|---|---|---|---|
634 | Storage of text records in ENS | Richard Moore (@ricmoo) | Standards Track | https://github.com/ethereum/EIPs/issues/2439 | ERC | Draft | 2017-05-17 |
Abstract
This EIP defines a resolver profile for ENS that permits the lookup of arbitrary key-value text data. This allows ENS name holders to associate e-mail addresses, URLs and other informational data with a ENS name.
Motivation
There is often a desire for human-readable metadata to be associated with otherwise machine-driven data; used for debugging, maintenance, reporting and general information.
In this EIP we define a simple resolver profile for ENS that permits ENS names to associate arbitrary key-value text.
Specification
Resolver Profile
A new resolver interface is defined, consisting of the following method:
function text(bytes32 node, string key) constant returns (string text);
The interface ID of this interface is 0x59d1d43c.
The text
data may be any arbitrary UTF-8 string. If the key is not present, the empty string
must be returned.
Initial Recommended Keys
Keys must be made up of lowercase letters, numbers and the hyphen (-). Vendor specific
services must be prefixed with vnd.
.
-
email - an e-mail address
-
url - a URL
-
avatar - a URL to an image used as an avatar or logo
-
description - A description of the name
-
notice - A notice regarding this name;
-
keywords - A list of comma-separated keywords, ordered by most significant first; clients that interpresent this field may choose a threshold beyond which to ignore
-
vnd.github - a GitHub username
-
vnd.peepeth - a peepeth username
-
vnd.twitter - a twitter username
Usernames SHOULD not be prefixed with the @ symbol.
Rationale
Application-specific vs general-purpose record types
Rather than define a large number of specific record types (each for generally human-readable
data) such as url
and email
, we follow an adapted model of DNS's TXT
records, which allow
for a general keys and values, allowing future extension without adjusting the resolver, while
allowing applications to use custom keys for their own purposes.
Backwards Compatibility
Not applicable.
Test Cases
TBD
Implementation
None yet.
Copyright
Copyright and related rights waived via CC0.