@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.18 kB
TypeScript
import { UseMutateAsyncFunction, UseMutateFunction, UseMutationResult } from '@tanstack/react-query';
import { SafeClientResult, SendSafeOperationProps } from '@safe-global/sdk-starter-kit';
import { ConfigParam, SafeConfigWithSigner } from '../types/index.js';
export type SendSafeOperationVariables = SendSafeOperationProps;
export type UseSendSafeOperationParams = ConfigParam<SafeConfigWithSigner>;
export type UseSendSafeOperationReturnType = Omit<UseMutationResult<SafeClientResult, Error, SendSafeOperationVariables>, 'mutate' | 'mutateAsync'> & {
sendSafeOperation: UseMutateFunction<SafeClientResult, Error, SendSafeOperationVariables, unknown>;
sendSafeOperationAsync: UseMutateAsyncFunction<SafeClientResult, Error, SendSafeOperationVariables, unknown>;
};
/**
* Hook to send or propose 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 sendSafeOperation function.
*/
export declare function useSendSafeOperation(params?: UseSendSafeOperationParams): UseSendSafeOperationReturnType;