Type alias Tag

Tag: {
    description?: string;
    extensions?: Extensions;
    name: string;
    uris?: URIs;
}

Tags allow registries to classify and group identities by a variety of characteristics. Tags are standardized within a registry and may represent either labels applied by that registry or designations by external authorities (certification, membership, ownership, etc.) that are tracked by that registry.

Examples of possible tags include: individual, organization, token, wallet, exchange, staking, utility-token, security-token, stablecoin, wrapped, collectable, deflationary, governance, decentralized-exchange, liquidity-provider, sidechain, sidechain-bridge, acme-audited, acme-endorsed, etc.

Tags may be used by clients in search, discovery, and filtering of identities, and they can also convey information like accreditation from investor protection organizations, public certifications by security or financial auditors, and other designations that signal integrity and value to users.

Type declaration

  • Optional description?: string

    A string describing this tag for use in user interfaces.

    In user interfaces with limited space, descriptions should be hidden beyond the first newline character or 140 characters until revealed by the user.

    E.g.:

    • An identity maintained by a single individual.
    • An identity representing a type of token.
    • An on-chain application that has passed security audits by ACME, Inc.
  • Optional extensions?: Extensions

    A mapping of Tag extension identifiers to extension definitions. Extensions may be widely standardized or application-specific.

  • name: string

    The name of this tag for use in interfaces.

    In user interfaces with limited space, names should be hidden beyond the first newline character or 20 characters until revealed by the user.

    E.g.:

    • Individual
    • Token
    • Audited by ACME, Inc.
  • Optional uris?: URIs

    A mapping of identifiers to URIs associated with this tag. URI identifiers may be widely-standardized or registry-specific. Values must be valid URIs, including a protocol prefix (e.g. https:// or ipfs://). Clients are only required to support https and ipfs URIs, but any scheme may be specified.

    The following identifiers are recommended for all tags:

    • icon
    • web

    The following optional identifiers are standardized:

    • blog
    • chat
    • forum
    • icon-intro
    • registry
    • support

    For details on these standard identifiers, see: https://github.com/bitjson/chip-bcmr#uri-identifiers

    Custom URI identifiers allow for sharing social networking profiles, p2p connection information, and other application-specific URIs. Identifiers must be lowercase, alphanumeric strings, with no whitespace or special characters other than dashes (as a regular expression: /^[-a-z0-9]+$/).

    For example, some common identifiers include: discord, docker, facebook, git, github, gitter, instagram, linkedin, matrix, npm, reddit, slack, substack, telegram, twitter, wechat, youtube.

Generated using TypeDoc