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. That context defaults to TransactionPlanResultContextWithSignature — a required transaction Signature, and optionally the TransactionMessage and the full Transaction object — but a different TContext may drop the signature requirement entirely.

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

• successfulSingleTransactionPlanResultFromTransaction
• successfulSingleTransactionPlanResult
• isSuccessfulSingleTransactionPlanResult
• assertIsSuccessfulSingleTransactionPlanResult

Type Parameters

Properties

context

context: Readonly<TContext>;

kind

kind: "single";

plannedMessage

plannedMessage: TTransactionMessage;

planType

planType: "transactionPlanResult";

status

status: "successful";