SingleTransactionPlanResult

type SingleTransactionPlanResult<TContext, TTransactionMessage> = 
  | CanceledSingleTransactionPlanResult<TContext, TTransactionMessage>
  | FailedSingleTransactionPlanResult<TContext, TTransactionMessage>
| SuccessfulSingleTransactionPlanResult<TContext, TTransactionMessage>;

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 successfulSingleTransactionPlanResultFromTransaction, 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 results
TTransactionMessage extends TransactionMessage & TransactionMessageWithFeePayerTransactionMessage & TransactionMessageWithFeePayerThe type of the transaction message

Examples

Successful result with a transaction and context.

const result = successfulSingleTransactionPlanResultFromTransaction(
  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