successfulSingleTransactionPlanResultFromTransaction

function successfulSingleTransactionPlanResultFromTransaction<
    TContext,
    TTransactionMessage,
>(
    plannedMessage,
    transaction,
    context?,
): SuccessfulSingleTransactionPlanResult<TContext, TTransactionMessage>;

Creates a successful SingleTransactionPlanResult from a transaction message and transaction.

This function creates a single result with a 'successful' status, indicating that the transaction was successfully executed. It also includes the original transaction message, the executed transaction, and an optional context object.

Type Parameters

Type ParameterDefault typeDescription
TContext extends TransactionPlanResultContextTransactionPlanResultContextThe type of the context object
TTransactionMessage extends TransactionMessage & TransactionMessageWithFeePayer<string>TransactionMessage & TransactionMessageWithFeePayer<string>The type of the transaction message

Parameters

ParameterTypeDescription
plannedMessageTTransactionMessageThe original transaction message
transactionTransactionThe successfully executed transaction
context?Omit<BaseTransactionPlanResultContext, "signature" | "transaction"> & TContextOptional context object to be included with the result

Returns

SuccessfulSingleTransactionPlanResult<TContext, TTransactionMessage>

Example

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

See

SingleTransactionPlanResult

On this page