TransactionPlanInput

type TransactionPlanInput = 
  | SingleTransactionPlan["message"]
  | TransactionPlan
  | readonly (
  | SingleTransactionPlan["message"]
  | TransactionPlan)[];

A flexible input type that can be used to create a TransactionPlan.

This type accepts:

• A single TransactionMessage with a fee payer.
• An existing TransactionPlan.
• An array of transaction messages and/or transaction plans.

Use the parseTransactionPlanInput function to convert this input into a proper TransactionPlan.

Examples

Using a single transaction message.

const input: TransactionPlanInput = myTransactionMessage;

Use as argument type in a function that will parse it into a TransactionPlan.

function myFunction(input: TransactionPlanInput) {
  const plan = parseTransactionPlanInput(input);
  // Use the plan...
}

See

• parseTransactionPlanInput
• TransactionPlan