useTransferFunds

Hook for transferring a fraction of account balance to a recipient.

Import

import { useTransferFunds } from '@growae/reactive-react'

Usage

import { useTransferFunds } from '@growae/reactive-react'

function TransferHalf() {
  const { mutate: transferFunds, isPending, isSuccess, data } = useTransferFunds()

  return (
    <div>
      <button
        onClick={() =>
          transferFunds({ fraction: 0.5, recipient: 'ak_...' })
        }
        disabled={isPending}
      >
        Transfer 50%
      </button>
      {isSuccess && <p>Tx: {data.hash}</p>}
    </div>
  )
}

Return Type

See TanStack Query mutation docs for full return type.

data

See transferFunds Return Type.

Parameters

See transferFunds Parameters for all available options.

Key parameters:

Parameter	Type	Default	Description
fraction	number	—	Required. Fraction of balance to transfer (0–1).
recipient	string	—	Required. Recipient address (ak_...).
ttl	number	300	Transaction TTL in blocks.
waitMined	boolean	true	Whether to wait for the transaction to be mined.

mutation

See TanStack Query mutation docs for mutation options.

Action

• transferFunds