@hedera-name-service/hns-resolution-sdk v2.0.11

HNS resolution SDK

The HNS namespace currently includes .hbar, .boo, and .cream TLDs, which are native to HNS. Since the namespace will expand over time, a hardcoded list of TLDs for recognizing HNS names will regularly be out-of-date. The HNS Resolution SDK ensures a correct resolution of account holders and their domains.

Name Resolution

Domains can have many types of data associated with them; the most common is cryptocurrency addresses, or Hedera Account IDs in the context of HNS.

Installation

Install the SDK. There are no additional peer dependencies required at this time.

npm install @hedera-name-service/hns-resolution-sdk

Initialization

Initialize the resolver by defining the API service you will use with the SDK and JSON-RPC Provider. The SDK currently supports the following services:

• hedera_main: Hedera Mainnet Public Mirror Node
• hedera_test: Hedera Testnet Public Mirror Node

Example to initialize resolver with hedera_main:

import { Resolver } from "@hedera-name-service/hns-resolution-sdk";
// Which will use the default JSON-RPC Provider, Hashio.io
const resolver = new Resolver("hedera_main");

• arkhia_main: Hedera Mainnet Arkhia API Service
• arkhia_test: Hedera Testnet Arkhia API Service

Example to initialize resolver with arkhia_main:

import { Resolver } from "@hedera-name-service/hns-resolution-sdk";
// Which will use the default JSON-RPC Provider, Hashio.io
const resolver = new Resolver("arkhia_main", config);

Example to use Arkhia JSON-RPC with arkhia_main:

import { Resolver } from "@hedera-name-service/hns-resolution-sdk";

const resolver = new Resolver("arkhia_main", config);

Note: Config is an object to put keys it consistent of the following:

ResolverConfigs {
    arkhiaUrl?: string;
    arkhiaApiValue?: string;
    arkhiaSecretValue?: string;
    jRpc?: string;
}

Note: The example above demonstrates how to initialize the resolver with Arkhia. This is only for demonstration purposes and should not be implemented on any client side code. Always keep your API keys hidden!

Note: There is an env.example with setup example for easy set up for developers

Resolving domain names

Domains can have many types of data associated with them; the most common is cryptocurrency addresses, or in the context of Hedera, account IDs. HNS supports storing and resolving the account IDs from a given domain name, if associated.

Resolver.resolveSLD

Method:

resolveSLD(domain: string): Promise<string>

Parameter:

domain: string: Any valid string that could represent a domain name.

Return:

Promise<string | undefined>: If the specified domain name resolves to an account ID, the account ID will be returned. If it does not resolve to an account ID, undefined is returned.

Errors:

new Error('Unable to query'): Was unable to query at the time, try again later or report the issue

new Error('No Contract Address'): The Json RPC wasn't able to find contract information

new Error(Not a valid domain): The input domain is not valid

Example:

// Initialize the resolver
const res = await resolver.resolveSLD(`hns.hbar`);
// 0.0.838546

Get Domain Information

You will need to know the domain name, Hedera transaction ID, or the name hash in order to get the domain records.

Resolver.getDomainInfo

Method:

getDomainInfo(domainOrNameHashOrTxId: string | NameHash): Promise<DomainInfo>

Parameter:

domainOrNameHashOrTxId: string | NameHash: A domain name, NameHash object, or Hedera transaction ID. The transaction ID must be in either of these formats: <accountId>@<seconds>.<nanoseconds> or <accountId>-<seconds>.<nanoseconds>.

Return:

Promise<DomainInfo>: An object that represents the requested domain information.

Errors:

new Error('Not Found'): This domain is not found (i.e available to purchase)

new Error('Invalid Input'): The parameter is formatted incorrectly or incompatible

new Error('No Contract Address'); The Json RPC wasn't able to find contract information

new Error('Unable to query'): Was unable to query at the time, try again later or report the issue

Example:

// Initialize the resolver
const res = await resolver.getDomainInfo(`hns.hbar`);
// {}

Resolving Domains from Account IDs

HNS supports reverse resolution to all applications to display HNS names in place of Hedera Account IDs or other data associated with the HNS name(s).

HNS does not enforce the accuracy of reverse records - for instance, anyone may claim that the name for their address is hns.hbar. To be certain that the claim is correct, you must always perform the reverse resolution and render the returned value(s).

Resolver.getAllDomainsForAccount

Method:

getAllDomainsForAccount(accountId: string): Promise<IndexerDomainInfo[] | Record<string, string>[]>

Parameter:

accountId: string: A Hedera Account ID in the format of 0.0.<Account>. Read the docs on Hedera Account IDs for more info.

Return:

Promise<IndexerDomainInfo[] | Record<string, string>[]>: An array of domains that the the specified accountId owns or maps to. The method will return an empty array the accountId does not own or resolve to any domains.

Errors:

new Error('Unable to query'): Was unable to query at the time, try again later or report the issue

Example:

// Initialize the resolver
const res = await resolver.getAllDomainsForAccount(`0.0.800`);
// []

Domain's Metadata

HNS domains have metadata (i.e., saving users' Twitter usernames, Reddit usernames, etc.) to provide more information for users. This will return metadata that is visible in the app in a JSON object.

Resolver.getDomainMetaData

Method:

getDomainMetaData(domain: string): Promise<MetadataType>

Return:

Promise<MetadataType>: An object of the domain's profile metadata

Errors:

new Error(Unable to find domain's profile metadata): Unable to fetch profile metadata

Example:

// Initialize the resolver
const res = await resolver.getDomainMetaData("3yrs.cream");
 {
  domain: '3yrs.cream',
  eth: '',
  btc: '',
  sol: '',
  avatar: '',
  twitter: '',
  email: '',
  url: '',
  description: 'testing',
  keywords: '',
  discord: '',
  github: '',
  reddit: '',
  telegram: '',
  extras: ''
}

Blacklisted Domains

HNS has observed cases of duplicate domains, where there should strictly be only one valid (non-expired) domain in the ecosystem at any given time. To counteract this, the system will list the domains and account IDs related to duplicate domains.

Resolver.getBlackList

Method:

getBlackList(): Promise<DomainInfo[]>

Return:

Promise<DomainInfo[]>: An array of domains that are restricted, and shouldn't be able to be sold or traded.

Errors:

new Error('Unable to fetch blacklist'): Was unable to query at the time, try again later

Example:

// Initialize the resolver
const res = await resolver.getBlackList();
 [
    {
        transactionId: '1707334280.338577662',
        nameHash: {
            domain: 'token.hbar',
            tldHash: 'f861eb72cf942a90b9f6cfa87c4988a5cbeb2d9f48e5365bd88dbf63091584dc',
            sldHash: '6fdf284cdf2eb1e636024067437d76d9535a58dfc84c69c4f4eb5948af7ed23d'
        },
        nftId: '0.0.1234197:19814',
        expiration: 1738870318000,
        provider: 'HNS',
        providerData: { contractId: '0.0.3819952' },
        accountId: '0.0.680340'
    },
  ...
  ]