Retrieve a Name
Search for a name in the Dash Platform Name Service (DPNS)
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)
Code
const Dash = require('dash');
const client = new Dash.Client({ network: 'testnet' });
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.toJSON()))
.catch((e) => console.error('Something went wrong:\n', e))
.finally(() => client.disconnect());
const Dash = require('dash');
const client = new Dash.Client({ network: 'testnet' });
const retrieveNameByRecord = async () => {
// Retrieve by a name's identity ID
return client.platform.names.resolveByRecord(
'dashUniqueIdentityId',
'<identity id>',
);
};
retrieveNameByRecord()
.then((d) => console.log('Name retrieved:\n', d[0].toJSON()))
.catch((e) => console.error('Something went wrong:\n', e))
.finally(() => client.disconnect());
const Dash = require('dash');
const client = new Dash.Client({ network: 'testnet' });
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.toJSON());
}
})
.catch((e) => console.error('Something went wrong:\n', e))
.finally(() => client.disconnect());
Example Name
The following example response shows a retrieved name (user-9999.dash
):
{
"$protocolVersion": 0,
"$id": "4veLBZPHDkaCPF9LfZ8fX3JZiS5q5iUVGhdBbaa9ga5E",
"$type": "domain",
"$dataContractId": "566vcJkmebVCAb2Dkj2yVMSgGFcsshupnQqtsz1RFbcy",
"$ownerId": "HBNMY5QWuBVKNFLhgBTC1VmpEnscrmqKPMXpnYSHwhfn",
"$revision": 1,
"label": "user-9999",
"records": {
"dashUniqueIdentityId": "HBNMY5QWuBVKNFLhgBTC1VmpEnscrmqKPMXpnYSHwhfn"
},
"preorderSalt": "BzQi567XVqc8wYiVHS887sJtL6MDbxLHNnp+UpTFSB0",
"subdomainRules": { "allowSubdomains": false },
"normalizedLabel": "user-9999",
"normalizedParentDomainName": "dash"
}
What's Happening
After we initialize the Client, we request a name. The code examples demonstrate the three ways to request a name:
- Resolve by name. The
platform.names.resolve
method takes a single argument: a fully-qualified name (e.g.,user-9999.dash
). - Resolve by record. The
platform.names.resolveByRecord
method takes two arguments: the record type (e.g.,dashUniqueIdentityId
) and the record value to resolve. - 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.
Updated 9 months ago