feat(bidder_deposit): implement DepositCleanup sub-validator

Author: errfrom

src/HydraAuctionOnchain/Errors/Validators/BidderDeposit.hs

@@ -26,6 +26,10 @@ data PBidderDepositError (s :: S)
   | BidderDeposit'ReclaimDepositLoser'Error'IncorrectValidityInterval
   | BidderDeposit'ReclaimDepositLoser'Error'InvalidBidderAddress
   | BidderDeposit'ReclaimDepositLoser'Error'NoBidderConsent
+  | -- DepositCleanup errors
+    BidderDeposit'DepositCleanup'Error'IncorrectValidityInterval
+  | BidderDeposit'DepositCleanup'Error'InvalidBidderAddress
+  | BidderDeposit'DepositCleanup'Error'NoBidderConsent
   deriving stock (Generic, Eq)
   deriving anyclass (PlutusType)
 

src/HydraAuctionOnchain/Validators/BidderDeposit.hs

@@ -21,7 +21,11 @@ import HydraAuctionOnchain.Helpers
   )
 import HydraAuctionOnchain.Lib.Address (paddrPaymentKeyHash)
 import HydraAuctionOnchain.Lib.ScriptContext (pinputSpentWithRedeemer)
-import HydraAuctionOnchain.Types.AuctionTerms (PAuctionTerms, ppostBiddingPeriod)
+import HydraAuctionOnchain.Types.AuctionTerms
+  ( PAuctionTerms
+  , pcleanupPeriod
+  , ppostBiddingPeriod
+  )
 import HydraAuctionOnchain.Types.BidderInfo (PBidderInfo)
 import HydraAuctionOnchain.Types.Error (errCode, passert, passertMaybe)
 import HydraAuctionOnchain.Types.StandingBidState (PStandingBidState, pbidderLost, pbidderWon)
@@ -104,6 +108,11 @@ bidderDepositValidator = phoistAcyclic $
           # auctionCs
           # auctionTerms
           # bidderInfo
+      DepositCleanupRedeemer _ ->
+        pcheckDepositCleanup
+          # txInfo
+          # auctionTerms
+          # bidderInfo
       _ -> undefined
 
 ----------------------------------------------------------------------
@@ -233,3 +242,32 @@ pcheckReclaimDepositLoser = phoistAcyclic $
       ptxSignedBy # txInfoFields.signatories # pdata bidderPkh
 
     pcon PUnit
+
+----------------------------------------------------------------------
+-- DepositCleanup
+--
+-- If, for whatever reason, there are bidder deposits left during
+-- the cleanup period, then whoever placed a deposit can freely
+-- reclaim it.
+
+pcheckDepositCleanup :: Term s (PTxInfo :--> PAuctionTerms :--> PBidderInfo :--> PUnit)
+pcheckDepositCleanup = phoistAcyclic $
+  plam $ \txInfo auctionTerms bidderInfo -> P.do
+    txInfoFields <- pletFields @["signatories", "validRange"] txInfo
+
+    -- This redeemer can only be used during the cleanup period.
+    passert $(errCode BidderDeposit'DepositCleanup'Error'IncorrectValidityInterval) $
+      pcontains # (pcleanupPeriod # auctionTerms) # txInfoFields.validRange
+
+    -- The payment part of the bidder address should be pkh.
+    bidderPkh <-
+      plet $
+        passertMaybe
+          $(errCode BidderDeposit'DepositCleanup'Error'InvalidBidderAddress)
+          (paddrPaymentKeyHash #$ pfield @"biBidderAddress" # bidderInfo)
+
+    -- The bidder deposit's bidder signed the transaction.
+    passert $(errCode BidderDeposit'DepositCleanup'Error'NoBidderConsent) $
+      ptxSignedBy # txInfoFields.signatories # pdata bidderPkh
+
+    pcon PUnit