assertIsSuccessfulSingleTransactionPlanResult

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

Asserts that the given transaction plan result is a successful SingleTransactionPlanResult.

Parameters

ParameterTypeDescription
planTransactionPlanResultThe transaction plan result to assert.

Returns

asserts plan is SuccessfulSingleTransactionPlanResult<TransactionPlanResultContext>

Throws

Throws a SolanaError with code SOLANA_ERROR__INSTRUCTION_PLANS__UNEXPECTED_TRANSACTION_PLAN_RESULT if the result is not a successful single transaction plan result.

Example

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

See

On this page