ZNSConnect SDK Documentation

The ZNSConnect SDK provides a set of functionalities to interact with blockchain domain names, including resolving addresses, getting metadata, checking domain availability, and more. Below is the documentation for each function available in the SDK.

Functions

resolveAddress

Resolves the blockchain address for a given top-level domain (TLD) and address.

| Parameter | Type | Description | |-----------|----------|--------------------------------------------------| | tld | string | The top-level domain (e.g., 'nft', 'xterio'). | | address | string | The blockchain address to resolve (prefixed with 0x). |

Returns: Promise<any> - The resolution result.

Example:

const result = await ZNSConnect.resolveAddress('nft', '0x123...');
console.log(result);

resolveDomain

Resolves the owner of a given domain.

| Parameter | Type | Description | |-----------|----------|-----------------------------------| | domain | string | The domain name to resolve. |

Returns: Promise<string> - The owner's address.

Example:

const owner = await ZNSConnect.resolveDomain('example.nft');
console.log(owner);

getRegistry

Gets the registry information for a given domain.

| Parameter | Type | Description | |-----------|----------|------------------------------| | domain | string | The domain to get info for. |

Returns: Promise<any> - The registry information.

Example:

const registry = await ZNSConnect.getRegistry('example.nft');
console.log(registry);

getMetadata

Retrieves metadata for a given domain.

| Parameter | Type | Description | |-----------|----------|----------------------------| | domain | string | The domain to get metadata for. |

Returns: Promise<any> - The domain metadata.

Example:

const metadata = await ZNSConnect.getMetadata('example.nft');
console.log(metadata);

checkDomain

Checks if a domain is already registered.

| Parameter | Type | Description | |-----------|----------|---------------------------| | domain | string | The domain to check. |

Returns: Promise<boolean> - true if the domain is registered, otherwise false.

Example:

const isRegistered = await ZNSConnect.checkDomain('example.nft');
console.log(isRegistered ? 'Registered' : 'Available');

getPrice

Gets the total price for registering a list of domains under a specific TLD.

| Parameter | Type | Description | |--------------|------------|---------------------------------------| | domainArray| string[] | The list of domains to check the price for. | | tld | string | The top-level domain. |

Returns: Promise<any> - The total price.

Example:

const price = await ZNSConnect.getPrice(['example1', 'example2'], 'nft');
console.log(price);

register

Registers a list of domains under a specific TLD to specified owner addresses.

| Parameter | Type | Description | |----------------|------------------|-----------------------------------------------| | walletClient | WalletClient | The wallet client instance. | | domainNames | string[] | The list of domains to register. | | ownerAddresses| string[] | The list of owner addresses for the domains. | | tld | string | The top-level domain. |

Returns: Promise<any> - The registration result.

Example:

await ZNSConnect.register(walletClient, ['example1', 'example2'], ['0x123...', '0x456...'], 'nft');

This documentation provides a comprehensive guide to using the ZNSConnect SDK for interacting with blockchain domains.