Skip to main content

Domain attributes

Domain (and subdomain) attributes are stored on-chain as key-value pairs. Keys and values are utf-8 encoded bytestrings.

Restrictions#

  • length: 1 - 64 characters for both keys and values (this is the upper limit for bytestring length in datums on Cardano)
  • at most 20 attributes per domain (or subdomain)
  • values can only contain the following characters:
    • letters: a - z and A - Z
    • digits: 0 - 9
    • other characters: !"#$%&'()*+,\-./:;<=>?@[\]^_{|}~ and space

Attribute keys#

There are two types of attribute keys: predefined and custom keys.

Predefined keys are used to store cryptocurrency addresses, socials, contact information and define web browser redirects. The following are all currently supported predefined keys:

  • Cryptocurrency addresses - addr
    • addr.ada - Cardano
    • addr.btc - Bitcoin
    • addr.eth - Ethereum
  • Contact information - con
    • con.mail - email address
    • con.mobi - mobile number
  • Socials - soc
    • soc.dsc.inv - Discord invite link
    • soc.dsc.usr - Discord username
    • soc.ig - Instagram
    • soc.tel.shr - Telegram share link
    • soc.tel.usr - Telegram username
    • soc.tktk - Tiktok
    • soc.twtr - Twitter
    • soc.yt - Youtube
  • Web browser - web
    • web.ipfs - valid IPFS hash
    • web.url - valid URL which can be resolved in a web browser (some examples are listed below)
      • https://example.com
      • http://www.example.com/home?q=abc
      • mailto:example@mydomain.com

Custom keys must always start with cus. and can only contain the following characters: a - z, 0 - 9 and - (for example cus.my-custom-attribute1).