Normalized address storage.

All addresses are stored in lowercase form. If you want to see it as a checksummed address, use Eth.Utils.addressToChecksumString.
Eth.Utils.addressFromString still checks for EIP-55 compliance if input is mixed case.

Signed-off-by: Coury Ditch <[email protected]>

Author: cmditch

src/Eth/Sentry/Event.elm

@@ -76,12 +76,10 @@ init tagger nodePath =
     )
 
 
-{-|
+{-| Returns the first log found.
 
-    Returns the first log found.
-
-    If a block range is defined in the LogFilter,
-    this will only return the first log found within that given block range.
+If a block range is defined in the LogFilter,
+this will only return the first log found within that given block range.
 
 -}
 watchOnce : (Log -> msg) -> EventSentry msg -> LogFilter -> ( EventSentry msg, Cmd msg )
@@ -90,15 +88,13 @@ watchOnce onReceive eventSentry logFilter =
         |> (\( eventSentry_, cmd, _ ) -> ( eventSentry_, cmd ))
 
 
-{-|
-
-    Continuously polls for logs in newly mined blocks.
+{-| Continuously polls for logs in newly mined blocks.
 
-    If the range within the LogFilter includes past blocks,
-    then all events within the given block range are returned,
-    along with events in the latest block.
+If the range within the LogFilter includes past blocks,
+then all events within the given block range are returned,
+along with events in the latest block.
 
-    Polling continues until `stopWatching` is called.
+Polling continues until `stopWatching` is called.
 
 -}
 watch : (Log -> msg) -> EventSentry msg -> LogFilter -> ( EventSentry msg, Cmd msg, Ref )

src/Eth/Utils.elm

@@ -99,14 +99,17 @@ toAddress str =
 
         emptyZerosInBytes32 =
             String.left 24 noZeroX
+
+        normalize =
+            String.toLower >> Internal.Address >> Ok
     in
     -- Address is always stored without "0x"
     if String.length noZeroX == 64 && String.all ((==) '0') emptyZerosInBytes32 then
         if isUpperCaseAddress bytes32Address || isLowerCaseAddress bytes32Address then
-            Ok <| Internal.Address bytes32Address
+            normalize bytes32Address
 
         else if isChecksumAddress bytes32Address then
-            Ok <| Internal.Address bytes32Address
+            normalize bytes32Address
 
         else
             Err <| "Given address " ++ quote str ++ " failed the EIP-55 checksum test."
@@ -118,10 +121,10 @@ toAddress str =
         Err <| "Given address " ++ quote str ++ " contains invalid hex characters."
 
     else if isUpperCaseAddress noZeroX || isLowerCaseAddress noZeroX then
-        Ok <| Internal.Address noZeroX
+        normalize noZeroX
 
     else if isChecksumAddress noZeroX then
-        Ok <| Internal.Address noZeroX
+        normalize noZeroX
 
     else
         Err <| "Given address " ++ quote str ++ " failed the EIP-55 checksum test."

tests/Address.elm

@@ -19,20 +19,25 @@ toAddressTests =
             , test "from uppercase address with 0x" <|
                 \_ ->
                     Eth.toAddress "0XF85FEEA2FDD81D51177F6B8F35F0E6734CE45F5F"
-                        |> Expect.equal (Ok <| Internal.Address "F85FEEA2FDD81D51177F6B8F35F0E6734CE45F5F")
+                        |> Expect.equal (Ok <| Internal.Address "f85feea2fdd81d51177f6b8f35f0e6734ce45f5f")
             , test "from evm" <|
                 \_ ->
                     Eth.toAddress "000000000000000000000000f85feea2fdd81d51177f6b8f35f0e6734ce45f5f"
                         |> Expect.equal (Ok <| Internal.Address "f85feea2fdd81d51177f6b8f35f0e6734ce45f5f")
             , test "from already checksummed" <|
                 \_ ->
                     Eth.toAddress "0xe4219dc25D6a05b060c2a39e3960A94a214aAeca"
-                        |> Expect.equal (Ok <| Internal.Address "e4219dc25D6a05b060c2a39e3960A94a214aAeca")
+                        |> Expect.equal (Ok <| Internal.Address "e4219dc25d6a05b060c2a39e3960a94a214aaeca")
             , test "addressToString" <|
                 \_ ->
                     Eth.toAddress "0XF85FEEA2FDD81D51177F6B8F35F0E6734CE45F5F"
                         |> Result.map Eth.addressToString
-                        |> Expect.equal (Ok "0xF85FEEA2FDD81D51177F6B8F35F0E6734CE45F5F")
+                        |> Expect.equal (Ok "0xf85feea2fdd81d51177f6b8f35f0e6734ce45f5f")
+            , test "addressToChecksumString" <|
+                \_ ->
+                    Eth.toAddress "0xe4219dc25d6a05b060c2a39e3960a94a214aaeca"
+                        |> Result.map Eth.addressToChecksumString
+                        |> Expect.equal (Ok "0xe4219dc25D6a05b060c2a39e3960A94a214aAeca")
             ]
         , describe "toAddress fails"
             [ test "from short address with 0x" <|