useScaffoldStrkBalance

The useScaffoldStrkBalance hook is a custom React hook designed to fetch and display the balance of STRK tokens for a given address on the StarkNet blockchain. It simplifies the process of reading contract data by using StarkNet React utilities.

Usage Example

import useScaffoldStrkBalance from '~~/hooks/scaffold-stark/useScaffoldStrkBalance';
import { useAccount } from '~~/hooks/useAccount';

function StrkBalanceDisplay() {
  const { address } = useAccount();
  const { value, formatted, symbol } = useScaffoldStrkBalance({ address: address || "" });

  return (
    <div>
      <h3>STRK Balance:</h3>
      <p>Raw Value: {value ? value.toString() : ""}</p>
      <p>Formatted: {formatted}</p>
      <p>Symbol: {symbol}</p>
    </div>
  );
}

This example demonstrates how to use the useScaffoldStrkBalance hook to display the raw and formatted STRK token balance for a user's address.

Configuration

Parameter	Type	Description
address	Address | string	The STRK address to fetch the balance for. If not provided, it will attempt to fetch the balance for the current connected account.

Return Values

Parameter	Type	Description
value	bigint	The raw STRK balance fetched from the contract as a bigint.
decimals	number	Number of decimals for the token. Defaults to 18 for STRK.
symbol	string	The token symbol. For this contract, it will return "STRK".
formatted	string	The balance formatted into a human-readable string using ethers' formatUnits.
error	Error	Error object in case there is a failure fetching the balance.

Best Practices

• Use this hook in components that need to display STRK token balances.
• Ensure that the component using this hook is wrapped in a StarkNet React provider.
• Handle loading and error states appropriately in the parent component.

Error Handling

While the hook doesn't explicitly handle errors, the returned props object from useReadContract includes an error property that can be checked in the parent component.

const { value, formatted, symbol, error } = useScaffoldStrkBalance({ address });

if (error) {
  return <div>Error fetching STRK balance</div>;
}