SingleTransactionPlanResult

type SingleTransactionPlanResult<TContext, TTransactionMessage> = Readonly<{
  kind: "single";
  message: TTransactionMessage;
  status: TransactionPlanResultStatus<TContext>;
}>;

A result for a single transaction plan.

This represents the execution result of a SingleTransactionPlan and contains the original transaction message along with its execution status.

You may use the successfulSingleTransactionPlanResult, failedSingleTransactionPlanResult, or canceledSingleTransactionPlanResult helpers to create objects of this type.

Type Parameters

Type ParameterDefault typeDescription
TContext extends TransactionPlanResultContextTransactionPlanResultContextThe type of the context object that may be passed along with successful results
TTransactionMessage extends BaseTransactionMessage & TransactionMessageWithFeePayerBaseTransactionMessage & TransactionMessageWithFeePayerThe type of the transaction message

Examples

Successful result with a transaction and context.

const result = successfulSingleTransactionPlanResult(
  transactionMessage,
  transaction
);
result satisfies SingleTransactionPlanResult;

Failed result with an error.

const result = failedSingleTransactionPlanResult(
  transactionMessage,
  new SolanaError(SOLANA_ERROR__TRANSACTION_ERROR__INSUFFICIENT_FUNDS_FOR_FEE),
);
result satisfies SingleTransactionPlanResult;

Canceled result.

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

See

On this page