Safe Haskell	None
Language	Haskell2010

Plutus.Contracts.GameStateMachine

Description

A guessing game that

Uses a state machine to keep track of the current secret word
Uses a token to keep track of who is allowed to make a guess

Synopsis

contract :: Contract () GameStateMachineSchema GameError ()
typedValidator :: GameParam -> TypedValidator GameStateMachine
data GameParam = GameParam {
- gameParamPayeePkh :: Address
- gameParamStartTime :: POSIXTime
}
data GameState
- = Initialised MintingPolicyHash TokenName HashedString
- | Locked MintingPolicyHash TokenName HashedString
- | Finished
data GameInput
- = MintToken
- | Guess Address ClearString HashedString Value
data GuessToken
mkValidator :: GameParam -> ValidatorType GameStateMachine
mintingPolicy :: GameParam -> MintingPolicy
data LockArgs = LockArgs {
- lockArgsGameParam :: GameParam
- lockArgsSecret :: SecretArgument String
- lockArgsValue :: Value
}
data GuessArgs = GuessArgs {
- guessArgsGameParam :: GameParam
- guessTokenTarget :: Address
- guessArgsOldSecret :: String
- guessArgsNewSecret :: SecretArgument String
- guessArgsValueTakenOut :: Value
}
type GameStateMachineSchema = Endpoint "lock" LockArgs .\/ Endpoint "guess" GuessArgs
data GameError
token :: MintingPolicyHash -> TokenName -> Value
covIdx :: CoverageIndex

Documentation

contract :: Contract () GameStateMachineSchema GameError () Source #

Top-level contract, exposing both endpoints.

typedValidator :: GameParam -> TypedValidator GameStateMachine Source #

data GameParam Source #

Datatype for creating a parameterized validator.

Constructors

GameParam
Fields gameParamPayeePkh :: Address Payment address of the wallet locking some funds gameParamStartTime :: POSIXTime Starting time of the game

Instances

Instances details

Show GameParam Source #
Instance details Defined in Plutus.Contracts.GameStateMachine Methods showsPrec :: Int -> GameParam -> ShowS Source # show :: GameParam -> String Source # showList :: [GameParam] -> ShowS Source #
Generic GameParam Source #
Instance details Defined in Plutus.Contracts.GameStateMachine Associated Types type Rep GameParam :: Type -> Type Source # Methods from :: GameParam -> Rep GameParam x Source # to :: Rep GameParam x -> GameParam Source #
ToJSON GameParam Source #
Instance details Defined in Plutus.Contracts.GameStateMachine Methods toJSON :: GameParam -> Value Source # toEncoding :: GameParam -> Encoding Source # toJSONList :: [GameParam] -> Value Source # toEncodingList :: [GameParam] -> Encoding Source #
FromJSON GameParam Source #
Instance details Defined in Plutus.Contracts.GameStateMachine Methods parseJSON :: Value -> Parser GameParam Source # parseJSONList :: Value -> Parser [GameParam] Source #
ToSchema GameParam Source #
Instance details Defined in Plutus.Contracts.GameStateMachine Methods toSchema :: FormSchema Source #
Lift DefaultUni GameParam Source #
Instance details Defined in Plutus.Contracts.GameStateMachine Methods lift :: GameParam -> RTCompile DefaultUni fun (Term TyName Name DefaultUni fun ()) Source #
Typeable DefaultUni GameParam Source #
Instance details Defined in Plutus.Contracts.GameStateMachine Methods typeRep :: Proxy GameParam -> RTCompile DefaultUni fun (Type TyName DefaultUni ()) Source #
type Rep GameParam Source #
Instance details Defined in Plutus.Contracts.GameStateMachine type Rep GameParam = D1 ('MetaData "GameParam" "Plutus.Contracts.GameStateMachine" "plutus-use-cases-1.1.0.0-9kk4ZO09YVFKU77qwQaRsf" 'False) (C1 ('MetaCons "GameParam" 'PrefixI 'True) (S1 ('MetaSel ('Just "gameParamPayeePkh") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Address) :*: S1 ('MetaSel ('Just "gameParamStartTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 POSIXTime)))

data GameState Source #

State of the guessing game

Constructors

Initialised MintingPolicyHash TokenName HashedString	Initial state. In this state only the `MintTokens` action is allowed.
Locked MintingPolicyHash TokenName HashedString	Funds have been locked. In this state only the `Guess` action is allowed.
Finished	All funds were unlocked.

Instances

Instances details

Show GameState Source #
Instance details Defined in Plutus.Contracts.GameStateMachine Methods showsPrec :: Int -> GameState -> ShowS Source # show :: GameState -> String Source # showList :: [GameState] -> ShowS Source #
Generic GameState Source #
Instance details Defined in Plutus.Contracts.GameStateMachine Associated Types type Rep GameState :: Type -> Type Source # Methods from :: GameState -> Rep GameState x Source # to :: Rep GameState x -> GameState Source #
ToJSON GameState Source #
Instance details Defined in Plutus.Contracts.GameStateMachine Methods toJSON :: GameState -> Value Source # toEncoding :: GameState -> Encoding Source # toJSONList :: [GameState] -> Value Source # toEncodingList :: [GameState] -> Encoding Source #
FromJSON GameState Source #
Instance details Defined in Plutus.Contracts.GameStateMachine Methods parseJSON :: Value -> Parser GameState Source # parseJSONList :: Value -> Parser [GameState] Source #
UnsafeFromData GameState Source #
Instance details Defined in Plutus.Contracts.GameStateMachine Methods unsafeFromBuiltinData :: BuiltinData -> GameState Source #
FromData GameState Source #
Instance details Defined in Plutus.Contracts.GameStateMachine Methods fromBuiltinData :: BuiltinData -> Maybe GameState Source #
ToData GameState Source #
Instance details Defined in Plutus.Contracts.GameStateMachine Methods toBuiltinData :: GameState -> BuiltinData Source #
Eq GameState Source #
Instance details Defined in Plutus.Contracts.GameStateMachine Methods (==) :: GameState -> GameState -> Bool Source #
Lift DefaultUni GameState Source #
Instance details Defined in Plutus.Contracts.GameStateMachine Methods lift :: GameState -> RTCompile DefaultUni fun (Term TyName Name DefaultUni fun ()) Source #
Typeable DefaultUni GameState Source #
Instance details Defined in Plutus.Contracts.GameStateMachine Methods typeRep :: Proxy GameState -> RTCompile DefaultUni fun (Type TyName DefaultUni ()) Source #
type Rep GameState Source #
Instance details Defined in Plutus.Contracts.GameStateMachine type Rep GameState

data GameInput Source #

Inputs (actions)

Constructors

MintToken	Mint the "guess" token
Guess Address ClearString HashedString Value	Make a guess, extract the funds, and lock the remaining funds using a new secret word.

Instances

Instances details

Show GameInput Source #
Instance details Defined in Plutus.Contracts.GameStateMachine Methods showsPrec :: Int -> GameInput -> ShowS Source # show :: GameInput -> String Source # showList :: [GameInput] -> ShowS Source #
Generic GameInput Source #
Instance details Defined in Plutus.Contracts.GameStateMachine Associated Types type Rep GameInput :: Type -> Type Source # Methods from :: GameInput -> Rep GameInput x Source # to :: Rep GameInput x -> GameInput Source #
ToJSON GameInput Source #
Instance details Defined in Plutus.Contracts.GameStateMachine Methods toJSON :: GameInput -> Value Source # toEncoding :: GameInput -> Encoding Source # toJSONList :: [GameInput] -> Value Source # toEncodingList :: [GameInput] -> Encoding Source #
FromJSON GameInput Source #
Instance details Defined in Plutus.Contracts.GameStateMachine Methods parseJSON :: Value -> Parser GameInput Source # parseJSONList :: Value -> Parser [GameInput] Source #
UnsafeFromData GameInput Source #
Instance details Defined in Plutus.Contracts.GameStateMachine Methods unsafeFromBuiltinData :: BuiltinData -> GameInput Source #
FromData GameInput Source #
Instance details Defined in Plutus.Contracts.GameStateMachine Methods fromBuiltinData :: BuiltinData -> Maybe GameInput Source #
ToData GameInput Source #
Instance details Defined in Plutus.Contracts.GameStateMachine Methods toBuiltinData :: GameInput -> BuiltinData Source #
Lift DefaultUni GameInput Source #
Instance details Defined in Plutus.Contracts.GameStateMachine Methods lift :: GameInput -> RTCompile DefaultUni fun (Term TyName Name DefaultUni fun ()) Source #
Typeable DefaultUni GameInput Source #
Instance details Defined in Plutus.Contracts.GameStateMachine Methods typeRep :: Proxy GameInput -> RTCompile DefaultUni fun (Type TyName DefaultUni ()) Source #
type Rep GameInput Source #
Instance details Defined in Plutus.Contracts.GameStateMachine type Rep GameInput

data GuessToken Source #

The token that represents the right to make a guess

Instances

Instances details

Show GuessToken Source #
Instance details Defined in Plutus.Contracts.GameStateMachine Methods showsPrec :: Int -> GuessToken -> ShowS Source # show :: GuessToken -> String Source # showList :: [GuessToken] -> ShowS Source #
UnsafeFromData GuessToken Source #
Instance details Defined in Plutus.Contracts.GameStateMachine Methods unsafeFromBuiltinData :: BuiltinData -> GuessToken Source #
FromData GuessToken Source #
Instance details Defined in Plutus.Contracts.GameStateMachine Methods fromBuiltinData :: BuiltinData -> Maybe GuessToken Source #
ToData GuessToken Source #
Instance details Defined in Plutus.Contracts.GameStateMachine Methods toBuiltinData :: GuessToken -> BuiltinData Source #
Eq GuessToken Source #
Instance details Defined in Plutus.Contracts.GameStateMachine Methods (==) :: GuessToken -> GuessToken -> Bool Source #
Lift DefaultUni GuessToken Source #
Instance details Defined in Plutus.Contracts.GameStateMachine Methods lift :: GuessToken -> RTCompile DefaultUni fun (Term TyName Name DefaultUni fun ()) Source #
Typeable DefaultUni GuessToken Source #
Instance details Defined in Plutus.Contracts.GameStateMachine Methods typeRep :: Proxy GuessToken -> RTCompile DefaultUni fun (Type TyName DefaultUni ()) Source #

mkValidator :: GameParam -> ValidatorType GameStateMachine Source #

mintingPolicy :: GameParam -> MintingPolicy Source #

data LockArgs Source #

Arguments for the "lock" endpoint

Constructors

LockArgs
Fields lockArgsGameParam :: GameParam The parameters for parameterizing the validator. lockArgsSecret :: SecretArgument String The secret lockArgsValue :: Value Value that is locked by the contract initially

Instances

Instances details

Show LockArgs Source #
Instance details Defined in Plutus.Contracts.GameStateMachine Methods showsPrec :: Int -> LockArgs -> ShowS Source # show :: LockArgs -> String Source # showList :: [LockArgs] -> ShowS Source #
Generic LockArgs Source #
Instance details Defined in Plutus.Contracts.GameStateMachine Associated Types type Rep LockArgs :: Type -> Type Source # Methods from :: LockArgs -> Rep LockArgs x Source # to :: Rep LockArgs x -> LockArgs Source #
ToJSON LockArgs Source #
Instance details Defined in Plutus.Contracts.GameStateMachine Methods toJSON :: LockArgs -> Value Source # toEncoding :: LockArgs -> Encoding Source # toJSONList :: [LockArgs] -> Value Source # toEncodingList :: [LockArgs] -> Encoding Source #
FromJSON LockArgs Source #
Instance details Defined in Plutus.Contracts.GameStateMachine Methods parseJSON :: Value -> Parser LockArgs Source # parseJSONList :: Value -> Parser [LockArgs] Source #
ToSchema LockArgs Source #
Instance details Defined in Plutus.Contracts.GameStateMachine Methods toSchema :: FormSchema Source #
type Rep LockArgs Source #
Instance details Defined in Plutus.Contracts.GameStateMachine type Rep LockArgs = D1 ('MetaData "LockArgs" "Plutus.Contracts.GameStateMachine" "plutus-use-cases-1.1.0.0-9kk4ZO09YVFKU77qwQaRsf" 'False) (C1 ('MetaCons "LockArgs" 'PrefixI 'True) (S1 ('MetaSel ('Just "lockArgsGameParam") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 GameParam) :: (S1 ('MetaSel ('Just "lockArgsSecret") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (SecretArgument String)) :: S1 ('MetaSel ('Just "lockArgsValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Value))))

data GuessArgs Source #

Arguments for the "guess" endpoint

Constructors

GuessArgs
Fields guessArgsGameParam :: GameParam The parameters for parameterizing the validator. guessTokenTarget :: Address The recipient of the guess token guessArgsOldSecret :: String The guess guessArgsNewSecret :: SecretArgument String The new secret guessArgsValueTakenOut :: Value How much to extract from the contract

Instances

Instances details

Show GuessArgs Source #
Instance details Defined in Plutus.Contracts.GameStateMachine Methods showsPrec :: Int -> GuessArgs -> ShowS Source # show :: GuessArgs -> String Source # showList :: [GuessArgs] -> ShowS Source #
Generic GuessArgs Source #
Instance details Defined in Plutus.Contracts.GameStateMachine Associated Types type Rep GuessArgs :: Type -> Type Source # Methods from :: GuessArgs -> Rep GuessArgs x Source # to :: Rep GuessArgs x -> GuessArgs Source #
ToJSON GuessArgs Source #
Instance details Defined in Plutus.Contracts.GameStateMachine Methods toJSON :: GuessArgs -> Value Source # toEncoding :: GuessArgs -> Encoding Source # toJSONList :: [GuessArgs] -> Value Source # toEncodingList :: [GuessArgs] -> Encoding Source #
FromJSON GuessArgs Source #
Instance details Defined in Plutus.Contracts.GameStateMachine Methods parseJSON :: Value -> Parser GuessArgs Source # parseJSONList :: Value -> Parser [GuessArgs] Source #
ToSchema GuessArgs Source #
Instance details Defined in Plutus.Contracts.GameStateMachine Methods toSchema :: FormSchema Source #
type Rep GuessArgs Source #
Instance details Defined in Plutus.Contracts.GameStateMachine type Rep GuessArgs = D1 ('MetaData "GuessArgs" "Plutus.Contracts.GameStateMachine" "plutus-use-cases-1.1.0.0-9kk4ZO09YVFKU77qwQaRsf" 'False) (C1 ('MetaCons "GuessArgs" 'PrefixI 'True) ((S1 ('MetaSel ('Just "guessArgsGameParam") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 GameParam) :: S1 ('MetaSel ('Just "guessTokenTarget") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Address)) :: (S1 ('MetaSel ('Just "guessArgsOldSecret") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 String) :: (S1 ('MetaSel ('Just "guessArgsNewSecret") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (SecretArgument String)) :: S1 ('MetaSel ('Just "guessArgsValueTakenOut") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Value)))))

type GameStateMachineSchema = Endpoint "lock" LockArgs .\/ Endpoint "guess" GuessArgs Source #

The schema of the contract. It consists of the two endpoints "lock" and "guess" with their respective argument types.

data GameError Source #

Instances

Instances details

Show GameError Source #
Instance details Defined in Plutus.Contracts.GameStateMachine Methods showsPrec :: Int -> GameError -> ShowS Source # show :: GameError -> String Source # showList :: [GameError] -> ShowS Source #
Generic GameError Source #
Instance details Defined in Plutus.Contracts.GameStateMachine Associated Types type Rep GameError :: Type -> Type Source # Methods from :: GameError -> Rep GameError x Source # to :: Rep GameError x -> GameError Source #
ToJSON GameError Source #
Instance details Defined in Plutus.Contracts.GameStateMachine Methods toJSON :: GameError -> Value Source # toEncoding :: GameError -> Encoding Source # toJSONList :: [GameError] -> Value Source # toEncodingList :: [GameError] -> Encoding Source #
FromJSON GameError Source #
Instance details Defined in Plutus.Contracts.GameStateMachine Methods parseJSON :: Value -> Parser GameError Source # parseJSONList :: Value -> Parser [GameError] Source #
AsContractError GameError Source #
Instance details Defined in Plutus.Contracts.GameStateMachine Methods _ContractError :: Prism' GameError ContractError Source # _WalletContractError :: Prism' GameError WalletAPIError Source # _ChainIndexContractError :: Prism' GameError (Text, ChainIndexResponse) Source # _EmulatorAssertionContractError :: Prism' GameError AssertionError Source # _ConstraintResolutionContractError :: Prism' GameError MkTxError Source # _TxConstraintResolutionContractError :: Prism' GameError MkTxError Source # _TxToCardanoConvertContractError :: Prism' GameError ToCardanoError Source # _ResumableContractError :: Prism' GameError MatchingError Source # _CCheckpointContractError :: Prism' GameError CheckpointError Source # _EndpointDecodeContractError :: Prism' GameError (EndpointDescription, EndpointValue Value, Text) Source # _OtherContractError :: Prism' GameError Text Source #
AsSMContractError GameError Source #
Instance details Defined in Plutus.Contracts.GameStateMachine Methods _SMContractError :: Prism' GameError SMContractError Source # _ChooserError :: Prism' GameError Text Source # _UnableToExtractTransition :: Prism' GameError () Source # _SMCContractError :: Prism' GameError ContractError Source #
type Rep GameError Source #
Instance details Defined in Plutus.Contracts.GameStateMachine type Rep GameError = D1 ('MetaData "GameError" "Plutus.Contracts.GameStateMachine" "plutus-use-cases-1.1.0.0-9kk4ZO09YVFKU77qwQaRsf" 'False) (C1 ('MetaCons "GameContractError" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ContractError)) :+: C1 ('MetaCons "GameSMError" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SMContractError)))

token :: MintingPolicyHash -> TokenName -> Value Source #

covIdx :: CoverageIndex Source #