@snsdomains/js

The Sui Name Service is a decentralized naming and identity protocol for the Sui Network. This package provides all the JavaScript resources to interact with the on-chain domains program. We are proudly open-source and community-run.

Install with npm:

$ npm install @snsdomains/js

Install with yarn:

$ yarn add @snsdomains/js

Quick start

For a quick start guide, please see the examples below. The library is very lightweight and actively used in our production software. If you require any on-boarding assistance or have a partnership requests, please email us at [email protected].

Sui Devnet

Please note that the Sui devnet updates will require us to update this library to work with the new deployed addresses. Luckily, this feature is built-in and you don't have to continuously update your addreses. Instead, it will fetch from our objects.json repository.

Built to Scale

The Sui Name Service domains program is built to scale to 100m+ names on-chain, by using the Sui dynamic object API. The API structure for domains is as follows:

1. Resolver: Stores all domain text records and a reference to its ownership NFT. (Can be cached)
2. Domain NFT: Represents ownership of the domain name. Whoever owns this NFT is automatically the resolvable address for the domain.
3. Profile: Automatically created with a user's first domain registration (free of charge). This is used to reflect a user's identity on Sui and can be configured with all elements of their basic profile.

To prevent confusion, the DomainNFT owner will always be the resolvable address of the domain. This was done to prevent mis-transfers of funds following secondary sales, and the limited use cases associated with changing the resolvable address of a domain.

Examples

Resolve a domain in five lines of code! Below are listed all of our available query methods.

GET a Domain's SuiAddress

This is the core query of the Sui Name Service and resolves a domain to its owner. Our library is made to work whenever the Sui Network resets without you having to update to a new version. It automatically fetches our latest deployed program IDs from our Github.

import {SnsApi, queryForObjects} from '@snsdomains/js';
import {JsonRpcProvider, Network} from "@mysten/sui.js";

// *This is only required for dev-net.
// It fetches our program IDs without you having to update this library
const objects = await queryForObjects(Network.DEVNET);

// Configure API / provider
const provider = new JsonRpcProvider(Network.DEVNET);
const api = new SnsApi(provider, Network.DEVNET, objects);

// Resolve domain
const address = await api.domains.getAddress("anthony.sui");

GET an Ownership DomainNFT

const nft = await api.domains.getDomain("anthony.sui");

GET a DomainResolver

Domain name-service records are stored on the resolver. For consecutive queries of the same name, please cache the domain's Resolver and use it to re-query the domain address or records.

const resolver = await api.domains.getResolver("anthony.sui");

GET a user's Sui Profile

const userAddress = "0xc4173a804406a365e69dfb297d4eaaf002546ebd"
const profile = await api.profiles.getProfile(userAddress);

GET a user's Sui Primary Domain Name

const userAddress = "0xc4173a804406a365e69dfb297d4eaaf002546ebd"
const profile = await api.profiles.getProfile(userAddress);
const primary = await api.profiles.getPrimaryDomain(profile);

Versioning

• 0.0.1 Increase: object.json update / and or readme.md
• 0.1.0 Increase: feature update
• 1.0.0 Increase: major / breaking changes