UNPKG

@safe-global/safe-react-hooks

Version:

A collection of React Hooks that facilitates the interaction of React apps with Safe Smart Accounts

20 lines (19 loc) 1.24 kB
import { UseMutateAsyncFunction, UseMutateFunction, UseMutationResult } from '@tanstack/react-query'; import { SafeTransaction, TransactionBase } from '@safe-global/types-kit'; import { SafeClientResult } from '@safe-global/sdk-starter-kit'; import { ConfigParam, SafeConfigWithSigner } from '../types/index.js'; export type SendTransactionVariables = { transactions: (TransactionBase | SafeTransaction)[]; }; export type UseSendTransactionParams = ConfigParam<SafeConfigWithSigner>; export type UseSendTransactionReturnType = Omit<UseMutationResult<SafeClientResult, Error, SendTransactionVariables>, 'mutate' | 'mutateAsync'> & { sendTransaction: UseMutateFunction<SafeClientResult, Error, SendTransactionVariables, unknown>; sendTransactionAsync: UseMutateAsyncFunction<SafeClientResult, Error, SendTransactionVariables, unknown>; }; /** * Hook to send or propose a multisig transaction. * @param params Parameters to customize the hook behavior. * @param params.config SafeConfig to use instead of the one provided by `SafeProvider`. * @returns Object containing the mutation state and the send function. */ export declare function useSendTransaction(params?: UseSendTransactionParams): UseSendTransactionReturnType;