Safe Haskell	None
Language	Haskell2010

Plutus.Contracts.Auction

Synopsis

data AuctionState
- = Ongoing HighestBid
- | Finished HighestBid
data AuctionInput
- = Bid {
  - newBid :: Ada
  - newBidder :: Address
  }
- | Payout
type BuyerSchema = Endpoint "bid" Ada
type SellerSchema = EmptySchema
data AuctionParams = AuctionParams {
- apOwner :: Address
- apAsset :: Value
- apEndTime :: POSIXTime
}
data HighestBid = HighestBid {
- highestBid :: Ada
- highestBidder :: Address
}
auctionBuyer :: ThreadToken -> AuctionParams -> Contract AuctionOutput BuyerSchema AuctionError ()
auctionSeller :: Value -> POSIXTime -> Contract AuctionOutput SellerSchema AuctionError ()
data AuctionOutput = AuctionOutput {
- auctionState :: Last AuctionState
- auctionThreadToken :: Last ThreadToken
}
data AuctionError
- = StateMachineContractError SMContractError
- | AuctionContractError ContractError
data ThreadToken
getThreadToken :: forall e w (schema :: Row Type). AsSMContractError e => Contract w schema e ThreadToken
covIdx :: CoverageIndex

Documentation

data AuctionState Source #

The states of the auction

Constructors

Ongoing HighestBid
Finished HighestBid

Instances

Instances details

Eq AuctionState Source #
Instance details Defined in Plutus.Contracts.Auction Methods (==) :: AuctionState -> AuctionState -> Bool Source # (/=) :: AuctionState -> AuctionState -> Bool Source #
Show AuctionState Source #
Instance details Defined in Plutus.Contracts.Auction Methods showsPrec :: Int -> AuctionState -> ShowS Source # show :: AuctionState -> String Source # showList :: [AuctionState] -> ShowS Source #
Generic AuctionState Source #
Instance details Defined in Plutus.Contracts.Auction Associated Types type Rep AuctionState :: Type -> Type Source # Methods from :: AuctionState -> Rep AuctionState x Source # to :: Rep AuctionState x -> AuctionState Source #
ToJSON AuctionState Source #
Instance details Defined in Plutus.Contracts.Auction Methods toJSON :: AuctionState -> Value Source # toEncoding :: AuctionState -> Encoding Source # toJSONList :: [AuctionState] -> Value Source # toEncodingList :: [AuctionState] -> Encoding Source #
FromJSON AuctionState Source #
Instance details Defined in Plutus.Contracts.Auction Methods parseJSON :: Value -> Parser AuctionState Source # parseJSONList :: Value -> Parser [AuctionState] Source #
UnsafeFromData AuctionState Source #
Instance details Defined in Plutus.Contracts.Auction Methods unsafeFromBuiltinData :: BuiltinData -> AuctionState Source #
FromData AuctionState Source #
Instance details Defined in Plutus.Contracts.Auction Methods fromBuiltinData :: BuiltinData -> Maybe AuctionState Source #
ToData AuctionState Source #
Instance details Defined in Plutus.Contracts.Auction Methods toBuiltinData :: AuctionState -> BuiltinData Source #
type Rep AuctionState Source #
Instance details Defined in Plutus.Contracts.Auction type Rep AuctionState = D1 ('MetaData "AuctionState" "Plutus.Contracts.Auction" "plutus-use-cases-1.1.0.0-9kk4ZO09YVFKU77qwQaRsf" 'False) (C1 ('MetaCons "Ongoing" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 HighestBid)) :+: C1 ('MetaCons "Finished" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 HighestBid)))

data AuctionInput Source #

Transition between auction states

Constructors

Bid
Fields newBid :: Ada newBidder :: Address
Payout

Instances

Instances details

Show AuctionInput Source #
Instance details Defined in Plutus.Contracts.Auction Methods showsPrec :: Int -> AuctionInput -> ShowS Source # show :: AuctionInput -> String Source # showList :: [AuctionInput] -> ShowS Source #
Generic AuctionInput Source #
Instance details Defined in Plutus.Contracts.Auction Associated Types type Rep AuctionInput :: Type -> Type Source # Methods from :: AuctionInput -> Rep AuctionInput x Source # to :: Rep AuctionInput x -> AuctionInput Source #
ToJSON AuctionInput Source #
Instance details Defined in Plutus.Contracts.Auction Methods toJSON :: AuctionInput -> Value Source # toEncoding :: AuctionInput -> Encoding Source # toJSONList :: [AuctionInput] -> Value Source # toEncodingList :: [AuctionInput] -> Encoding Source #
FromJSON AuctionInput Source #
Instance details Defined in Plutus.Contracts.Auction Methods parseJSON :: Value -> Parser AuctionInput Source # parseJSONList :: Value -> Parser [AuctionInput] Source #
UnsafeFromData AuctionInput Source #
Instance details Defined in Plutus.Contracts.Auction Methods unsafeFromBuiltinData :: BuiltinData -> AuctionInput Source #
FromData AuctionInput Source #
Instance details Defined in Plutus.Contracts.Auction Methods fromBuiltinData :: BuiltinData -> Maybe AuctionInput Source #
ToData AuctionInput Source #
Instance details Defined in Plutus.Contracts.Auction Methods toBuiltinData :: AuctionInput -> BuiltinData Source #
type Rep AuctionInput Source #
Instance details Defined in Plutus.Contracts.Auction type Rep AuctionInput = D1 ('MetaData "AuctionInput" "Plutus.Contracts.Auction" "plutus-use-cases-1.1.0.0-9kk4ZO09YVFKU77qwQaRsf" 'False) (C1 ('MetaCons "Bid" 'PrefixI 'True) (S1 ('MetaSel ('Just "newBid") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Ada) :*: S1 ('MetaSel ('Just "newBidder") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Address)) :+: C1 ('MetaCons "Payout" 'PrefixI 'False) (U1 :: Type -> Type))

type BuyerSchema = Endpoint "bid" Ada Source #

type SellerSchema = EmptySchema Source #

data AuctionParams Source #

Definition of an auction

Constructors

AuctionParams
Fields apOwner :: Address Current owner of the asset. This is where the proceeds of the auction will be sent. apAsset :: Value The asset itself. This value is going to be locked by the auction script output. apEndTime :: POSIXTime When the time window for bidding ends.

Instances

Instances details

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

data HighestBid Source #

Constructors

HighestBid
Fields highestBid :: Ada highestBidder :: Address

Instances

Instances details

Eq HighestBid Source #
Instance details Defined in Plutus.Contracts.Auction Methods (==) :: HighestBid -> HighestBid -> Bool Source # (/=) :: HighestBid -> HighestBid -> Bool Source #
Show HighestBid Source #
Instance details Defined in Plutus.Contracts.Auction Methods showsPrec :: Int -> HighestBid -> ShowS Source # show :: HighestBid -> String Source # showList :: [HighestBid] -> ShowS Source #
Generic HighestBid Source #
Instance details Defined in Plutus.Contracts.Auction Associated Types type Rep HighestBid :: Type -> Type Source # Methods from :: HighestBid -> Rep HighestBid x Source # to :: Rep HighestBid x -> HighestBid Source #
ToJSON HighestBid Source #
Instance details Defined in Plutus.Contracts.Auction Methods toJSON :: HighestBid -> Value Source # toEncoding :: HighestBid -> Encoding Source # toJSONList :: [HighestBid] -> Value Source # toEncodingList :: [HighestBid] -> Encoding Source #
FromJSON HighestBid Source #
Instance details Defined in Plutus.Contracts.Auction Methods parseJSON :: Value -> Parser HighestBid Source # parseJSONList :: Value -> Parser [HighestBid] Source #
UnsafeFromData HighestBid Source #
Instance details Defined in Plutus.Contracts.Auction Methods unsafeFromBuiltinData :: BuiltinData -> HighestBid Source #
FromData HighestBid Source #
Instance details Defined in Plutus.Contracts.Auction Methods fromBuiltinData :: BuiltinData -> Maybe HighestBid Source #
ToData HighestBid Source #
Instance details Defined in Plutus.Contracts.Auction Methods toBuiltinData :: HighestBid -> BuiltinData Source #
type Rep HighestBid Source #
Instance details Defined in Plutus.Contracts.Auction type Rep HighestBid = D1 ('MetaData "HighestBid" "Plutus.Contracts.Auction" "plutus-use-cases-1.1.0.0-9kk4ZO09YVFKU77qwQaRsf" 'False) (C1 ('MetaCons "HighestBid" 'PrefixI 'True) (S1 ('MetaSel ('Just "highestBid") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Ada) :*: S1 ('MetaSel ('Just "highestBidder") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Address)))

auctionBuyer :: ThreadToken -> AuctionParams -> Contract AuctionOutput BuyerSchema AuctionError () Source #

auctionSeller :: Value -> POSIXTime -> Contract AuctionOutput SellerSchema AuctionError () Source #

Client code for the seller

data AuctionOutput Source #

Observable state of the auction app

Constructors

AuctionOutput
Fields auctionState :: Last AuctionState auctionThreadToken :: Last ThreadToken

Instances

Instances details

Eq AuctionOutput Source #
Instance details Defined in Plutus.Contracts.Auction Methods (==) :: AuctionOutput -> AuctionOutput -> Bool Source # (/=) :: AuctionOutput -> AuctionOutput -> Bool Source #
Show AuctionOutput Source #
Instance details Defined in Plutus.Contracts.Auction Methods showsPrec :: Int -> AuctionOutput -> ShowS Source # show :: AuctionOutput -> String Source # showList :: [AuctionOutput] -> ShowS Source #
Generic AuctionOutput Source #
Instance details Defined in Plutus.Contracts.Auction Associated Types type Rep AuctionOutput :: Type -> Type Source # Methods from :: AuctionOutput -> Rep AuctionOutput x Source # to :: Rep AuctionOutput x -> AuctionOutput Source #
Semigroup AuctionOutput Source #
Instance details Defined in Plutus.Contracts.Auction Methods (<>) :: AuctionOutput -> AuctionOutput -> AuctionOutput Source # sconcat :: NonEmpty AuctionOutput -> AuctionOutput Source # stimes :: Integral b => b -> AuctionOutput -> AuctionOutput Source #
Monoid AuctionOutput Source #
Instance details Defined in Plutus.Contracts.Auction Methods mempty :: AuctionOutput Source # mappend :: AuctionOutput -> AuctionOutput -> AuctionOutput Source # mconcat :: [AuctionOutput] -> AuctionOutput Source #
ToJSON AuctionOutput Source #
Instance details Defined in Plutus.Contracts.Auction Methods toJSON :: AuctionOutput -> Value Source # toEncoding :: AuctionOutput -> Encoding Source # toJSONList :: [AuctionOutput] -> Value Source # toEncodingList :: [AuctionOutput] -> Encoding Source #
FromJSON AuctionOutput Source #
Instance details Defined in Plutus.Contracts.Auction Methods parseJSON :: Value -> Parser AuctionOutput Source # parseJSONList :: Value -> Parser [AuctionOutput] Source #
type Rep AuctionOutput Source #
Instance details Defined in Plutus.Contracts.Auction type Rep AuctionOutput = D1 ('MetaData "AuctionOutput" "Plutus.Contracts.Auction" "plutus-use-cases-1.1.0.0-9kk4ZO09YVFKU77qwQaRsf" 'False) (C1 ('MetaCons "AuctionOutput" 'PrefixI 'True) (S1 ('MetaSel ('Just "auctionState") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Last AuctionState)) :*: S1 ('MetaSel ('Just "auctionThreadToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Last ThreadToken))))

data AuctionError Source #

Constructors

StateMachineContractError SMContractError	State machine operation failed
AuctionContractError ContractError	Endpoint, coin selection, etc. failed

Instances

Instances details

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

data ThreadToken Source #

Instances

Instances details

Eq ThreadToken
Instance details Defined in Plutus.Contract.StateMachine.ThreadToken Methods (==) :: ThreadToken -> ThreadToken -> Bool Source # (/=) :: ThreadToken -> ThreadToken -> Bool Source #
Ord ThreadToken
Instance details Defined in Plutus.Contract.StateMachine.ThreadToken Methods compare :: ThreadToken -> ThreadToken -> Ordering Source # (<) :: ThreadToken -> ThreadToken -> Bool Source # (<=) :: ThreadToken -> ThreadToken -> Bool Source # (>) :: ThreadToken -> ThreadToken -> Bool Source # (>=) :: ThreadToken -> ThreadToken -> Bool Source # max :: ThreadToken -> ThreadToken -> ThreadToken Source # min :: ThreadToken -> ThreadToken -> ThreadToken Source #
Show ThreadToken
Instance details Defined in Plutus.Contract.StateMachine.ThreadToken Methods showsPrec :: Int -> ThreadToken -> ShowS Source # show :: ThreadToken -> String Source # showList :: [ThreadToken] -> ShowS Source #
Generic ThreadToken
Instance details Defined in Plutus.Contract.StateMachine.ThreadToken Associated Types type Rep ThreadToken :: Type -> Type Source # Methods from :: ThreadToken -> Rep ThreadToken x Source # to :: Rep ThreadToken x -> ThreadToken Source #
ToJSON ThreadToken
Instance details Defined in Plutus.Contract.StateMachine.ThreadToken Methods toJSON :: ThreadToken -> Value Source # toEncoding :: ThreadToken -> Encoding Source # toJSONList :: [ThreadToken] -> Value Source # toEncodingList :: [ThreadToken] -> Encoding Source #
FromJSON ThreadToken
Instance details Defined in Plutus.Contract.StateMachine.ThreadToken Methods parseJSON :: Value -> Parser ThreadToken Source # parseJSONList :: Value -> Parser [ThreadToken] Source #
ToSchema ThreadToken
Instance details Defined in Plutus.Contract.StateMachine.ThreadToken Methods declareNamedSchema :: Proxy ThreadToken -> Declare (Definitions Schema) NamedSchema Source #
ToSchema ThreadToken
Instance details Defined in Schema Methods toSchema :: FormSchema Source #
UnsafeFromData ThreadToken
Instance details Defined in Plutus.Contract.StateMachine.ThreadToken Methods unsafeFromBuiltinData :: BuiltinData -> ThreadToken Source #
FromData ThreadToken
Instance details Defined in Plutus.Contract.StateMachine.ThreadToken Methods fromBuiltinData :: BuiltinData -> Maybe ThreadToken Source #
ToData ThreadToken
Instance details Defined in Plutus.Contract.StateMachine.ThreadToken Methods toBuiltinData :: ThreadToken -> BuiltinData Source #
Lift DefaultUni ThreadToken
Instance details Defined in Plutus.Contract.StateMachine.ThreadToken Methods lift :: ThreadToken -> RTCompile DefaultUni fun (Term TyName Name DefaultUni fun ()) Source #
Typeable DefaultUni ThreadToken
Instance details Defined in Plutus.Contract.StateMachine.ThreadToken Methods typeRep :: Proxy ThreadToken -> RTCompile DefaultUni fun (Type TyName DefaultUni ()) Source #
type Rep ThreadToken
Instance details Defined in Plutus.Contract.StateMachine.ThreadToken type Rep ThreadToken = D1 ('MetaData "ThreadToken" "Plutus.Contract.StateMachine.ThreadToken" "plutus-contract-1.1.0.0-KZTRXOViW1GCXNPMdYqx30" 'False) (C1 ('MetaCons "ThreadToken" 'PrefixI 'True) (S1 ('MetaSel ('Just "ttOutRef") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 TxOutRef) :*: S1 ('MetaSel ('Just "ttCurrencySymbol") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 CurrencySymbol)))

getThreadToken :: forall e w (schema :: Row Type). AsSMContractError e => Contract w schema e ThreadToken Source #

Create a thread token. The thread token contains a reference to an unspent output of the wallet, so it needs to used with mkStateMachine immediately, and the machine must be initialised, to prevent the output from getting spent in the mean time.

covIdx :: CoverageIndex Source #