@safe-global/safe-react-hooks
Version:
A collection of React Hooks that facilitates the interaction of React apps with Safe Smart Accounts
17 lines (16 loc) • 1.22 kB
TypeScript
import { UseMutateAsyncFunction, UseMutateFunction, UseMutationResult } from '@tanstack/react-query';
import { ConfirmSafeOperationProps, SafeClientResult } from '@safe-global/sdk-starter-kit';
import { ConfigParam, SafeConfigWithSigner } from '../types/index.js';
export type ConfirmSafeOperationVariables = ConfirmSafeOperationProps;
export type UseConfirmSafeOperationParams = ConfigParam<SafeConfigWithSigner>;
export type UseConfirmSafeOperationReturnType = Omit<UseMutationResult<SafeClientResult, Error, ConfirmSafeOperationVariables>, 'mutate' | 'mutateAsync'> & {
confirmSafeOperation: UseMutateFunction<SafeClientResult, Error, ConfirmSafeOperationVariables, unknown>;
confirmSafeOperationAsync: UseMutateAsyncFunction<SafeClientResult, Error, ConfirmSafeOperationVariables, unknown>;
};
/**
* Hook to confirm pending Safe Operations.
* @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 confirmSafeOperation function.
*/
export declare function useConfirmSafeOperation(params?: UseConfirmSafeOperationParams): UseConfirmSafeOperationReturnType;