Fix correctness issue in ZkProgram typing #1962
Merged
Conversation
This file contains 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
rpanic
changed the title
mitschabaude
approved these changes
Jan 31, 2025
| [I in keyof MethodSignatures]: Get<MethodSignatures[I], 'auxiliaryOutput'>; | ||
| } | ||
| Config extends ConfigBaseType, | ||
| _ extends unknown = unknown // weird hack that makes methods infer correctly when their inputs are not annotated |
There was a problem hiding this comment.
this extra line fixed the type error in foreign-field-gadgets.unit-test.ts
I also noticed that you could remove the errors when explicitly annotating method inputs in that file. Which would be good practice, since if you don't do it the inputs will be typed as any inside the method.
however, I also found that adding any extra generic type argument makes the error disappear. no idea why!
since writing a zkprogram is already hard, because you tend to get confusing type errors on an incomplete ZkProgram definition, I think it's worth keeping this hack to remove one more confusing error.
Trivo25
approved these changes
Feb 1, 2025
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.
Currently, the ZkProgram method declares a lot of convenience types as generic parameters. However, this leads to wrong typings when explicitly typing those generic parameters as they become inconsistent with the original ZkProgram's Config and therefore the resulting ZkProgram.
Furthermore, this hugely increases friction when trying to type anything outside of o1js that does stuff with ZkPrograms in some way.