useTransfer

Hook to decode or pay an invoice

Import

import { useTransfer } from '@lawallet/react';

Usage

index.tsx

import { useTransfer } from '@lawallet/react';
import { config } from './config';
 
function App() {
  const { isLoading, isSuccess, execInternalTransfer, execOutboundTransfer } = useTransfer({
    tokenName: 'BTC',
    config,
  });
}

Parameters

import { type UseTransferParameters } from '@lawallet/react';

tokenName

String

id of the token to transfer

import { useTransfer } from '@lawallet/react';
 
function App() {
  const { isLoading, isSuccess, execInternalTransfer, execOutboundTransfer } = useTransfer({
    tokenName: 'BTC',
  });
}

onSuccess

undefined | () => void

Function to execute when the transfer is successful.

import { useTransfer } from '@lawallet/react';
 
function App() {
  const { isLoading, isSuccess, execInternalTransfer, execOutboundTransfer } = useTransfer({
    tokenName: 'BTC',
    onSuccess: () => {
      console.log('successful payment');
    },
  });
}

onError

undefined | (message?: string) => void

Function to execute when the transfer has an error.

import { useTransfer } from '@lawallet/react';
 
function App() {
  const { isLoading, isSuccess, execInternalTransfer, execOutboundTransfer } = useTransfer({
    tokenName: 'BTC',
    onError: () => {
      console.log('error on payment');
    },
  });
}

config

Config | undefined

Config to use instead of retrieving from the from nearest LaWalletConfig.

import { useTransfer } from '@lawallet/react';
import { config } from './config';
 
function App() {
  const { isLoading, isSuccess, execInternalTransfer, execOutboundTransfer } = useTransfer({
    tokenName: 'BTC',
    config,
  });
}

Return Type

import { type UseTransferReturns } from '@lawallet/react';

isLoading

Boolean

This variable defines whether the transfer is in the loading stage

isSuccess

Boolean

This variable defines whether the transfer was successful

isError

Boolean

This variable defines whether the transfer had an error

error

string | undefined

This variable defines the error that occurred in the transfer

execInternalTransfer

(params: InternalTransferParameters) => Promise<boolean> InternalTransferParameters

Function to execute an internal transfer

execInternalTransfer

(params: OutboundTransferParameters) => Promise<boolean> OutboundTransferParameters

Function to execute an external transfer

Getting started useCards