Skip to content

Document the instruction display API in the README#1019

Open
lorisleiva wants to merge 1 commit into
06-25-add_the_instruction_display_orchestrator_and_public_apifrom
07-07-document_the_instruction_display_api_in_the_readme
Open

Document the instruction display API in the README#1019
lorisleiva wants to merge 1 commit into
06-25-add_the_instruction_display_orchestrator_and_public_apifrom
07-07-document_the_instruction_display_api_in_the_readme

Conversation

@lorisleiva

Copy link
Copy Markdown
Member

This PR documents the clear-signing instruction display API in the @codama/dynamic-instructions README. It adds an Instruction display section covering getInstructionDisplay and getInstructionDisplayFromParsedInstruction, the InstructionDisplay result shape (intent, interpolatedIntent, fields), and the fetchAccountData option for resolving account-sourced values, noting that address presentation is left to the renderer. No changeset is included, consistent with the rest of the 1.7.0 stack.

@changeset-bot

changeset-bot Bot commented Jul 7, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: 30d0336

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link
Copy Markdown
Member Author

Warning

This pull request is not mergeable via GitHub because a downstack PR is open. Once all requirements are satisfied, merge this PR as a stack on Graphite.
Learn more

This stack of pull requests is managed by Graphite. Learn more about stacking.

@lorisleiva lorisleiva marked this pull request as ready for review July 7, 2026 11:51
This PR documents the clear-signing instruction display API in the @codama/dynamic-instructions README. It adds an Instruction display section covering getInstructionDisplay and getInstructionDisplayFromParsedInstruction, the InstructionDisplay result shape (intent, interpolatedIntent, fields), and the fetchAccountData option for resolving account-sourced values, noting that address presentation is left to the renderer. No changeset is included, consistent with the rest of the 1.7.0 stack.
@lorisleiva lorisleiva force-pushed the 07-07-document_the_instruction_display_api_in_the_readme branch from de23a9e to 30d0336 Compare July 8, 2026 08:25
@lorisleiva lorisleiva force-pushed the 06-25-add_the_instruction_display_orchestrator_and_public_api branch from 603593d to 17ce2b4 Compare July 8, 2026 08:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant