Type alias IdentitySnapshot

Type declaration

• Optional description?: string

  A string describing this identity 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.:

  • The common stock issued by ACME, Inc.
  • A metadata registry maintained by Company Name, the embedded registry for Wallet Name.
  • Software developer and lead maintainer of Wallet Name.

• Optional extensions?: Extensions

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

  Standardized extensions for IdentitySnapshots include the authchain extension. See https://github.com/bitjson/chip-bcmr#authchain-extension for details.

• Optional migrated?: string

  The timestamp at which this identity snapshot is fully in effect. This value should only be provided if the snapshot takes effect over a period of time (e.g. an in-circulation token identity is gradually migrating to a new category). In these cases, clients should gradually migrate to using the new information beginning after the identity snapshot's timestamp and the migrated time.

  This timestamp must be provided in simplified extended ISO 8601 format, a 24-character string of format YYYY-MM-DDTHH:mm:ss.sssZ where timezone is zero UTC (denoted by Z). Note, this is the format returned by ECMAScript Date.toISOString().

• name: string

  The name of this identity 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. ACME Class A Shares, ACME Registry, Satoshi Nakamoto, etc.

• Optional splitId?: string

  The split ID of this identity's chain of record.

  If undefined, defaults to MetadataRegistry.defaultChain.

• Optional status?: "active" | "burned" | "inactive"

  The status of this identity, must be active, inactive, or burned. If omitted, defaults to active.

  • Identities with an active status should be actively tracked by clients.
  • Identities with an inactive status may be considered for archival by clients and may be removed in future registry versions.
  • Identities with a burned status have been destroyed by setting the latest identity output to a data-carrier output (OP_RETURN), permanently terminating the authchain. Clients should archive burned identities and – if the burned identity represented a token type – consider burning any remaining tokens of that category to reclaim funds from those outputs.

• Optional tags?: string[]

  An array of Tag identifiers marking the Tags associated with this identity. All specified tag identifiers must be defined in the registry's tags mapping.

• Optional token?: TokenCategory

  If this identity is a type of token, a data structure indicating how tokens should be understood and displayed in user interfaces. Omitted for non-token identities.

• Optional uris?: URIs

  A mapping of identifiers to URIs associated with this identity. 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 identities:

  • icon
  • web

  The following optional identifiers are standardized:

  • blog
  • chat
  • forum
  • icon-intro
  • image
  • migrate
  • 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.