Skip to main content

useConfidentialTransfer

High-level hook for executing confidential token transfers.

Usage​

import { useConfidentialTransfer } from '@fhevmsdk/react'

function TransferForm() {
  const { transfer, isLoading, isSuccess } = useConfidentialTransfer({
    contractAddress: '0x...',
    abi: tokenABI,
  })

  const handleTransfer = async () => {
    await transfer({
      to: '0xRecipient...',
      amount: '10.5',
    })
  }

  return <button onClick={handleTransfer} disabled={isLoading}>Transfer</button>
}

Parameters​

interface Params {
  contractAddress: `0x${string}`
  abi: Abi
  functionName?: string  // default: 'confidentialTransfer'
  decimals?: number      // default: 6
}

Returns​

interface Return {
  transfer: (params: TransferParams) => Promise<void>
  isLoading: boolean
  isPreparingTx: boolean
  isEncrypting: boolean
  isPending: boolean
  isConfirming: boolean
  isSuccess: boolean
  txHash: `0x${string}` | undefined
  error: string | null
  reset: () => void
  canTransfer: boolean
}

TransferParams​

interface TransferParams {
  to: string           // Recipient address
  amount: string | bigint  // Amount as string "10.5" or bigint
}

Examples​

Complete Transfer Form​

import { useConfidentialTransfer } from '@fhevmsdk/react'
import { useState } from 'react'

function TransferForm() {
  const [to, setTo] = useState('')
  const [amount, setAmount] = useState('')

  const {
    transfer,
    isLoading,
    isSuccess,
    txHash,
    error,
    reset,
    canTransfer,
  } = useConfidentialTransfer({
    contractAddress: '0x...',
    abi: tokenABI,
    decimals: 18,
  })

  const handleSubmit = async (e) => {
    e.preventDefault()
    await transfer({ to, amount })
  }

  return (
    <form onSubmit={handleSubmit}>
      <input
        value={to}
        onChange={(e) => setTo(e.target.value)}
        placeholder="Recipient address"
      />
      <input
        value={amount}
        onChange={(e) => setAmount(e.target.value)}
        placeholder="Amount"
      />
      <button type="submit" disabled={!canTransfer || isLoading}>
        {isLoading ? 'Processing...' : 'Transfer'}
      </button>
      {isSuccess && <p>Success! TX: {txHash}</p>}
      {error && <p className="error">{error}</p>}
    </form>
  )
}

With Status Tracking​

function TransferWithStatus() {
  const {
    transfer,
    isPreparingTx,
    isEncrypting,
    isPending,
    isConfirming,
    isSuccess,
  } = useConfidentialTransfer({ contractAddress: '0x...', abi: tokenABI })

  const getStatus = () => {
    if (isPreparingTx) return 'Preparing transaction...'
    if (isEncrypting) return 'Encrypting amount...'
    if (isPending) return 'Waiting for confirmation...'
    if (isConfirming) return 'Confirming on blockchain...'
    if (isSuccess) return 'Transfer complete!'
    return 'Ready'
  }

  return (
    <div>
      <p>Status: {getStatus()}</p>
      <button onClick={() => transfer({ to: '0x...', amount: '10' })}>
        Transfer
      </button>
    </div>
  )
}

BigInt Amount​

const { transfer } = useConfidentialTransfer({
  contractAddress: '0x...',
  abi: tokenABI,
})

// Use bigint directly
await transfer({
  to: '0xRecipient...',
  amount: 1000000n,
})

Custom Function​

const { transfer } = useConfidentialTransfer({
  contractAddress: '0x...',
  abi: tokenABI,
  functionName: 'transfer', // Custom function name
  decimals: 6,
})

State Properties​

PropertyTypeDescription
isLoadingbooleanOverall loading state
isPreparingTxbooleanPreparing transaction
isEncryptingbooleanEncrypting amount
isPendingbooleanWaiting for user confirmation
isConfirmingbooleanConfirming on blockchain
isSuccessbooleanTransfer completed
txHashstringTransaction hash (when submitted)
errorstring | nullError message
canTransferbooleanWhether transfer can be executed

Error Messages​

The hook provides user-friendly error messages:

  • "Insufficient balance to complete this transfer"
  • "Transaction was rejected by user"
  • "Insufficient funds to pay for gas fees"
  • "Transaction failed. Please try again."

Notes​

  • ✅ Handles complete transfer flow (encrypt + submit + confirm)
  • ✅ Validates recipient address
  • ✅ Parses string amounts automatically
  • ✅ Provides granular loading states
  • ✅ User-friendly error messages
  • ⚠️ Requires wallet connection
  • ⚠️ Must be used within FHEVMProvider and WagmiProvider

See Also​