Add planType to distinguish between InstructionPlan, TransactionPlan and TransactionPlanResult#1309
Merged
Conversation
🦋 Changeset detectedLatest commit: 6711d7a The changes in this PR will be included in the next version bump. This PR includes changesets to release 43 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
This was referenced Feb 3, 2026
Member
Author
This was referenced Feb 3, 2026
BundleMonFiles updated (4)
Unchanged files (132)
Total files change +677B +0.17% Final result: ✅ View report in BundleMon website ➡️ |
Contributor
|
Documentation Preview: https://kit-docs-o7rfhauv4-anza-tech.vercel.app |
mcintyre94
approved these changes
Feb 3, 2026
Member
mcintyre94
left a comment
mcintyre94
left a comment
There was a problem hiding this comment.
Looks great! I prefer an explicit extra key like this to changing the name of kind for each one because I think it's clearer.
lorisleiva
changed the base branch from
02-03-add_documentation_guide_link_to_instruction_plan_readme
to
graphite-base/1309
…Plan` and `TransactionPlanResult`
lorisleiva
force-pushed
the
graphite-base/1309
branch
from
abbe5f1 to
91cdb71
Compare
lorisleiva
force-pushed
the
02-03-add_plantype_to_distinguish_between_instructionplan_transactionplan_and_transactionplanresult_
branch
from
003dc4e to
6711d7a
Compare
lorisleiva
deleted the
02-03-add_plantype_to_distinguish_between_instructionplan_transactionplan_and_transactionplanresult_
branch
Contributor
|
🔎💬 Inkeep AI search and chat service is syncing content for source 'Solana Kit Docs' |
This was referenced Feb 3, 2026
Merged
Closed
Contributor
|
Because there has been no activity on this PR for 14 days since it was merged, it has been automatically locked. Please open a new issue if it requires a follow up. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Problem
There is currently now way to distinguish between
InstructionPlan,TransactionPlanandTransactionPlanResulttypes without inspecting the whole tree structure recursively and identifying the types of their leaves.Summary of Changes
This PR adds a new
planTypeproperty to allInstructionPlan,TransactionPlan, andTransactionPlanResulttypes to distinguish them from each other at runtime. This property is a string literal with the value'instructionPlan','transactionPlan', or'transactionPlanResult'respectively.This PR also adds new type guard functions that make use of that new property:
isInstructionPlan,isTransactionPlan, andisTransactionPlanResult.This means a function can now request an argument such as
InstructionPlan | TransactionPlanand distinguish between them to tackle them differently. This will be useful in our instruction plan Kit Plugins as it will allow consumers to also passTransactionPlansand skip the planning phase.Alternatives
I went with
planTypefor the discriminator because we already havekindto distinguish between the different kinds of plans inside a tree structure. Do let me know if{ planType, kind }is clear enough as a "discriminator pair".Alternatively, instead of
{ planType, kind }we could have a differentkindname depending on the type of plan. For instance,instructionPlanKind,transactionPlanKindandtransactionPlanResultKind. The property key would then be used to distinguish the plan types and the value to distinguish between the different structures inside that plan type.