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.

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

Type Parameters

Type Parameter	Default type	Description
`TContext` extends `TransactionPlanResultContext`	`TransactionPlanResultContext`	The type of the context object that may be passed along with the result.
`TTransactionMessage` extends `TransactionMessage` & `TransactionMessageWithFeePayer`	`TransactionMessage` & `TransactionMessageWithFeePayer`	The type of the transaction message.

Properties

context

context: Readonly<TContext>;

kind

kind: "single";

plannedMessage

plannedMessage: TTransactionMessage;

status

status: "canceled";

CanceledSingleTransactionPlanResult

On this page