navi-sdk/src/libs/Coins/index.ts

The NAVI SDK Client provides tools for interacting with the Sui blockchain networks, designed for handling transactions, accounts, and smart contracts efficiently. This documentation covers the setup, account management, and transaction handling within th

import { SuiClient } from "@mysten/sui/client";

/**
 * Retrieves the amount of a specific coin owned by a sender.
 *
 * @param client - The SuiClient instance used to interact with the blockchain.
 * @param sender - The address of the sender.
 * @param coinType - The type of the coin to retrieve the amount for.
 * @returns A Promise that resolves to the amount of the specified coin owned by the sender.
 * @throws An error if the sender or client is undefined.
 */
export async function getCoinAmount(
  client: SuiClient,
  sender: string,
  coinType: string
): Promise<number> {
  if (!sender) {
    throw new Error("Sender is undefined.");
  }
  if (!client) {
    throw new Error("Client is undefined.");
  }
  const coinInfo = await client.getBalance({
    owner: sender,
    coinType,
  });
  const tokenBalance = Number(coinInfo.totalBalance);
  console.log("Token Type : ", coinType, "Balance: ", tokenBalance);
  return tokenBalance;
}

/**
 * Retrieves the decimal value for a specific coin type.
 * @param client - The SuiClient instance.
 * @param coinType - The type of coin.
 * @returns A Promise that resolves to the decimal value of the coin.
 */
export async function getCoinDecimal(
  client: SuiClient,
  coinType: string
): Promise<any> {
  const coinMetadata = await client.getCoinMetadata({ coinType: coinType });
  if (coinMetadata) return coinMetadata.decimals;
  return 9;
}