GNS JS-KIT SDK

The JS-KIT SDK is a JavaScript toolkit for managing .gor domains and records. Built on @solana/web3.js 1.x, it simplifies development and ensures secure and efficient functionality.

User guide can be found here.

Gorbagana Domain Service Guide

A guide to retrieve all domains owned by a user using the Gorbagana Name Service.

Overview

This example demonstrates how to:

• Get all domains owned by a specific user
• Perform reverse lookup from account to domain name
• Resolve domain names to wallet addresses

Prerequisites

Make sure you have the required dependencies installed:

npm install @solana/web3.js @gorid/spl-name-service

Usage

import { Connection, PublicKey } from "@solana/web3.js";
import {
  getAllDomains,
  resolve,
  reverseLookup,
  ROOT_DOMAIN_ACCOUNT,
} from "@gorid/spl-name-service";

export async function main() {
  const connection = new Connection("https://rpc.gorbagana.wtf/");

  // Get all domains owned by a specific user
  const allDomains = await getAllDomains(
    connection,
    new PublicKey("55M2GxZ55saab85Qcd4NTet6TYqVni1tM3SvUQQiNG6H"),
  );
  console.log(
    "List domain that user owns",
    allDomains.map((d) => d.toString()),
  );

  // Reverse lookup: Get domain name from account address
  const resolveDomain = await reverseLookup(
    connection,
    new PublicKey("GSjr7i3U6xPQMHQN2sWJNhahCJRqQPv23e1HJ4ZtpeWc"),
  );
  console.log("Resolve domain from account name: ", resolveDomain.toString());

  // Resolve domain name to wallet address
  const owner = await resolve(connection, "jade");
  console.log("Owner :", owner.toString()); // 55M2GxZ55saab85Qcd4NTet6TYqVni1tM3SvUQQiNG6H

  // Transfer ownership
  const tx = await transferNameOwnership(
    connection,
    "demo",
    new PublicKey("94nXXA7birWgrQ6XNZvMY8vfUBYNXkb9EmKkCzgfMWKy"), // new owner
    undefined,
    ROOT_DOMAIN_ACCOUNT,
  );
  const result = await connection.sendTransaction(new Transaction().add(tx), [
    signer,
  ]);
}

Functions

getAllDomains(connection, publicKey)

Retrieves all domains owned by the specified public key.

Parameters:

• connection: RPC connection
• publicKey: The owner's public key

Returns: Array of domain names

reverseLookup(connection, publicKey)

Performs reverse lookup to get the domain name associated with an account.

Parameters:

• connection: RPC connection
• publicKey: The account's public key

Returns: Domain name string

resolve(connection, domainName)

Resolves a domain name to its associated wallet address.

Parameters:

• connection: RPC connection
• domainName: The domain name to resolve

Returns: Public key of the domain owner

transferNameOwnership(connection, domainName, newOwner, nameClass, parentName)

Transfer a domain name to a new wallet address.

Parameters:

• connection: RPC connection
• domainName: The domain name to transfer
• newOwner: New owner of domain
• nameClass: The name class address
• parentName: The parent address, in this example it's ROOT_DOMAIN_ACCOUNT

Returns: Instruction to transfer ownership

Dependencies

• @solana/web3.js - Solana JavaScript SDK
• @gorid/spl-name-service - SPL Name Service utilities