JS Kit SDK API Reference / Domain
Domain
Domain resolution, derivation, records, and subdomain APIs.
Interfaces
| Interface | Description |
|---|---|
| GetAllSnsDomainsParams | Parameters for retrieving all SNS domains. |
| GetAllSnsDomainsResult | A top-level SNS domain account. |
| GetDomainOwnerParams | Parameters for retrieving a domain owner. |
| GetDomainRecordOptions | Options for retrieving a domain record. |
| GetDomainRecordParams | Parameters for retrieving a domain record. |
| GetDomainRecordResult | A retrieved domain record. |
| GetDomainRecordsOptions | Options for retrieving domain records. |
| GetDomainRecordsParams | Parameters for retrieving domain records. |
| GetDomainRecordsResult | A retrieved domain record. |
| GetDomainRecordsVerification | Verification status for a domain record. |
| GetDomainRecordVerification | Verification status for a domain record. |
| GetSnsDomainAddressParams | Parameters for deriving an SNS domain address. |
| GetSnsDomainAddressResult | A derived SNS domain address. |
| GetSrsDomainAddressParams | Parameters for deriving an SRS domain address. |
| GetSrsDomainAddressResult | A derived SRS domain address. |
| GetSubdomainsParams | Parameters for retrieving subdomains under a parent domain. |
| GetSubdomainsResult | A subdomain and the owner recorded in its name registry. |
| ResolveParams | Parameters for resolving a domain. |
Type Aliases
| Type Alias | Description |
|---|---|
| ResolveOptions | Controls whether resolution may return program-derived addresses. |
Functions
| Function | Description |
|---|---|
| getAllSnsDomains | Retrieves all top-level SNS domain accounts. |
| getDomainOwner | Retrieves the owner of the specified domain. If the domain is tokenized, the NFT's owner is returned; otherwise, the registry owner is returned. |
| getDomainRecord | Retrieves a V2 record under a domain, verifies it, and optionally decodes its content. |
| getDomainRecords | Retrieves V2 records under a domain, verifies them, and optionally decodes their content. |
| getSnsDomainAddress | Derives the address of a domain, subdomain, or record account. |
| getSrsDomainAddress | Derives the canonical SRS record address for a TLD-trimmed .sol name. |
| getSubdomains | Retrieves subdomains under a parent domain, including their owners. |
| resolve | Resolves a .sns or .sol domain to its target address. |
| safeResolve | Resolves a .sns or .sol domain using the same routing as resolve. |