SequentialTransactionPlanResult

type SequentialTransactionPlanResult<TContext, TTransactionMessage, TSingle> = Readonly<{
  divisible: boolean;
  kind: "sequential";
  plans: TransactionPlanResult<TContext, TTransactionMessage, TSingle>[];
  planType: "transactionPlanResult";
}>;

A result for a sequential transaction plan.

This represents the execution result of a SequentialTransactionPlan and contains child results that were executed sequentially. It also retains the divisibility property from the original plan.

You may use the sequentialTransactionPlanResult and nonDivisibleSequentialTransactionPlanResult helpers to create objects of this type.

Type Parameters

Type ParameterDefault typeDescription
TContext extends TransactionPlanResultContextTransactionPlanResultContextThe type of the context object that may be passed along with results
TTransactionMessage extends TransactionMessage & TransactionMessageWithFeePayerTransactionMessage & TransactionMessageWithFeePayerThe type of the transaction message
TSingle extends SingleTransactionPlanResult<TContext, TTransactionMessage>SingleTransactionPlanResult<TContext, TTransactionMessage>The type of single transaction plan results in this tree

Examples

const result = sequentialTransactionPlanResult([
  singleResultA,
  singleResultB,
]);
result satisfies SequentialTransactionPlanResult;

Non-divisible sequential result.

const result = nonDivisibleSequentialTransactionPlanResult([
  singleResultA,
  singleResultB,
]);
result satisfies SequentialTransactionPlanResult & { divisible: false };

See

On this page