feat(human-readable): parameter validation and strict mode #138
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
🦋 Changeset detectedLatest commit: e90ae65 The changes in this PR will be included in the next version bump. 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 |
FeaturesChore
Bug Fixes
Code Refactoring
ContributorsCommit-Lint commandsYou can trigger Commit-Lint actions by commenting on this PR:
|
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
|
Size Change: +62 B (0%) Total Size: 47.1 kB
ℹ️ View Unchanged
|
Raiden1411
commented
May 18, 2023
|
|
||
| - Type `boolean` | ||
| - Default `false` | ||
|
|
||
| ```ts twoslash | ||
| declare module 'abitype' { | ||
| export interface Config { | ||
| StrictAbiType: false | ||
| Strict: false |
There was a problem hiding this comment.
With this change it will affect type checking not only on types but also valid modifiers and parameter names. Kept as default so folks can hop in instead of out.
Codecov Report
@@ Coverage Diff @@
## main #138 +/- ##
========================================
Coverage 99.89% 99.90%
========================================
Files 21 21
Lines 1914 2029 +115
Branches 308 308
========================================
+ Hits 1912 2027 +115
Misses 2 2
|
Raiden1411
commented
May 18, 2023
| @@ -128,7 +129,7 @@ export type IsName<TName extends string> = TName extends '' | |||
| : false | |||
| export type ValidateName< | |||
| TName extends string, | |||
| CheckCharacters extends boolean = false, | |||
| CheckCharacters extends boolean = ResolvedConfig['Strict'], | |||
There was a problem hiding this comment.
This now gets enabled once folks enable strict mode instead of always being false.
Raiden1411
commented
May 18, 2023
| @@ -1,9 +1,9 @@ | |||
| import type { AbiParameter } from '../../abi.js' | |||
| import type { InferredAbiParameter } from '../../abi.js' | |||
There was a problem hiding this comment.
Had to change this to InferredAbiParameter because while parsing structs with StrictAbiType = true it would cause some components to be never.
Raiden1411
commented
May 18, 2023
Raiden1411
commented
May 18, 2023
Raiden1411
commented
May 18, 2023
Raiden1411
commented
May 18, 2023
| AllKeys extends keyof T = keyof T, | ||
| > = [AllKeys] extends [never] ? true : false | ||
|
|
||
| export type Flatten< |
There was a problem hiding this comment.
This also filters out all never types. It wasn't playing to well with never as members since never extends any[] is true.
Raiden1411
commented
May 18, 2023
|
@tmm, made some comments on the files. Let me know what you think about this. |
Raiden1411
changed the title
|
Will close this and break this down into seperate PRs. Currently doing to much on this one |
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.
Description
Adds parameter validation to
parseAbiParameterandparseAbiParameters.Changes
StrictAbiTypetoStrict.Additional Information
Your ENS/address:
PR-Codex overview
This PR adds parameter validation and stricter checks to
parseAbiParameterandparseAbiParameters. It also renamesStrictAbiTypetoStrictand enforces stricter checks on human-readable ABIs. Notable changes include:parseAbiParameterandparseAbiParametersStrictAbiTypetoStrictInferredAbiinstead ofAbiExtractAbiParseErrors,Flatten,IsEmptyObject,IsArrayString,Pop,IsNever, andRange