Skip to content

Add EIP-1191 checksum encoding #174

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jan 3, 2025
Merged

Add EIP-1191 checksum encoding #174

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5cf6d22
Add EIP-1191 checksum encoding
BlazeWasHere Jan 3, 2025
cf0e71e
cleanup
BlazeWasHere Jan 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 28 additions & 7 deletions lib/ethers/utils.ex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -237,26 +237,47 @@ defmodule Ethers.Utils do
@doc """
Will convert an upper or lowercase Ethereum address to a checksum address.

If `chain_id` is specified, ERC-1191 checksum encoding will be used.
NOTE: ERC-1191 is generally NOT backwards compatible with ERC-55 encoding
(encoding without `chain_id`).

## Examples

iex> Ethers.Utils.to_checksum_address("0xc1912fee45d61c87cc5ea59dae31190fffff232d")
"0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d"

iex> Ethers.Utils.to_checksum_address("0XC1912FEE45D61C87CC5EA59DAE31190FFFFF232D")
"0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d"

iex> Ethers.Utils.to_checksum_address("0xde709f2102306220921060314715629080e2fb77", 31)
"0xDE709F2102306220921060314715629080e2Fb77"

iex> Ethers.Utils.to_checksum_address("0XDE709F2102306220921060314715629080e2Fb77", 30)
"0xDe709F2102306220921060314715629080e2FB77"
"""
@spec to_checksum_address(Ethers.Types.t_address()) :: Ethers.Types.t_address()
def to_checksum_address("0x" <> address), do: to_checksum_address(address)
def to_checksum_address("0X" <> address), do: to_checksum_address(address)
@spec to_checksum_address(Ethers.Types.t_address(), pos_integer() | nil) ::
Ethers.Types.t_address()
def to_checksum_address(address, chain_id \\ nil)

def to_checksum_address("0x" <> address, chain_id), do: to_checksum_address(address, chain_id)
def to_checksum_address("0X" <> address, chain_id), do: to_checksum_address(address, chain_id)

def to_checksum_address(<<address_bin::binary-20>>, chain_id),
do: hex_encode(address_bin, false) |> to_checksum_address(chain_id)

def to_checksum_address(address, nil), do: calculate_checksum_address(address, address)

def to_checksum_address(<<address_bin::binary-20>>),
do: hex_encode(address_bin) |> to_checksum_address()
def to_checksum_address(address, chain_id) when is_integer(chain_id),
do: calculate_checksum_address(address, "#{chain_id}0x#{address}")

def to_checksum_address(address) do
defp calculate_checksum_address(address, hash_input) do
address = String.downcase(address)

hashed_address =
address |> Ethers.keccak_module().hash_256() |> Base.encode16(case: :lower)
hash_input
|> String.downcase()
|> Ethers.keccak_module().hash_256()
|> Base.encode16(case: :lower)

checksum_address =
address
Expand Down
41 changes: 41 additions & 0 deletions test/ethers/utils_test.exs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,38 @@ defmodule Ethers.UtilsTest do
alias Ethers.Utils
doctest Ethers.Utils

@rsk_mainnet_addresses [
"0x27b1FdB04752BBc536007A920D24ACB045561c26",
"0x3599689E6292B81B2D85451025146515070129Bb",
"0x42712D45473476B98452f434E72461577d686318",
"0x52908400098527886E0F7030069857D2E4169ee7",
"0x5aaEB6053f3e94c9b9a09f33669435E7ef1bEAeD",
"0x6549F4939460DE12611948B3F82B88C3C8975323",
"0x66F9664f97f2B50F62d13EA064982F936de76657",
"0x8617E340b3D01Fa5f11f306f4090fd50E238070D",
"0x88021160c5C792225E4E5452585947470010289d",
"0xD1220A0Cf47c7B9BE7a2e6ba89F429762E7B9adB",
"0xDBF03B407c01E7CD3cBea99509D93F8Dddc8C6FB",
"0xDe709F2102306220921060314715629080e2FB77",
"0xFb6916095cA1Df60bb79ce92cE3EA74c37c5d359"
]

@rsk_testnet_addresses [
"0x27B1FdB04752BbC536007a920D24acB045561C26",
"0x3599689e6292b81b2D85451025146515070129Bb",
"0x42712D45473476B98452F434E72461577D686318",
"0x52908400098527886E0F7030069857D2e4169EE7",
"0x5aAeb6053F3e94c9b9A09F33669435E7EF1BEaEd",
"0x6549f4939460dE12611948b3f82b88C3c8975323",
"0x66f9664F97F2b50f62d13eA064982F936DE76657",
"0x8617e340b3D01fa5F11f306F4090Fd50e238070d",
"0x88021160c5C792225E4E5452585947470010289d",
"0xd1220a0CF47c7B9Be7A2E6Ba89f429762E7b9adB",
"0xdbF03B407C01E7cd3cbEa99509D93f8dDDc8C6fB",
"0xDE709F2102306220921060314715629080e2Fb77",
"0xFb6916095CA1dF60bb79CE92ce3Ea74C37c5D359"
]

describe "get_block_timestamp" do
test "returns the block timestamp" do
assert {:ok, n} = Ethers.current_block_number()
Expand Down Expand Up @@ -101,6 +133,15 @@ defmodule Ethers.UtilsTest do
assert Ethers.Utils.to_checksum_address(bin_address) ==
"0x90F8bf6A479f320ead074411a4B0e7944Ea8c9C1"
end

test "does erc-1191 checksum" do
%{30 => @rsk_mainnet_addresses, 31 => @rsk_testnet_addresses}
|> Enum.each(fn {chain_id, addresses} ->
Enum.each(addresses, fn address ->
assert Ethers.Utils.to_checksum_address(address, chain_id) == address
end)
end)
end
end

describe "public_key_to_address/2" do
Expand Down
Loading