isSuccessfulSingleTransactionPlanResult

function isSuccessfulSingleTransactionPlanResult(
    plan,
): plan is SuccessfulSingleTransactionPlanResult<TransactionPlanResultContext>;

Checks if the given transaction plan result is a successful SingleTransactionPlanResult.

Parameters

ParameterTypeDescription
planTransactionPlanResultThe transaction plan result to check.

Returns

plan is SuccessfulSingleTransactionPlanResult<TransactionPlanResultContext>

true if the result is a successful single transaction plan result, false otherwise.

Example

const result: TransactionPlanResult = successfulSingleTransactionPlanResult(message, transaction);
 
if (isSuccessfulSingleTransactionPlanResult(result)) {
  console.log(result.status.signature); // TypeScript knows this is a successful result.
}

See

On this page