useTransferToken

Send a fungible token transfer using a flow-aware hook.

Import

import { useTransferToken } from "hierokit";

Parameters

• options?: TransactionFlowOptions

  Passed through to useTransactionFlow:

  • timeoutMs?: number

Execute arguments

type TransferTokenArgs = {
  tokenId: string | TokenId;
  from?: string | AccountId;
  to: string | AccountId;
  amount: number;
};

• If from is omitted, the client's operator account is used.

Returns

{
  flow: FlowHandle<TransactionReceipt>;
  execute: (args: TransferTokenArgs) => Promise<void>;
}

Usage

import { useTransferToken } from "hierokit";

function SendToken() {
  const { flow, execute } = useTransferToken();

  return (
    <div>
      <button
        onClick={() =>
          execute({
            tokenId: "0.0.token",
            to: "0.0.recipient",
            amount: 100,
          })
        }
      >
        Send 100 units
      </button>
      <p>Status: {flow.status}</p>
    </div>
  );
}