SuccessfulSingleTransactionPlanResult

type SuccessfulSingleTransactionPlanResult<TContext, TTransactionMessage> = object;

A SingleTransactionPlanResult with a 'successful' status.

This type represents a single transaction that was successfully executed. It includes the original planned message and a context object containing the fields from SuccessfulBaseTransactionPlanResultContext — namely a required transaction Signature, and optionally the TransactionMessage and the full Transaction object.

You may use the successfulSingleTransactionPlanResultFromTransaction or successfulSingleTransactionPlanResult helpers to create objects of this type.

Example

Creating a successful result from a transaction.

const result = successfulSingleTransactionPlanResultFromTransaction(
  transactionMessage,
  transaction,
);
result satisfies SuccessfulSingleTransactionPlanResult;
result.context.signature; // The transaction signature.

See

Type Parameters

Type ParameterDefault typeDescription
TContext extends TransactionPlanResultContextTransactionPlanResultContextThe type of the context object that may be passed along with the result.
TTransactionMessage extends TransactionMessage & TransactionMessageWithFeePayerTransactionMessage & TransactionMessageWithFeePayerThe type of the transaction message.

Properties

context

context: Readonly<SuccessfulBaseTransactionPlanResultContext & TContext>;

kind

kind: "single";

plannedMessage

plannedMessage: TTransactionMessage;

planType

planType: "transactionPlanResult";

status

status: "successful";

On this page