add and fix haddock doc comments

This commit is contained in:
Emily Martins 2022-06-02 15:24:58 +02:00
parent 5edd4d4ef1
commit 8e71ecbdfd
10 changed files with 28 additions and 13 deletions

View file

@ -87,6 +87,7 @@ inputGAT =
, txOutDatumHash = Just (DatumHash "")
}
-- | Create an input given the index of the treasury and the 'Value' at this input.
inputTreasury :: Int -> Value -> TxInInfo
inputTreasury indx val =
TxInInfo
@ -97,6 +98,7 @@ inputTreasury indx val =
, txOutDatumHash = Just (DatumHash "")
}
-- | Create a input given the index of the user and the 'Value' at this input.
inputUser :: Int -> Value -> TxInInfo
inputUser indx val =
TxInInfo
@ -107,6 +109,7 @@ inputUser indx val =
, txOutDatumHash = Just (DatumHash "")
}
-- | Create a input representing the collateral given by a user.
inputCollateral :: Int -> TxInInfo
inputCollateral indx =
TxInInfo -- Initiator
@ -117,6 +120,7 @@ inputCollateral indx =
, txOutDatumHash = Just (DatumHash "")
}
-- | Create an output at the nth treasury with the given 'Value'.
outputTreasury :: Int -> Value -> TxOut
outputTreasury indx val =
TxOut
@ -125,6 +129,7 @@ outputTreasury indx val =
, txOutDatumHash = Nothing
}
-- | Create an output at the nth user with the given 'Value'.
outputUser :: Int -> Value -> TxOut
outputUser indx val =
TxOut
@ -133,6 +138,7 @@ outputUser indx val =
, txOutDatumHash = Nothing
}
-- | Create a list of the outputs that are required as encoded in 'TreasuryWithdrawalDatum'.
buildReceiversOutputFromDatum :: TreasuryWithdrawalDatum -> [TxOut]
buildReceiversOutputFromDatum (TreasuryWithdrawalDatum xs _) = f <$> xs
where
@ -147,7 +153,7 @@ buildReceiversOutputFromDatum (TreasuryWithdrawalDatum xs _) = f <$> xs
validator :: Validator
validator = mkValidator $ treasuryWithdrawalValidator currSymbol
-- | 'TokenName' that represents the hash of the 'Stake' validator.
-- | 'TokenName' that represents the hash of the 'Agora.Stake.Stake' validator.
validatorHashTN :: TokenName
validatorHashTN = let ValidatorHash vh = validatorHash validator in TokenName vh