agora-0.1.0
Maintainerconnor@mlabs.city
Safe HaskellSafe-Inferred
LanguageHaskell2010

Agora.Effect.GovernorMutation

Description

An effect for mutating governor settings.

Synopsis

Haskell-land

data MutateGovernorDatum Source #

Haskell-level datum for the governor mutation effect script.

Since: 0.1.0

Constructors

MutateGovernorDatum 

Fields

Instances

Instances details
Generic MutateGovernorDatum Source # 
Instance details

Defined in Agora.Effect.GovernorMutation

Associated Types

type Rep MutateGovernorDatum :: Type -> Type Source #

Methods

from :: MutateGovernorDatum -> Rep MutateGovernorDatum x Source #

to :: Rep MutateGovernorDatum x -> MutateGovernorDatum Source #

Show MutateGovernorDatum Source # 
Instance details

Defined in Agora.Effect.GovernorMutation

Methods

showsPrec :: Int -> MutateGovernorDatum -> ShowS Source #

show :: MutateGovernorDatum -> String Source #

showList :: [MutateGovernorDatum] -> ShowS Source #

Generic MutateGovernorDatum Source # 
Instance details

Defined in Agora.Effect.GovernorMutation

Associated Types

type Code MutateGovernorDatum :: [[Type]] Source #

Methods

from :: MutateGovernorDatum -> Rep MutateGovernorDatum Source #

to :: Rep MutateGovernorDatum -> MutateGovernorDatum Source #

PConstantDecl MutateGovernorDatum Source # 
Instance details

Defined in Agora.Effect.GovernorMutation

Associated Types

type PConstantRepr MutateGovernorDatum Source #

type PConstanted MutateGovernorDatum :: PType Source #

Methods

pconstantToRepr :: MutateGovernorDatum -> PConstantRepr MutateGovernorDatum Source #

pconstantFromRepr :: PConstantRepr MutateGovernorDatum -> Maybe MutateGovernorDatum Source #

FromData MutateGovernorDatum Source # 
Instance details

Defined in Agora.Effect.GovernorMutation

Methods

fromBuiltinData :: BuiltinData -> Maybe MutateGovernorDatum Source #

ToData MutateGovernorDatum Source # 
Instance details

Defined in Agora.Effect.GovernorMutation

Methods

toBuiltinData :: MutateGovernorDatum -> BuiltinData Source #

UnsafeFromData MutateGovernorDatum Source # 
Instance details

Defined in Agora.Effect.GovernorMutation

Methods

unsafeFromBuiltinData :: BuiltinData -> MutateGovernorDatum Source #

type Rep MutateGovernorDatum Source # 
Instance details

Defined in Agora.Effect.GovernorMutation

type Rep MutateGovernorDatum = D1 ('MetaData "MutateGovernorDatum" "Agora.Effect.GovernorMutation" "agora-0.1.0-C1o5klqsCO77ggIWQdJiNp" 'False) (C1 ('MetaCons "MutateGovernorDatum" 'PrefixI 'True) (S1 ('MetaSel ('Just "governorRef") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 TxOutRef) :*: S1 ('MetaSel ('Just "newDatum") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 GovernorDatum)))
type Code MutateGovernorDatum Source # 
Instance details

Defined in Agora.Effect.GovernorMutation

type Code MutateGovernorDatum = GCode MutateGovernorDatum
type PConstantRepr MutateGovernorDatum Source #

Since: 0.1.0

Instance details

Defined in Agora.Effect.GovernorMutation

type PConstantRepr MutateGovernorDatum = PConstantRepr (DerivePConstantViaData MutateGovernorDatum PMutateGovernorDatum)
type PConstanted MutateGovernorDatum Source # 
Instance details

Defined in Agora.Effect.GovernorMutation

type PConstanted MutateGovernorDatum = PConstanted (DerivePConstantViaData MutateGovernorDatum PMutateGovernorDatum)

Plutarch-land

newtype PMutateGovernorDatum (s :: S) Source #

Plutarch-level version of MutateGovernorDatum.

Since: 0.1.0

Constructors

PMutateGovernorDatum (Term s (PDataRecord '["governorRef" := PTxOutRef, "newDatum" := PGovernorDatum])) 

Instances

Instances details
PEq PMutateGovernorDatum Source #

Since: 0.1.0

Instance details

Defined in Agora.Effect.GovernorMutation

Methods

(#==) :: forall (s :: S). Term s PMutateGovernorDatum -> Term s PMutateGovernorDatum -> Term s PBool Source #

PIsData PMutateGovernorDatum Source #

Since: 0.1.0

Instance details

Defined in Agora.Effect.GovernorMutation

Methods

pfromDataImpl :: forall (s :: S). Term s (PAsData PMutateGovernorDatum) -> Term s PMutateGovernorDatum Source #

pdataImpl :: forall (s :: S). Term s PMutateGovernorDatum -> Term s PData Source #

PIsDataRepr PMutateGovernorDatum Source # 
Instance details

Defined in Agora.Effect.GovernorMutation

Associated Types

type PIsDataReprRepr PMutateGovernorDatum :: [[PLabeledType]] Source #

Methods

pconRepr :: forall (s :: S). PMutateGovernorDatum s -> Term s (PDataSum (PIsDataReprRepr PMutateGovernorDatum)) Source #

pmatchRepr :: forall (s :: S) (b :: PType). Term s (PDataSum (PIsDataReprRepr PMutateGovernorDatum)) -> (PMutateGovernorDatum s -> Term s b) -> Term s b Source #

PDataFields PMutateGovernorDatum Source # 
Instance details

Defined in Agora.Effect.GovernorMutation

Associated Types

type PFields PMutateGovernorDatum :: [PLabeledType] Source #

Methods

ptoFields :: forall (s :: S). Term s PMutateGovernorDatum -> Term s (PDataRecord (PFields PMutateGovernorDatum)) Source #

PlutusType PMutateGovernorDatum Source # 
Instance details

Defined in Agora.Effect.GovernorMutation

Associated Types

type PInner PMutateGovernorDatum b' :: PType Source #

Methods

pcon' :: forall (s :: S) (b :: PType). PMutateGovernorDatum s -> Term s (PInner PMutateGovernorDatum b) Source #

pmatch' :: forall (s :: S) (b :: PType). Term s (PInner PMutateGovernorDatum b) -> (PMutateGovernorDatum s -> Term s b) -> Term s b Source #

PUnsafeLiftDecl PMutateGovernorDatum Source #

Since: 0.1.0

Instance details

Defined in Agora.Effect.GovernorMutation

Associated Types

type PLifted PMutateGovernorDatum = (r :: Type) Source #

PTryFrom PData (PAsData PMutateGovernorDatum) Source # 
Instance details

Defined in Agora.Effect.GovernorMutation

Associated Types

type PTryFromExcess PData (PAsData PMutateGovernorDatum) :: PType Source #

Methods

ptryFrom' :: forall (s :: S) (r :: PType). Term s PData -> ((Term s (PAsData PMutateGovernorDatum), Reduce (PTryFromExcess PData (PAsData PMutateGovernorDatum) s)) -> Term s r) -> Term s r Source #

Generic (PMutateGovernorDatum s) Source # 
Instance details

Defined in Agora.Effect.GovernorMutation

Associated Types

type Rep (PMutateGovernorDatum s) :: Type -> Type Source #

Methods

from :: PMutateGovernorDatum s -> Rep (PMutateGovernorDatum s) x Source #

to :: Rep (PMutateGovernorDatum s) x -> PMutateGovernorDatum s Source #

Generic (PMutateGovernorDatum s) Source # 
Instance details

Defined in Agora.Effect.GovernorMutation

Associated Types

type Code (PMutateGovernorDatum s) :: [[Type]] Source #

Methods

from :: PMutateGovernorDatum s -> Rep (PMutateGovernorDatum s) Source #

to :: Rep (PMutateGovernorDatum s) -> PMutateGovernorDatum s Source #

type PIsDataReprRepr PMutateGovernorDatum Source #

Since: 0.1.0

Instance details

Defined in Agora.Effect.GovernorMutation

type PIsDataReprRepr PMutateGovernorDatum = PDataRecordFields2 (PCode 'SI PMutateGovernorDatum)
type PFields PMutateGovernorDatum Source #

Since: 0.1.0

Instance details

Defined in Agora.Effect.GovernorMutation

type PFields PMutateGovernorDatum = PFields (PIsDataReprInstances PMutateGovernorDatum)
type PLifted PMutateGovernorDatum Source # 
Instance details

Defined in Agora.Effect.GovernorMutation

type PLifted PMutateGovernorDatum = MutateGovernorDatum
type PInner PMutateGovernorDatum b' Source #

Since: 0.1.0

Instance details

Defined in Agora.Effect.GovernorMutation

type PInner PMutateGovernorDatum b' = PInner (PIsDataReprInstances PMutateGovernorDatum) b'
type PTryFromExcess PData (PAsData PMutateGovernorDatum) Source #

Since: 0.1.0

Instance details

Defined in Agora.Effect.GovernorMutation

type PTryFromExcess PData (PAsData PMutateGovernorDatum) = PTryFromExcess PData (PAsData (PIsDataReprInstances PMutateGovernorDatum))
type Rep (PMutateGovernorDatum s) Source #

Since: 0.1.0

Instance details

Defined in Agora.Effect.GovernorMutation

type Rep (PMutateGovernorDatum s) = D1 ('MetaData "PMutateGovernorDatum" "Agora.Effect.GovernorMutation" "agora-0.1.0-C1o5klqsCO77ggIWQdJiNp" 'True) (C1 ('MetaCons "PMutateGovernorDatum" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Term s (PDataRecord '["governorRef" := PTxOutRef, "newDatum" := PGovernorDatum])))))
type Code (PMutateGovernorDatum s) Source #

Since: 0.1.0

Instance details

Defined in Agora.Effect.GovernorMutation

type Code (PMutateGovernorDatum s) = GCode (PMutateGovernorDatum s)

Scripts

mutateGovernorValidator :: Governor -> ClosedTerm PValidator Source #

Validator for the governor mutation effect.

This effect is implemented using the makeEffect wrapper, meaning that the burning of GAT is checked in said wrapper.

In order to locate the governor, the validator is parametrized with a Governor.

All the information it needs to validate the effect is encoded in the MutateGovernorDatum, so regardless what redeemer it's given, it will check:

  • No token is minted/burnt other than GAT.
  • Nothing is being paid to the the effect validator.

  • The governor's state UTXO must be spent:

    • It carries exactly one GST.
    • It's referenced by governorRef in the effect's datum.

  • A new state UTXO is paid to the governor:

    • It contains the GST.
    • It has valid governor state datum.
    • The datum is exactly the same as the newDatum.

Since: 0.1.0