Bump @spruceid/siwe-parser to 2.1.0 #4141
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
|
New and removed dependencies detected. Learn more about Socket for GitHub ↗︎
🚮 Removed packages: npm/apg-js@4.3.0 |
NicholasEllul
force-pushed
the
ellul/bump-siwe-parser
branch
from
74a113f
to
4613ae4
Compare
|
Each commit takes a different approach to testing. In the first commit, I am explicit about the expected return values within the code. However, comparing them to the output of the In the second commit, I switch this to be less explicit, but easier test maintainability/cleaner code. This is what i'm proposing in the final changes. Open to discussion if anyone feels strongly about the approach. |
NicholasEllul
commented
Apr 10, 2024
| @@ -251,12 +240,12 @@ describe('siwe', () => { | |||
| origin, | |||
| })}`, () => { | |||
| const result = isValidSIWEOrigin({ | |||
| from: '0x0', | |||
| from: '0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2', | |||
There was a problem hiding this comment.
Changing due to the fact the previous value was not a valid EIP-55 address which is required for SIWE: https://eips.ethereum.org/EIPS/eip-4361#abnf-message-format
address = "0x" 40*40HEXDIG
; Must also conform to capitalization
; checksum encoding specified in EIP-55
; where applicable (EOAs).
7 tasks
digiwand
added a commit
to MetaMask/metamask-extension
that referenced
this pull request
Apr 24, 2024
#24138) ## **Description** Resolves @spruceid/siwe-parser 1.1.3 → 2.1.0 The updated @spruceid/siwe-parser allows `http` and `https` schemas in a transaction message's URL. Additional changes are included in the @spruceid/siwe-parser upgrade from v1.1.3 → v2.1.0. One important update is the requirement of [EIP-55](https://npmfs.com/package/@spruceid/siwe-parser/1.1.3/lib/abnf.ts) complaint addresses. This means that if a dapp attempts to sign a `personal_sign` message with a from address that is not EIP-55 compliant, SIWE will not be detected. This is what we want as [EIP-4361](https://eips.ethereum.org/EIPS/eip-4361) enforces EIP-55 addresses. There's a separate ticket that'll warn users if a `personal_sign` message looks like a SIWE but doesn't parse to a SIWE message: #24128 Issue to update test-dapp SIWE addresses to be EIP-55 complaint: MetaMask/test-dapp#326 Related Links (Thanks @NicholasEllul for these): - https://app.warp.dev/block/4eE6QC12lVuwARbpFj62VJ - https://npmfs.com/package/@spruceid/siwe-parser/1.1.3/lib/abnf.ts ## **Related issues** Fixes: MetaMask/MetaMask-planning#2256 Relates To: MetaMask/MetaMask-planning#2278 Related to: #24107 Related to: MetaMask/core#4153 Related to: MetaMask/core#4141 ## **Manual testing steps** 1. Go to the metamask test-dapp or run the test-dapp locally 2. When testing locally, optionally update the from addresses used by the buttons 3. Test Sign-in With Ethereum buttons 4. Observe MM ## **Screenshots/Recordings** <!-- If applicable, add screenshots and/or recordings to visualize the before and after of your change. --> ### **Before** <!-- [screenshots/recordings] --> ### **After** <!-- [screenshots/recordings] --> ## **Pre-merge author checklist** - [ ] I’ve followed [MetaMask Coding Standards](https://github.com/MetaMask/metamask-extension/blob/develop/.github/guidelines/CODING_GUIDELINES.md). - [ ] I've completed the PR template to the best of my ability - [ ] I’ve included tests if applicable - [ ] I’ve documented my code using [JSDoc](https://jsdoc.app/) format if applicable - [ ] I’ve applied the right labels on the PR (see [labeling guidelines](https://github.com/MetaMask/metamask-extension/blob/develop/.github/guidelines/LABELING_GUIDELINES.md)). Not required for external contributors. ## **Pre-merge reviewer checklist** - [ ] I've manually tested the PR (e.g. pull and build branch, run the app, test code being changed). - [ ] I confirm that this PR addresses all acceptance criteria described in the ticket it closes and includes the necessary testing evidence such as recordings and or screenshots. --------- Co-authored-by: MetaMask Bot <metamaskbot@users.noreply.github.com> Co-authored-by: legobeat <109787230+legobeat@users.noreply.github.com> Co-authored-by: Nicholas Ellul <nicholas.ellul1@gmail.com>
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.
Explanation
This pull request bumps the siwe-parser to the latest version which adds additional support for the
schemeparameter. I also refactor the tests to explicitly call the siwe-parser library to act as a smoke test that can catch any issues in the future. This will make breaking changes easier to catch.References
https://github.com/MetaMask/MetaMask-planning/issues/2278
Changelog
None
Checklist