Interface Descriptor

Human friendly descriptor structure

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

interface Descriptor {
    account?: string;
    alias?: string;
    avatar?: IpfsMediaType;
    background?: IpfsMediaType;
    description?: string;
    extension?: string;
    homePage?: string;
    id?: string;
    name?: string;
    resolvedAlias?: Descriptor;
    sendRule?: RegExp;
    socialMediaLinks?: string[];
    type?: SRC44DescriptorType;
    version: number;
    [other: string]: unknown;
}

Indexable

  • [other: string]: unknown

    Custom inline extensions...

Properties

account? alias? avatar? background? description? extension? homePage? id? name? resolvedAlias? sendRule? socialMediaLinks? type? version

Properties

Optionalaccount

account?: string

A reference to a Signum Account

Optionalalias

alias?: string

A reference to a Signum Alias

Optionalavatar

avatar?: IpfsMediaType

IPFS Media Link for the Avatar

Optionalbackground

background?: IpfsMediaType

IPFS Media Link for the background image

Optionaldescription

description?: string

Description, maximal 384 characters

Optionalextension

extension?: string

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

OptionalhomePage

homePage?: string

Homepage - maximal 128 characters

Optionalid

id?: string

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

Optionalname

name?: string

Name, maximal 24 characters

OptionalresolvedAlias

resolvedAlias?: Descriptor

The resolved Descriptor data from a referenced alias

OptionalsendRule

sendRule?: RegExp

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

OptionalsocialMediaLinks

socialMediaLinks?: string[]

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

Optionaltype

type?: SRC44DescriptorType

Descriptor type

version

version: number

Version Number - Should be 1 for now

Settings

Member Visibility

On This Page

Properties