useTransferPreview

Hook for estimating the network fee for an HBAR transfer before submitting it.

Import

import { useTransferPreview } from "hierokit";

Parameters

type TransferPreviewArgs = {
  to: string | AccountId;
  amount: number | Hbar;
  memo?: string;
};

Pass null to disable the hook.

Returns

{
  data: Hbar | null;
  status: "idle" | "loading" | "success" | "error";
  error: unknown | null;
  refresh: () => void;
}

Usage

import { useTransferPreview } from "hierokit";

function PreviewPanel() {
  const { data, status, refresh } = useTransferPreview({
    to: "0.0.recipient",
    amount: 1,
  });

  return (
    <div>
      <button onClick={refresh}>Estimate fee</button>
      <p>Status: {status}</p>
      <p>Estimated fee: {data ? data.toString() : "–"}</p>
    </div>
  );
}