Safe Haskell	None
Language	Haskell2010

Plutus.Contracts.Prism.StateMachine

Description

State machine that manages credential tokens

Synopsis

data IDState
- = Active
- | Revoked
data IDAction
- = PresentCredential
- | RevokeCredential
data UserCredential = UserCredential {
- ucAddress :: PaymentPubKeyHash
- ucCredential :: Credential
- ucToken :: Value
}
typedValidator :: UserCredential -> TypedValidator (StateMachine IDState IDAction)
machineClient :: TypedValidator (StateMachine IDState IDAction) -> UserCredential -> StateMachineClient IDState IDAction
mkMachineClient :: CredentialAuthority -> PaymentPubKeyHash -> TokenName -> StateMachineClient IDState IDAction

Documentation

data IDState Source #

Constructors

Active	The credential is active and can be used in transactions
Revoked	The credential has been revoked and can't be used anymore.

Instances

Instances details

Eq IDState Source #
Instance details Defined in Plutus.Contracts.Prism.StateMachine Methods (==) :: IDState -> IDState -> Bool Source # (/=) :: IDState -> IDState -> Bool Source #
Show IDState Source #
Instance details Defined in Plutus.Contracts.Prism.StateMachine Methods showsPrec :: Int -> IDState -> ShowS Source # show :: IDState -> String Source # showList :: [IDState] -> ShowS Source #
Generic IDState Source #
Instance details Defined in Plutus.Contracts.Prism.StateMachine Associated Types type Rep IDState :: Type -> Type Source # Methods from :: IDState -> Rep IDState x Source # to :: Rep IDState x -> IDState Source #
ToJSON IDState Source #
Instance details Defined in Plutus.Contracts.Prism.StateMachine Methods toJSON :: IDState -> Value Source # toEncoding :: IDState -> Encoding Source # toJSONList :: [IDState] -> Value Source # toEncodingList :: [IDState] -> Encoding Source #
FromJSON IDState Source #
Instance details Defined in Plutus.Contracts.Prism.StateMachine Methods parseJSON :: Value -> Parser IDState Source # parseJSONList :: Value -> Parser [IDState] Source #
UnsafeFromData IDState Source #
Instance details Defined in Plutus.Contracts.Prism.StateMachine Methods unsafeFromBuiltinData :: BuiltinData -> IDState Source #
FromData IDState Source #
Instance details Defined in Plutus.Contracts.Prism.StateMachine Methods fromBuiltinData :: BuiltinData -> Maybe IDState Source #
ToData IDState Source #
Instance details Defined in Plutus.Contracts.Prism.StateMachine Methods toBuiltinData :: IDState -> BuiltinData Source #
Lift DefaultUni IDState Source #
Instance details Defined in Plutus.Contracts.Prism.StateMachine Methods lift :: IDState -> RTCompile DefaultUni fun (Term TyName Name DefaultUni fun ()) Source #
Typeable DefaultUni IDState Source #
Instance details Defined in Plutus.Contracts.Prism.StateMachine Methods typeRep :: Proxy IDState -> RTCompile DefaultUni fun (Type TyName DefaultUni ()) Source #
type Rep IDState Source #
Instance details Defined in Plutus.Contracts.Prism.StateMachine type Rep IDState = D1 ('MetaData "IDState" "Plutus.Contracts.Prism.StateMachine" "plutus-use-cases-1.1.0.0-9kk4ZO09YVFKU77qwQaRsf" 'False) (C1 ('MetaCons "Active" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Revoked" 'PrefixI 'False) (U1 :: Type -> Type))

data IDAction Source #

Constructors

PresentCredential	Present the credential in a transaction
RevokeCredential	Revoke the credential

Instances

Instances details

Eq IDAction Source #
Instance details Defined in Plutus.Contracts.Prism.StateMachine Methods (==) :: IDAction -> IDAction -> Bool Source # (/=) :: IDAction -> IDAction -> Bool Source #
Show IDAction Source #
Instance details Defined in Plutus.Contracts.Prism.StateMachine Methods showsPrec :: Int -> IDAction -> ShowS Source # show :: IDAction -> String Source # showList :: [IDAction] -> ShowS Source #
Generic IDAction Source #
Instance details Defined in Plutus.Contracts.Prism.StateMachine Associated Types type Rep IDAction :: Type -> Type Source # Methods from :: IDAction -> Rep IDAction x Source # to :: Rep IDAction x -> IDAction Source #
ToJSON IDAction Source #
Instance details Defined in Plutus.Contracts.Prism.StateMachine Methods toJSON :: IDAction -> Value Source # toEncoding :: IDAction -> Encoding Source # toJSONList :: [IDAction] -> Value Source # toEncodingList :: [IDAction] -> Encoding Source #
FromJSON IDAction Source #
Instance details Defined in Plutus.Contracts.Prism.StateMachine Methods parseJSON :: Value -> Parser IDAction Source # parseJSONList :: Value -> Parser [IDAction] Source #
UnsafeFromData IDAction Source #
Instance details Defined in Plutus.Contracts.Prism.StateMachine Methods unsafeFromBuiltinData :: BuiltinData -> IDAction Source #
FromData IDAction Source #
Instance details Defined in Plutus.Contracts.Prism.StateMachine Methods fromBuiltinData :: BuiltinData -> Maybe IDAction Source #
ToData IDAction Source #
Instance details Defined in Plutus.Contracts.Prism.StateMachine Methods toBuiltinData :: IDAction -> BuiltinData Source #
Lift DefaultUni IDAction Source #
Instance details Defined in Plutus.Contracts.Prism.StateMachine Methods lift :: IDAction -> RTCompile DefaultUni fun (Term TyName Name DefaultUni fun ()) Source #
Typeable DefaultUni IDAction Source #
Instance details Defined in Plutus.Contracts.Prism.StateMachine Methods typeRep :: Proxy IDAction -> RTCompile DefaultUni fun (Type TyName DefaultUni ()) Source #
type Rep IDAction Source #
Instance details Defined in Plutus.Contracts.Prism.StateMachine type Rep IDAction = D1 ('MetaData "IDAction" "Plutus.Contracts.Prism.StateMachine" "plutus-use-cases-1.1.0.0-9kk4ZO09YVFKU77qwQaRsf" 'False) (C1 ('MetaCons "PresentCredential" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "RevokeCredential" 'PrefixI 'False) (U1 :: Type -> Type))

data UserCredential Source #

A Credential issued to a user (public key address)

Constructors

UserCredential
Fields ucAddress :: PaymentPubKeyHash Address of the credential holder ucCredential :: Credential The credential ucToken :: Value The `Value` containing a token of the credential (this needs to be included here because `token` is not available in on-chain code)

Instances

Instances details

Eq UserCredential Source #
Instance details Defined in Plutus.Contracts.Prism.StateMachine Methods (==) :: UserCredential -> UserCredential -> Bool Source # (/=) :: UserCredential -> UserCredential -> Bool Source #
Show UserCredential Source #
Instance details Defined in Plutus.Contracts.Prism.StateMachine Methods showsPrec :: Int -> UserCredential -> ShowS Source # show :: UserCredential -> String Source # showList :: [UserCredential] -> ShowS Source #
Generic UserCredential Source #
Instance details Defined in Plutus.Contracts.Prism.StateMachine Associated Types type Rep UserCredential :: Type -> Type Source # Methods from :: UserCredential -> Rep UserCredential x Source # to :: Rep UserCredential x -> UserCredential Source #
Hashable UserCredential Source #
Instance details Defined in Plutus.Contracts.Prism.StateMachine Methods hashWithSalt :: Int -> UserCredential -> Int Source # hash :: UserCredential -> Int Source #
ToJSON UserCredential Source #
Instance details Defined in Plutus.Contracts.Prism.StateMachine Methods toJSON :: UserCredential -> Value Source # toEncoding :: UserCredential -> Encoding Source # toJSONList :: [UserCredential] -> Value Source # toEncodingList :: [UserCredential] -> Encoding Source #
FromJSON UserCredential Source #
Instance details Defined in Plutus.Contracts.Prism.StateMachine Methods parseJSON :: Value -> Parser UserCredential Source # parseJSONList :: Value -> Parser [UserCredential] Source #
Lift DefaultUni UserCredential Source #
Instance details Defined in Plutus.Contracts.Prism.StateMachine Methods lift :: UserCredential -> RTCompile DefaultUni fun (Term TyName Name DefaultUni fun ()) Source #
Typeable DefaultUni UserCredential Source #
Instance details Defined in Plutus.Contracts.Prism.StateMachine Methods typeRep :: Proxy UserCredential -> RTCompile DefaultUni fun (Type TyName DefaultUni ()) Source #
type Rep UserCredential Source #
Instance details Defined in Plutus.Contracts.Prism.StateMachine type Rep UserCredential = D1 ('MetaData "UserCredential" "Plutus.Contracts.Prism.StateMachine" "plutus-use-cases-1.1.0.0-9kk4ZO09YVFKU77qwQaRsf" 'False) (C1 ('MetaCons "UserCredential" 'PrefixI 'True) (S1 ('MetaSel ('Just "ucAddress") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 PaymentPubKeyHash) :: (S1 ('MetaSel ('Just "ucCredential") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Credential) :: S1 ('MetaSel ('Just "ucToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Value))))

typedValidator :: UserCredential -> TypedValidator (StateMachine IDState IDAction) Source #

machineClient :: TypedValidator (StateMachine IDState IDAction) -> UserCredential -> StateMachineClient IDState IDAction Source #

mkMachineClient :: CredentialAuthority -> PaymentPubKeyHash -> TokenName -> StateMachineClient IDState IDAction Source #