@solana/instruction-plans 5.0.1-canary-20251119203851 → 5.1.0-canary-20251203213248

package/dist/types/transaction-plan-result.d.ts

@@ -1,4 +1,4 @@
-import { SolanaError } from '@solana/errors';
+import { Signature } from '@solana/keys';
 import { BaseTransactionMessage, TransactionMessageWithFeePayer } from '@solana/transaction-messages';
 import { Transaction } from '@solana/transactions';
 /**
@@ -153,9 +153,10 @@ export type SingleTransactionPlanResult<TContext extends TransactionPlanResultCo
 export type TransactionPlanResultStatus<TContext extends TransactionPlanResultContext = TransactionPlanResultContext> = Readonly<{
     context: TContext;
     kind: 'successful';
-    transaction: Transaction;
+    signature: Signature;
+    transaction?: Transaction;
 }> | Readonly<{
-    error: SolanaError;
+    error: Error;
     kind: 'failed';
 }> | Readonly<{
     kind: 'canceled';
@@ -254,6 +255,31 @@ export declare function parallelTransactionPlanResult<TContext extends Transacti
  * @see {@link SingleTransactionPlanResult}
  */
 export declare function successfulSingleTransactionPlanResult<TContext extends TransactionPlanResultContext = TransactionPlanResultContext, TTransactionMessage extends BaseTransactionMessage & TransactionMessageWithFeePayer = BaseTransactionMessage & TransactionMessageWithFeePayer>(transactionMessage: TTransactionMessage, transaction: Transaction, context?: TContext): SingleTransactionPlanResult<TContext, TTransactionMessage>;
+/**
+ * Creates a successful {@link SingleTransactionPlanResult} from a transaction message and signature.
+ *
+ * This function creates a single result with a 'successful' status, indicating that
+ * the transaction was successfully executed. It also includes the original transaction
+ * message, the signature of the executed transaction, and an optional context object.
+ *
+ * @template TContext - The type of the context object
+ * @template TTransactionMessage - The type of the transaction message
+ * @param transactionMessage - The original transaction message
+ * @param signature - The signature of the successfully executed transaction
+ * @param context - Optional context object to be included with the result
+ *
+ * @example
+ * ```ts
+ * const result = successfulSingleTransactionPlanResult(
+ *   transactionMessage,
+ *   signature
+ * );
+ * result satisfies SingleTransactionPlanResult;
+ * ```
+ *
+ * @see {@link SingleTransactionPlanResult}
+ */
+export declare function successfulSingleTransactionPlanResultFromSignature<TContext extends TransactionPlanResultContext = TransactionPlanResultContext, TTransactionMessage extends BaseTransactionMessage & TransactionMessageWithFeePayer = BaseTransactionMessage & TransactionMessageWithFeePayer>(transactionMessage: TTransactionMessage, signature: Signature, context?: TContext): SingleTransactionPlanResult<TContext, TTransactionMessage>;
 /**
  * Creates a failed {@link SingleTransactionPlanResult} from a transaction message and error.
  *
@@ -280,7 +306,7 @@ export declare function successfulSingleTransactionPlanResult<TContext extends T
  *
  * @see {@link SingleTransactionPlanResult}
  */
-export declare function failedSingleTransactionPlanResult<TContext extends TransactionPlanResultContext = TransactionPlanResultContext, TTransactionMessage extends BaseTransactionMessage & TransactionMessageWithFeePayer = BaseTransactionMessage & TransactionMessageWithFeePayer>(transactionMessage: TTransactionMessage, error: SolanaError): SingleTransactionPlanResult<TContext, TTransactionMessage>;
+export declare function failedSingleTransactionPlanResult<TContext extends TransactionPlanResultContext = TransactionPlanResultContext, TTransactionMessage extends BaseTransactionMessage & TransactionMessageWithFeePayer = BaseTransactionMessage & TransactionMessageWithFeePayer>(transactionMessage: TTransactionMessage, error: Error): SingleTransactionPlanResult<TContext, TTransactionMessage>;
 /**
  * Creates a canceled {@link SingleTransactionPlanResult} from a transaction message.
  *
@@ -300,4 +326,53 @@ export declare function failedSingleTransactionPlanResult<TContext extends Trans
  * @see {@link SingleTransactionPlanResult}
  */
 export declare function canceledSingleTransactionPlanResult<TContext extends TransactionPlanResultContext = TransactionPlanResultContext, TTransactionMessage extends BaseTransactionMessage & TransactionMessageWithFeePayer = BaseTransactionMessage & TransactionMessageWithFeePayer>(transactionMessage: TTransactionMessage): SingleTransactionPlanResult<TContext, TTransactionMessage>;
+/**
+ * Flattens a {@link TransactionPlanResult} into an array of {@link SingleTransactionPlanResult}.
+ * @param result The transaction plan result to flatten
+ * @returns An array of single transaction plan results
+ */
+export declare function flattenTransactionPlanResult(result: TransactionPlanResult): SingleTransactionPlanResult[];
+/**
+ * A {@link SingleTransactionPlanResult} with 'successful' status.
+ */
+export type SuccessfulSingleTransactionPlanResult = SingleTransactionPlanResult & {
+    status: {
+        kind: 'successful';
+    };
+};
+/**
+ * A {@link SingleTransactionPlanResult} with 'failed' status.
+ */
+export type FailedSingleTransactionPlanResult = SingleTransactionPlanResult & {
+    status: {
+        kind: 'failed';
+    };
+};
+/**
+ * A {@link SingleTransactionPlanResult} with 'canceled' status.
+ */
+export type CanceledSingleTransactionPlanResult = SingleTransactionPlanResult & {
+    status: {
+        kind: 'canceled';
+    };
+};
+/**
+ * A summary of a {@link TransactionPlanResult}, categorizing transactions by their execution status.
+ * - `successful`: Indicates whether all transactions were successful (i.e., no failed or canceled transactions).
+ * - `successfulTransactions`: An array of successful transactions, each including its signature.
+ * - `failedTransactions`: An array of failed transactions, each including the error that caused the failure.
+ * - `canceledTransactions`: An array of canceled transactions.
+ */
+export type TransactionPlanResultSummary = Readonly<{
+    canceledTransactions: CanceledSingleTransactionPlanResult[];
+    failedTransactions: FailedSingleTransactionPlanResult[];
+    successful: boolean;
+    successfulTransactions: SuccessfulSingleTransactionPlanResult[];
+}>;
+/**
+ * Summarize a {@link TransactionPlanResult} into a {@link TransactionPlanResultSummary}.
+ * @param result The transaction plan result to summarize
+ * @returns A summary of the transaction plan result
+ */
+export declare function summarizeTransactionPlanResult(result: TransactionPlanResult): TransactionPlanResultSummary;
 //# sourceMappingURL=transaction-plan-result.d.ts.map

package/dist/types/transaction-plan-result.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"transaction-plan-result.d.ts","sourceRoot":"","sources":["../../src/transaction-plan-result.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,EAAE,sBAAsB,EAAE,8BAA8B,EAAE,MAAM,8BAA8B,CAAC;AACtG,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AAEnD;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,MAAM,qBAAqB,CAAC,QAAQ,SAAS,4BAA4B,GAAG,4BAA4B,IACxG,6BAA6B,CAAC,QAAQ,CAAC,GACvC,+BAA+B,CAAC,QAAQ,CAAC,GACzC,2BAA2B,CAAC,QAAQ,CAAC,CAAC;AAE5C,yEAAyE;AACzE,MAAM,MAAM,4BAA4B,GAAG,MAAM,CAAC,MAAM,GAAG,MAAM,GAAG,MAAM,EAAE,OAAO,CAAC,CAAC;AAErF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACH,MAAM,MAAM,+BAA+B,CACvC,QAAQ,SAAS,4BAA4B,GAAG,4BAA4B,IAC5E,QAAQ,CAAC;IACT,SAAS,EAAE,OAAO,CAAC;IACnB,IAAI,EAAE,YAAY,CAAC;IACnB,KAAK,EAAE,qBAAqB,CAAC,QAAQ,CAAC,EAAE,CAAC;CAC5C,CAAC,CAAC;AAEH;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,MAAM,6BAA6B,CACrC,QAAQ,SAAS,4BAA4B,GAAG,4BAA4B,IAC5E,QAAQ,CAAC;IACT,IAAI,EAAE,UAAU,CAAC;IACjB,KAAK,EAAE,qBAAqB,CAAC,QAAQ,CAAC,EAAE,CAAC;CAC5C,CAAC,CAAC;AAEH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2CG;AACH,MAAM,MAAM,2BAA2B,CACnC,QAAQ,SAAS,4BAA4B,GAAG,4BAA4B,EAC5E,mBAAmB,SAAS,sBAAsB,GAAG,8BAA8B,GAAG,sBAAsB,GACxG,8BAA8B,IAClC,QAAQ,CAAC;IACT,IAAI,EAAE,QAAQ,CAAC;IACf,OAAO,EAAE,mBAAmB,CAAC;IAC7B,MAAM,EAAE,2BAA2B,CAAC,QAAQ,CAAC,CAAC;CACjD,CAAC,CAAC;AAEH;;;;;;;;;;GAUG;AACH,MAAM,MAAM,2BAA2B,CAAC,QAAQ,SAAS,4BAA4B,GAAG,4BAA4B,IAC9G,QAAQ,CAAC;IAAE,OAAO,EAAE,QAAQ,CAAC;IAAC,IAAI,EAAE,YAAY,CAAC;IAAC,WAAW,EAAE,WAAW,CAAA;CAAE,CAAC,GAC7E,QAAQ,CAAC;IAAE,KAAK,EAAE,WAAW,CAAC;IAAC,IAAI,EAAE,QAAQ,CAAA;CAAE,CAAC,GAChD,QAAQ,CAAC;IAAE,IAAI,EAAE,UAAU,CAAA;CAAE,CAAC,CAAC;AAErC;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,wBAAgB,+BAA+B,CAC3C,QAAQ,SAAS,4BAA4B,GAAG,4BAA4B,EAC9E,KAAK,EAAE,qBAAqB,CAAC,QAAQ,CAAC,EAAE,GAAG,+BAA+B,CAAC,QAAQ,CAAC,GAAG;IAAE,SAAS,EAAE,IAAI,CAAA;CAAE,CAE3G;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,wBAAgB,2CAA2C,CACvD,QAAQ,SAAS,4BAA4B,GAAG,4BAA4B,EAC9E,KAAK,EAAE,qBAAqB,CAAC,QAAQ,CAAC,EAAE,GAAG,+BAA+B,CAAC,QAAQ,CAAC,GAAG;IAAE,SAAS,EAAE,KAAK,CAAA;CAAE,CAE5G;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,6BAA6B,CACzC,QAAQ,SAAS,4BAA4B,GAAG,4BAA4B,EAC9E,KAAK,EAAE,qBAAqB,CAAC,QAAQ,CAAC,EAAE,GAAG,6BAA6B,CAAC,QAAQ,CAAC,CAEnF;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,wBAAgB,qCAAqC,CACjD,QAAQ,SAAS,4BAA4B,GAAG,4BAA4B,EAC5E,mBAAmB,SAAS,sBAAsB,GAAG,8BAA8B,GAAG,sBAAsB,GACxG,8BAA8B,EAElC,kBAAkB,EAAE,mBAAmB,EACvC,WAAW,EAAE,WAAW,EACxB,OAAO,CAAC,EAAE,QAAQ,GACnB,2BAA2B,CAAC,QAAQ,EAAE,mBAAmB,CAAC,CAM5D;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,wBAAgB,iCAAiC,CAC7C,QAAQ,SAAS,4BAA4B,GAAG,4BAA4B,EAC5E,mBAAmB,SAAS,sBAAsB,GAAG,8BAA8B,GAAG,sBAAsB,GACxG,8BAA8B,EAElC,kBAAkB,EAAE,mBAAmB,EACvC,KAAK,EAAE,WAAW,GACnB,2BAA2B,CAAC,QAAQ,EAAE,mBAAmB,CAAC,CAM5D;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,mCAAmC,CAC/C,QAAQ,SAAS,4BAA4B,GAAG,4BAA4B,EAC5E,mBAAmB,SAAS,sBAAsB,GAAG,8BAA8B,GAAG,sBAAsB,GACxG,8BAA8B,EACpC,kBAAkB,EAAE,mBAAmB,GAAG,2BAA2B,CAAC,QAAQ,EAAE,mBAAmB,CAAC,CAMrG"}
+{"version":3,"file":"transaction-plan-result.d.ts","sourceRoot":"","sources":["../../src/transaction-plan-result.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AACzC,OAAO,EAAE,sBAAsB,EAAE,8BAA8B,EAAE,MAAM,8BAA8B,CAAC;AACtG,OAAO,EAA+B,WAAW,EAAE,MAAM,sBAAsB,CAAC;AAEhF;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,MAAM,qBAAqB,CAAC,QAAQ,SAAS,4BAA4B,GAAG,4BAA4B,IACxG,6BAA6B,CAAC,QAAQ,CAAC,GACvC,+BAA+B,CAAC,QAAQ,CAAC,GACzC,2BAA2B,CAAC,QAAQ,CAAC,CAAC;AAE5C,yEAAyE;AACzE,MAAM,MAAM,4BAA4B,GAAG,MAAM,CAAC,MAAM,GAAG,MAAM,GAAG,MAAM,EAAE,OAAO,CAAC,CAAC;AAErF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACH,MAAM,MAAM,+BAA+B,CACvC,QAAQ,SAAS,4BAA4B,GAAG,4BAA4B,IAC5E,QAAQ,CAAC;IACT,SAAS,EAAE,OAAO,CAAC;IACnB,IAAI,EAAE,YAAY,CAAC;IACnB,KAAK,EAAE,qBAAqB,CAAC,QAAQ,CAAC,EAAE,CAAC;CAC5C,CAAC,CAAC;AAEH;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,MAAM,6BAA6B,CACrC,QAAQ,SAAS,4BAA4B,GAAG,4BAA4B,IAC5E,QAAQ,CAAC;IACT,IAAI,EAAE,UAAU,CAAC;IACjB,KAAK,EAAE,qBAAqB,CAAC,QAAQ,CAAC,EAAE,CAAC;CAC5C,CAAC,CAAC;AAEH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2CG;AACH,MAAM,MAAM,2BAA2B,CACnC,QAAQ,SAAS,4BAA4B,GAAG,4BAA4B,EAC5E,mBAAmB,SAAS,sBAAsB,GAAG,8BAA8B,GAAG,sBAAsB,GACxG,8BAA8B,IAClC,QAAQ,CAAC;IACT,IAAI,EAAE,QAAQ,CAAC;IACf,OAAO,EAAE,mBAAmB,CAAC;IAC7B,MAAM,EAAE,2BAA2B,CAAC,QAAQ,CAAC,CAAC;CACjD,CAAC,CAAC;AAEH;;;;;;;;;;GAUG;AACH,MAAM,MAAM,2BAA2B,CAAC,QAAQ,SAAS,4BAA4B,GAAG,4BAA4B,IAC9G,QAAQ,CAAC;IAAE,OAAO,EAAE,QAAQ,CAAC;IAAC,IAAI,EAAE,YAAY,CAAC;IAAC,SAAS,EAAE,SAAS,CAAC;IAAC,WAAW,CAAC,EAAE,WAAW,CAAA;CAAE,CAAC,GACpG,QAAQ,CAAC;IAAE,KAAK,EAAE,KAAK,CAAC;IAAC,IAAI,EAAE,QAAQ,CAAA;CAAE,CAAC,GAC1C,QAAQ,CAAC;IAAE,IAAI,EAAE,UAAU,CAAA;CAAE,CAAC,CAAC;AAErC;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,wBAAgB,+BAA+B,CAC3C,QAAQ,SAAS,4BAA4B,GAAG,4BAA4B,EAC9E,KAAK,EAAE,qBAAqB,CAAC,QAAQ,CAAC,EAAE,GAAG,+BAA+B,CAAC,QAAQ,CAAC,GAAG;IAAE,SAAS,EAAE,IAAI,CAAA;CAAE,CAE3G;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,wBAAgB,2CAA2C,CACvD,QAAQ,SAAS,4BAA4B,GAAG,4BAA4B,EAC9E,KAAK,EAAE,qBAAqB,CAAC,QAAQ,CAAC,EAAE,GAAG,+BAA+B,CAAC,QAAQ,CAAC,GAAG;IAAE,SAAS,EAAE,KAAK,CAAA;CAAE,CAE5G;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,6BAA6B,CACzC,QAAQ,SAAS,4BAA4B,GAAG,4BAA4B,EAC9E,KAAK,EAAE,qBAAqB,CAAC,QAAQ,CAAC,EAAE,GAAG,6BAA6B,CAAC,QAAQ,CAAC,CAEnF;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,wBAAgB,qCAAqC,CACjD,QAAQ,SAAS,4BAA4B,GAAG,4BAA4B,EAC5E,mBAAmB,SAAS,sBAAsB,GAAG,8BAA8B,GAAG,sBAAsB,GACxG,8BAA8B,EAElC,kBAAkB,EAAE,mBAAmB,EACvC,WAAW,EAAE,WAAW,EACxB,OAAO,CAAC,EAAE,QAAQ,GACnB,2BAA2B,CAAC,QAAQ,EAAE,mBAAmB,CAAC,CAW5D;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,wBAAgB,kDAAkD,CAC9D,QAAQ,SAAS,4BAA4B,GAAG,4BAA4B,EAC5E,mBAAmB,SAAS,sBAAsB,GAAG,8BAA8B,GAAG,sBAAsB,GACxG,8BAA8B,EAElC,kBAAkB,EAAE,mBAAmB,EACvC,SAAS,EAAE,SAAS,EACpB,OAAO,CAAC,EAAE,QAAQ,GACnB,2BAA2B,CAAC,QAAQ,EAAE,mBAAmB,CAAC,CAM5D;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,wBAAgB,iCAAiC,CAC7C,QAAQ,SAAS,4BAA4B,GAAG,4BAA4B,EAC5E,mBAAmB,SAAS,sBAAsB,GAAG,8BAA8B,GAAG,sBAAsB,GACxG,8BAA8B,EACpC,kBAAkB,EAAE,mBAAmB,EAAE,KAAK,EAAE,KAAK,GAAG,2BAA2B,CAAC,QAAQ,EAAE,mBAAmB,CAAC,CAMnH;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,mCAAmC,CAC/C,QAAQ,SAAS,4BAA4B,GAAG,4BAA4B,EAC5E,mBAAmB,SAAS,sBAAsB,GAAG,8BAA8B,GAAG,sBAAsB,GACxG,8BAA8B,EACpC,kBAAkB,EAAE,mBAAmB,GAAG,2BAA2B,CAAC,QAAQ,EAAE,mBAAmB,CAAC,CAMrG;AAED;;;;GAIG;AACH,wBAAgB,4BAA4B,CAAC,MAAM,EAAE,qBAAqB,GAAG,2BAA2B,EAAE,CAezG;AAED;;GAEG;AACH,MAAM,MAAM,qCAAqC,GAAG,2BAA2B,GAAG;IAAE,MAAM,EAAE;QAAE,IAAI,EAAE,YAAY,CAAA;KAAE,CAAA;CAAE,CAAC;AAErH;;GAEG;AACH,MAAM,MAAM,iCAAiC,GAAG,2BAA2B,GAAG;IAAE,MAAM,EAAE;QAAE,IAAI,EAAE,QAAQ,CAAA;KAAE,CAAA;CAAE,CAAC;AAE7G;;GAEG;AACH,MAAM,MAAM,mCAAmC,GAAG,2BAA2B,GAAG;IAAE,MAAM,EAAE;QAAE,IAAI,EAAE,UAAU,CAAA;KAAE,CAAA;CAAE,CAAC;AAEjH;;;;;;GAMG;AACH,MAAM,MAAM,4BAA4B,GAAG,QAAQ,CAAC;IAChD,oBAAoB,EAAE,mCAAmC,EAAE,CAAC;IAC5D,kBAAkB,EAAE,iCAAiC,EAAE,CAAC;IACxD,UAAU,EAAE,OAAO,CAAC;IACpB,sBAAsB,EAAE,qCAAqC,EAAE,CAAC;CACnE,CAAC,CAAC;AAEH;;;;GAIG;AACH,wBAAgB,8BAA8B,CAAC,MAAM,EAAE,qBAAqB,GAAG,4BAA4B,CA8B1G"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@solana/instruction-plans",
-  "version": "5.0.1-canary-20251119203851",
+  "version": "5.1.0-canary-20251203213248",
   "description": "Construct, plan and execute transactions from multiple instructions.",
   "homepage": "https://www.solanakit.com/api#solanainstruction-plans",
   "exports": {
@@ -55,11 +55,12 @@
     "maintained node versions"
   ],
   "dependencies": {
-    "@solana/errors": "5.0.1-canary-20251119203851",
-    "@solana/instructions": "5.0.1-canary-20251119203851",
-    "@solana/promises": "5.0.1-canary-20251119203851",
-    "@solana/transaction-messages": "5.0.1-canary-20251119203851",
-    "@solana/transactions": "5.0.1-canary-20251119203851"
+    "@solana/errors": "5.1.0-canary-20251203213248",
+    "@solana/instructions": "5.1.0-canary-20251203213248",
+    "@solana/keys": "5.1.0-canary-20251203213248",
+    "@solana/promises": "5.1.0-canary-20251203213248",
+    "@solana/transaction-messages": "5.1.0-canary-20251203213248",
+    "@solana/transactions": "5.1.0-canary-20251203213248"
   },
   "peerDependencies": {
     "typescript": ">=5.3.3"