fix(types): payable value inference ts value #2307
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
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
🦋 Changeset detectedLatest commit: db22244 The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
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 |
size-limit report 📦
|
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #2307 +/- ##
==========================================
- Coverage 96.60% 92.90% -3.71%
==========================================
Files 675 644 -31
Lines 57392 52672 -4720
Branches 2439 1990 -449
==========================================
- Hits 55443 48934 -6509
- Misses 1919 3692 +1773
- Partials 30 46 +16 ☔ View full report in Codecov by Sentry. |
tmm
commented
May 24, 2024
Comment on lines
+70
to
+96
| test('args: value', () => { | ||
| // payable function | ||
| simulateContract(clientWithAccount, { | ||
| abi: baycContractConfig.abi, | ||
| address: '0x', | ||
| functionName: 'mintApe', | ||
| args: [69n], | ||
| value: 5n, | ||
| }) | ||
|
|
||
| // payable function (undefined) | ||
| simulateContract(clientWithAccount, { | ||
| abi: baycContractConfig.abi, | ||
| address: '0x', | ||
| functionName: 'mintApe', | ||
| args: [69n], | ||
| }) | ||
|
|
||
| // nonpayable function | ||
| simulateContract(clientWithAccount, { | ||
| abi: baycContractConfig.abi, | ||
| address: '0x', | ||
| functionName: 'approve', | ||
| // @ts-expect-error | ||
| value: 5n, | ||
| }) | ||
| }) |
There was a problem hiding this comment.
Adding more coverage for GetValue
| @@ -309,10 +309,10 @@ export type GetValue< | |||
| _Narrowable extends boolean = IsNarrowable<TAbi, Abi>, | |||
| > = _Narrowable extends true | |||
| ? TAbiFunction['stateMutability'] extends 'payable' | |||
| ? { value?: NoUndefined<TValueType> | undefined } | |||
There was a problem hiding this comment.
NoUndefined is necessary anymore as the property is marked as optional and is a union with undefined.
| @@ -309,10 +309,10 @@ export type GetValue< | |||
| _Narrowable extends boolean = IsNarrowable<TAbi, Abi>, | |||
| > = _Narrowable extends true | |||
| ? TAbiFunction['stateMutability'] extends 'payable' | |||
| ? { value?: NoUndefined<TValueType> | undefined } | |||
| ? { value?: NoInfer<TValueType> | undefined } | |||
There was a problem hiding this comment.
We add NoInfer so that TValueType does not get inferred based on the property value.
Before
writeContract({
functionName: 'nonpayable',
value: '123',
// ^? value (property): string
})
writeContract({
functionName: 'payable',
value: 123n,
// ^? value (property): bigint
})After
writeContract({
functionName: 'nonpayable',
value: '123',
// ^? value (property): undefined
})
writeContract({
functionName: 'payable',
value: 123n,
// ^? value (property): bigint | undefined
})Might not look like a lot, but downstream this causes an issue with type transformations.
| : TAbiFunction['payable'] extends true | ||
| ? { value?: NoUndefined<TValueType> | undefined } | ||
| : { value?: never | undefined } |
There was a problem hiding this comment.
never | undefined becomes undefined so removing it so the compiler can have an extra vacation
Merged
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.
Upstream issue in
wagmiand@wagmi/vuewith payablevalueproperty.wevm/wagmi#3984
PR-Codex overview
This PR improves type inference for the
valueproperty in contracts and updates test cases forsimulateContract.Detailed summary
valueproperty in contractsNoInfertype utilitysimulateContractwithvalueproperty