Skip to content

feat: break out address checksum encoding to erc55EncodeAddress function - #113

Merged
mikesposito merged 5 commits into
MetaMask:feat/is-valid-hex-addressfrom
legobeat:feat/is-valid-hex-address-encode
Jul 11, 2023
Merged

feat: break out address checksum encoding to erc55EncodeAddress function#113
mikesposito merged 5 commits into
MetaMask:feat/is-valid-hex-addressfrom
legobeat:feat/is-valid-hex-address-encode

Conversation

@legobeat

@legobeatlegobeat commented Jul 11, 2023

Copy link
Copy Markdown
Contributor

Targeting #112

  • break out encoding to separate function
  • implementation closer to ERC spec code
  • functional approach

IMO this improves readability.

@legobeat
legobeat requested a review from a team as a code ownerJuly 11, 2023 03:48
@legobeatlegobeat mentioned this pull request Jul 11, 2023
Merged
@legobeat
legobeat requested a review from GudahttJuly 11, 2023 03:50
@legobeat
legobeat requested a review from MrtenzJuly 11, 2023 04:13
Mrtenz
Mrtenz requested changes Jul 11, 2023
View reviewed changes

@MrtenzMrtenz left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you add tests for this function? EIP-55 has some test cases which we can use.

Comment threadsrc/hex.ts Outdated
Comment threadsrc/hex.ts Outdated
Comment threadsrc/hex.ts Outdated
@mikesposito

mikesposito commented Jul 11, 2023

Copy link
Copy Markdown
Member

The only significant difference I can note is that we now calculate the entire hash and then we compare it, instead of early terminating the function on the first wrong char. But that isn't necessarily a bad thing

@Mrtenz

Mrtenz commented Jul 11, 2023

Copy link
Copy Markdown
Member

The only significant difference I can note is that we now calculate the entire hash and then we compare it, instead of early terminating the function on the first wrong char. But that isn't necessarily a bad thing

The difference in performance is probably negligible?

@mikesposito
mikesposito merged commit 58ae2d2 into MetaMask:feat/is-valid-hex-addressJul 11, 2023
mikesposito added a commit that referenced this pull request Jul 11, 2023
@mikesposito@legobeat
@Mrtenz@Gudahtt
Add address related utils (#112)
f1024ca
* feat: add isValidHexAddress function
* fix: accept only prefixed addresses
* fix: remove case insensitive flag
* test: add test case for 0X
* feat: validate checksum addresses
* feat: break out address checksum encoding to erc55EncodeAddress function (#113)
* feat: break out address checksum encoding to erc55EncodeAddress function
* deps: ethereum-cryptography@2.0.0->2.1.0; dedupe @noble/hashes
* Update jsdoc
Co-authored-by: Maarten Zuidhoorn <maarten@zuidhoorn.com>
* refactor: rename erc55EncodeAddress function
* test: add test cases for getChecksumAddress
---------
Co-authored-by: Maarten Zuidhoorn <maarten@zuidhoorn.com>
Co-authored-by: Michele Esposito <michele@esposito.codes>
* docs: edit isValidHexAddress jsdoc description
* Update src/hex.ts
Co-authored-by: Mark Stacey <markjstacey@gmail.com>
* fix: add validation assertions
---------
Co-authored-by: legobeat <109787230+legobeat@users.noreply.github.com>
Co-authored-by: Maarten Zuidhoorn <maarten@zuidhoorn.com>
Co-authored-by: Mark Stacey <markjstacey@gmail.com>
@legobeat
legobeat deleted the feat/is-valid-hex-address-encode branch July 11, 2023 23:17
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@MrtenzMrtenzMrtenz approved these changes
@mikespositomikespositoAwaiting requested review from mikesposito
@GudahttGudahttAwaiting requested review from Gudahtt

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@legobeat@mikesposito@Mrtenz