## Issue ADP-3157 ## Summary This PR replaces the use of `Cardano.Wallet.Primitive.Types.Coin` with `Cardano.Ledger.Coin` in the type signature of `balanceTransaction`.
import Cardano.Wallet.Write.ProtocolParameters
( ProtocolParameters (..) )
import Cardano.Wallet.Write.Tx
( FeePerByte (..)
( Coin (..)
, FeePerByte (..)
, IsRecentEra (..)
, KeyWitnessCount (..)
, PParams
ErrBalanceTxInsufficientCollateralError
{ largestCombinationAvailable :: W.UTxO
-- ^ The largest available combination of pure ada UTxOs.
, minimumCollateralAmount :: W.Coin
, minimumCollateralAmount :: Coin
-- ^ The minimum quantity of ada necessary for collateral.
}
deriving (Eq, Generic, Show)
--
data ErrBalanceTxUnableToCreateChangeError =
ErrBalanceTxUnableToCreateChangeError
{ requiredCost :: !W.Coin
{ requiredCost :: !Coin
-- ^ An estimate of the minimal fee required for this transaction to
-- be considered valid.
--
-- TODO: ADP-2547
-- Investigate whether this field is really appropriate and necessary,
-- and if not, remove it.
, shortfall :: !W.Coin
, shortfall :: !Coin
-- ^ The total additional quantity of ada required to pay for the
-- minimum ada quantities of all change outputs as well as the
-- marginal fee for including these outputs in the transaction.
deriving (Eq, Generic, Show)
data ErrBalanceTxInternalError
= ErrUnderestimatedFee W.Coin SealedTx KeyWitnessCount
= ErrUnderestimatedFee Coin SealedTx KeyWitnessCount
| ErrFailedBalancing Cardano.Value
deriving (Show, Eq)
| otherwise ->
throwE . ErrBalanceTxInternalError $
ErrUnderestimatedFee
(W.Coin.unsafeFromIntegral (-c))
(Coin (-c))
(toSealed candidateTx)
witCount
TxFeeAndChange updatedFee updatedChange <- withExceptT
(\(ErrMoreSurplusNeeded c) ->
ErrBalanceTxInternalError $
ErrUnderestimatedFee c (toSealed candidateTx) witCount)
ErrUnderestimatedFee
(W.toLedgerCoin c) (toSealed candidateTx) witCount
)
(ExceptT . pure $
distributeSurplus feePerByte surplus feeAndChange)
UnableToConstructChangeError {shortfall, requiredCost} ->
ErrBalanceTxUnableToCreateChange
ErrBalanceTxUnableToCreateChangeError
{shortfall, requiredCost}
{ shortfall = W.toLedgerCoin shortfall
, requiredCost = W.toLedgerCoin requiredCost
}
EmptyUTxO ->
ErrBalanceTxUnableToCreateInput
SelectionCollateralErrorOf SelectionCollateralError
& fmap W.TokenBundle.fromCoin
& toExternalUTxOMap
, minimumCollateralAmount
= minimumSelectionAmount
= W.toLedgerCoin minimumSelectionAmount
}
--------------------------------------------------------------------------------
-- 'IsServerError' definition along with most instances
--
module Cardano.Wallet.Api.Http.Server.Error
( IsServerError (..)
, liftHandler
, liftE
, apiError
, err425
, showT
, handler
)
where
( IsServerError (..)
, liftHandler
, liftE
, apiError
, err425
, showT
, handler
)
where
import Prelude
( Flat (..) )
import Cardano.Wallet.Primitive.Types.Tx.SealedTx
( serialisedTx )
import Cardano.Wallet.Shelley.Compatibility.Ledger
( toWalletCoin )
import Cardano.Wallet.Transaction
( ErrSignTx (..) )
import Cardano.Wallet.Write.Tx.Balance
( isInfixOf, isPrefixOf, isSubsequenceOf )
import Data.Maybe
( isJust )
import Data.Quantity
( Quantity (Quantity) )
import Data.Text
( Text )
import Data.Text.Class
, "is not enough ada available to pay for the fee and"
, "also pay for the minimum ada quantities of all"
, "change outputs. I need approximately"
, pretty (view #shortfall e)
, pretty (toWalletCoin (view #shortfall e))
, "ada to proceed. Try increasing your wallet balance"
, "or sending a smaller amount."
]
ErrUnderestimatedFee coin candidateTx (KeyWitnessCount nWits nBootWits) ->
apiError err500 (BalanceTxUnderestimatedFee info) $ T.unwords
[ "I have somehow underestimated the fee of the transaction by"
, pretty coin, "and cannot finish balancing."
, pretty (toWalletCoin coin), "and cannot finish balancing."
]
where
info = ApiErrorBalanceTxUnderestimatedFee
{ underestimation = Quantity $ Coin.toNatural coin
{ underestimation = Coin.toQuantity $ toWalletCoin coin
, candidateTxHex = hexText $ serialisedTx candidateTx
, candidateTxReadable = T.pack (show candidateTx)
, estimatedNumberOfKeyWits = intCast nWits
, "of pure ada UTxOs in your wallet is insufficient to cover"
, "the minimum amount of collateral required."
, "I need an ada amount of at least:"
, pretty (view #minimumCollateralAmount e)
, pretty (toWalletCoin (view #minimumCollateralAmount e))
, "The largest combination of pure ada UTxOs I could find is:"
, pretty $ listF $ L.sort
$ fmap (view #coin . view #tokens . snd)
, fromCardanoWdrls
)
import Cardano.Wallet.Shelley.Compatibility.Ledger
( toWallet )
( toWallet, toWalletCoin )
import Cardano.Wallet.Shelley.Transaction
( txWitnessTagForKey )
import Cardano.Wallet.Transaction
handleCannotCover = \case
ErrBalanceTxUnableToCreateChange
ErrBalanceTxUnableToCreateChangeError {requiredCost} ->
pure $ Fee requiredCost
pure $ Fee $ toWalletCoin requiredCost
e -> throwE e
-- | Make a pair of fee estimation percentiles more imprecise.
, toCardanoValue
)
import Cardano.Wallet.Shelley.Compatibility.Ledger
( toBabbageTxOut, toLedger, toLedgerTokenBundle, toWallet )
( toBabbageTxOut, toLedger, toLedgerTokenBundle, toWallet, toWalletCoin )
import Cardano.Wallet.Shelley.Transaction
( EraConstraints
, TxWitnessTag (..)
feeEstimationRegressionSpec :: Spec
feeEstimationRegressionSpec = describe "Regression tests" $ do
it "#1740 Fee estimation at the boundaries" $ do
let requiredCost = Fee (Coin.fromNatural 166_029)
let requiredCostLovelace :: Natural
requiredCostLovelace = 166_029
let estimateFee = except $ Left
$ ErrBalanceTxUnableToCreateChange
$ ErrBalanceTxUnableToCreateChangeError
{ requiredCost = feeToCoin requiredCost
, shortfall = Coin 100_000
{ requiredCost = Ledger.Coin $ intCast requiredCostLovelace
, shortfall = Ledger.Coin 100_000
}
result <- runExceptT (calculateFeePercentiles estimateFee)
result `shouldBe` Right
( Percentile requiredCost
, Percentile requiredCost
( Percentile $ Fee $ Coin requiredCostLovelace
, Percentile $ Fee $ Coin requiredCostLovelace
)
binaryCalculationsSpec :: AnyRecentEra -> Spec
Left (ErrBalanceTxInternalError
(ErrUnderestimatedFee delta candidateTx nWits)) ->
let counterexampleText = unlines
[ "underestimated fee by " <> pretty delta
[ "underestimated fee by "
<> pretty (toWalletCoin delta)
, "candidate tx: " <> pretty candidateTx
, "assuming key witness count: " <> show nWits
]
Alonzo builds
