Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Descriptor

Human friendly descriptor structure

See SRC44Descriptor, DescriptorData and DescriptorDataBuilder to create, update this structure

Hierarchy

  • Descriptor

Indexable

[other: string]: unknown

Custom inline extensions...

See SRC44Descriptor, DescriptorData and DescriptorDataBuilder to create, update this structure

Index

Properties

Optional account

account: string

A reference to a Signum Account

Optional alias

alias: string

A reference to a Signum Alias

Optional avatar

IPFS Media Link for the Avatar

Optional background

background: IpfsMediaType

IPFS Media Link for the background image

Optional description

description: string

Description, maximal 384 characters

Optional extension

extension: string

An IPFS CID reference to more (off-chain) data

Optional homePage

homePage: string

Homepage - maximal 128 characters

Optional id

id: string

An arbitrary identifier, i.e. external reference - max 48 characters

Optional name

name: string

Name, maximal 24 characters

Optional resolvedAlias

resolvedAlias: Descriptor

The resolved Descriptor data from a referenced alias

Optional sendRule

sendRule: RegExp

Send Rule - must be a valid regex expression (mind the correct escape sequences)

Optional socialMediaLinks

socialMediaLinks: string[]

A list of social media links, maximal 3 URLs, with at maximum 92 characters length

Optional type

Descriptor type

version

version: number

Version Number - Should be 1 for now