fix missing documentation for governorValidator

This commit is contained in:
fanghr 2022-04-21 23:34:04 +08:00
parent 4a645af531
commit b84ed61356

View file

@ -22,8 +22,8 @@ module Agora.Governor (
governorValidator, governorValidator,
-- * Utilities -- * Utilities
governorStateTokenAssetClass, gstAssetClass,
authorityTokenSymbolFromGovernor, gatSymbolFromGovernor,
) where ) where
-------------------------------------------------------------------------------- --------------------------------------------------------------------------------
@ -235,7 +235,7 @@ governorPolicy params =
popaque (pconstant ()) popaque (pconstant ())
{- Validator for Governors. {- | Validator for Governors.
No matter what redeemer it receives, it will always check: No matter what redeemer it receives, it will always check:
- The utxo which has the GST must be spent. - The utxo which has the GST must be spent.
@ -490,7 +490,7 @@ governorValidator params =
popaque $ singleAuthorityTokenBurned pgatSym ctx.txInfo txInfo.mint popaque $ singleAuthorityTokenBurned pgatSym ctx.txInfo txInfo.mint
where where
stateTokenAssetClass :: AssetClass stateTokenAssetClass :: AssetClass
stateTokenAssetClass = governorStateTokenAssetClass params stateTokenAssetClass = gstAssetClass params
proposalDatum :: Proposal proposalDatum :: Proposal
proposalDatum = proposalDatum =
@ -523,7 +523,7 @@ governorValidator params =
stateTokenValueOf = passetClassValueOf' stateTokenAssetClass stateTokenValueOf = passetClassValueOf' stateTokenAssetClass
pgatSym :: Term s PCurrencySymbol pgatSym :: Term s PCurrencySymbol
pgatSym = phoistAcyclic $ pconstant $ authorityTokenSymbolFromGovernor params pgatSym = phoistAcyclic $ pconstant $ gatSymbolFromGovernor params
pyesResultTag :: Term s PResultTag pyesResultTag :: Term s PResultTag
pyesResultTag = phoistAcyclic $ pcon $ PResultTag $ pconstant 1 pyesResultTag = phoistAcyclic $ pcon $ PResultTag $ pconstant 1
@ -533,8 +533,8 @@ governorValidator params =
-------------------------------------------------------------------------------- --------------------------------------------------------------------------------
governorStateTokenAssetClass :: Governor -> AssetClass gstAssetClass :: Governor -> AssetClass
governorStateTokenAssetClass gov = AssetClass (symbol, gov.gstName) gstAssetClass gov = AssetClass (symbol, gov.gstName)
where where
policy :: MintingPolicy policy :: MintingPolicy
policy = mkMintingPolicy $ governorPolicy gov policy = mkMintingPolicy $ governorPolicy gov
@ -542,8 +542,8 @@ governorStateTokenAssetClass gov = AssetClass (symbol, gov.gstName)
symbol :: CurrencySymbol symbol :: CurrencySymbol
symbol = mintingPolicySymbol policy symbol = mintingPolicySymbol policy
authorityTokenSymbolFromGovernor :: Governor -> CurrencySymbol gatSymbolFromGovernor :: Governor -> CurrencySymbol
authorityTokenSymbolFromGovernor gov = mintingPolicySymbol policy gatSymbolFromGovernor gov = mintingPolicySymbol policy
where where
params = AuthorityToken $ governorStateTokenAssetClass gov params = AuthorityToken $ gstAssetClass gov
policy = mkMintingPolicy $ authorityTokenPolicy params policy = mkMintingPolicy $ authorityTokenPolicy params