Generate a visited consumer-facing IDL - #501
Open
lorisleiva wants to merge 1 commit into
Open
Conversation
Separate the raw interface IDL from the consumer-facing IDL. codama-rs now writes its macro-generated output to interface-idl.json, after which the Codama CLI applies the configured before visitors and uses writeIdlVisitor to write the resolved tree to idl.json. The Makefile owns both steps, keeping CI regeneration deterministic. As a result, consumers of idl.json receive the same transformed tree used by client generation, including resolved clock aliases, flattened instruction data and the stake account wrapper, with no dangling defined-type links.
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 join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This PR separates the raw interface IDL from the consumer-facing IDL.
Pipeline
make generate-idl-interfacenow:codama-rsand writes the macro-generated tree tointerface-idl.json;idlscript, applying all configuredbeforevisitors;@codama/renderers-core#writeIdlVisitorto write the resolved tree toidl.json.The Makefile owns both steps, so CI regenerates and checks both artifacts deterministically.
make generate-clientsalso runs theidl,jsandrustscripts from the same post-visitor tree.Result
interface-idl.jsonis byte-identical to the previously committed rawidl.json.idl.jsonnow matches the transformed tree used by client generation:redelegateremoved;epochandunixTimestampaliases resolved (including date-time display);stakeStateAccountwrapper present;Also adds
@codama/renderers-core@^1.4.0and updatescodamato^1.10.2.Verification