Domain Data

All records allow for storing arbitrary information in the "data" map:

type data_map = (string, bytes) map

All entries have:

  • A key that should have a unique meaning. There is a set of reserved keys for typical use, but users are free to create new keys.

  • A value which must be represented in JSON (RFC 8259) and encoded in UTF-8.

Reserved Keys

Tezos Domains

All keys with the prefix td: are reserved for Tezos Domains-related metadata. We currently recognize:

Key

Meaning

Type

Example

td:ttl

The time-to-live of the record and an associated reverse record, if any (in seconds). If defined, it specifies the maximum time the record should be stored in caches and other secondary-storage mechanisms.

number

600

All keys with the prefix etherlink: are reserved for Etherlink-related metadata. We currently recognize:

Key

Meaning

Type

Example

etherlink:address

Your etherlink address.

string

0x0000000000000000000000000000000000000000

Web

The prefix web: is reserved for website urls.

Key

Meaning

Type

Example

web:governance_profile_url

The governance post url which is desribing your Tezos Domains Delegate profile. More details here.

string

OpenID

The prefix openid: is reserved for OpenID claims. The values have their respective meanings according to the OpenID spec. The value types specified in the OpenID spec must be adhered to.

Key

Meaning

Type

Example

openid:<claim>

(e.g. openid:name)

see OpenID spec

"Alice Smith"

Gravatar

To provide an avatar representing their account, Gravatar users can equip their Tezos Domain with the MD5 hash of their Gravatar e-mail.

Key

Meaning

Type

Example

gravatar:hash

The MD5 hash of the user's e-mail on Gravatar in hexadecimal format.

string

"0bc83cb571cd1c50ba6f3e8a78ef1346"

Social media

Key

Meaning

Type

Example

twitter:handle

The associated Twitter handle of the domain.

string

"BillGates"

instagram:handle

The associated Instagram handle of the domain.

string

"nasa"

Developer accounts

Key

Meaning

Type

Example

github:username

User's GitHub account name.

string

"torvalds"

gitlab:username

User's GitLab account name.

string

"foobar"

keybase:username

User's Keybase account name.

string

"foobar"

Source control

Key

Meaning

Type

Example

project:repository_url

Project's Git repository.

string

"https://gitlab.com/tezos-domains/contracts.git"

Last updated