Skip to content

Add missing type parameters to TransactionPlanResult types and helpers #1275

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
lorisleiva merged 1 commit into from
Feb 3, 2026
Merged

Add missing type parameters to TransactionPlanResult types and helpers #1275

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/slick-rooms-guess.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@solana/instruction-plans': minor
---

Add missing `TContext`, `TTransactionMessage` and/or `TSingle` type parameters to `TransactionPlanResult` types and helper functions to better preserve type information through narrowing operations.
92 changes: 92 additions & 0 deletions packages/instruction-plans/src/__typetests__/transaction-plan-result-typetest.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -221,6 +221,15 @@ type CustomContext = { customData: string };
plan satisfies SingleTransactionPlanResult;
}
}

// It keeps TSingle information.
{
const plan = null as unknown as SuccessfulTransactionPlanResult;
if (isSingleTransactionPlanResult(plan)) {
plan satisfies SingleTransactionPlanResult;
plan satisfies SuccessfulSingleTransactionPlanResult;
}
}
}

// [DESCRIBE] assertIsSingleTransactionPlanResult
Expand All @@ -231,6 +240,14 @@ type CustomContext = { customData: string };
assertIsSingleTransactionPlanResult(plan);
plan satisfies SingleTransactionPlanResult;
}

// It keeps TSingle information.
{
const plan = null as unknown as SuccessfulTransactionPlanResult;
assertIsSingleTransactionPlanResult(plan);
plan satisfies SingleTransactionPlanResult;
plan satisfies SuccessfulSingleTransactionPlanResult;
}
}

// [DESCRIBE] isSuccessfulSingleTransactionPlanResult
Expand Down Expand Up @@ -305,6 +322,19 @@ type CustomContext = { customData: string };
plan satisfies SequentialTransactionPlanResult;
}
}

// It keeps TSingle information.
{
const plan = null as unknown as SuccessfulTransactionPlanResult;
if (isSequentialTransactionPlanResult(plan)) {
plan satisfies SequentialTransactionPlanResult;
plan satisfies SequentialTransactionPlanResult<
TransactionPlanResultContext,
TransactionMessage & TransactionMessageWithFeePayer,
SuccessfulSingleTransactionPlanResult
>;
}
}
}

// [DESCRIBE] assertIsSequentialTransactionPlanResult
Expand All @@ -315,6 +345,18 @@ type CustomContext = { customData: string };
assertIsSequentialTransactionPlanResult(plan);
plan satisfies SequentialTransactionPlanResult;
}

// It keeps TSingle information.
{
const plan = null as unknown as SuccessfulTransactionPlanResult;
assertIsSequentialTransactionPlanResult(plan);
plan satisfies SequentialTransactionPlanResult;
plan satisfies SequentialTransactionPlanResult<
TransactionPlanResultContext,
TransactionMessage & TransactionMessageWithFeePayer,
SuccessfulSingleTransactionPlanResult
>;
}
}

// [DESCRIBE] isNonDivisibleTransactionPlanResult
Expand All @@ -326,6 +368,19 @@ type CustomContext = { customData: string };
plan satisfies SequentialTransactionPlanResult & { divisible: false };
}
}

// It keeps TSingle information.
{
const plan = null as unknown as SuccessfulTransactionPlanResult;
if (isNonDivisibleSequentialTransactionPlanResult(plan)) {
plan satisfies SequentialTransactionPlanResult & { divisible: false };
plan satisfies SequentialTransactionPlanResult<
TransactionPlanResultContext,
TransactionMessage & TransactionMessageWithFeePayer,
SuccessfulSingleTransactionPlanResult
> & { divisible: false };
}
}
}

// [DESCRIBE] assertIsNonDivisibleSequentialTransactionPlanResult
Expand All @@ -336,6 +391,18 @@ type CustomContext = { customData: string };
assertIsNonDivisibleSequentialTransactionPlanResult(plan);
plan satisfies SequentialTransactionPlanResult & { divisible: false };
}

// It keeps TSingle information.
{
const plan = null as unknown as SuccessfulTransactionPlanResult;
assertIsNonDivisibleSequentialTransactionPlanResult(plan);
plan satisfies SequentialTransactionPlanResult & { divisible: false };
plan satisfies SequentialTransactionPlanResult<
TransactionPlanResultContext,
TransactionMessage & TransactionMessageWithFeePayer,
SuccessfulSingleTransactionPlanResult
> & { divisible: false };
}
}

// [DESCRIBE] isParallelTransactionPlanResult
Expand All @@ -347,6 +414,19 @@ type CustomContext = { customData: string };
plan satisfies ParallelTransactionPlanResult;
}
}

// It keeps TSingle information.
{
const plan = null as unknown as SuccessfulTransactionPlanResult;
if (isParallelTransactionPlanResult(plan)) {
plan satisfies ParallelTransactionPlanResult;
plan satisfies ParallelTransactionPlanResult<
TransactionPlanResultContext,
TransactionMessage & TransactionMessageWithFeePayer,
SuccessfulSingleTransactionPlanResult
>;
}
}
}

// [DESCRIBE] assertIsParallelTransactionPlanResult
Expand All @@ -357,6 +437,18 @@ type CustomContext = { customData: string };
assertIsParallelTransactionPlanResult(plan);
plan satisfies ParallelTransactionPlanResult;
}

// It keeps TSingle information.
{
const plan = null as unknown as SuccessfulTransactionPlanResult;
assertIsParallelTransactionPlanResult(plan);
plan satisfies ParallelTransactionPlanResult;
plan satisfies ParallelTransactionPlanResult<
TransactionPlanResultContext,
TransactionMessage & TransactionMessageWithFeePayer,
SuccessfulSingleTransactionPlanResult
>;
}
}

// [DESCRIBE] isSuccessfulTransactionPlanResult
Expand Down
Loading