Skip to content

Commit

Permalink
Add W.balanceTx helper (#4629)
Browse files Browse the repository at this point in the history 
Add `W.balanceTx` helper used by the following endpoints
- `constructTransaction`
- `constructTransactionShared`
- `balanceTransaction`

such that
- A future PR can make `W.balanceTx` automatically query the node for
the `UTxO` corresponding to the inputs of the `PartialTx` (this is part
of the fix for the integration test in the 8.11 branch; if we have the
`UTxO` of the reference input, then `Ledger.getMinFeeTxUtxo pp tx utxo`
will correctly account for `minFeeRefScriptCoinsPerByte *
totalRefScriptSize`)
- We can hide some balanceTx configuration (utxoAssumptions,
argGenChange) to the api handlers

### Comments

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

### Issue Number

ADP-3373
  • Loading branch information
@Anviking
Anviking authored Jun 25, 2024
2 parents 15ca1da + 620ff36 commit fae66a5
Show file tree
Hide file tree
Showing 3 changed files with 156 additions and 135 deletions.
19 changes: 3 additions & 16 deletions lib/api/src/Cardano/Wallet/Api/Http/Server.hs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -43,11 +43,9 @@ import Cardano.Wallet
, networkLayer
, normalizeDelegationAddress
, normalizeSharedAddress
, utxoAssumptionsForWallet
)
import Cardano.Wallet.Address.Derivation
( Role (..)
, delegationAddressS
( delegationAddressS
, paymentAddressS
)
import Cardano.Wallet.Address.Derivation.Icarus
Expand All @@ -56,9 +54,6 @@ import Cardano.Wallet.Address.Derivation.Icarus
import Cardano.Wallet.Address.Derivation.Shared
( SharedKey (..)
)
import Cardano.Wallet.Address.Derivation.SharedKey
( constructAddressFromIx
)
import Cardano.Wallet.Address.Derivation.Shelley
( ShelleyKey (..)
)
Expand Down Expand Up @@ -209,9 +204,6 @@ import Cardano.Wallet.Api.Types.SchemaMetadata
( TxMetadataSchema (..)
, parseSimpleMetadataFlag
)
import Cardano.Wallet.Flavor
( WalletFlavorS (..)
)
import Cardano.Wallet.Pools
( StakePoolLayer (..)
)
Expand Down Expand Up @@ -377,7 +369,6 @@ server byron icarus shelley multisig spl ntp blockchainSource =
shelleyTransactions :: Server (ShelleyTransactions n)
shelleyTransactions =
constructTransaction shelley
(delegationAddressS @n)
(knownPools spl)
(getPoolLifeCycleStatus spl)
:<|> signTransaction shelley
Expand All @@ -394,11 +385,7 @@ server byron icarus shelley multisig spl ntp blockchainSource =
:<|> deleteTransaction shelley
:<|> postTransactionOld shelley (delegationAddressS @n)
:<|> postTransactionFeeOld shelley
:<|> balanceTransaction
shelley
(delegationAddressS @n)
(utxoAssumptionsForWallet ShelleyWallet)
mempty
:<|> balanceTransaction shelley
:<|> decodeTransaction shelley
:<|> submitTransaction @_ @_ @_ @n shelley

Expand Down Expand Up @@ -653,7 +640,7 @@ server byron icarus shelley multisig spl ntp blockchainSource =
:: ApiLayer (SharedState n SharedKey)
-> Server (SharedTransactions n)
sharedTransactions apilayer =
constructSharedTransaction apilayer (constructAddressFromIx @n UtxoInternal)
constructSharedTransaction apilayer
(knownPools spl) (getPoolLifeCycleStatus spl)
:<|> signTransaction apilayer
:<|> decodeSharedTransaction apilayer
Expand Down
157 changes: 73 additions & 84 deletions lib/api/src/Cardano/Wallet/Api/Http/Shelley/Server.hs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -211,7 +211,6 @@ import Cardano.Wallet
, readPrivateKey
, readWalletMeta
, txWitnessTagForKey
, utxoAssumptionsForWallet
)
import Cardano.Wallet.Address.Book
( AddressBookIso
Expand Down Expand Up @@ -505,16 +504,21 @@ import Cardano.Wallet.DB
, DBLayer
)
import Cardano.Wallet.Flavor
( CredFromOf
( AllFlavors
, CredFromOf
, Excluding
, FlavorOf
, Including
, KeyFlavorS (..)
, KeyOf
, NetworkOf
, WalletFlavor (..)
, WalletFlavor
, WalletFlavorS (..)
, WalletFlavors (..)
, keyFlavorFromState
, keyOfWallet
, shelleyOrShared
, walletFlavor
)
import Cardano.Wallet.Network
( ErrFetchBlock (..)
Expand Down Expand Up @@ -628,7 +632,6 @@ import Cardano.Wallet.Primitive.Types.Tx
, UnsignedTx (..)
, cardanoTxInExactEra
, getSealedTxWitnesses
, sealedTxFromCardanoBody
)
import Cardano.Wallet.Primitive.Types.Tx.Constraints
( txMintBurnMaxTokenQuantity
Expand Down Expand Up @@ -829,8 +832,8 @@ import Internal.Cardano.Write.Tx
( AnyRecentEra (..)
)
import Internal.Cardano.Write.Tx.Balance
( Redeemer (..)
, UTxOAssumptions (..)
( PartialTx (..)
, Redeemer (..)
)
import Internal.Cardano.Write.Tx.Sign
( TimelockKeyWitnessCounts
Expand Down Expand Up @@ -952,8 +955,10 @@ import qualified Internal.Cardano.Write.Tx as Write
, IsRecentEra
, PParamsInAnyRecentEra (PParamsInAnyRecentEra)
, RecentEra
, Tx
, TxIn
, TxOutInRecentEra (TxOutInRecentEra)
, cardanoEra
, cardanoEraFromRecentEra
, fromCardanoApiTx
, getFeePerByte
Expand All @@ -963,9 +968,6 @@ import qualified Internal.Cardano.Write.Tx as Write
)
import qualified Internal.Cardano.Write.Tx.Balance as Write
( PartialTx (PartialTx)
, balanceTx
, constructUTxOIndex
, fromWalletUTxO
)
import qualified Internal.Cardano.Write.Tx.Sign as Write
( TimelockKeyWitnessCounts (TimelockKeyWitnessCounts)
Expand Down Expand Up @@ -2709,13 +2711,12 @@ constructTransaction
:: forall s n
. (HasSNetworkId n, s ~ SeqState n ShelleyKey)
=> ApiLayer s
-> ArgGenChange s
-> IO (Set PoolId)
-> (PoolId -> IO PoolLifeCycleStatus)
-> ApiT WalletId
-> ApiConstructTransactionData n
-> Handler (ApiConstructTransaction n)
constructTransaction api argGenChange knownPools poolStatus apiWalletId body = do
constructTransaction api knownPools poolStatus apiWalletId body = do
body & \(ApiConstructTransactionData _ _ _ _ _ _ _ _ _ _) ->
-- Above is the way to get a compiler error when number of fields changes,
-- in order not to forget to update the pattern below:
Expand Down Expand Up @@ -2756,7 +2757,7 @@ constructTransaction api argGenChange knownPools poolStatus apiWalletId body = d
let db = wrk ^. dbLayer
netLayer = wrk ^. networkLayer

(Write.PParamsInAnyRecentEra era pp, _)
(Write.PParamsInAnyRecentEra era pp, timeTranslation)
<- liftIO $ W.readNodeTipStateForTxWrite netLayer

when (isJust (body ^. #vote)) $
Expand Down Expand Up @@ -2916,18 +2917,16 @@ constructTransaction api argGenChange knownPools poolStatus apiWalletId body = d
$ maybe [] NE.toList mintBurnDatum

balancedTx <-
balanceTransaction
api
argGenChange
(utxoAssumptionsForWallet (walletFlavor @s))
mintBurnTimelockKeyWitCounts
apiWalletId
ApiBalanceTransactionPostData
{ transaction = ApiT
$ sealedTxFromCardanoBody unbalancedTx
, inputs = []
, redeemers = []
, encoding = body ^. #encoding
fmap (toApiSerialisedTransaction (body ^. #encoding))
. liftIO $ W.balanceTx
wrk
pp
timeTranslation
PartialTx
{ tx = Write.fromCardanoApiTx $ Cardano.Tx unbalancedTx []
, extraUTxO = mempty
, redeemers = mempty
, timelockKeyWitnessCounts = mintBurnTimelockKeyWitCounts
}

apiDecoded <- decodeTransaction @_ @n api apiWalletId
Expand Down Expand Up @@ -3263,14 +3262,13 @@ parseValidityInterval ti validityInterval = do
constructSharedTransaction
:: forall n . HasSNetworkId n
=> ApiLayer (SharedState n SharedKey)
-> ArgGenChange (SharedState n SharedKey)
-> IO (Set PoolId)
-> (PoolId -> IO PoolLifeCycleStatus)
-> ApiT WalletId
-> ApiConstructTransactionData n
-> Handler (ApiConstructTransaction n)
constructSharedTransaction
api argGenChange knownPools getPoolStatus (ApiT wid) body = do
api knownPools getPoolStatus (ApiT wid) body = do
let isNoPayload =
isNothing (body ^. #payments) &&
isNothing (body ^. #withdrawal) &&
Expand All @@ -3293,7 +3291,7 @@ constructSharedTransaction
netLayer = wrk ^. networkLayer

currentEpochSlotting <- liftIO $ getCurrentEpochSlotting netLayer
(Write.PParamsInAnyRecentEra era pp, _)
(Write.PParamsInAnyRecentEra era pp, timeTranslation)
<- liftIO $ W.readNodeTipStateForTxWrite netLayer
(cp, _, _) <- handler $ W.readWallet wrk

Expand Down Expand Up @@ -3339,28 +3337,27 @@ constructSharedTransaction
[]
Just (ApiPaymentAddresses content) ->
F.toList (addressAmountToTxOut <$> content)
(unbalancedTx, scriptLookup) <- liftHandler $
unbalancedTx <- liftHandler $
W.constructUnbalancedSharedTransaction @n era
db txCtx PreSelection {outputs = outs}

balancedTx <-
balanceTransaction api argGenChange
(AllScriptPaymentCredentialsFrom
(Shared.paymentTemplate (getState cp))
(scriptLookup . Convert.toWalletAddress)
)
mempty
(ApiT wid)
ApiBalanceTransactionPostData
{ transaction =
ApiT $ sealedTxFromCardanoBody unbalancedTx
, inputs = []
, redeemers = []
, encoding = body ^. #encoding
balancedTx <- liftIO $ W.balanceTx
wrk
pp
timeTranslation
PartialTx
{ tx = Write.fromCardanoApiTx
$ Cardano.Tx unbalancedTx []
, extraUTxO = mempty
, redeemers = mempty
, timelockKeyWitnessCounts = mempty
}

apiDecoded <- decodeSharedTransaction api (ApiT wid)
(toApiDecodeTransactionPostData balancedTx)
apiDecoded <- decodeSharedTransaction api (ApiT wid) $
ApiDecodeTransactionPostData
{ transaction = ApiT (sealWriteTx balancedTx)
, decrypt_metadata = Nothing
}
let deposits = case optionalDelegationAction of
Just (JoinRegisteringKey _poolId) ->
[W.getStakeKeyDeposit pp]
Expand All @@ -3384,7 +3381,9 @@ constructSharedTransaction
pure Nothing

pure $ ApiConstructTransaction
{ transaction = balancedTx
{ transaction = toApiSerialisedTransaction
(body ^. #encoding)
balancedTx
, coinSelection =
mkApiCoinSelection deposits refunds
delCertsWithPath md
Expand Down Expand Up @@ -3512,53 +3511,27 @@ decodeSharedTransaction ctx (ApiT wid) postData = do
}

balanceTransaction
:: forall s
. (GenChange s, WalletFlavor s)
:: forall s.
( GenChange s
, WalletFlavor s
, Including AllFlavors '[ 'ShelleyF, 'SharedF] (FlavorOf s)
, HasSNetworkId (NetworkOf s)
)
=> ApiLayer s
-> ArgGenChange s
-> UTxOAssumptions
-> TimelockKeyWitnessCounts
-> ApiT WalletId
-> ApiBalanceTransactionPostData (NetworkOf s)
-> Handler ApiSerialisedTransaction
balanceTransaction
ctx@ApiLayer{..}
argGenChange
utxoAssumptions
timelockKeyWitnessCounts
(ApiT wid)
body
= do
(Write.PParamsInAnyRecentEra era pp, timeTranslation)
<- liftIO $ W.readNodeTipStateForTxWrite netLayer
balanceTransaction ctx (ApiT wid) body = do
withWorkerCtx ctx wid liftE liftE $ \wrk -> do
(utxo, wallet, _txs) <- handler $ W.readWalletUTxO wrk
let utxoIndex =
Write.constructUTxOIndex $
Write.fromWalletUTxO utxo
(Write.PParamsInAnyRecentEra era pp, timeTranslation)
<- liftIO $ W.readNodeTipStateForTxWrite (wrk ^. networkLayer)
partialTx <- parsePartialTx era
balancedTx <- liftHandler
. fmap
( Cardano.InAnyCardanoEra
(Write.cardanoEraFromRecentEra era)
. Write.toCardanoApiTx
. fst
)
$ Write.balanceTx
balancedTx <- liftIO $ W.balanceTx
wrk
pp
timeTranslation
utxoAssumptions
utxoIndex
(W.defaultChangeAddressGen argGenChange)
(getState wallet)
partialTx

case body ^. #encoding of
Just HexEncoded ->
pure $ ApiSerialisedTransaction
(ApiT $ W.sealedTxFromCardano balancedTx) HexEncoded
_ -> pure $ ApiSerialisedTransaction
(ApiT $ W.sealedTxFromCardano balancedTx) Base64Encoded
return $ toApiSerialisedTransaction (body ^. #encoding) balancedTx
where
parsePartialTx
:: Write.IsRecentEra era
Expand All @@ -3585,7 +3558,7 @@ balanceTransaction
(Write.fromCardanoApiTx tx)
externalUTxO
(fromApiRedeemer <$> body ^. #redeemers)
timelockKeyWitnessCounts
(mempty :: TimelockKeyWitnessCounts)
Left e -> liftHandler $ throwE e

decodeTransaction
Expand Down Expand Up @@ -5116,6 +5089,22 @@ fromApiRedeemer = \case
ApiRedeemerRewarding (ApiBytesT bytes) (StakeAddress x y) ->
RedeemerRewarding bytes (RewardAcnt x y)

sealWriteTx :: forall era. Write.IsRecentEra era => Write.Tx era -> W.SealedTx
sealWriteTx = W.sealedTxFromCardano
. Cardano.InAnyCardanoEra (Write.cardanoEra @era)
. Write.toCardanoApiTx

toApiSerialisedTransaction
:: Write.IsRecentEra era
=> Maybe ApiSealedTxEncoding
-> Write.Tx era
-> ApiSerialisedTransaction
toApiSerialisedTransaction maybeEncoding tx =
let
encoding = fromMaybe Base64Encoded maybeEncoding
in
ApiSerialisedTransaction (ApiT $ sealWriteTx tx) encoding

{-------------------------------------------------------------------------------
Api Layer
-------------------------------------------------------------------------------}
Expand Down
Loading

0 comments on commit fae66a5

Please sign in to comment.