Skip to content

useTransferFunds

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

Import

typescript
import { useTransferFunds } from '@growae/reactive-solid'

Usage

tsx
import { useTransferFunds } from '@growae/reactive-solid'

function TransferHalf() {
  const transferFunds = useTransferFunds()

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

Parameters

See transferFunds Parameters.

Key parameters:

ParameterTypeDefaultDescription
fractionnumberRequired. Fraction of balance to transfer (0–1).
recipientstringRequired. Recipient address (ak_...).
ttlnumber300Transaction TTL in blocks.
waitMinedbooleantrueWhether to wait for the transaction to be mined.

Action