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

Index

Accessors

account

get account(): string
Returns string
- Defined in packages/standards/src/src44/DescriptorData.ts:51

alias

get alias(): string
The alias may have a tld, which then returns the alias as alias:tld

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

avatar

get avatar(): IpfsMediaType
Returns IpfsMediaType
- Defined in packages/standards/src/src44/DescriptorData.ts:67

background

get background(): IpfsMediaType
Returns IpfsMediaType
- Defined in packages/standards/src/src44/DescriptorData.ts:71

description

get description(): string
Returns string
- Defined in packages/standards/src/src44/DescriptorData.ts:55

extension

get extension(): string
Returns string
- Defined in packages/standards/src/src44/DescriptorData.ts:63

homePage

get homePage(): string
Returns string
- Defined in packages/standards/src/src44/DescriptorData.ts:79

id

get id(): string
Returns string
- Defined in packages/standards/src/src44/DescriptorData.ts:47

name

get name(): string
Returns string
- Defined in packages/standards/src/src44/DescriptorData.ts:36

raw

get raw(): SRC44Descriptor
Leaky abstraction to get access to the pure raw SRC44 descriptor data

Returns SRC44Descriptor
the raw SRC44 object.
- Defined in packages/standards/src/src44/DescriptorData.ts:28

sendRule

get sendRule(): RegExp
Returns RegExp
- Defined in packages/standards/src/src44/DescriptorData.ts:75

socialMediaLinks

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

type

get type(): SRC44DescriptorType
Returns SRC44DescriptorType
- Defined in packages/standards/src/src44/DescriptorData.ts:59

version

get version(): number
Returns number
- Defined in packages/standards/src/src44/DescriptorData.ts:32

Methods

clone

clone(): DescriptorData
Clones the current instance.

Returns DescriptorData
A copied instance of DescriptorData
- Defined in packages/standards/src/src44/DescriptorData.ts:122

estimateFeePlanck

estimateFeePlanck(baseFee?): string
Estimates the minimum transaction fee for the given payload
Parameters
- baseFee: number = 2000_0000
  The baseFee for calculation in planck. Default is 0.2 SIGNA = 20000000 Planck
Returns string
fee in Planck
- Defined in packages/standards/src/src44/DescriptorData.ts:205

get

get(): Descriptor
Gets a more human friendly version of the data

Returns Descriptor
- Defined in packages/standards/src/src44/DescriptorData.ts:150

getCustomField

getCustomField(fieldName): unknown
Gets a custom field (inline extension)
Parameters
- fieldName: string
Returns unknown
- Defined in packages/standards/src/src44/DescriptorData.ts:143

merge

merge(data): DescriptorData
Merges another descriptor data instance into this one. This operation mutates this instance.
Parameters
- data: DescriptorData
  data to be merged
Returns DescriptorData
The merged result.
- Defined in packages/standards/src/src44/DescriptorData.ts:131

stringify

stringify(): string
Returns string
The SRC44 string to be set with Signum Accounts, Contracts and/or Aliases

Throws
if the string exceeds 1000 bytes.
- Defined in packages/standards/src/src44/DescriptorData.ts:191

validate

validate(): void
Validates the current descriptor data.

Returns void
Throws
in case of invalid data.
- Defined in packages/standards/src/src44/DescriptorData.ts:183

`Static`create

create(name?): DescriptorData
Creates a bare minimum, but strict, SRC44 descriptor instance.
Parameters
- Optionalname: string
  The name
Returns DescriptorData
- Defined in packages/standards/src/src44/DescriptorData.ts:91

`Static`parse

parse(jsonString, strict?): DescriptorData
Creates/Parses a SRC44 compliant descriptor string
Parameters
- jsonString: string
  The SRC44 compliant string. See also stringify
- strict: boolean = true
  If true, the standard check is more strictly
Returns DescriptorData
A new instance of DescriptorData

Throws
SRC44ParseException in case of errors
- Defined in packages/standards/src/src44/DescriptorData.ts:105