Merge #1746

1746: encode shelley addresses with their final encoding (bech32 / base58) r=KtorZ a=KtorZ

# Issue Number

<!-- Put here a reference to the issue this PR relates to and which requirements it tackles -->

N/A

# Overview

<!-- Detail in a few bullet points the work accomplished in this PR -->

Still, I kept support for base16 when decoding addresses, so that we don't necessarily break compatibility with cardano-cli.



# Comments

<!-- Additional comments or screenshots to attach if any -->

<!-- 
Don't forget to:

 ✓ Self-review your changes to make sure nothing unexpected slipped through
 ✓ Assign yourself to the PR
 ✓ Assign one or several reviewer(s)
 ✓ Once created, link this PR to its corresponding ticket
 ✓ Assign the PR to a corresponding milestone
 ✓ Acknowledge any changes required to the Wiki
-->


Co-authored-by: KtorZ <[email protected]>
Co-authored-by: IOHK <[email protected]>

lib/core-integration/src/Test/Integration/Scenario/CLI/Shelley/Transactions.hs

@@ -1064,7 +1064,8 @@ spec = do
           , (Just validTime1, Just validTime2)
           ]
 
-      encodeErr = "Unable to decode Address:"
+      encodeErr = "Unrecognized address encoding"
+      encodeErr2 = "Unable to decode address"
       parseErr = "Parse error. Expecting format \"<amount>@<address>\""
       matrixInvalidAddrs =
 -- TODO: For the haskell node, hex is valid. For jormungandr it is not.
@@ -1073,14 +1074,14 @@ spec = do
 --          [ ( "long hex", longAddr, encodeErr )
 --          , ( "short hex", "1", encodeErr )
           [ ( "-1000", "-1000", encodeErr )
-          , ( "q", "q", encodeErr )
-          , ( "empty", "", encodeErr )
+          , ( "q", "q", encodeErr2 )
+          , ( "empty", "", encodeErr2 )
           , ( "wildcards", T.unpack wildcardsWalletName, parseErr )
           , ( "arabic", T.unpack arabicWalletName, encodeErr )
           , ( "kanji", T.unpack kanjiWalletName, encodeErr )
           , ( "polish", T.unpack polishWalletName, encodeErr )
           , ( "[]", "[]", encodeErr )
-          , ( "no address", "", encodeErr )
+          , ( "no address", "", encodeErr2 )
           , ( "address is space", " ", encodeErr )
           ]
       errNum = "Expecting natural number"

lib/shelley/cardano-wallet-shelley.cabal

@@ -32,13 +32,17 @@ library
       base
     , aeson
     , async
+    , base58-bytestring
+    , bech32
+    , bech32-th
     , bytestring
     , cardano-addresses
     , cardano-api
     , cardano-binary
     , cardano-config
     , cardano-crypto
     , cardano-crypto-class
+    , cardano-ledger
     , cardano-slotting
     , cardano-wallet-cli
     , cardano-wallet-core
@@ -128,6 +132,9 @@ test-suite unit
     ghc-options: -O2 -Werror
   build-depends:
       base
+    , base58-bytestring
+    , bech32
+    , bech32-th
     , bytestring
     , cardano-addresses
     , cardano-crypto-class

lib/shelley/src/Cardano/Wallet/Shelley/Compatibility.hs

@@ -6,6 +6,8 @@
 {-# LANGUAGE NamedFieldPuns #-}
 {-# LANGUAGE NumericUnderscores #-}
 {-# LANGUAGE PatternSynonyms #-}
+{-# LANGUAGE QuasiQuotes #-}
+{-# LANGUAGE ScopedTypeVariables #-}
 {-# LANGUAGE TupleSections #-}
 {-# LANGUAGE TypeApplications #-}
 {-# LANGUAGE TypeFamilies #-}
@@ -87,25 +89,31 @@ import Cardano.Slotting.Slot
 import Cardano.Wallet.Api.Types
     ( DecodeAddress (..), EncodeAddress (..) )
 import Cardano.Wallet.Primitive.AddressDerivation
-    ( NetworkDiscriminant (..), hex )
+    ( NetworkDiscriminant (..) )
 import Cardano.Wallet.Unsafe
     ( unsafeDeserialiseCbor )
-import Control.Arrow
-    ( left )
+import Codec.Binary.Bech32
+    ( dataPartFromBytes, dataPartToBytes )
+import Control.Applicative
+    ( (<|>) )
+import Control.Monad
+    ( when )
 import Crypto.Hash.Algorithms
     ( Blake2b_256 (..) )
 import Data.ByteArray.Encoding
     ( Base (Base16), convertFromBase )
 import Data.ByteString
     ( ByteString )
+import Data.ByteString.Base58
+    ( bitcoinAlphabet, decodeBase58, encodeBase58 )
 import Data.Coerce
     ( coerce )
 import Data.Foldable
     ( toList )
 import Data.Map.Strict
     ( Map )
 import Data.Maybe
-    ( fromMaybe, mapMaybe )
+    ( fromMaybe, isJust, mapMaybe )
 import Data.Quantity
     ( Quantity (..), mkPercentage )
 import Data.Text
@@ -155,7 +163,11 @@ import Ouroboros.Network.Point
     ( WithOrigin (..) )
 
 import qualified Cardano.Api as Cardano
+import qualified Cardano.Byron.Codec.Cbor as CBOR
+import qualified Cardano.Chain.Common as Byron
 import qualified Cardano.Wallet.Primitive.Types as W
+import qualified Codec.Binary.Bech32 as Bech32
+import qualified Codec.Binary.Bech32.TH as Bech32
 import qualified Crypto.Hash as Crypto
 import qualified Data.ByteArray as BA
 import qualified Data.ByteString as BS
@@ -658,31 +670,88 @@ toStakePoolDlgCert xpub (W.PoolId pid) =
 -------------------------------------------------------------------------------}
 
 instance EncodeAddress 'Mainnet where
-    encodeAddress = T.decodeUtf8 . hex . W.unAddress
+    encodeAddress = _encodeAddress
 
 instance EncodeAddress ('Testnet pm) where
-    encodeAddress = T.decodeUtf8 . hex . W.unAddress
+    encodeAddress = _encodeAddress
 
-_decodeAddress :: Text -> Either TextDecodingError W.Address
-_decodeAddress x = validateWithLedger =<< W.Address <$> fromHex x
+_encodeAddress :: W.Address -> Text
+_encodeAddress (W.Address bytes) =
+    if isJust (CBOR.deserialiseCbor CBOR.decodeAddressPayload bytes)
+        then base58
+        else bech32
   where
-    fromHex :: Text -> Either TextDecodingError ByteString
-    fromHex =
-        left (const $ TextDecodingError "Unable to decode Address: not valid hex encoding.")
-        .  convertFromBase @ByteString @ByteString Base16
-        . T.encodeUtf8
-
-    validateWithLedger addr@(W.Address bytes) =
-        case SL.deserialiseAddr @TPraosStandardCrypto bytes of
-            Just _ -> Right addr
-            Nothing -> Left $ TextDecodingError
-                "Unable to decode Address: not a well-formed Shelley Address."
+    base58 = T.decodeUtf8 $ encodeBase58 bitcoinAlphabet bytes
+    bech32 = Bech32.encodeLenient hrp (dataPartFromBytes bytes)
+    hrp = [Bech32.humanReadablePart|addr|]
 
 instance DecodeAddress 'Mainnet where
-    decodeAddress = _decodeAddress
+    decodeAddress = _decodeAddress SL.Mainnet
 
 instance DecodeAddress ('Testnet pm) where
-    decodeAddress = _decodeAddress
+    decodeAddress = _decodeAddress SL.Testnet
+
+-- Note that for 'Byron', we always assume no discrimination. In
+-- practice, there is one discrimination for 'Shelley' addresses, and one for
+-- 'Byron' addresses. Yet, on Mainnet, 'Byron' addresses have no explicit
+-- discrimination.
+_decodeAddress
+    :: SL.Network
+    -> Text
+    -> Either TextDecodingError W.Address
+_decodeAddress serverNetwork text =
+    case tryBase16 <|> tryBech32 <|> tryBase58 of
+        Just bytes ->
+            decodeShelleyAddress bytes
+        _ ->
+            Left $ TextDecodingError
+                "Unrecognized address encoding: must be either bech32, base58 or base16"
+  where
+    -- | Attempt decoding an 'Address' using a Bech32 encoding.
+    tryBech32 :: Maybe ByteString
+    tryBech32 = do
+        (_, dp) <- either (const Nothing) Just (Bech32.decodeLenient text)
+        dataPartToBytes dp
+
+    -- | Attempt decoding a legacy 'Address' using a Base58 encoding.
+    tryBase58 :: Maybe ByteString
+    tryBase58 =
+        decodeBase58 bitcoinAlphabet (T.encodeUtf8 text)
+
+    -- | Attempt decoding an 'Address' using Base16 encoding
+    tryBase16 :: Maybe ByteString
+    tryBase16 =
+        either (const Nothing) Just $ convertFromBase Base16 (T.encodeUtf8 text)
+
+    decodeShelleyAddress :: ByteString -> Either TextDecodingError W.Address
+    decodeShelleyAddress bytes = do
+        case SL.deserialiseAddr @TPraosStandardCrypto bytes of
+            Just (SL.Addr addrNetwork _ _) -> do
+                guardNetwork addrNetwork
+                pure (W.Address bytes)
+
+            Just (SL.AddrBootstrap addr) -> do
+                guardNetwork (toNetwork (Byron.addrNetworkMagic addr))
+                pure (W.Address bytes)
+
+            Nothing -> Left $ TextDecodingError
+                "Unable to decode address: not a well-formed Shelley nor Byron address."
+
+      where
+        guardNetwork :: SL.Network -> Either TextDecodingError ()
+        guardNetwork addrNetwork =
+            when (addrNetwork /= serverNetwork) $
+                Left $ TextDecodingError $
+                    "Invalid network discrimination on address. Expecting "
+                    <> show serverNetwork
+                    <> " but got "
+                    <> show addrNetwork
+                    <> "."
+
+        toNetwork :: Byron.NetworkMagic -> SL.Network
+        toNetwork = \case
+            Byron.NetworkMainOrStage -> SL.Mainnet
+            Byron.NetworkTestnet{}   -> SL.Testnet
 
 {-------------------------------------------------------------------------------
                                     Logging

lib/shelley/test/integration/Main.hs

@@ -136,7 +136,7 @@ import qualified Test.Integration.Scenario.CLI.Shelley.Wallets as WalletsCLI
 instance KnownCommand Shelley where
     commandName = "cardano-wallet-shelley"
 
-main :: forall t n . (t ~ Shelley, n ~ 'Testnet 1) => IO ()
+main :: forall t n . (t ~ Shelley, n ~ 'Mainnet) => IO ()
 main = withUtf8Encoding $ withLogging Nothing Info $ \(_, tr) -> do
     hSetBuffering stdout LineBuffering
     hspec $ do