@gear-js/react-hooks/dist/hooks/sails/use-prepare-program-transaction.d.ts

React hooks used across Gear applications

import { FunctionName, ServiceName, GenericTransactionReturn, Transaction, TransactionReturn, UsePrepareProgramTransactionParameters, SignAndSendOptions } from './types';
declare function usePrepareProgramTransaction<TProgram, TServiceName extends ServiceName<TProgram>, TFunctionName extends FunctionName<TProgram[TServiceName], GenericTransactionReturn>, TTransaction extends Transaction<TProgram[TServiceName][TFunctionName]>, TTransactionReturn extends TransactionReturn<TTransaction>>({ program, serviceName, functionName, }: UsePrepareProgramTransactionParameters<TProgram, TServiceName, TFunctionName>): {
    data: undefined;
    variables: undefined;
    error: null;
    isError: false;
    isIdle: true;
    isPending: false;
    isSuccess: false;
    status: "idle";
    mutate: import('@tanstack/react-query').UseMutateFunction<{
        transaction: TTransactionReturn;
        fee: bigint;
    }, Error, SignAndSendOptions<Parameters<TTransaction>>, unknown>;
    reset: () => void;
    context: unknown;
    failureCount: number;
    failureReason: Error | null;
    isPaused: boolean;
    submittedAt: number;
    mutateAsync: import('@tanstack/react-query').UseMutateAsyncFunction<{
        transaction: TTransactionReturn;
        fee: bigint;
    }, Error, SignAndSendOptions<Parameters<TTransaction>>, unknown>;
    prepareTransaction: import('@tanstack/react-query').UseMutateFunction<{
        transaction: TTransactionReturn;
        fee: bigint;
    }, Error, SignAndSendOptions<Parameters<TTransaction>>, unknown>;
    prepareTransactionAsync: import('@tanstack/react-query').UseMutateAsyncFunction<{
        transaction: TTransactionReturn;
        fee: bigint;
    }, Error, SignAndSendOptions<Parameters<TTransaction>>, unknown>;
} | {
    data: undefined;
    variables: SignAndSendOptions<Parameters<TTransaction>>;
    error: null;
    isError: false;
    isIdle: false;
    isPending: true;
    isSuccess: false;
    status: "pending";
    mutate: import('@tanstack/react-query').UseMutateFunction<{
        transaction: TTransactionReturn;
        fee: bigint;
    }, Error, SignAndSendOptions<Parameters<TTransaction>>, unknown>;
    reset: () => void;
    context: unknown;
    failureCount: number;
    failureReason: Error | null;
    isPaused: boolean;
    submittedAt: number;
    mutateAsync: import('@tanstack/react-query').UseMutateAsyncFunction<{
        transaction: TTransactionReturn;
        fee: bigint;
    }, Error, SignAndSendOptions<Parameters<TTransaction>>, unknown>;
    prepareTransaction: import('@tanstack/react-query').UseMutateFunction<{
        transaction: TTransactionReturn;
        fee: bigint;
    }, Error, SignAndSendOptions<Parameters<TTransaction>>, unknown>;
    prepareTransactionAsync: import('@tanstack/react-query').UseMutateAsyncFunction<{
        transaction: TTransactionReturn;
        fee: bigint;
    }, Error, SignAndSendOptions<Parameters<TTransaction>>, unknown>;
} | {
    data: undefined;
    error: Error;
    variables: SignAndSendOptions<Parameters<TTransaction>>;
    isError: true;
    isIdle: false;
    isPending: false;
    isSuccess: false;
    status: "error";
    mutate: import('@tanstack/react-query').UseMutateFunction<{
        transaction: TTransactionReturn;
        fee: bigint;
    }, Error, SignAndSendOptions<Parameters<TTransaction>>, unknown>;
    reset: () => void;
    context: unknown;
    failureCount: number;
    failureReason: Error | null;
    isPaused: boolean;
    submittedAt: number;
    mutateAsync: import('@tanstack/react-query').UseMutateAsyncFunction<{
        transaction: TTransactionReturn;
        fee: bigint;
    }, Error, SignAndSendOptions<Parameters<TTransaction>>, unknown>;
    prepareTransaction: import('@tanstack/react-query').UseMutateFunction<{
        transaction: TTransactionReturn;
        fee: bigint;
    }, Error, SignAndSendOptions<Parameters<TTransaction>>, unknown>;
    prepareTransactionAsync: import('@tanstack/react-query').UseMutateAsyncFunction<{
        transaction: TTransactionReturn;
        fee: bigint;
    }, Error, SignAndSendOptions<Parameters<TTransaction>>, unknown>;
} | {
    data: {
        transaction: TTransactionReturn;
        fee: bigint;
    };
    error: null;
    variables: SignAndSendOptions<Parameters<TTransaction>>;
    isError: false;
    isIdle: false;
    isPending: false;
    isSuccess: true;
    status: "success";
    mutate: import('@tanstack/react-query').UseMutateFunction<{
        transaction: TTransactionReturn;
        fee: bigint;
    }, Error, SignAndSendOptions<Parameters<TTransaction>>, unknown>;
    reset: () => void;
    context: unknown;
    failureCount: number;
    failureReason: Error | null;
    isPaused: boolean;
    submittedAt: number;
    mutateAsync: import('@tanstack/react-query').UseMutateAsyncFunction<{
        transaction: TTransactionReturn;
        fee: bigint;
    }, Error, SignAndSendOptions<Parameters<TTransaction>>, unknown>;
    prepareTransaction: import('@tanstack/react-query').UseMutateFunction<{
        transaction: TTransactionReturn;
        fee: bigint;
    }, Error, SignAndSendOptions<Parameters<TTransaction>>, unknown>;
    prepareTransactionAsync: import('@tanstack/react-query').UseMutateAsyncFunction<{
        transaction: TTransactionReturn;
        fee: bigint;
    }, Error, SignAndSendOptions<Parameters<TTransaction>>, unknown>;
};
export { usePrepareProgramTransaction };
export type { UsePrepareProgramTransactionParameters };