Class NamesController

Functions related to DPNS names (usernames)

Index

Methods

normalizeLabel registerName searchByIdentity searchByName testNameContested validateName

Methods

normalizeLabel

normalizeLabel(label: string): string
Converts DPNS name to normalized format (ex. alice.dash -> al1ce.dash)

source: https://github.com/dashpay/platform/blob/master/packages/js-dash-sdk/src/utils/convertToHomographSafeChars.ts
Parameters
- label: string
  {string}
Returns string
- Defined in names/index.ts:107

registerName

registerName(
    name: string,
    identityId: IdentifierLike,
    privateKey: PrivateKeyWASM,
): Promise<void>
Performs a DPNS name registration sequence Contested names are include additional fee of 0.2 Dash Check your name is contested with .testNameContested(name) method to check if additional fee will be charged
Parameters
- name: string
  {string} username (ex. pshenmic.dash)
- identityId: IdentifierLike
  {IdentifierLike} identity identifier
- privateKey: PrivateKeyWASM
  {PrivateKeyWASM} Authentication / High private key from your identity
Returns Promise<void>
- Defined in names/index.ts:85

searchByIdentity

searchByIdentity(identifier: IdentifierLike): Promise<DocumentWASM[]>
Parameters
- identifier: IdentifierLike
Returns Promise<DocumentWASM[]>
- Defined in names/index.ts:72

searchByName

searchByName(name: string): Promise<DocumentWASM[]>
Searches for a registered DPNS name in the network

Should be in a human-readable format, for example pshenmic.dash

Returns a {DocumentWASM} document of type 'domain' from DPNS system data contract if found, returns null if not found.

https://testnet.platform-explorer.com/dataContract/GWRSAVFMjXx8HpQFaNJMqBV7MBgMK4br5UESsB4S31Ec?tab=schema
Parameters
- name: string
  {string}
Returns Promise<DocumentWASM[]>
Promise<DocumentWASM | null>
- Defined in names/index.ts:39

testNameContested

testNameContested(name: string): boolean
Tests a given username against contested names rules. Contested names includes an additional fee of 0.2 Dash as a voting resolution fee

This function return boolean whether given username (f.e pshenmic.dash) falls under contested names rules.
Parameters
- name: string
Returns boolean
- Defined in names/index.ts:58

validateName

validateName(fullName: string): null | string
Validates a DPNS name that you would like to register
Parameters
- fullName: string
  {string} full DPNS name (ex. pshenmic.dash)
Returns null | string
null if valid or string with a reason
- Defined in names/index.ts:118