0.9.1-beta • Published 3 months ago

@solana-name-service/sns-sdk-kit v0.9.1-beta

Weekly downloads
-
License
MIT
Repository
github
Last release
3 months ago

SNS JS-KIT SDK

npm version TypeScript License

The JS-KIT SDK is a JavaScript toolkit for managing .sol domains and records. Built on @solana/kit (formerly @solana/web3.js 2.x), it simplifies development and ensures secure and efficient functionality.

Note: This SDK is currently in beta and subject to changes. Features, APIs, and functionality may evolve as development progresses.

Table of Contents

Features

  • Domain resolution and primary domain lookup
  • Domain/Subdomain Management
  • Record Handling

Installation

npm install @solana-name-service/sns-sdk-kit@beta @solana/kit
yarn add @solana-name-service/sns-sdk-kit@beta @solana/kit

Example Usage

import {
  Record,
  getDomainRecord,
  getPrimaryDomain,
  resolveDomain,
} from "@solana-name-service/sns-sdk-kit";
import {
  Address,
  createDefaultRpcTransport,
  createSolanaRpcFromTransport,
} from "@solana/kit";

(async () => {
  // Initialize rpc interface
  const transport = createDefaultRpcTransport({
    url: YOUR_RPC_URL,
  });
  const rpc = createSolanaRpcFromTransport(transport);

  // Resolve .sol domain
  const resolved = await resolveDomain({ rpc, domain: "sns.sol" });

  // Get domain records
  const records = await getDomainRecord({
    rpc,
    domain: "sns.sol",
    record: Record.Url,
    options: {
      deserialize: true,
    },
  });

  // Get primary domain for address
  const primaryDomain = await getPrimaryDomain({
    rpc,
    walletAddress: "36Dn3RWhB8x4c83W6ebQ2C2eH9sh5bQX2nMdkP2cWaA4" as Address,
  });

  console.log({ resolved, records, primaryDomain });
})();

Documentation

The documentation for the JS-KIT SDK is currently a work-in-progress. Stay tuned for updates!

License

This project is licensed under the MIT License. See the LICENSE file for more details.