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

React hooks used across Gear applications

import { FunctionName, GenericTransactionReturn, SendTransactionParameters, ServiceName, SignAndSendOptions, Transaction, TransactionReturn, UseSendProgramTransactionParameters } from './types';
declare function useSendProgramTransaction<TProgram, TServiceName extends ServiceName<TProgram>, TFunctionName extends FunctionName<TProgram[TServiceName], GenericTransactionReturn>, TTransaction extends Transaction<TProgram[TServiceName][TFunctionName]>, TTransactionReturn extends TransactionReturn<TTransaction>>({ program, serviceName, functionName }: UseSendProgramTransactionParameters<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<{
        response: Awaited<ReturnType<Transaction<TTransaction>> extends GenericTransactionReturn<infer R> ? R : never>;
        isFinalized: boolean | Promise<boolean>;
        blockHash: `0x${string}`;
        msgId: `0x${string}`;
        txHash: `0x${string}`;
    }, Error, ({
        transaction: TTransactionReturn;
    } | SignAndSendOptions<Parameters<TTransaction>>) & SendTransactionParameters, unknown>;
    reset: () => void;
    context: unknown;
    failureCount: number;
    failureReason: Error | null;
    isPaused: boolean;
    submittedAt: number;
    mutateAsync: import('@tanstack/react-query').UseMutateAsyncFunction<{
        response: Awaited<ReturnType<Transaction<TTransaction>> extends GenericTransactionReturn<infer R> ? R : never>;
        isFinalized: boolean | Promise<boolean>;
        blockHash: `0x${string}`;
        msgId: `0x${string}`;
        txHash: `0x${string}`;
    }, Error, ({
        transaction: TTransactionReturn;
    } | SignAndSendOptions<Parameters<TTransaction>>) & SendTransactionParameters, unknown>;
    sendTransaction: import('@tanstack/react-query').UseMutateFunction<{
        response: Awaited<ReturnType<Transaction<TTransaction>> extends GenericTransactionReturn<infer R> ? R : never>;
        isFinalized: boolean | Promise<boolean>;
        blockHash: `0x${string}`;
        msgId: `0x${string}`;
        txHash: `0x${string}`;
    }, Error, ({
        transaction: TTransactionReturn;
    } | SignAndSendOptions<Parameters<TTransaction>>) & SendTransactionParameters, unknown>;
    sendTransactionAsync: import('@tanstack/react-query').UseMutateAsyncFunction<{
        response: Awaited<ReturnType<Transaction<TTransaction>> extends GenericTransactionReturn<infer R> ? R : never>;
        isFinalized: boolean | Promise<boolean>;
        blockHash: `0x${string}`;
        msgId: `0x${string}`;
        txHash: `0x${string}`;
    }, Error, ({
        transaction: TTransactionReturn;
    } | SignAndSendOptions<Parameters<TTransaction>>) & SendTransactionParameters, unknown>;
} | {
    data: undefined;
    variables: ({
        transaction: TTransactionReturn;
    } | SignAndSendOptions<Parameters<TTransaction>>) & SendTransactionParameters;
    error: null;
    isError: false;
    isIdle: false;
    isPending: true;
    isSuccess: false;
    status: "pending";
    mutate: import('@tanstack/react-query').UseMutateFunction<{
        response: Awaited<ReturnType<Transaction<TTransaction>> extends GenericTransactionReturn<infer R> ? R : never>;
        isFinalized: boolean | Promise<boolean>;
        blockHash: `0x${string}`;
        msgId: `0x${string}`;
        txHash: `0x${string}`;
    }, Error, ({
        transaction: TTransactionReturn;
    } | SignAndSendOptions<Parameters<TTransaction>>) & SendTransactionParameters, unknown>;
    reset: () => void;
    context: unknown;
    failureCount: number;
    failureReason: Error | null;
    isPaused: boolean;
    submittedAt: number;
    mutateAsync: import('@tanstack/react-query').UseMutateAsyncFunction<{
        response: Awaited<ReturnType<Transaction<TTransaction>> extends GenericTransactionReturn<infer R> ? R : never>;
        isFinalized: boolean | Promise<boolean>;
        blockHash: `0x${string}`;
        msgId: `0x${string}`;
        txHash: `0x${string}`;
    }, Error, ({
        transaction: TTransactionReturn;
    } | SignAndSendOptions<Parameters<TTransaction>>) & SendTransactionParameters, unknown>;
    sendTransaction: import('@tanstack/react-query').UseMutateFunction<{
        response: Awaited<ReturnType<Transaction<TTransaction>> extends GenericTransactionReturn<infer R> ? R : never>;
        isFinalized: boolean | Promise<boolean>;
        blockHash: `0x${string}`;
        msgId: `0x${string}`;
        txHash: `0x${string}`;
    }, Error, ({
        transaction: TTransactionReturn;
    } | SignAndSendOptions<Parameters<TTransaction>>) & SendTransactionParameters, unknown>;
    sendTransactionAsync: import('@tanstack/react-query').UseMutateAsyncFunction<{
        response: Awaited<ReturnType<Transaction<TTransaction>> extends GenericTransactionReturn<infer R> ? R : never>;
        isFinalized: boolean | Promise<boolean>;
        blockHash: `0x${string}`;
        msgId: `0x${string}`;
        txHash: `0x${string}`;
    }, Error, ({
        transaction: TTransactionReturn;
    } | SignAndSendOptions<Parameters<TTransaction>>) & SendTransactionParameters, unknown>;
} | {
    data: undefined;
    error: Error;
    variables: ({
        transaction: TTransactionReturn;
    } | SignAndSendOptions<Parameters<TTransaction>>) & SendTransactionParameters;
    isError: true;
    isIdle: false;
    isPending: false;
    isSuccess: false;
    status: "error";
    mutate: import('@tanstack/react-query').UseMutateFunction<{
        response: Awaited<ReturnType<Transaction<TTransaction>> extends GenericTransactionReturn<infer R> ? R : never>;
        isFinalized: boolean | Promise<boolean>;
        blockHash: `0x${string}`;
        msgId: `0x${string}`;
        txHash: `0x${string}`;
    }, Error, ({
        transaction: TTransactionReturn;
    } | SignAndSendOptions<Parameters<TTransaction>>) & SendTransactionParameters, unknown>;
    reset: () => void;
    context: unknown;
    failureCount: number;
    failureReason: Error | null;
    isPaused: boolean;
    submittedAt: number;
    mutateAsync: import('@tanstack/react-query').UseMutateAsyncFunction<{
        response: Awaited<ReturnType<Transaction<TTransaction>> extends GenericTransactionReturn<infer R> ? R : never>;
        isFinalized: boolean | Promise<boolean>;
        blockHash: `0x${string}`;
        msgId: `0x${string}`;
        txHash: `0x${string}`;
    }, Error, ({
        transaction: TTransactionReturn;
    } | SignAndSendOptions<Parameters<TTransaction>>) & SendTransactionParameters, unknown>;
    sendTransaction: import('@tanstack/react-query').UseMutateFunction<{
        response: Awaited<ReturnType<Transaction<TTransaction>> extends GenericTransactionReturn<infer R> ? R : never>;
        isFinalized: boolean | Promise<boolean>;
        blockHash: `0x${string}`;
        msgId: `0x${string}`;
        txHash: `0x${string}`;
    }, Error, ({
        transaction: TTransactionReturn;
    } | SignAndSendOptions<Parameters<TTransaction>>) & SendTransactionParameters, unknown>;
    sendTransactionAsync: import('@tanstack/react-query').UseMutateAsyncFunction<{
        response: Awaited<ReturnType<Transaction<TTransaction>> extends GenericTransactionReturn<infer R> ? R : never>;
        isFinalized: boolean | Promise<boolean>;
        blockHash: `0x${string}`;
        msgId: `0x${string}`;
        txHash: `0x${string}`;
    }, Error, ({
        transaction: TTransactionReturn;
    } | SignAndSendOptions<Parameters<TTransaction>>) & SendTransactionParameters, unknown>;
} | {
    data: {
        response: Awaited<ReturnType<Transaction<TTransaction>> extends GenericTransactionReturn<infer R> ? R : never>;
        isFinalized: boolean | Promise<boolean>;
        blockHash: `0x${string}`;
        msgId: `0x${string}`;
        txHash: `0x${string}`;
    };
    error: null;
    variables: ({
        transaction: TTransactionReturn;
    } | SignAndSendOptions<Parameters<TTransaction>>) & SendTransactionParameters;
    isError: false;
    isIdle: false;
    isPending: false;
    isSuccess: true;
    status: "success";
    mutate: import('@tanstack/react-query').UseMutateFunction<{
        response: Awaited<ReturnType<Transaction<TTransaction>> extends GenericTransactionReturn<infer R> ? R : never>;
        isFinalized: boolean | Promise<boolean>;
        blockHash: `0x${string}`;
        msgId: `0x${string}`;
        txHash: `0x${string}`;
    }, Error, ({
        transaction: TTransactionReturn;
    } | SignAndSendOptions<Parameters<TTransaction>>) & SendTransactionParameters, unknown>;
    reset: () => void;
    context: unknown;
    failureCount: number;
    failureReason: Error | null;
    isPaused: boolean;
    submittedAt: number;
    mutateAsync: import('@tanstack/react-query').UseMutateAsyncFunction<{
        response: Awaited<ReturnType<Transaction<TTransaction>> extends GenericTransactionReturn<infer R> ? R : never>;
        isFinalized: boolean | Promise<boolean>;
        blockHash: `0x${string}`;
        msgId: `0x${string}`;
        txHash: `0x${string}`;
    }, Error, ({
        transaction: TTransactionReturn;
    } | SignAndSendOptions<Parameters<TTransaction>>) & SendTransactionParameters, unknown>;
    sendTransaction: import('@tanstack/react-query').UseMutateFunction<{
        response: Awaited<ReturnType<Transaction<TTransaction>> extends GenericTransactionReturn<infer R> ? R : never>;
        isFinalized: boolean | Promise<boolean>;
        blockHash: `0x${string}`;
        msgId: `0x${string}`;
        txHash: `0x${string}`;
    }, Error, ({
        transaction: TTransactionReturn;
    } | SignAndSendOptions<Parameters<TTransaction>>) & SendTransactionParameters, unknown>;
    sendTransactionAsync: import('@tanstack/react-query').UseMutateAsyncFunction<{
        response: Awaited<ReturnType<Transaction<TTransaction>> extends GenericTransactionReturn<infer R> ? R : never>;
        isFinalized: boolean | Promise<boolean>;
        blockHash: `0x${string}`;
        msgId: `0x${string}`;
        txHash: `0x${string}`;
    }, Error, ({
        transaction: TTransactionReturn;
    } | SignAndSendOptions<Parameters<TTransaction>>) & SendTransactionParameters, unknown>;
};
export { useSendProgramTransaction };
export type { UseSendProgramTransactionParameters };