fix: .extend performance #2328
Merged
fix: .extend performance #2328
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: fbcb2fc 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 |
tmm
commented
May 28, 2024
|
New and removed dependencies detected. Learn more about Socket for GitHub ↗︎
🚮 Removed packages: npm/@actions/core@1.10.1, npm/@actions/github@5.1.1 |
tmm
commented
May 28, 2024
| @@ -209,9 +209,7 @@ export type ContractFunctionParameters< | |||
| | allFunctionNames // show all options | |||
| | (functionName extends allFunctionNames ? functionName : never) // infer value | |||
| args?: (abi extends Abi ? UnionWiden<args> : never) | allArgs | undefined | |||
| } & (readonly [] extends allArgs ? {} : { args: Widen<args> }) & | |||
| // TODO: Remove `GetValue` from here (should be applied to top-level type as separate utility) | |||
| GetValue<abi, functionName> | |||
There was a problem hiding this comment.
GetValue was causing ContractFunctionParameters to blow up when used with .extend + publicActions
tmm
commented
May 28, 2024
Comment on lines
-1
to
-2
| ### Description | ||
|
|
tmm
commented
May 28, 2024
.github/workflows/verify.yml
Outdated
| @@ -54,7 +54,7 @@ jobs: | |||
| timeout-minutes: 5 | |||
| strategy: | |||
| matrix: | |||
| typescript-version: ['5.3.2', 'latest'] | |||
| version: ['5.0.4', '5.1.6', '5.2.2', '5.3.3', '5.4.5'] | |||
There was a problem hiding this comment.
test against more ts versions
There was a problem hiding this comment.
wonder if it's worth the work to fix the types that are incompatible with older versions
tmm
commented
May 28, 2024
There was a problem hiding this comment.
these type benchmarking tests make sure the types don't blow up too much
size-limit report 📦
|
tmm
commented
May 28, 2024
Comment on lines
+124
to
+149
| export type WriteContractFunctionParameters< | ||
| abi extends Abi | readonly unknown[] = Abi, | ||
| mutability extends AbiStateMutability = AbiStateMutability, | ||
| functionName extends ContractFunctionName< | ||
| abi, | ||
| mutability | ||
| > = ContractFunctionName<abi, mutability>, | ||
| args extends ContractFunctionArgs< | ||
| abi, | ||
| mutability, | ||
| functionName | ||
| > = ContractFunctionArgs<abi, mutability, functionName>, | ||
| /// | ||
| allFunctionNames = ContractFunctionName<abi, mutability>, | ||
| allArgs = ContractFunctionArgs<abi, mutability, functionName>, | ||
| // when `args` is inferred to `readonly []` ("inputs": []) or `never` (`abi` declared as `Abi` or not inferrable), allow `args` to be optional. | ||
| // important that both branches return same structural type | ||
| > = { | ||
| address: Address | ||
| abi: abi | ||
| functionName: | ||
| | allFunctionNames // show all options | ||
| | (functionName extends allFunctionNames ? functionName : never) // infer value | ||
| args?: (abi extends Abi ? UnionWiden<args> : never) | allArgs | undefined | ||
| } & (readonly [] extends allArgs ? {} : { args: Widen<args> }) & | ||
| GetValue<abi, functionName> |
There was a problem hiding this comment.
duplicated this type here for now. will address during some more extensive cleanup.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #2328 +/- ##
=======================================
Coverage 99.67% 99.67%
=======================================
Files 673 673
Lines 57331 57367 +36
Branches 2770 2772 +2
=======================================
+ Hits 57145 57181 +36
+ Misses 169 168 -1
- Partials 17 18 +1 ☔ View full report in Codecov by Sentry. |
jxom
approved these changes
May 28, 2024
This was referenced May 29, 2024
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.
GetValuewas causingContractFunctionParametersto blow up when used with.extend+publicActions.Added some type benchmarks using
attestto protect against this in the future.Resolves #2322
PR-Codex overview
This PR focuses on improving performance and adding type checking.
Detailed summary
.extendincreateClientwriteContractsfunction for better readability