@bonfida/sns-react
v3.1.2
Published
A set of React hooks to interact with the Solana Name Service
Downloads
218
Readme
This library provides a set of reusable React hooks to help make your components more efficient and easier to read.
npm install @bonfida/sns-react
or
yarn add @bonfida/sns-react
This library depends on the following peer dependencies:
@tanstack/react-query
@solana/web3.js
It utilizes React Query version 5, making all useQuery
functionalities available (with the exception of queryFn
) across all hooks. If you're not already using @tanstack/react-query
, you'll need to install it, then initialize a query client and encapsulate your application with a provider. For more information, visit the Tanstack Query documentation.
Below is a brief description of the hooks available in this library. Detailed usage and API guides are available in each hook's respective documentation.
useDomainOwner
This hook can be used to resolve the owner of a domain name.
useDomainsForOwner
This hook can be used to retrieve all the domains owned by a wallet
useDomainSize
This hook can be used to retrive the size of a domain name account
usePrimaryDomain
This hook can be used to retrieve the primary domain of a wallet if it exists. Previously known as useFavoriteDomain
.
useProfilePic
This hook can be used to retrieve the profile picture of a domain name if it exists
useRecords
This hook can be used to retrieve the content of multiple records v1 (deperecated)
useRecordsV2
This hook can be used to retrieve the content of multiple records v2
useReverseLookup
This hook can be used to retrieve the reverse of domain name from this public key
useSubdomains
This hook can be used to retrieve the subdomains of .sol domain name
useSuggestions
This hook can be used to generate unregistered domain suggestions related to the given domain
useTopDomainsSales
This hook can be used to retrieve the top domain sales for a given time window
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
SNS React is an open-source project licensed under MIT. Feel free to explore, expand, and improve!