assertIsSequentialTransactionPlan

function assertIsSequentialTransactionPlan(
    plan,
): asserts plan is Readonly<{
    divisible: boolean;
    kind: 'sequential';
    plans: TransactionPlan[];
    planType: 'transactionPlan';
}>;

Asserts that the given transaction plan is a SequentialTransactionPlan.

Parameters

Parameter	Type	Description
`plan`	`TransactionPlan`	The transaction plan to assert.

Returns

asserts plan is Readonly<{ divisible: boolean; kind: "sequential"; plans: TransactionPlan[]; planType: "transactionPlan" }>

Throws

Throws a SolanaError with code SOLANA_ERROR__INSTRUCTION_PLANS__UNEXPECTED_TRANSACTION_PLAN if the plan is not a sequential transaction plan.

Example

const plan: TransactionPlan = sequentialTransactionPlan([messageA, messageB]);
 
assertIsSequentialTransactionPlan(plan);
console.log(plan.divisible); // TypeScript knows this is a SequentialTransactionPlan.

See