canceledSingleTransactionPlanResult

function canceledSingleTransactionPlanResult<
    TContext,
    TTransactionMessage,
>(
    plannedMessage,
    context?,
): CanceledSingleTransactionPlanResult<TContext, TTransactionMessage>;

Creates a canceled SingleTransactionPlanResult from a transaction message.

This function creates a single result with a 'canceled' status, indicating that the transaction execution was canceled. It includes the original transaction message.

Type Parameters

Type ParameterDefault typeDescription
TContext extends TransactionPlanResultContextTransactionPlanResultContextThe type of the context object
TTransactionMessage extends TransactionMessage & TransactionMessageWithFeePayer<string>TransactionMessage & TransactionMessageWithFeePayer<string>The type of the transaction message

Parameters

ParameterTypeDescription
plannedMessageTTransactionMessageThe original transaction message
context?TContext-

Returns

CanceledSingleTransactionPlanResult<TContext, TTransactionMessage>

Example

const result = canceledSingleTransactionPlanResult(transactionMessage);
result satisfies SingleTransactionPlanResult;

See

SingleTransactionPlanResult

On this page