Retrieve a name

In this tutorial we will retrieve the name created in the Register a Name for an Identity tutorial. Additional details regarding identities can be found in the Identity description.

Prerequisites

• General prerequisites (Node.js / Dash SDK installed)

• A configured client: Setup SDK Client

Code

JavaScript - Resolve by Name

const setupDashClient = require('../setupDashClient');

const client = setupDashClient();

const retrieveName = async () => {
  // Retrieve by full name (e.g., myname.dash)
  return client.platform.names.resolve('<identity name>.dash');
};

retrieveName()
  .then((d) => console.log('Name retrieved:\n', d.getData()))
  .catch((e) => console.error('Something went wrong:\n', e))
  .finally(() => client.disconnect());

JavaScript - Revolve by Record

const setupDashClient = require('../setupDashClient');

const client = setupDashClient();

const retrieveNameByRecord = async () => {
  // Retrieve by a name's identity ID
  return client.platform.names.resolveByRecord(
    'identity',
    '<identity id>',
  );
};

retrieveNameByRecord()
  .then((d) => console.log('Name retrieved:\n', d[0].getData()))
  .catch((e) => console.error('Something went wrong:\n', e))
  .finally(() => client.disconnect());

JavaScript - Search for Name

const setupDashClient = require('../setupDashClient');

const client = setupDashClient();

const retrieveNameBySearch = async () => {
  // Search for names (e.g. `user*`)
  return client.platform.names.search('user', 'dash');
};

retrieveNameBySearch()
  .then((d) => {
    for (const name of d) {
      console.log('Name retrieved:\n', name.getData());
    }
  })
  .catch((e) => console.error('Something went wrong:\n', e))
  .finally(() => client.disconnect());

Example Name

The following example response shows a retrieved name:

{
  "label": "Tutorial-Test-Jettie-94475",
  "normalizedLabel": "tut0r1a1-test-jett1e-94475",
  "normalizedParentDomainName": "dash",
  "parentDomainName": "dash",
  "records": {
    "identity": "woTQprzGS4bLqqbAhY2heG8QfD58Doo2UhDbiVVrLKG"
  },
  "subdomainRules": {
    "allowSubdomains": false
  }
}

What’s Happening

After we initialize the Client, we request a name. The code examples demonstrate the three ways to request a name:

1. Resolve by name. The platform.names.resolve method takes a single argument: a fully-qualified name (e.g., user-9999.dash).

2. Resolve by record. The platform.names.resolveByRecord method takes two arguments: the record type (e.g., identity) and the record value to resolve.

3. Search. The platform.names.search method takes two arguments: the leading characters of the name to search for and the domain to search (e.g., dash for names in the *.dash domain). The search will return names that begin the with string provided in the first parameter.

After the name is retrieved, it is displayed on the console.