document newly added validation context types

This commit is contained in:
Hongrui Fang 2022-09-06 21:50:48 +08:00 committed by 方泓睿
parent e5dc29f98b
commit 0db0abbe49
No known key found for this signature in database
GPG key ID: F10AB2CCE24113DD
2 changed files with 34 additions and 12 deletions

View file

@ -197,6 +197,11 @@ stakePolicy gtClassRef =
--------------------------------------------------------------------------------
{- | Validation context for stake redeemers that allow only one stake to be
spent in the transaction.
@since 1.0.0
-}
data POnlyOneStakeContext (s :: S) = POnlyOneStakeContext
{ ownOutputDatum :: Term s PStakeDatum
, ownOutputValue :: Term s (PValue 'Sorted 'Positive)
@ -204,12 +209,15 @@ data POnlyOneStakeContext (s :: S) = POnlyOneStakeContext
, onlyLocksUpdated :: Term s PBool
}
deriving stock
( Generic
( -- | @since 1.0.0
Generic
)
deriving anyclass
( PlutusType
( -- | @since 1.0.0
PlutusType
)
-- | @since 1.0.0
instance DerivePlutusType POnlyOneStakeContext where
type DPTStrat _ = PlutusTypeScott