Class DescriptorData

Descriptor Data

SRC44-compliant Descriptor Data to be used as description in Smart Contracts, Account Info, and/or Aliases. Use DescriptorDataBuilder to construct from the scratch, or use this to parse json data

Hierarchy

DescriptorData

Index

Accessors

Methods

Accessors

account

get account(): string

- Defined in packages/standards/src/src44/DescriptorData.ts:51
Returns string

alias

get alias(): string

- Defined in packages/standards/src/src44/DescriptorData.ts:43
The alias may have a tld, which then returns the alias as alias:tld

Returns string

avatar

get avatar(): IpfsMediaType

- Defined in packages/standards/src/src44/DescriptorData.ts:67
Returns IpfsMediaType

background

get background(): IpfsMediaType

- Defined in packages/standards/src/src44/DescriptorData.ts:71
Returns IpfsMediaType

description

get description(): string

- Defined in packages/standards/src/src44/DescriptorData.ts:55
Returns string

extension

get extension(): string

- Defined in packages/standards/src/src44/DescriptorData.ts:63
Returns string

homePage

get homePage(): string

- Defined in packages/standards/src/src44/DescriptorData.ts:79
Returns string

id

get id(): string

- Defined in packages/standards/src/src44/DescriptorData.ts:47
Returns string

name

get name(): string

- Defined in packages/standards/src/src44/DescriptorData.ts:36
Returns string

raw

get raw(): SRC44Descriptor

- Defined in packages/standards/src/src44/DescriptorData.ts:28
Leaky abstraction to get access to the pure raw SRC44 descriptor data

Returns SRC44Descriptor

the raw SRC44 object.

sendRule

get sendRule(): RegExp

- Defined in packages/standards/src/src44/DescriptorData.ts:75
Returns RegExp

socialMediaLinks

get socialMediaLinks(): string[]

- Defined in packages/standards/src/src44/DescriptorData.ts:83
Returns string[]

type

get type(): SRC44DescriptorType

- Defined in packages/standards/src/src44/DescriptorData.ts:59
Returns SRC44DescriptorType

version

get version(): number

- Defined in packages/standards/src/src44/DescriptorData.ts:32
Returns number

Methods

clone

clone(): DescriptorData

- Defined in packages/standards/src/src44/DescriptorData.ts:122
Clones the current instance.

Returns DescriptorData

A copied instance of DescriptorData

estimateFeePlanck

estimateFeePlanck(baseFee?: number): string

- Defined in packages/standards/src/src44/DescriptorData.ts:205
Estimates the minimum transaction fee for the given payload

Parameters
- Default value baseFee: number = 20000000
  
  The baseFee for calculation in planck. Default is 0.2 SIGNA = 20000000 Planck
Returns string

fee in Planck

get

get(): Descriptor

- Defined in packages/standards/src/src44/DescriptorData.ts:150
Gets a more human friendly version of the data

Returns Descriptor

getCustomField

getCustomField(fieldName: string): unknown

- Defined in packages/standards/src/src44/DescriptorData.ts:143
Gets a custom field (inline extension)

Parameters
- fieldName: string
Returns unknown

merge

merge(data: DescriptorData): this

- Defined in packages/standards/src/src44/DescriptorData.ts:131
Merges another descriptor data instance into this one. This operation mutates this instance.

Parameters
- data: DescriptorData
  
  data to be merged
Returns this

The merged result.

stringify

stringify(): string

- Defined in packages/standards/src/src44/DescriptorData.ts:191
throws

if the string exceeds 1000 bytes.

Returns string

The SRC44 string to be set with Signum Accounts, Contracts and/or Aliases

validate

validate(): void

- Defined in packages/standards/src/src44/DescriptorData.ts:183
Validates the current descriptor data.

throws

in case of invalid data.

Returns void

Static create

create(name?: string): DescriptorData

- Defined in packages/standards/src/src44/DescriptorData.ts:91
Creates a bare minimum, but strict, SRC44 descriptor instance.

Parameters
- Optional name: string
  
  The name
Returns DescriptorData

Static parse

parse(jsonString: string, strict?: boolean): DescriptorData

- Defined in packages/standards/src/src44/DescriptorData.ts:105
Creates/Parses a SRC44 compliant descriptor string

throws

SRC44ParseException in case of errors

Parameters
- jsonString: string
  
  The SRC44 compliant string. See also stringify
- Default value strict: boolean = true
  
  If true, the standard check is more strictly
Returns DescriptorData

A new instance of DescriptorData