assertIsFailedSingleTransactionPlanResult

function assertIsFailedSingleTransactionPlanResult<
    TContext,
    TTransactionMessage,
>(
    plan,
): asserts plan is FailedSingleTransactionPlanResult<
    TContext,
    TTransactionMessage
>;

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

Type Parameters

Type Parameter	Default type
`TContext` extends `TransactionPlanResultContext`	`TransactionPlanResultContext`
`TTransactionMessage` extends `TransactionMessage` & `TransactionMessageWithFeePayer`<`string`>	`TransactionMessage` & `TransactionMessageWithFeePayer`<`string`>

Parameters

Parameter	Type	Description
`plan`	`TransactionPlanResult`<`TContext`, `TTransactionMessage`>	The transaction plan result to assert.

Returns

asserts plan is FailedSingleTransactionPlanResult<TContext, TTransactionMessage>

Throws

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

Example

const result: TransactionPlanResult = failedSingleTransactionPlanResult(message, error);
 
assertIsFailedSingleTransactionPlanResult(result);
console.log(result.error); // TypeScript knows this is a failed result.