Add optional address parameter to listTransaction (#4004)

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

Before you submit, don't forget to:

* Make sure the GitHub PR fields are correct:
   ✓ Set a good Title for your PR.
   ✓ Assign yourself to the PR.
   ✓ Assign one or more reviewer(s).
   ✓ Link to a Jira issue, and/or other GitHub issues or PRs.
   ✓ In the PR description delete any empty sections
     and all text commented in <!--, so that this text does not appear
     in merge commit messages.

* Don't waste reviewers' time:
   ✓ If it's a draft, select the Create Draft PR option.
✓ Self-review your changes to make sure nothing unexpected slipped
through.

* Try to make your intent clear:
   ✓ Write a good Description that explains what this PR is meant to do.
   ✓ Jira will detect and link to this PR once created, but you can also
     link this PR in the description of the corresponding Jira ticket.
   ✓ Highlight what Testing you have done.
   ✓ Acknowledge any changes required to the Documentation.
-->

- [x] Add support for optional address in api
- [x] Handle inputs, outputs, collateral inputs and collateral output
- [x] tests for shelley style
- [x] tests for byron style
- [x] tests for shared  style
- [x] swagger update

### Comments

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

### Issue Number
https://cardanofoundation.atlassian.net/browse/ADP-2817
<!-- Reference the Jira/GitHub issue that this PR relates to, and which
requirements it tackles.
  Note: Jira issues of the form ADP- will be auto-linked. -->

lib/wallet/api/http/Cardano/CLI.hs

@@ -948,6 +948,7 @@ cmdTransactionList mkTxClient =
             mTimeRangeEnd
             (ApiT <$> mOrder)
             (ApiLimit <$> limit)
+            Nothing
             (metadataSchema == TxMetadataNoSchema)
 
 -- | Arguments for 'transaction submit' command

lib/wallet/api/http/Cardano/Wallet/Api.hs

@@ -604,6 +604,7 @@ type ListTransactions n = "wallets"
     :> QueryParam "end" Iso8601Time
     :> QueryParam "order" (ApiT SortOrder)
     :> QueryParam "max_count" ApiLimit
+    :> QueryParam "address" (ApiAddressIdT n)
     :> QueryFlag "simple-metadata"
     :> Get '[JSON] [ApiTransactionT n]
 
@@ -924,6 +925,7 @@ type ListByronTransactions n = "byron-wallets"
     :> QueryParam "end" Iso8601Time
     :> QueryParam "order" (ApiT SortOrder)
     :> QueryParam "max_count" ApiLimit
+    :> QueryParam "address" (ApiAddressIdT n)
     :> Get '[JSON] [ApiTransactionT n]
 
 -- | https://cardano-foundation.github.io/cardano-wallet/api/#operation/getByronTransaction
@@ -1188,6 +1190,7 @@ type ListSharedTransactions n = "shared-wallets"
     :> QueryParam "end" Iso8601Time
     :> QueryParam "order" (ApiT SortOrder)
     :> QueryParam "max_count" ApiLimit
+    :> QueryParam "address" (ApiAddressIdT n)
     :> QueryFlag "simple-metadata"
     :> Get '[JSON] [ApiTransactionT n]
 

lib/wallet/api/http/Cardano/Wallet/Api/Client.hs

@@ -172,6 +172,7 @@ data TransactionClient = TransactionClient
         -> Maybe Iso8601Time
         -> Maybe (ApiT SortOrder)
         -> Maybe ApiLimit
+        -> Maybe (ApiAddressIdT Aeson.Value)
         -> Bool
         -> ClientM [ApiTransactionT Aeson.Value]
     , signTransaction
@@ -366,8 +367,8 @@ byronTransactionClient =
             = client (Proxy @("v2" :> Proxy_))
 
     in TransactionClient
-        { listTransactions = \wid start end order limit _ ->
-            _listTransactions wid start end order limit
+        { listTransactions = \wid start end order limit addr _ ->
+            _listTransactions wid start end order limit addr
         , postTransaction = _postTransaction
         , postTransactionFee = _postTransactionFee
         , postExternalTransaction = _postExternalTransaction . fromSerialisedTx

lib/wallet/api/http/Cardano/Wallet/Api/Http/Server.hs

@@ -335,9 +335,9 @@ server byron icarus shelley multisig spl ntp blockchainSource =
                 (getPoolLifeCycleStatus spl)
         :<|> signTransaction shelley
         :<|>
-            (\wid mMinWithdrawal mStart mEnd mOrder mLimit simpleMetadataFlag ->
+            (\wid mMinWithdrawal mStart mEnd mOrder mLimit mAddress simpleMetadataFlag ->
                 listTransactions shelley wid mMinWithdrawal mStart mEnd mOrder mLimit
-                    (parseSimpleMetadataFlag simpleMetadataFlag)
+                    mAddress (parseSimpleMetadataFlag simpleMetadataFlag)
             )
         :<|>
             (\wid txId simpleMetadataFlag ->
@@ -479,14 +479,14 @@ server byron icarus shelley multisig spl ntp blockchainSource =
 
     byronTransactions :: Server (ByronTransactions n)
     byronTransactions =
-            (\wid r0 r1 s l -> withLegacyLayer wid
+            (\wid r0 r1 s l a -> withLegacyLayer wid
                 ( byron
                 , listTransactions
-                    byron wid Nothing r0 r1 s l TxMetadataDetailedSchema
+                    byron wid Nothing r0 r1 s l a TxMetadataDetailedSchema
                 )
                 ( icarus
                 , listTransactions
-                    icarus wid Nothing r0 r1 s l TxMetadataDetailedSchema
+                    icarus wid Nothing r0 r1 s l a TxMetadataDetailedSchema
                 )
              )
         :<|>
@@ -614,9 +614,9 @@ server byron icarus shelley multisig spl ntp blockchainSource =
                     (parseSimpleMetadataFlag simpleMetadataFlag)
             )
         :<|>
-            (\wid mMinWithdrawal mStart mEnd mOrder mLimit simpleMetadataFlag ->
+            (\wid mMinWithdrawal mStart mEnd mOrder mLimit mAddress simpleMetadataFlag ->
                 listTransactions apilayer wid mMinWithdrawal mStart mEnd mOrder
-                    mLimit (parseSimpleMetadataFlag simpleMetadataFlag)
+                    mLimit mAddress (parseSimpleMetadataFlag simpleMetadataFlag)
             )
 
     blocks :: Handler ApiBlockHeader

lib/wallet/api/http/Cardano/Wallet/Api/Http/Shelley/Server.hs

@@ -2254,10 +2254,11 @@ listTransactions
     -> Maybe Iso8601Time
     -> Maybe (ApiT SortOrder)
     -> Maybe ApiLimit
+    -> Maybe (ApiAddress n)
     -> TxMetadataSchema
     -> Handler [ApiTransaction n]
 listTransactions
-    ctx (ApiT wid) mMinWithdrawal mStart mEnd mOrder mLimit metadataSchema =
+    ctx (ApiT wid) mMinWithdrawal mStart mEnd mOrder mLimit mAddress metadataSchema =
         withWorkerCtx ctx wid liftE liftE $ \wrk -> do
             txs <- liftHandler $
                 W.listTransactions wrk
@@ -2266,6 +2267,7 @@ listTransactions
                 (getIso8601Time <$> mEnd)
                 (maybe defaultSortOrder getApiT mOrder)
                 (fromApiLimit <$> mLimit)
+                (apiAddress <$> mAddress)
             depo <- liftIO $ W.stakeKeyDeposit <$>
                 NW.currentProtocolParameters (wrk ^. networkLayer)
             forM txs $ \tx ->

lib/wallet/api/http/Cardano/Wallet/Api/Link.hs

@@ -128,7 +128,8 @@ import Cardano.Wallet.Address.Derivation
 import Cardano.Wallet.Address.Discovery.Shared
     ( CredentialType (..) )
 import Cardano.Wallet.Api.Types
-    ( ApiAddressInspectData (..)
+    ( ApiAddress (..)
+    , ApiAddressInspectData (..)
     , ApiPoolSpecifier
     , ApiT (..)
     , ApiTxId (ApiTxId)
@@ -144,7 +145,7 @@ import Cardano.Wallet.Api.Types.Transaction
 import Cardano.Wallet.Primitive.Types
     ( SmashServer, SortOrder, WalletId (..) )
 import Cardano.Wallet.Primitive.Types.Address
-    ( AddressState )
+    ( Address, AddressState )
 import Cardano.Wallet.Primitive.Types.Coin
     ( Coin (..) )
 import Cardano.Wallet.Primitive.Types.Hash
@@ -614,7 +615,7 @@ listTransactions
     => w
     -> (Method, Text)
 listTransactions w =
-    listTransactions' @style w Nothing Nothing Nothing Nothing Nothing
+    listTransactions' @style w Nothing Nothing Nothing Nothing Nothing Nothing
 
 listTransactions'
     :: forall (style :: WalletStyle) w.
@@ -627,8 +628,9 @@ listTransactions'
     -> Maybe Iso8601Time
     -> Maybe SortOrder
     -> Maybe ApiLimit
+    -> Maybe Address
     -> (Method, Text)
-listTransactions' w minWithdrawal inf sup order limit = discriminate @style
+listTransactions' w minWithdrawal inf sup order limit address = discriminate @style
     (endpoint @(Api.ListTransactions Net)
         (\mk -> mk
             wid
@@ -637,11 +639,12 @@ listTransactions' w minWithdrawal inf sup order limit = discriminate @style
             sup
             (ApiT <$> order)
             limit
+            (ApiAddress <$> address)
             (toSimpleMetadataFlag TxMetadataDetailedSchema)
         )
     )
     (endpoint @(Api.ListByronTransactions Net)
-        (\mk -> mk wid inf sup (ApiT <$> order) limit))
+        (\mk -> mk wid inf sup (ApiT <$> order) limit (ApiAddress <$> address)))
     (endpoint @(Api.ListSharedTransactions Net)
         (\mk -> mk
             wid
@@ -650,6 +653,7 @@ listTransactions' w minWithdrawal inf sup order limit = discriminate @style
             sup
             (ApiT <$> order)
             limit
+            (ApiAddress <$> address)
             (toSimpleMetadataFlag TxMetadataDetailedSchema)
         )
     )

lib/wallet/bench/api-bench.hs

@@ -246,12 +246,12 @@ benchmarksSeq BenchmarkConfig{benchmarkName,ctx} = do
         $ fmap (fromIntegral . length)
         $ unsafeRunExceptT
         $ W.listTransactions ctx
-            Nothing Nothing Nothing Descending Nothing
+            Nothing Nothing Nothing Descending Nothing Nothing
 
     (_, listTransactionsLimitedTime) <- bench "listTransactions (max_count=50)"
         $ unsafeRunExceptT
         $ W.listTransactions ctx
-            Nothing Nothing Nothing Descending (Just 50)
+            Nothing Nothing Nothing Descending (Just 50) Nothing
 
     (_, createMigrationPlanTime) <- bench "createMigrationPlan"
         $ W.createMigrationPlan ctx Tx.NoWithdrawal
@@ -326,12 +326,12 @@ benchmarksShared BenchmarkConfig{benchmarkName,ctx} = do
         $ fmap (fromIntegral . length)
         $ unsafeRunExceptT
         $ W.listTransactions ctx
-            Nothing Nothing Nothing Descending Nothing
+            Nothing Nothing Nothing Descending Nothing Nothing
 
     (_, listTransactionsLimitedTime) <- bench "listTransactions (max_count=50)"
         $ unsafeRunExceptT
         $ W.listTransactions ctx
-            Nothing Nothing Nothing Descending (Just 50)
+            Nothing Nothing Nothing Descending (Just 50) Nothing
 
     pure BenchSharedResults
         { benchName = benchmarkName
@@ -395,12 +395,12 @@ benchmarksRnd BenchmarkConfig{benchmarkName,ctx} = do
         $ fmap (fromIntegral . length)
         $ unsafeRunExceptT
         $ W.listTransactions ctx
-            Nothing Nothing Nothing Descending Nothing
+            Nothing Nothing Nothing Descending Nothing Nothing
 
     (_, listTransactionsLimitedTime) <- bench "listTransactions (max_count=50)"
         $ unsafeRunExceptT
         $ W.listTransactions ctx
-            Nothing Nothing Nothing Descending (Just 50)
+            Nothing Nothing Nothing Descending (Just 50) Nothing
 
     (_, createMigrationPlanTime) <- bench "createMigrationPlan"
         $ W.createMigrationPlan ctx Tx.NoWithdrawal

lib/wallet/bench/db-bench.hs

@@ -529,7 +529,7 @@ benchReadTxHistory
     -> DBLayerBench
     -> IO [TransactionInfo]
 benchReadTxHistory sortOrder (inf, sup) mstatus mlimit DBLayer{..} =
-    atomically $ readTransactions Nothing sortOrder range mstatus mlimit
+    atomically $ readTransactions Nothing sortOrder range mstatus mlimit Nothing
   where
     range = Range
         (SlotNo . fromIntegral <$> inf)

lib/wallet/bench/restore-bench.hs

@@ -473,7 +473,7 @@ benchmarksRnd network w wname
         $ fmap (fromIntegral . length)
         $ unsafeRunExceptT
         $ W.listTransactions w Nothing Nothing Nothing Descending
-            Nothing
+            Nothing Nothing
 
     -- To aid with debugging, write the current wallet state to the log:
     let walletOverview = WalletOverview{utxo,addresses,transactions}
@@ -486,7 +486,7 @@ benchmarksRnd network w wname
     (_, listTransactionsLimitedTime) <- bench "list transactions (max_count = 100)" $ do
         unsafeRunExceptT
         $ W.listTransactions w Nothing Nothing Nothing Descending
-            (Just 100)
+            (Just 100) Nothing
 
     estimateFeesTime <-
         withNonEmptyUTxO cp pending CannotEstimateFeeForWalletWithEmptyUTxO $
@@ -569,7 +569,7 @@ benchmarksSeq network w _wname
         $ fmap (fromIntegral . length)
         $ unsafeRunExceptT
         $ W.listTransactions w Nothing Nothing Nothing Descending
-            Nothing
+            Nothing Nothing
 
     -- To aid with debugging, write the current wallet state to the log:
     let walletOverview = WalletOverview{utxo,addresses,transactions}
@@ -582,7 +582,7 @@ benchmarksSeq network w _wname
     (_, listTransactionsLimitedTime) <- bench "list transactions (max_count = 100)" $ do
         unsafeRunExceptT
         $ W.listTransactions w Nothing Nothing Nothing Descending
-            (Just 100)
+            (Just 100) Nothing
 
     estimateFeesTime <-
         withNonEmptyUTxO cp pending CannotEstimateFeeForWalletWithEmptyUTxO $

lib/wallet/integration/src/Test/Integration/Framework/DSL.hs

@@ -2712,6 +2712,7 @@ listTransactions ctx w mStart mEnd mOrder mLimit = do
         (Iso8601Time <$> mEnd)
         mOrder
         mLimit
+        Nothing
 
 -- | Delete all wallets
 deleteAllWallets :: Context -> IO ()