refactor: move auction tokens related functions to separate module

Author: errfrom

hydra-auction-onchain.cabal

@@ -105,7 +105,6 @@ library
     HydraAuctionOnchain.Errors.AuctionEscrow
     HydraAuctionOnchain.Errors.StandingBid
     HydraAuctionOnchain.Helpers
-    HydraAuctionOnchain.MintingPolicies.Auction
     HydraAuctionOnchain.Scripts
     HydraAuctionOnchain.Types.AuctionEscrowState
     HydraAuctionOnchain.Types.AuctionInfo
@@ -114,6 +113,7 @@ library
     HydraAuctionOnchain.Types.BidTerms
     HydraAuctionOnchain.Types.Error
     HydraAuctionOnchain.Types.StandingBidState
+    HydraAuctionOnchain.Types.Tokens
     HydraAuctionOnchain.Validators.AuctionEscrow
     HydraAuctionOnchain.Validators.AuctionMetadata
     HydraAuctionOnchain.Validators.StandingBid

src/HydraAuctionOnchain/Helpers.hs

@@ -13,17 +13,11 @@ module HydraAuctionOnchain.Helpers
   , pintervalFiniteClosedOpen
   , ponlyOneInputFromAddress
   , pserialise
-  , ptxOutContainsAuctionEscrowToken
-  , ptxOutContainsStandingBidToken
   , putxoAddress
   , pvaluePaidTo
   , pvaluePaidToScript
   ) where
 
-import HydraAuctionOnchain.MintingPolicies.Auction
-  ( auctionEscrowTokenName
-  , standingBidTokenName
-  )
 import Plutarch.Api.V1.Address (PCredential (PPubKeyCredential, PScriptCredential))
 import Plutarch.Api.V1.Value (pvalueOf)
 import Plutarch.Api.V2
@@ -181,18 +175,6 @@ ponlyOneInputFromAddress = phoistAcyclic $
 pserialise :: PIsData a => Term s (a :--> PByteString)
 pserialise = phoistAcyclic $ plam $ \x -> pserialiseData #$ pforgetData $ pdata x
 
-ptxOutContainsAuctionEscrowToken :: Term s (PCurrencySymbol :--> PTxOut :--> PBool)
-ptxOutContainsAuctionEscrowToken = phoistAcyclic $
-  plam $ \auctionCs txOut ->
-    (pvalueOf # (pfield @"value" # txOut) # auctionCs # auctionEscrowTokenName)
-      #== 1
-
-ptxOutContainsStandingBidToken :: Term s (PCurrencySymbol :--> PTxOut :--> PBool)
-ptxOutContainsStandingBidToken = phoistAcyclic $
-  plam $ \auctionCs txOut ->
-    (pvalueOf # (pfield @"value" # txOut) # auctionCs # standingBidTokenName)
-      #== 1
-
 putxoAddress :: Term s (PTxInInfo :--> PAddress)
 putxoAddress = phoistAcyclic $
   plam $ \utxo ->

src/HydraAuctionOnchain/MintingPolicies/Auction.hs renamed to src/HydraAuctionOnchain/Types/Tokens.hs

@@ -1,16 +1,20 @@
-module HydraAuctionOnchain.MintingPolicies.Auction
-  ( allAuctionTokensBurned
-  , auctionEscrowTokenName
+module HydraAuctionOnchain.Types.Tokens
+  ( auctionEscrowTokenName
   , auctionMetadataTokenName
+  , pallAuctionTokensBurned
+  , ptxOutContainsAuctionEscrowToken
+  , ptxOutContainsStandingBidToken
   , standingBidTokenName
   ) where
 
+import Plutarch.Api.V1.Value (pvalueOf)
 import Plutarch.Api.V1.Value qualified as Value (psingleton)
 import Plutarch.Api.V2
   ( AmountGuarantees (NonZero)
   , KeyGuarantees (Sorted)
   , PCurrencySymbol
   , PTokenName
+  , PTxOut
   , PValue
   )
 import Plutarch.Monadic qualified as P
@@ -27,10 +31,22 @@ auctionMetadataTokenName = pconstant "AUCTION_METADATA"
 standingBidTokenName :: Term s PTokenName
 standingBidTokenName = pconstant "STANDING_BID"
 
-allAuctionTokensBurned :: Term s (PCurrencySymbol :--> PValue 'Sorted 'NonZero)
-allAuctionTokensBurned = phoistAcyclic $
+pallAuctionTokensBurned :: Term s (PCurrencySymbol :--> PValue 'Sorted 'NonZero)
+pallAuctionTokensBurned = phoistAcyclic $
   plam $ \auctionCs -> P.do
     mkValue <- plet $ plam $ \tn -> Value.psingleton # auctionCs # tn # (-1)
     (mkValue # auctionEscrowTokenName)
       <> (mkValue # auctionMetadataTokenName)
       <> (mkValue # standingBidTokenName)
+
+ptxOutContainsAuctionEscrowToken :: Term s (PCurrencySymbol :--> PTxOut :--> PBool)
+ptxOutContainsAuctionEscrowToken = phoistAcyclic $
+  plam $ \auctionCs txOut ->
+    (pvalueOf # (pfield @"value" # txOut) # auctionCs # auctionEscrowTokenName)
+      #== 1
+
+ptxOutContainsStandingBidToken :: Term s (PCurrencySymbol :--> PTxOut :--> PBool)
+ptxOutContainsStandingBidToken = phoistAcyclic $
+  plam $ \auctionCs txOut ->
+    (pvalueOf # (pfield @"value" # txOut) # auctionCs # standingBidTokenName)
+      #== 1

src/HydraAuctionOnchain/Validators/AuctionEscrow.hs

@@ -19,13 +19,10 @@ import HydraAuctionOnchain.Helpers
   , pfindUniqueOutputWithScriptHash
   , pgetOwnInput
   , ponlyOneInputFromAddress
-  , ptxOutContainsAuctionEscrowToken
-  , ptxOutContainsStandingBidToken
   , putxoAddress
   , pvaluePaidTo
   , pvaluePaidToScript
   )
-import HydraAuctionOnchain.MintingPolicies.Auction (allAuctionTokensBurned)
 import HydraAuctionOnchain.Types.AuctionEscrowState
   ( PAuctionEscrowState (AuctionConcluded)
   , pvalidateAuctionEscrowTransitionToAuctionConcluded
@@ -42,6 +39,11 @@ import HydraAuctionOnchain.Types.AuctionTerms
 import HydraAuctionOnchain.Types.BidTerms (psellerPayout, pvalidateBidTerms)
 import HydraAuctionOnchain.Types.Error (errCode, passert, passertMaybe, passertMaybeData)
 import HydraAuctionOnchain.Types.StandingBidState (PStandingBidState (PStandingBidState))
+import HydraAuctionOnchain.Types.Tokens
+  ( pallAuctionTokensBurned
+  , ptxOutContainsAuctionEscrowToken
+  , ptxOutContainsStandingBidToken
+  )
 import Plutarch.Api.V1.Value (plovelaceValueOf, pnormalize)
 import Plutarch.Api.V2
   ( PAddress
@@ -493,7 +495,7 @@ pcheckCleanupAuction = phoistAcyclic $
     -- tokens of the auction should all be burned. No other tokens
     -- should be minted or burned.
     passert $(errCode AuctionEscrow'CleanupAuction'Error'AuctionTokensNotBurnedExactly) $
-      pnormalize # txInfoFields.mint #== allAuctionTokensBurned # auctionCs
+      pnormalize # txInfoFields.mint #== pallAuctionTokensBurned # auctionCs
 
     -- (AUES40) This redeemer can only be used during the cleanup period.
     passert $(errCode AuctionEscrow'CleanupAuction'Error'IncorrectValidityInterval) $

src/HydraAuctionOnchain/Validators/AuctionMetadata.hs

@@ -2,12 +2,12 @@ module HydraAuctionOnchain.Validators.AuctionMetadata
   ( auctionMetadataValidator
   ) where
 
-import HydraAuctionOnchain.MintingPolicies.Auction
+import HydraAuctionOnchain.Types.AuctionInfo (PAuctionInfo)
+import HydraAuctionOnchain.Types.Tokens
   ( auctionEscrowTokenName
   , auctionMetadataTokenName
   , standingBidTokenName
   )
-import HydraAuctionOnchain.Types.AuctionInfo (PAuctionInfo)
 import Plutarch.Api.V1.Value (pvalueOf)
 import Plutarch.Api.V2 (PScriptContext)
 import Plutarch.Extra.Bool (passert)

src/HydraAuctionOnchain/Validators/StandingBid.hs

@@ -12,13 +12,15 @@ import HydraAuctionOnchain.Helpers
   , pfindUniqueOutputWithAddress
   , pgetOwnInput
   , ponlyOneInputFromAddress
-  , ptxOutContainsStandingBidToken
   , putxoAddress
   )
-import HydraAuctionOnchain.MintingPolicies.Auction (auctionEscrowTokenName)
 import HydraAuctionOnchain.Types.AuctionTerms (PAuctionTerms, pbiddingPeriod)
 import HydraAuctionOnchain.Types.Error (errCode, passert, passertMaybe)
 import HydraAuctionOnchain.Types.StandingBidState (PStandingBidState, pvalidateNewBid)
+import HydraAuctionOnchain.Types.Tokens
+  ( auctionEscrowTokenName
+  , ptxOutContainsStandingBidToken
+  )
 import HydraAuctionOnchain.Validators.AuctionEscrow (pisConcluding)
 import Plutarch.Api.V2
   ( PCurrencySymbol