@solana-name-service/sns-sdk-kit 1.0.0 → 1.1.0-beta.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (278) hide show
  1. package/README.md +335 -322
  2. package/dist/cjs/address/getPrimaryDomain.cjs.map +1 -1
  3. package/dist/cjs/address/getPrimaryDomainsBatch.cjs.map +1 -1
  4. package/dist/cjs/address/getSnsDomainsForAddress.cjs.map +1 -1
  5. package/dist/cjs/address/getSnsNftsForAddress.cjs.map +1 -1
  6. package/dist/cjs/address/getSolDomainsForAddress.cjs +86 -0
  7. package/dist/cjs/address/getSolDomainsForAddress.cjs.map +1 -0
  8. package/dist/cjs/address/getSolNftsForAddress.cjs +144 -0
  9. package/dist/cjs/address/getSolNftsForAddress.cjs.map +1 -0
  10. package/dist/cjs/address/index.cjs +4 -0
  11. package/dist/cjs/address/index.cjs.map +1 -1
  12. package/dist/cjs/bindings/burnDomain.cjs.map +1 -1
  13. package/dist/cjs/bindings/createNameRegistry.cjs.map +1 -1
  14. package/dist/cjs/bindings/createRecord.cjs.map +1 -1
  15. package/dist/cjs/bindings/createReverse.cjs.map +1 -1
  16. package/dist/cjs/bindings/createSubdomain.cjs.map +1 -1
  17. package/dist/cjs/bindings/deleteNameRegistry.cjs.map +1 -1
  18. package/dist/cjs/bindings/deleteRecord.cjs.map +1 -1
  19. package/dist/cjs/bindings/recordValidation.cjs.map +1 -1
  20. package/dist/cjs/bindings/registerDomain.cjs.map +1 -1
  21. package/dist/cjs/bindings/registerDomainWithNft.cjs.map +1 -1
  22. package/dist/cjs/bindings/setPrimaryDomain.cjs.map +1 -1
  23. package/dist/cjs/bindings/setRecordRoaVerifier.cjs.map +1 -1
  24. package/dist/cjs/bindings/setRecordStalenessVerifier.cjs.map +1 -1
  25. package/dist/cjs/bindings/transferDomain.cjs.map +1 -1
  26. package/dist/cjs/bindings/transferSubdomain.cjs.map +1 -1
  27. package/dist/cjs/bindings/updateNameRegistry.cjs.map +1 -1
  28. package/dist/cjs/bindings/updateRecord.cjs.map +1 -1
  29. package/dist/cjs/bindings/validateRecordRoa.cjs.map +1 -1
  30. package/dist/cjs/bindings/validateRecordRoaEthereum.cjs.map +1 -1
  31. package/dist/cjs/codecs.cjs.map +1 -1
  32. package/dist/cjs/constants/addresses.cjs +26 -16
  33. package/dist/cjs/constants/addresses.cjs.map +1 -1
  34. package/dist/cjs/constants/index.cjs +18 -0
  35. package/dist/cjs/constants/index.cjs.map +1 -1
  36. package/dist/cjs/constants/pythFeeds.cjs.map +1 -1
  37. package/dist/cjs/constants/records.cjs.map +1 -1
  38. package/dist/cjs/constants/srs.cjs +48 -0
  39. package/dist/cjs/constants/srs.cjs.map +1 -0
  40. package/dist/cjs/domain/getAllSnsDomains.cjs.map +1 -1
  41. package/dist/cjs/domain/getAllSolDomains.cjs +58 -0
  42. package/dist/cjs/domain/getAllSolDomains.cjs.map +1 -0
  43. package/dist/cjs/domain/getDomainOwner.cjs +3 -3
  44. package/dist/cjs/domain/getDomainOwner.cjs.map +1 -1
  45. package/dist/cjs/domain/getDomainRecord.cjs +3 -3
  46. package/dist/cjs/domain/getDomainRecord.cjs.map +1 -1
  47. package/dist/cjs/domain/getDomainRecords.cjs +3 -3
  48. package/dist/cjs/domain/getDomainRecords.cjs.map +1 -1
  49. package/dist/cjs/domain/getSnsDomainAddress.cjs.map +1 -1
  50. package/dist/cjs/domain/getSnsDomainOwner.cjs +1 -2
  51. package/dist/cjs/domain/getSnsDomainOwner.cjs.map +1 -1
  52. package/dist/cjs/domain/getSolDomainAddress.cjs +36 -0
  53. package/dist/cjs/domain/getSolDomainAddress.cjs.map +1 -0
  54. package/dist/cjs/domain/getSrsDomainAddress.cjs +4 -17
  55. package/dist/cjs/domain/getSrsDomainAddress.cjs.map +1 -1
  56. package/dist/cjs/domain/getSubdomains.cjs +3 -3
  57. package/dist/cjs/domain/getSubdomains.cjs.map +1 -1
  58. package/dist/cjs/domain/index.cjs +4 -0
  59. package/dist/cjs/domain/index.cjs.map +1 -1
  60. package/dist/cjs/domain/resolve.cjs +19 -12
  61. package/dist/cjs/domain/resolve.cjs.map +1 -1
  62. package/dist/cjs/domain/resolveSns.cjs.map +1 -1
  63. package/dist/cjs/domain/resolveSol.cjs +129 -0
  64. package/dist/cjs/domain/resolveSol.cjs.map +1 -0
  65. package/dist/cjs/errors.cjs.map +1 -1
  66. package/dist/cjs/index.cjs +141 -115
  67. package/dist/cjs/index.cjs.map +1 -1
  68. package/dist/cjs/instructions/allocateAndPostRecordInstruction.cjs.map +1 -1
  69. package/dist/cjs/instructions/burnDomainInstruction.cjs.map +1 -1
  70. package/dist/cjs/instructions/createAtaIdempotentInstruction.cjs.map +1 -1
  71. package/dist/cjs/instructions/createNameRegistryInstruction.cjs.map +1 -1
  72. package/dist/cjs/instructions/createReverseInstruction.cjs.map +1 -1
  73. package/dist/cjs/instructions/createSplitV2Instruction.cjs.map +1 -1
  74. package/dist/cjs/instructions/createWithNftInstruction.cjs.map +1 -1
  75. package/dist/cjs/instructions/deleteNameRegistryInstruction.cjs.map +1 -1
  76. package/dist/cjs/instructions/deleteRecordInstruction.cjs.map +1 -1
  77. package/dist/cjs/instructions/reallocInstruction.cjs.map +1 -1
  78. package/dist/cjs/instructions/registerPrimaryInstruction.cjs.map +1 -1
  79. package/dist/cjs/instructions/setRecordRoaVerifierInstruction.cjs.map +1 -1
  80. package/dist/cjs/instructions/transferInstruction.cjs.map +1 -1
  81. package/dist/cjs/instructions/updateNameRegistryInstruction.cjs.map +1 -1
  82. package/dist/cjs/instructions/updateRecordInstruction.cjs.map +1 -1
  83. package/dist/cjs/instructions/validateEthereumSignatureInstruction.cjs.map +1 -1
  84. package/dist/cjs/instructions/validateSolanaSignatureInstruction.cjs.map +1 -1
  85. package/dist/cjs/nft/getSnsNftMint.cjs.map +1 -1
  86. package/dist/cjs/nft/getSnsNftOwner.cjs.map +1 -1
  87. package/dist/cjs/record/getRecordV1Address.cjs.map +1 -1
  88. package/dist/cjs/record/getRecordV2Address.cjs.map +1 -1
  89. package/dist/cjs/record/verifyRecordRightOfAssociation.cjs +3 -3
  90. package/dist/cjs/record/verifyRecordRightOfAssociation.cjs.map +1 -1
  91. package/dist/cjs/record/verifyRecordStaleness.cjs +3 -3
  92. package/dist/cjs/record/verifyRecordStaleness.cjs.map +1 -1
  93. package/dist/cjs/srs/additional-metadata.cjs +20 -0
  94. package/dist/cjs/srs/additional-metadata.cjs.map +1 -0
  95. package/dist/cjs/srs/metadata.cjs +27 -0
  96. package/dist/cjs/srs/metadata.cjs.map +1 -0
  97. package/dist/cjs/states/nft.cjs.map +1 -1
  98. package/dist/cjs/states/primaryDomain.cjs.map +1 -1
  99. package/dist/cjs/states/record.cjs.map +1 -1
  100. package/dist/cjs/states/registry.cjs.map +1 -1
  101. package/dist/cjs/types/record.cjs.map +1 -1
  102. package/dist/cjs/types/validation.cjs.map +1 -1
  103. package/dist/cjs/utils/check.cjs.map +1 -1
  104. package/dist/cjs/utils/checkAddressOnCurve/ed25519.cjs.map +1 -1
  105. package/dist/cjs/utils/checkAddressOnCurve/index.cjs.map +1 -1
  106. package/dist/cjs/utils/deriveAddress.cjs.map +1 -1
  107. package/dist/cjs/utils/deserializers/deserializeRecordContent.cjs.map +1 -1
  108. package/dist/cjs/utils/deserializers/deserializeReverse.cjs.map +1 -1
  109. package/dist/cjs/utils/fetchEncodedAccountsBatched.cjs +29 -0
  110. package/dist/cjs/utils/fetchEncodedAccountsBatched.cjs.map +1 -0
  111. package/dist/cjs/utils/getPythFeedAddress.cjs.map +1 -1
  112. package/dist/cjs/utils/getReverseAddress.cjs.map +1 -1
  113. package/dist/cjs/utils/getReverseAddressFromDomainAddress.cjs.map +1 -1
  114. package/dist/cjs/utils/parseSnsDomain.cjs +1 -2
  115. package/dist/cjs/utils/parseSnsDomain.cjs.map +1 -1
  116. package/dist/cjs/utils/reverseLookup.cjs.map +1 -1
  117. package/dist/cjs/utils/reverseLookupBatch.cjs.map +1 -1
  118. package/dist/cjs/utils/serializers/serializeRecordContent.cjs.map +1 -1
  119. package/dist/cjs/utils/tld.cjs +1 -1
  120. package/dist/cjs/utils/tld.cjs.map +1 -1
  121. package/dist/cjs/utils/token2022/assertValidAccountData.cjs +37 -0
  122. package/dist/cjs/utils/token2022/assertValidAccountData.cjs.map +1 -0
  123. package/dist/cjs/utils/token2022/extensions.cjs +91 -0
  124. package/dist/cjs/utils/token2022/extensions.cjs.map +1 -0
  125. package/dist/cjs/utils/token2022/unpackAccount.cjs +29 -0
  126. package/dist/cjs/utils/token2022/unpackAccount.cjs.map +1 -0
  127. package/dist/cjs/utils/token2022/unpackMint.cjs +27 -0
  128. package/dist/cjs/utils/token2022/unpackMint.cjs.map +1 -0
  129. package/dist/cjs/utils/uint8Array/uint8ArrayFromHex.cjs.map +1 -1
  130. package/dist/cjs/utils/uint8Array/uint8ArrayToHex.cjs.map +1 -1
  131. package/dist/cjs/utils/uint8Array/uint8ArraysEqual.cjs.map +1 -1
  132. package/dist/esm/address/getPrimaryDomain.mjs.map +1 -1
  133. package/dist/esm/address/getPrimaryDomainsBatch.mjs.map +1 -1
  134. package/dist/esm/address/getSnsDomainsForAddress.mjs.map +1 -1
  135. package/dist/esm/address/getSnsNftsForAddress.mjs.map +1 -1
  136. package/dist/esm/address/getSolDomainsForAddress.mjs +82 -0
  137. package/dist/esm/address/getSolDomainsForAddress.mjs.map +1 -0
  138. package/dist/esm/address/getSolNftsForAddress.mjs +140 -0
  139. package/dist/esm/address/getSolNftsForAddress.mjs.map +1 -0
  140. package/dist/esm/address/index.mjs +2 -0
  141. package/dist/esm/address/index.mjs.map +1 -1
  142. package/dist/esm/bindings/burnDomain.mjs.map +1 -1
  143. package/dist/esm/bindings/createNameRegistry.mjs.map +1 -1
  144. package/dist/esm/bindings/createRecord.mjs.map +1 -1
  145. package/dist/esm/bindings/createReverse.mjs.map +1 -1
  146. package/dist/esm/bindings/createSubdomain.mjs.map +1 -1
  147. package/dist/esm/bindings/deleteNameRegistry.mjs.map +1 -1
  148. package/dist/esm/bindings/deleteRecord.mjs.map +1 -1
  149. package/dist/esm/bindings/recordValidation.mjs.map +1 -1
  150. package/dist/esm/bindings/registerDomain.mjs.map +1 -1
  151. package/dist/esm/bindings/registerDomainWithNft.mjs.map +1 -1
  152. package/dist/esm/bindings/setPrimaryDomain.mjs.map +1 -1
  153. package/dist/esm/bindings/setRecordRoaVerifier.mjs.map +1 -1
  154. package/dist/esm/bindings/setRecordStalenessVerifier.mjs.map +1 -1
  155. package/dist/esm/bindings/transferDomain.mjs.map +1 -1
  156. package/dist/esm/bindings/transferSubdomain.mjs.map +1 -1
  157. package/dist/esm/bindings/updateNameRegistry.mjs.map +1 -1
  158. package/dist/esm/bindings/updateRecord.mjs.map +1 -1
  159. package/dist/esm/bindings/validateRecordRoa.mjs.map +1 -1
  160. package/dist/esm/bindings/validateRecordRoaEthereum.mjs.map +1 -1
  161. package/dist/esm/codecs.mjs.map +1 -1
  162. package/dist/esm/constants/addresses.mjs +24 -17
  163. package/dist/esm/constants/addresses.mjs.map +1 -1
  164. package/dist/esm/constants/index.mjs +2 -1
  165. package/dist/esm/constants/index.mjs.map +1 -1
  166. package/dist/esm/constants/pythFeeds.mjs.map +1 -1
  167. package/dist/esm/constants/records.mjs.map +1 -1
  168. package/dist/esm/constants/srs.mjs +31 -0
  169. package/dist/esm/constants/srs.mjs.map +1 -0
  170. package/dist/esm/domain/getAllSnsDomains.mjs.map +1 -1
  171. package/dist/esm/domain/getAllSolDomains.mjs +54 -0
  172. package/dist/esm/domain/getAllSolDomains.mjs.map +1 -0
  173. package/dist/esm/domain/getDomainOwner.mjs +3 -3
  174. package/dist/esm/domain/getDomainOwner.mjs.map +1 -1
  175. package/dist/esm/domain/getDomainRecord.mjs +3 -3
  176. package/dist/esm/domain/getDomainRecord.mjs.map +1 -1
  177. package/dist/esm/domain/getDomainRecords.mjs +3 -3
  178. package/dist/esm/domain/getDomainRecords.mjs.map +1 -1
  179. package/dist/esm/domain/getSnsDomainAddress.mjs.map +1 -1
  180. package/dist/esm/domain/getSnsDomainOwner.mjs +1 -2
  181. package/dist/esm/domain/getSnsDomainOwner.mjs.map +1 -1
  182. package/dist/esm/domain/getSolDomainAddress.mjs +32 -0
  183. package/dist/esm/domain/getSolDomainAddress.mjs.map +1 -0
  184. package/dist/esm/domain/getSrsDomainAddress.mjs +4 -17
  185. package/dist/esm/domain/getSrsDomainAddress.mjs.map +1 -1
  186. package/dist/esm/domain/getSubdomains.mjs +3 -3
  187. package/dist/esm/domain/getSubdomains.mjs.map +1 -1
  188. package/dist/esm/domain/index.mjs +2 -0
  189. package/dist/esm/domain/index.mjs.map +1 -1
  190. package/dist/esm/domain/resolve.mjs +20 -13
  191. package/dist/esm/domain/resolve.mjs.map +1 -1
  192. package/dist/esm/domain/resolveSns.mjs.map +1 -1
  193. package/dist/esm/domain/resolveSol.mjs +125 -0
  194. package/dist/esm/domain/resolveSol.mjs.map +1 -0
  195. package/dist/esm/errors.mjs.map +1 -1
  196. package/dist/esm/index.mjs +51 -46
  197. package/dist/esm/index.mjs.map +1 -1
  198. package/dist/esm/instructions/allocateAndPostRecordInstruction.mjs.map +1 -1
  199. package/dist/esm/instructions/burnDomainInstruction.mjs.map +1 -1
  200. package/dist/esm/instructions/createAtaIdempotentInstruction.mjs.map +1 -1
  201. package/dist/esm/instructions/createNameRegistryInstruction.mjs.map +1 -1
  202. package/dist/esm/instructions/createReverseInstruction.mjs.map +1 -1
  203. package/dist/esm/instructions/createSplitV2Instruction.mjs.map +1 -1
  204. package/dist/esm/instructions/createWithNftInstruction.mjs.map +1 -1
  205. package/dist/esm/instructions/deleteNameRegistryInstruction.mjs.map +1 -1
  206. package/dist/esm/instructions/deleteRecordInstruction.mjs.map +1 -1
  207. package/dist/esm/instructions/reallocInstruction.mjs.map +1 -1
  208. package/dist/esm/instructions/registerPrimaryInstruction.mjs.map +1 -1
  209. package/dist/esm/instructions/setRecordRoaVerifierInstruction.mjs.map +1 -1
  210. package/dist/esm/instructions/transferInstruction.mjs.map +1 -1
  211. package/dist/esm/instructions/updateNameRegistryInstruction.mjs.map +1 -1
  212. package/dist/esm/instructions/updateRecordInstruction.mjs.map +1 -1
  213. package/dist/esm/instructions/validateEthereumSignatureInstruction.mjs.map +1 -1
  214. package/dist/esm/instructions/validateSolanaSignatureInstruction.mjs.map +1 -1
  215. package/dist/esm/nft/getSnsNftMint.mjs +1 -1
  216. package/dist/esm/nft/getSnsNftMint.mjs.map +1 -1
  217. package/dist/esm/nft/getSnsNftOwner.mjs.map +1 -1
  218. package/dist/esm/record/getRecordV1Address.mjs.map +1 -1
  219. package/dist/esm/record/getRecordV2Address.mjs.map +1 -1
  220. package/dist/esm/record/verifyRecordRightOfAssociation.mjs +3 -3
  221. package/dist/esm/record/verifyRecordRightOfAssociation.mjs.map +1 -1
  222. package/dist/esm/record/verifyRecordStaleness.mjs +3 -3
  223. package/dist/esm/record/verifyRecordStaleness.mjs.map +1 -1
  224. package/dist/esm/srs/additional-metadata.mjs +16 -0
  225. package/dist/esm/srs/additional-metadata.mjs.map +1 -0
  226. package/dist/esm/srs/metadata.mjs +23 -0
  227. package/dist/esm/srs/metadata.mjs.map +1 -0
  228. package/dist/esm/states/nft.mjs.map +1 -1
  229. package/dist/esm/states/primaryDomain.mjs.map +1 -1
  230. package/dist/esm/states/record.mjs +1 -1
  231. package/dist/esm/states/record.mjs.map +1 -1
  232. package/dist/esm/states/registry.mjs.map +1 -1
  233. package/dist/esm/types/record.mjs.map +1 -1
  234. package/dist/esm/types/validation.mjs.map +1 -1
  235. package/dist/esm/utils/check.mjs.map +1 -1
  236. package/dist/esm/utils/checkAddressOnCurve/ed25519.mjs.map +1 -1
  237. package/dist/esm/utils/checkAddressOnCurve/index.mjs.map +1 -1
  238. package/dist/esm/utils/deriveAddress.mjs.map +1 -1
  239. package/dist/esm/utils/deserializers/deserializeRecordContent.mjs.map +1 -1
  240. package/dist/esm/utils/deserializers/deserializeReverse.mjs.map +1 -1
  241. package/dist/esm/utils/fetchEncodedAccountsBatched.mjs +25 -0
  242. package/dist/esm/utils/fetchEncodedAccountsBatched.mjs.map +1 -0
  243. package/dist/esm/utils/getPythFeedAddress.mjs.map +1 -1
  244. package/dist/esm/utils/getReverseAddress.mjs.map +1 -1
  245. package/dist/esm/utils/getReverseAddressFromDomainAddress.mjs.map +1 -1
  246. package/dist/esm/utils/parseSnsDomain.mjs +1 -2
  247. package/dist/esm/utils/parseSnsDomain.mjs.map +1 -1
  248. package/dist/esm/utils/reverseLookup.mjs.map +1 -1
  249. package/dist/esm/utils/reverseLookupBatch.mjs.map +1 -1
  250. package/dist/esm/utils/serializers/serializeRecordContent.mjs.map +1 -1
  251. package/dist/esm/utils/tld.mjs +1 -1
  252. package/dist/esm/utils/tld.mjs.map +1 -1
  253. package/dist/esm/utils/token2022/assertValidAccountData.mjs +33 -0
  254. package/dist/esm/utils/token2022/assertValidAccountData.mjs.map +1 -0
  255. package/dist/esm/utils/token2022/extensions.mjs +85 -0
  256. package/dist/esm/utils/token2022/extensions.mjs.map +1 -0
  257. package/dist/esm/utils/token2022/unpackAccount.mjs +25 -0
  258. package/dist/esm/utils/token2022/unpackAccount.mjs.map +1 -0
  259. package/dist/esm/utils/token2022/unpackMint.mjs +23 -0
  260. package/dist/esm/utils/token2022/unpackMint.mjs.map +1 -0
  261. package/dist/esm/utils/uint8Array/uint8ArrayFromHex.mjs.map +1 -1
  262. package/dist/esm/utils/uint8Array/uint8ArrayToHex.mjs.map +1 -1
  263. package/dist/esm/utils/uint8Array/uint8ArraysEqual.mjs.map +1 -1
  264. package/dist/types/address/index.d.ts +103 -2
  265. package/dist/types/constants/index.d.ts +53 -17
  266. package/dist/types/domain/index.d.ts +94 -32
  267. package/dist/types/index.d.ts +253 -54
  268. package/dist/types/record/index.d.ts +6 -6
  269. package/dist/types/utils/index.d.ts +1 -1
  270. package/package.json +2 -1
  271. package/dist/cjs/config.cjs +0 -18
  272. package/dist/cjs/config.cjs.map +0 -1
  273. package/dist/cjs/utils/assertTldSupported.cjs +0 -28
  274. package/dist/cjs/utils/assertTldSupported.cjs.map +0 -1
  275. package/dist/esm/config.mjs +0 -11
  276. package/dist/esm/config.mjs.map +0 -1
  277. package/dist/esm/utils/assertTldSupported.mjs +0 -24
  278. package/dist/esm/utils/assertTldSupported.mjs.map +0 -1
package/README.md CHANGED
@@ -1,322 +1,335 @@
1
- <p align="center">
2
- <img width="200" src="https://www.sns.id/assets/logo/brand.svg" alt="SNS logo" />
3
- </p>
4
-
5
- # SNS JS Kit SDK
6
-
7
- [![npm](https://img.shields.io/npm/v/@solana-name-service/sns-sdk-kit)](https://www.npmjs.com/package/@solana-name-service/sns-sdk-kit)
8
- [![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)](../LICENSE)
9
-
10
- TypeScript SDK for resolving Solana Name Service (SNS) domains, reading records and ownership, and constructing SNS instructions with [`@solana/kit`](https://www.npmjs.com/package/@solana/kit). It is the SDK for `@solana/kit`, not the `@solana/web3.js` 1.x SDK. It provides no React provider, wallet adapter, or global SDK client: pass your typed RPC client and compose transactions with your wallet or signer.
11
-
12
- > **Migrating from v0?** This release is not fully backward compatible. Review the [changelog](./CHANGELOG.md) for breaking changes and migration notes.
13
-
14
- ## Installation
15
-
16
- ```bash
17
- npm install @solana-name-service/sns-sdk-kit @solana/kit
18
- ```
19
-
20
- Requirements:
21
-
22
- - Node.js `>=24.0.0`.
23
- - `@solana/kit ^6.9.0` as a peer dependency.
24
- - An RPC client with the APIs required by the operation.
25
-
26
- Read APIs fetch and decode account data. Write builders return `Instruction`, `Promise<Instruction>`, or `Promise<Instruction[]>`. Build a transaction around the returned instruction(s), set its fee payer and recent blockhash, collect the signatures required by its account metas, and submit that transaction through your RPC client.
27
-
28
- ## Quick Start
29
-
30
- Create a typed `@solana/kit` RPC client and pass it explicitly to each operation:
31
-
32
- ```typescript
33
- import {
34
- createDefaultRpcTransport,
35
- createSolanaRpcFromTransport,
36
- } from "@solana/kit";
37
-
38
- const transport = createDefaultRpcTransport({
39
- url: "https://your-rpc-endpoint.example",
40
- });
41
- const rpc = createSolanaRpcFromTransport(transport);
42
- ```
43
-
44
- ### Resolve A Domain
45
-
46
- ```typescript
47
- import { resolve } from "@solana-name-service/sns-sdk-kit";
48
-
49
- const owner = await resolve({
50
- rpc,
51
- domain: "wallet-guide-9.sns",
52
- options: { allowPda: false },
53
- }); // Or use `safeResolve`.
54
-
55
- console.log(owner);
56
- ```
57
-
58
- ### Get A Primary Domain
59
-
60
- ```typescript
61
- import { getPrimaryDomain } from "@solana-name-service/sns-sdk-kit";
62
- import type { Address } from "@solana/kit";
63
-
64
- const walletAddress = "36Dn3RWhB8x4c83W6ebQ2C2eH9sh5bQX2nMdkP2cWaA4" as Address;
65
- const primaryDomain = await getPrimaryDomain({ rpc, walletAddress });
66
-
67
- console.log(primaryDomain.domainName, primaryDomain.stale);
68
- ```
69
-
70
- ### List Domains For An Address
71
-
72
- ```typescript
73
- import { getSnsDomainsForAddress } from "@solana-name-service/sns-sdk-kit";
74
- import type { Address } from "@solana/kit";
75
-
76
- const address = "36Dn3RWhB8x4c83W6ebQ2C2eH9sh5bQX2nMdkP2cWaA4" as Address;
77
- const domains = await getSnsDomainsForAddress({ rpc, address });
78
-
79
- console.log(domains);
80
- ```
81
-
82
- ## Domain Inputs And Resolution
83
-
84
- Use the form required by each API rather than normalizing names yourself:
85
-
86
- | API family | Required input | Scope |
87
- | -------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
88
- | High-level reads such as `resolve`, `safeResolve`, `getDomainOwner`, `getDomainRecord`, and `getDomainRecords` | Full suffixed name, for example `mydomain.sns` | `.sns`; legacy `.sol` reads have the transition rule below |
89
- | Subdomain reads such as `getSubdomains` | Full suffixed top-level name, for example `mydomain.sns` | `.sns` |
90
- | Top-level writes such as registration, transfer, and burn | Canonical lowercase `mydomain.sns` | Exactly one label before `.sns` |
91
- | Record writes | Canonical lowercase `mydomain.sns` or `sub.mydomain.sns` | Top-level domain or one-level subdomain |
92
- | Subdomain creation and transfer | Canonical lowercase `sub.mydomain.sns` | Exactly one subdomain level |
93
- | SNS derivation and record-address helpers | TLD-trimmed name, for example `mydomain` or `sub.mydomain` | Pass to `getSnsDomainAddress`; it derives domain, subdomain, and record addresses |
94
- | SRS derivation | TLD-trimmed `.sol` label, for example `mydomain` | Pass to `getSrsDomainAddress` only when an SRS address is specifically needed |
95
- | Raw registry helpers | Raw labels and explicit parent/class addresses | Use the advanced name-registry helpers when the higher-level `.sns` conventions do not apply |
96
-
97
- High-level `.sol` reads use the legacy SNS-backed path only before finalized slot `452,825,395`. At and after that slot, `.sol` is rejected. `.sol` writes are not supported.
98
-
99
- ## API Reference
100
-
101
- ### Resolution
102
-
103
- - **`resolve`** — resolves a full `.sns` domain, or a legacy `.sol` domain while the transition path remains available, to its effective owner.
104
-
105
- ```ts
106
- resolve({ rpc, domain, options? }): Promise<Address>
107
- ```
108
-
109
- - **`safeResolve`** — follows the same routing as `resolve`, except that when SRS-backed `.sol` resolution is enabled, it requires the `.sol` domain and its corresponding `.sns` domain to resolve to the same target; otherwise, it throws `SnsSolResolutionMismatchError`.
110
-
111
- ```ts
112
- safeResolve({ rpc, domain, options? }): Promise<Address>
113
- ```
114
-
115
- ### Record Reads And Validation
116
-
117
- - **`getDomainRecord`** — retrieves and verifies one V2 record.
118
-
119
- ```ts
120
- getDomainRecord({ rpc, domain, record, options? }): Promise<RecordResult>
121
- ```
122
-
123
- - **`getDomainRecords`** — returns one entry per requested record; a missing account is `undefined` at its corresponding index.
124
-
125
- ```ts
126
- getDomainRecords({ rpc, domain, records, options? }): Promise<(RecordResult | undefined)[]>
127
- ```
128
-
129
- The following standalone helpers do not come from `RecordResult`:
130
-
131
- - **`getRecordV1Address`** / **`getRecordV2Address`** — derive account addresses from a TLD-trimmed domain without fetching them.
132
-
133
- ```ts
134
- getRecordV1Address({ domain, record }): Promise<Address>
135
- getRecordV2Address({ domain, record }): Promise<Address>
136
- ```
137
-
138
- - **`serializeRecordContent`** / **`deserializeRecordContent`** — encode content for storage, or decode stored content.
139
-
140
- ```ts
141
- serializeRecordContent({ content, record }): ReadonlyUint8Array
142
- deserializeRecordContent({ content, record }): string
143
- ```
144
-
145
- - **`verifyRecordStaleness`** — independently fetches and checks a V2 record's staleness validation.
146
-
147
- ```ts
148
- verifyRecordStaleness({ rpc, domain, record }): Promise<boolean>
149
- ```
150
-
151
- - **`verifyRecordRightOfAssociation`** — independently fetches and checks a V2 record's right-of-association validation.
152
-
153
- ```ts
154
- verifyRecordRightOfAssociation(rpc, domain: string, record: Record, verifier?: ReadonlyUint8Array): Promise<boolean>
155
- ```
156
-
157
- ### Record Writes
158
-
159
- Each function below returns one `Instruction`:
160
-
161
- - **`createRecord`**
162
-
163
- ```ts
164
- createRecord({ domain, record, content, owner, payer }): Promise<Instruction>
165
- ```
166
-
167
- - **`updateRecord`**
168
-
169
- ```ts
170
- updateRecord({ domain, record, content, owner, payer }): Promise<Instruction>
171
- ```
172
-
173
- - **`deleteRecord`**
174
-
175
- ```ts
176
- deleteRecord({ domain, record, owner, payer }): Promise<Instruction>
177
- ```
178
-
179
- - **`setRecordStalenessVerifier`**
180
-
181
- ```ts
182
- setRecordStalenessVerifier({ domain, record, owner, payer, verifier }): Promise<Instruction>
183
- ```
184
-
185
- - **`setRecordRoaVerifier`**
186
-
187
- ```ts
188
- setRecordRoaVerifier({ domain, record, owner, payer, verifier }): Promise<Instruction>
189
- ```
190
-
191
- - **`validateRecordRoa`**
192
-
193
- ```ts
194
- validateRecordRoa({ domain, record, owner, payer, verifier }): Promise<Instruction>
195
- ```
196
-
197
- - **`validateRecordRoaEthereum`**
198
-
199
- ```ts
200
- validateRecordRoaEthereum({ domain, record, owner, payer, signature, expectedPubkey }): Promise<Instruction>
201
- ```
202
-
203
- ### Registration And Lifecycle
204
-
205
- Registration is limited to a lowercase top-level `.sns` name. Return shapes differ by operation:
206
-
207
- - **`registerDomain`** — returns the registration instructions. It uses a supported payment mint/feed and only incorporates a referrer when it is supported by the SDK.
208
-
209
- ```ts
210
- registerDomain({ domain, space, buyer, buyerTokenAccount, mint?, referrer? }): Promise<Instruction[]>
211
- ```
212
-
213
- - **`registerDomainWithNft`** — returns one NFT-based registration instruction.
214
-
215
- ```ts
216
- registerDomainWithNft({ domain, space, buyer, nftSource, nftMint }): Promise<Instruction>
217
- ```
218
-
219
- - **`transferDomain`** — retrieves the current owner and returns one transfer instruction.
220
-
221
- ```ts
222
- transferDomain({ rpc, domain, newOwner }): Promise<Instruction>
223
- ```
224
-
225
- - **`burnDomain`** — returns one burn instruction; `refundAddress` receives reclaimed lamports.
226
-
227
- ```ts
228
- burnDomain({ domain, owner, refundAddress }): Promise<Instruction>
229
- ```
230
-
231
- - **`setPrimaryDomain`** — returns one instruction for an already derived domain account. `domainAddress` is an already derived domain account, not a domain string.
232
-
233
- ```ts
234
- setPrimaryDomain({ rpc, domainAddress, owner }): Promise<Instruction>
235
- ```
236
-
237
- ### Subdomains
238
-
239
- - **`getSubdomains`** — lists subdomains and owners under a top-level parent. Entries without reverse data are omitted.
240
-
241
- ```ts
242
- getSubdomains({ rpc, domain }): Promise<{ subdomain: string; owner: Address }[]>
243
- ```
244
-
245
- - **`createSubdomain`** — returns the name-account creation instruction(s). `subdomain` must be a lowercase one-level `.sns` subdomain.
246
-
247
- ```ts
248
- createSubdomain({ rpc, subdomain, owner, space?, feePayer? }): Promise<Instruction[]>
249
- ```
250
-
251
- - **`transferSubdomain`** — returns one transfer instruction. When `currentOwner` is omitted, the function retrieves the current owner; set `isParentOwnerSigner` when the parent owner authorizes the transfer.
252
-
253
- ```ts
254
- transferSubdomain({ rpc, subdomain, newOwner, isParentOwnerSigner?, currentOwner? }): Promise<Instruction>
255
- ```
256
-
257
- ### Ownership And Reverse Lookup
258
-
259
- - **`getDomainOwner`** — returns the domain's owner: the tokenized-domain NFT owner when present, otherwise the registry owner. It does not apply `SOL`-record precedence or PDA policy, so the result is not necessarily the domain's SNS-IP-5 resolution target; use `resolve` when that target is required.
260
-
261
- ```ts
262
- getDomainOwner({ rpc, domain }): Promise<Address>
263
- ```
264
-
265
- - **`getAllSnsDomains`** — lists top-level SNS registry accounts and their registry owners.
266
-
267
- ```ts
268
- getAllSnsDomains({ rpc }): Promise<{ domainAddress: Address; owner: Address }[]>
269
- ```
270
-
271
- - **`getPrimaryDomain`** — returns a primary-domain account, its TLD-less name, and whether the wallet is no longer its effective owner.
272
-
273
- ```ts
274
- getPrimaryDomain({ rpc, walletAddress }): Promise<{ domainAddress: Address; domainName: string; stale: boolean }>
275
- ```
276
-
277
- - **`getPrimaryDomainsBatch`** — returns valid, non-stale, TLD-less primary names positionally aligned with `walletAddresses`.
278
-
279
- ```ts
280
- getPrimaryDomainsBatch({ rpc, walletAddresses }): Promise<(string | undefined)[]>
281
- ```
282
-
283
- - **`getSnsDomainsForAddress`** — returns directly registry-owned top-level domains only. Tokenized domains and subdomains are excluded, and entries without reverse records are omitted.
284
-
285
- ```ts
286
- getSnsDomainsForAddress({ rpc, address }): Promise<{ domain: string; domainAddress: Address }[]>
287
- ```
288
-
289
- - **`getSnsNftsForAddress`** — returns tokenized SNS domains with reverse data.
290
-
291
- ```ts
292
- getSnsNftsForAddress({ rpc, address }): Promise<{ domain: string; domainAddress: Address; mint: Address }[]>
293
- ```
294
-
295
- - **`reverseLookup`** — returns one TLD-less reverse name for a domain address.
296
-
297
- ```ts
298
- reverseLookup({ rpc, domainAddress, parentAddress? }): Promise<string>
299
- ```
300
-
301
- - **`reverseLookupBatch`** — returns TLD-less names in input order; missing reverse records are `undefined`.
302
-
303
- ```ts
304
- reverseLookupBatch({ rpc, domainAddresses }): Promise<(string | undefined)[]>
305
- ```
306
-
307
- ### Advanced APIs
308
-
309
- For account-level integrations, the root export also includes derivation and raw name-registry helpers such as `getSnsDomainAddress`, `getSrsDomainAddress`, `getReverseAddress`, `getReverseAddressFromDomainAddress`, `checkAddressOnCurve`, `deserializeReverse`, `getPythFeedAddress`, `getTld`, `createNameRegistry`, `updateNameRegistry`, `deleteNameRegistry`, and `createReverse`.
310
-
311
- NFT helpers and state classes include `getSnsNftMint`, `getSnsNftOwner`, `RegistryState`, `RecordState`, `NftState`, and `PrimaryDomainState`. Low-level instruction classes are also exported; use the `@solana-name-service/sns-sdk-kit/instructions` export for custom transaction composition rather than treating those constructors as an onboarding API.
312
-
313
- ## Documentation And Migration
314
-
315
- - [Developer documentation](https://dev.sns.id/)
316
- - [Migration notes and changelog](./CHANGELOG.md)
317
- - [SDK monorepo overview](../README.md)
318
- - [SNS guide](https://guide.sns.id/)
319
-
320
- ## License
321
-
322
- Released under the [MIT License](../LICENSE).
1
+ <p align="center">
2
+ <img width="200" src="https://www.sns.id/assets/logo/brand.svg" alt="SNS logo" />
3
+ </p>
4
+
5
+ # SNS JS Kit SDK
6
+
7
+ [![npm](https://img.shields.io/npm/v/@solana-name-service/sns-sdk-kit)](https://www.npmjs.com/package/@solana-name-service/sns-sdk-kit)
8
+ [![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)](../LICENSE)
9
+
10
+ TypeScript SDK for resolving Solana Name Service (SNS) domains, reading records and ownership, and constructing SNS instructions with [`@solana/kit`](https://www.npmjs.com/package/@solana/kit). It is the SDK for `@solana/kit`, not the `@solana/web3.js` 1.x SDK. It provides no React provider, wallet adapter, or global SDK client: pass your typed RPC client and compose transactions with your wallet or signer.
11
+
12
+ > **Migrating from v0?** This release is not fully backward compatible. Review the [changelog](./CHANGELOG.md) for breaking changes and migration notes.
13
+
14
+ ## Installation
15
+
16
+ ```bash
17
+ npm install @solana-name-service/sns-sdk-kit @solana/kit
18
+ ```
19
+
20
+ Requirements:
21
+
22
+ - Node.js `>=24.0.0`.
23
+ - `@solana/kit ^6.9.0` as a peer dependency.
24
+ - An RPC client with the APIs required by the operation.
25
+
26
+ Read APIs fetch and decode account data. Write builders return `Instruction`, `Promise<Instruction>`, or `Promise<Instruction[]>`. Build a transaction around the returned instruction(s), set its fee payer and recent blockhash, collect the signatures required by its account metas, and submit that transaction through your RPC client.
27
+
28
+ ## Quick Start
29
+
30
+ Create a typed `@solana/kit` RPC client and pass it explicitly to each operation:
31
+
32
+ ```typescript
33
+ import {
34
+ createDefaultRpcTransport,
35
+ createSolanaRpcFromTransport,
36
+ } from "@solana/kit";
37
+
38
+ const transport = createDefaultRpcTransport({
39
+ url: "https://your-rpc-endpoint.example",
40
+ });
41
+ const rpc = createSolanaRpcFromTransport(transport);
42
+ ```
43
+
44
+ ### Resolve A Domain
45
+
46
+ ```typescript
47
+ import { resolve } from "@solana-name-service/sns-sdk-kit";
48
+
49
+ const owner = await resolve({
50
+ rpc,
51
+ domain: "wallet-guide-9.sns",
52
+ options: { allowPda: false },
53
+ }); // Or use `safeResolve`.
54
+
55
+ console.log(owner);
56
+ ```
57
+
58
+ ### Get A Primary Domain
59
+
60
+ ```typescript
61
+ import { getPrimaryDomain } from "@solana-name-service/sns-sdk-kit";
62
+ import type { Address } from "@solana/kit";
63
+
64
+ const walletAddress = "36Dn3RWhB8x4c83W6ebQ2C2eH9sh5bQX2nMdkP2cWaA4" as Address;
65
+ const primaryDomain = await getPrimaryDomain({ rpc, walletAddress });
66
+
67
+ console.log(primaryDomain.domainName, primaryDomain.stale);
68
+ ```
69
+
70
+ ### List Domains For An Address
71
+
72
+ ```typescript
73
+ import { getSnsDomainsForAddress } from "@solana-name-service/sns-sdk-kit";
74
+ import type { Address } from "@solana/kit";
75
+
76
+ const address = "36Dn3RWhB8x4c83W6ebQ2C2eH9sh5bQX2nMdkP2cWaA4" as Address;
77
+ const domains = await getSnsDomainsForAddress({ rpc, address });
78
+
79
+ console.log(domains);
80
+ ```
81
+
82
+ ## Domain Inputs And Resolution
83
+
84
+ Use the form required by each API rather than normalizing names yourself:
85
+
86
+ | API family | Required input | Scope |
87
+ | --------------------------------------------------------- | ------------------------------------------------------------------ | ------------------------------------------------------ |
88
+ | Domain resolution with `resolve` and `safeResolve` | Full suffixed name, for example `mydomain.sns` or `mydomain.sol` | `.sns` and `.sol` domains |
89
+ | Top-level writes such as registration, transfer, and burn | Canonical lowercase `mydomain.sns` | Top-level domains only; subdomains are not accepted |
90
+ | Record reads and writes | Canonical lowercase `mydomain.sns` or `sub.mydomain.sns` | Top-level domain or one-level subdomain |
91
+ | Subdomain creation and transfer | Canonical lowercase `sub.mydomain.sns` | One-level subdomain |
92
+ | Derivation and raw name-account helpers | TLD-trimmed or raw input, for example `mydomain` or `sub.mydomain` | Follow each low-level helper's account-format contract |
93
+
94
+ ## API Reference
95
+
96
+ ### Resolution
97
+
98
+ - **`resolve`** — resolves a full `.sns` domain through SNS-IP 5 or a full `.sol` domain through its canonical SRS record.
99
+
100
+ ```ts
101
+ resolve({ rpc, domain, options? }): Promise<Address>
102
+ ```
103
+
104
+ - **`safeResolve`** — follows `resolve`, and for `.sol` input always requires the SRS and corresponding SNS targets to match; otherwise, it throws `SnsSolResolutionMismatchError`.
105
+
106
+ ```ts
107
+ safeResolve({ rpc, domain, options? }): Promise<Address>
108
+ ```
109
+
110
+ ### Record Reads And Validation
111
+
112
+ - **`getDomainRecord`** — retrieves and verifies one V2 record.
113
+
114
+ ```ts
115
+ getDomainRecord({ rpc, domain, record, options? }): Promise<RecordResult>
116
+ ```
117
+
118
+ - **`getDomainRecords`** — returns one entry per requested record; a missing account is `undefined` at its corresponding index.
119
+
120
+ ```ts
121
+ getDomainRecords({ rpc, domain, records, options? }): Promise<(RecordResult | undefined)[]>
122
+ ```
123
+
124
+ The following standalone helpers do not come from `RecordResult`:
125
+
126
+ - **`getRecordV1Address`** / **`getRecordV2Address`** — derive account addresses from a TLD-trimmed domain without fetching them.
127
+
128
+ ```ts
129
+ getRecordV1Address({ domain, record }): Promise<Address>
130
+ getRecordV2Address({ domain, record }): Promise<Address>
131
+ ```
132
+
133
+ - **`serializeRecordContent`** / **`deserializeRecordContent`** — encode content for storage, or decode stored content.
134
+
135
+ ```ts
136
+ serializeRecordContent({ content, record }): ReadonlyUint8Array
137
+ deserializeRecordContent({ content, record }): string
138
+ ```
139
+
140
+ - **`verifyRecordStaleness`** — independently fetches and checks a V2 record's staleness validation.
141
+
142
+ ```ts
143
+ verifyRecordStaleness({ rpc, domain, record }): Promise<boolean>
144
+ ```
145
+
146
+ - **`verifyRecordRightOfAssociation`** — independently fetches and checks a V2 record's right-of-association validation.
147
+
148
+ ```ts
149
+ verifyRecordRightOfAssociation(rpc, domain: string, record: Record, verifier?: ReadonlyUint8Array): Promise<boolean>
150
+ ```
151
+
152
+ ### Record Writes
153
+
154
+ Each function below returns one `Instruction`:
155
+
156
+ - **`createRecord`**
157
+
158
+ ```ts
159
+ createRecord({ domain, record, content, owner, payer }): Promise<Instruction>
160
+ ```
161
+
162
+ - **`updateRecord`**
163
+
164
+ ```ts
165
+ updateRecord({ domain, record, content, owner, payer }): Promise<Instruction>
166
+ ```
167
+
168
+ - **`deleteRecord`**
169
+
170
+ ```ts
171
+ deleteRecord({ domain, record, owner, payer }): Promise<Instruction>
172
+ ```
173
+
174
+ - **`setRecordStalenessVerifier`**
175
+
176
+ ```ts
177
+ setRecordStalenessVerifier({ domain, record, owner, payer, verifier }): Promise<Instruction>
178
+ ```
179
+
180
+ - **`setRecordRoaVerifier`**
181
+
182
+ ```ts
183
+ setRecordRoaVerifier({ domain, record, owner, payer, verifier }): Promise<Instruction>
184
+ ```
185
+
186
+ - **`validateRecordRoa`**
187
+
188
+ ```ts
189
+ validateRecordRoa({ domain, record, owner, payer, verifier }): Promise<Instruction>
190
+ ```
191
+
192
+ - **`validateRecordRoaEthereum`**
193
+
194
+ ```ts
195
+ validateRecordRoaEthereum({ domain, record, owner, payer, signature, expectedPubkey }): Promise<Instruction>
196
+ ```
197
+
198
+ ### Registration And Lifecycle
199
+
200
+ Registration is limited to a lowercase top-level `.sns` name. Return shapes differ by operation:
201
+
202
+ - **`registerDomain`** — returns the registration instructions. It uses a supported payment mint/feed and only incorporates a referrer when it is supported by the SDK.
203
+
204
+ ```ts
205
+ registerDomain({ domain, space, buyer, buyerTokenAccount, mint?, referrer? }): Promise<Instruction[]>
206
+ ```
207
+
208
+ - **`registerDomainWithNft`** — returns one NFT-based registration instruction.
209
+
210
+ ```ts
211
+ registerDomainWithNft({ domain, space, buyer, nftSource, nftMint }): Promise<Instruction>
212
+ ```
213
+
214
+ - **`transferDomain`** — retrieves the current owner and returns one transfer instruction.
215
+
216
+ ```ts
217
+ transferDomain({ rpc, domain, newOwner }): Promise<Instruction>
218
+ ```
219
+
220
+ - **`burnDomain`** — returns one burn instruction; `refundAddress` receives reclaimed lamports.
221
+
222
+ ```ts
223
+ burnDomain({ domain, owner, refundAddress }): Promise<Instruction>
224
+ ```
225
+
226
+ - **`setPrimaryDomain`** — returns one instruction for an already derived domain account. `domainAddress` is an already derived domain account, not a domain string.
227
+
228
+ ```ts
229
+ setPrimaryDomain({ rpc, domainAddress, owner }): Promise<Instruction>
230
+ ```
231
+
232
+ ### Subdomains
233
+
234
+ - **`getSubdomains`** — lists subdomains and owners under a top-level parent. Entries without reverse data are omitted.
235
+
236
+ ```ts
237
+ getSubdomains({ rpc, domain }): Promise<{ subdomain: string; owner: Address }[]>
238
+ ```
239
+
240
+ - **`createSubdomain`** — returns the name-account creation instruction(s). `subdomain` must be a lowercase one-level `.sns` subdomain.
241
+
242
+ ```ts
243
+ createSubdomain({ rpc, subdomain, owner, space?, feePayer? }): Promise<Instruction[]>
244
+ ```
245
+
246
+ - **`transferSubdomain`** — returns one transfer instruction. When `currentOwner` is omitted, the function retrieves the current owner; set `isParentOwnerSigner` when the parent owner authorizes the transfer.
247
+
248
+ ```ts
249
+ transferSubdomain({ rpc, subdomain, newOwner, isParentOwnerSigner?, currentOwner? }): Promise<Instruction>
250
+ ```
251
+
252
+ ### Ownership And Reverse Lookup
253
+
254
+ - **`getDomainOwner`** — returns the domain's owner: the tokenized-domain NFT owner when present, otherwise the registry owner. It does not apply `SOL`-record precedence or PDA policy, so the result is not necessarily the domain's SNS-IP-5 resolution target; use `resolve` when that target is required.
255
+
256
+ ```ts
257
+ getDomainOwner({ rpc, domain }): Promise<Address>
258
+ ```
259
+
260
+ - **`getAllSnsDomains`** — lists top-level SNS registry accounts and their registry owners.
261
+
262
+ ```ts
263
+ getAllSnsDomains({ rpc }): Promise<{ domainAddress: Address; owner: Address }[]>
264
+ ```
265
+
266
+ - **`getAllSolDomains`** — lists all top-level SRS records, including expired records. The returned `owner` is the raw SRS owner field and may be a wallet address or Token-2022 mint.
267
+
268
+ ```ts
269
+ getAllSolDomains({ rpc }): Promise<{ domainAddress: Address; owner: Address }[]>
270
+ ```
271
+
272
+ - **`getPrimaryDomain`** — returns a primary-domain account, its TLD-less name, and whether the wallet is no longer its effective owner.
273
+
274
+ ```ts
275
+ getPrimaryDomain({ rpc, walletAddress }): Promise<{ domainAddress: Address; domainName: string; stale: boolean }>
276
+ ```
277
+
278
+ - **`getPrimaryDomainsBatch`** — returns valid, non-stale, TLD-less primary names positionally aligned with `walletAddresses`.
279
+
280
+ ```ts
281
+ getPrimaryDomainsBatch({ rpc, walletAddresses }): Promise<(string | undefined)[]>
282
+ ```
283
+
284
+ - **`getSnsDomainsForAddress`** — returns directly registry-owned top-level domains only. Tokenized domains and subdomains are excluded, and entries without reverse records are omitted.
285
+
286
+ ```ts
287
+ getSnsDomainsForAddress({ rpc, address }): Promise<{ domain: string; domainAddress: Address }[]>
288
+ ```
289
+
290
+ - **`getSnsNftsForAddress`** — returns tokenized SNS domains with reverse data.
291
+
292
+ ```ts
293
+ getSnsNftsForAddress({ rpc, address }): Promise<{ domain: string; domainAddress: Address; mint: Address }[]>
294
+ ```
295
+
296
+ - **`getSolDomainsForAddress`** — returns non-expired, directly wallet-owned `.sol` records. Tokenized records are excluded and returned names are TLD-trimmed.
297
+
298
+ ```ts
299
+ getSolDomainsForAddress({ rpc, address }): Promise<{ domain: string; domainAddress: Address }[]>
300
+ ```
301
+
302
+ - **`getSolNftsForAddress`** — returns non-expired Token-2022 tokenized `.sol` records held by an address. Results include the TLD-trimmed name, SRS record address, and mint.
303
+
304
+ ```ts
305
+ getSolNftsForAddress({ rpc, address }): Promise<{ domain: string; domainAddress: Address; mint: Address }[]>
306
+ ```
307
+
308
+ - **`reverseLookup`** — returns one TLD-less reverse name for a domain address.
309
+
310
+ ```ts
311
+ reverseLookup({ rpc, domainAddress, parentAddress? }): Promise<string>
312
+ ```
313
+
314
+ - **`reverseLookupBatch`** — returns TLD-less names in input order; missing reverse records are `undefined`.
315
+
316
+ ```ts
317
+ reverseLookupBatch({ rpc, domainAddresses }): Promise<(string | undefined)[]>
318
+ ```
319
+
320
+ ### Advanced APIs
321
+
322
+ For account-level integrations, the root export also includes derivation and raw name-registry helpers such as `getSnsDomainAddress`, `getSolDomainAddress`, `getReverseAddress`, `getReverseAddressFromDomainAddress`, `checkAddressOnCurve`, `deserializeReverse`, `getPythFeedAddress`, `getTld`, `createNameRegistry`, `updateNameRegistry`, `deleteNameRegistry`, and `createReverse`.
323
+
324
+ NFT helpers and state classes include `getSnsNftMint`, `getSnsNftOwner`, `RegistryState`, `RecordState`, `NftState`, and `PrimaryDomainState`. Low-level instruction classes are also exported; use the `@solana-name-service/sns-sdk-kit/instructions` export for custom transaction composition rather than treating those constructors as an onboarding API.
325
+
326
+ ## Documentation And Migration
327
+
328
+ - [Developer documentation](https://dev.sns.id/)
329
+ - [Migration notes and changelog](./CHANGELOG.md)
330
+ - [SDK monorepo overview](../README.md)
331
+ - [SNS guide](https://guide.sns.id/)
332
+
333
+ ## License
334
+
335
+ Released under the [MIT License](../LICENSE).