CanceledSingleTransactionPlanResult

type CanceledSingleTransactionPlanResult<TContext, TTransactionMessage> = object;

A SingleTransactionPlanResult with a 'canceled' status.

This type represents a single transaction whose execution was canceled before it could complete. It includes the original planned message and a context object containing the fields from BaseTransactionPlanResultContext — namely optional TransactionMessage, Signature, and Transaction fields that may or may not be populated depending on how far execution progressed before cancellation.

You may use the canceledSingleTransactionPlanResult helper to create objects of this type.

Example

Creating a canceled result from a transaction message.

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

See

• canceledSingleTransactionPlanResult
• isCanceledSingleTransactionPlanResult
• assertIsCanceledSingleTransactionPlanResult

Type Parameters

Properties

context

context: Readonly<BaseTransactionPlanResultContext & TContext>;

kind

kind: "single";

plannedMessage

plannedMessage: TTransactionMessage;

planType

planType: "transactionPlanResult";

status

status: "canceled";