PLT-646 Deprecated the TotalFunds effect of WalletEffect.

In short, we won't be using the wallet to query blockchain information.
This is the responsability of the indexing component.
See our ADRs for more details.

Author: koslambrou

plutus-contract/src/Wallet/Effects.hs

@@ -9,6 +9,7 @@
 {-# LANGUAGE NamedFieldPuns    #-}
 {-# LANGUAGE OverloadedStrings #-}
 {-# LANGUAGE TemplateHaskell   #-}
+
 module Wallet.Effects(
     -- * Wallet effect
     WalletEffect(..)
@@ -31,6 +32,8 @@ import Ledger (Address, CardanoTx, Params, Slot, Value)
 import Ledger.Constraints.OffChain (UnbalancedTx)
 import Wallet.Error (WalletAPIError)
 
+{-# DEPRECATED TotalFunds "We won't use the wallet for querying blockchain information. See https://plutus-apps.readthedocs.io/en/latest/adr/0005-pab-indexing-solution-integration.html" #-}
+
 data WalletEffect r where
     SubmitTxn :: CardanoTx -> WalletEffect ()
     OwnAddresses :: WalletEffect (NonEmpty Address)

plutus-contract/src/Wallet/Emulator/Wallet.hs

@@ -19,6 +19,7 @@
 {-# LANGUAGE ViewPatterns          #-}
 
 {-# OPTIONS_GHC -Wno-orphans  #-}
+{-# OPTIONS_GHC -Wno-deprecations #-} -- TODO Remove once TotalFunds gets removed
 
 module Wallet.Emulator.Wallet where
 

plutus-pab/src/Cardano/Wallet/LocalClient.hs

@@ -7,6 +7,8 @@
 {-# LANGUAGE TypeApplications  #-}
 {-# LANGUAGE TypeOperators     #-}
 
+{-# OPTIONS_GHC -Wno-deprecations #-} -- TODO Remove once TotalFunds gets removed
+
 module Cardano.Wallet.LocalClient where
 
 import Cardano.Api qualified

plutus-pab/src/Cardano/Wallet/Mock/API.hs

@@ -42,5 +42,6 @@ type API walletId -- see note [WalletID type in wallet API]
       :<|> Capture "walletId" walletId :> "own-payment-public-key-hash" :> Get '[JSON] PaymentPubKeyHash
       :<|> Capture "walletId" walletId :> "own-addresses" :> Get '[JSON] (NonEmpty Address)
       :<|> Capture "walletId" walletId :> "balance-tx" :> ReqBody '[JSON] UnbalancedTx :> Post '[JSON] (Either WalletAPIError CardanoTx)
+      -- TODO: Should we removed as deprecated
       :<|> Capture "walletId" walletId :> "total-funds" :> Get '[JSON] Value
       :<|> Capture "walletId" walletId :> "sign" :> ReqBody '[JSON] CardanoTx :> Post '[JSON] CardanoTx

plutus-pab/src/Cardano/Wallet/Mock/Client.hs

@@ -5,6 +5,8 @@
 {-# LANGUAGE TypeApplications #-}
 {-# LANGUAGE TypeOperators    #-}
 
+{-# OPTIONS_GHC -Wno-deprecations #-} -- TODO Remove once TotalFunds gets removed
+
 module Cardano.Wallet.Mock.Client where
 
 import Cardano.Wallet.Mock.API (API)

plutus-pab/src/Cardano/Wallet/RemoteClient.hs

@@ -6,6 +6,8 @@
 {-# LANGUAGE TypeApplications  #-}
 {-# LANGUAGE TypeOperators     #-}
 
+{-# OPTIONS_GHC -Wno-deprecations #-} -- TODO Remove once TotalFunds gets removed
+
 module Cardano.Wallet.RemoteClient
     ( handleWalletClient
     ) where