Deprecate the cause property on SOLANA_ERROR__INSTRUCTION_PLANS__FAILED_TO_EXECUTE_TRANSACTION_PLAN#1260
Merged
Conversation
…ILED_TO_EXECUTE_TRANSACTION_PLAN
🦋 Changeset detectedLatest commit: 352933c 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 |
![github-code-quality[bot]](https://avatars.githubusercontent.com/u/9919?s=60&v=4){kind=small}
BundleMonFiles updated (3)
Unchanged files (133)
Total files change +82B +0.02% Final result: ✅ View report in BundleMon website ➡️ |
Contributor
|
Documentation Preview: https://kit-docs-rg5h7cn1u-anza-tech.vercel.app |
Member
Author
|
Refactored to use overloads instead of a conditional type, and the weird bug has gone away! 
|
mcintyre94
force-pushed
the
plan-cause
branch
from
b6775f1 to
352933c
Compare
Contributor
|
🔎💬 Inkeep AI search and chat service is syncing content for source 'Solana Kit Docs' |
Merged
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
The
causeproperty on this error includes only the first error in a plan result, and is not how we want developers to handle errors with transaction plans. ThetransactionPlanResultincludes all failed/canceled results and has enough information for any recovery approach.Summary of Changes
SOLANA_ERROR__INSTRUCTION_PLANS__FAILED_TO_EXECUTE_TRANSACTION_PLANSolanaErrorWithDeprecatedCausewhich replacescauseso that it is marked as deprecatedisSolanaErrorwhen the code isSOLANA_ERROR__INSTRUCTION_PLANS__FAILED_TO_EXECUTE_TRANSACTION_PLAN(or any code we add in future toSolanaErrorCodeWithDeprecatedCause)This PR does not change how we currently set
cause, which would be a breaking change, but consumers will see it marked deprecated for this function:Caveat: we may not want to merge this because there's a bug in... something (VSCode?) that's causing the deprecation text (but not strikethrough decoration) to show on errors where it shouldn't: