Got bad address checksum error from the valid address

[Pepewitch]

Ethers Version

5.7.0

Search Terms

No response

Describe the Problem

I found that ethers.utils.getAddress("0x964d9D1a532b5a5daeacbac71d46320de313ae9c") throws a bad checksum error. I think this address is valid because I can search for it on Etherscan. Maybe there is some issue in the checksum logic?
ref: https://etherscan.io/address/0x964d9D1a532b5a5daeacbac71d46320de313ae9c

Code Snippet

ethers.utils.getAddress(address)

Contract ABI

No response

Errors

Error: bad address checksum (argument="address", value="0x964d9D1a532b5a5daeacbac71d46320de313ae9c", code=INVALID_ARGUMENT, version=address/5.7.0)

Environment

node.js (v12 or newer)

Environment (Other)

No response

[ricmoo]

The checksum isn’t correct in that address. The correct checksum is "0x964d9D1A532B5a5DaeacBAc71d46320DE313AE9C".

When using Etherscan, if the checksum is wrong, it lowercases the address and computes the address itself. If you notice on the Etherscan page it has corrected the checksum for you too. :)

[Pepewitch]

@ricmoo tysm for the explanation :) Now, I can fix my bug by applying .toLowerCase() for any address before calling getAddress. It would be great if the lib could help handle this case by default because I expect to get the correct checksum address using the getAddress function when I input the incorrect checksum address.

[ricmoo]

You likely should not just lowercase the value automatically. If the checksum is wrong, it is quite likely the address is wrong (for some reason; most often this occurs when a person manually types an address which almost certainly results in multiple mistakes), and you should warn the user.

A checksum adds a level of safety to Ethereum transactions and ignoring it can result in loss of funds, burning NFTs or in general damaging or destroying assets.

The library checks addresses extensively to prevent human error. There isn’t really a good reason the checksum should ever be incorrect.

[Abidoyesimze]

So helpful