Safe Haskell	None
Language	Haskell2010

Plutus.Contracts.SimpleEscrow

Description

This simple escrow contract facilitiates and exchange of currencies.

Synopsis

data EscrowParams = EscrowParams {
- payee :: PaymentPubKeyHash
- paying :: Value
- expecting :: Value
- deadline :: POSIXTime
}
type EscrowSchema = (Endpoint "lock" EscrowParams .\/ Endpoint "refund" EscrowParams) .\/ Endpoint "redeem" EscrowParams
data Action
- = Redeem
- | Refund
data RedeemFailReason = DeadlinePassed
data EscrowError
class AsEscrowError r where
- _EscrowError :: Prism' r EscrowError
- _RedeemFailed :: Prism' r RedeemFailReason
- _RefundFailed :: Prism' r ()
- _EContractError :: Prism' r ContractError
newtype RefundSuccess = RefundSuccess TxId
newtype RedeemSuccess = RedeemSuccess TxId
data Escrow
escrowAddress :: CardanoAddress
escrowInstance :: TypedValidator Escrow
validate :: EscrowParams -> Action -> ScriptContext -> Bool
lockEp :: Promise () EscrowSchema EscrowError ()
redeemEp :: Promise () EscrowSchema EscrowError RedeemSuccess
refundEp :: Promise () EscrowSchema EscrowError RefundSuccess

Documentation

data EscrowParams Source #

Constructors

EscrowParams
Fields payee :: PaymentPubKeyHash The entity that needs to be paid the `expecting` `Value`. paying :: Value Value to be paid out to the redeemer. expecting :: Value Value to be received by the payee. deadline :: POSIXTime Time after which the contract expires.

Instances

Instances details

Show EscrowParams Source #
Instance details Defined in Plutus.Contracts.SimpleEscrow Methods showsPrec :: Int -> EscrowParams -> ShowS Source # show :: EscrowParams -> String Source # showList :: [EscrowParams] -> ShowS Source #
Generic EscrowParams Source #
Instance details Defined in Plutus.Contracts.SimpleEscrow Associated Types type Rep EscrowParams :: Type -> Type Source # Methods from :: EscrowParams -> Rep EscrowParams x Source # to :: Rep EscrowParams x -> EscrowParams Source #
ToJSON EscrowParams Source #
Instance details Defined in Plutus.Contracts.SimpleEscrow Methods toJSON :: EscrowParams -> Value Source # toEncoding :: EscrowParams -> Encoding Source # toJSONList :: [EscrowParams] -> Value Source # toEncodingList :: [EscrowParams] -> Encoding Source #
FromJSON EscrowParams Source #
Instance details Defined in Plutus.Contracts.SimpleEscrow Methods parseJSON :: Value -> Parser EscrowParams Source # parseJSONList :: Value -> Parser [EscrowParams] Source #
UnsafeFromData EscrowParams Source #
Instance details Defined in Plutus.Contracts.SimpleEscrow Methods unsafeFromBuiltinData :: BuiltinData -> EscrowParams Source #
FromData EscrowParams Source #
Instance details Defined in Plutus.Contracts.SimpleEscrow Methods fromBuiltinData :: BuiltinData -> Maybe EscrowParams Source #
ToData EscrowParams Source #
Instance details Defined in Plutus.Contracts.SimpleEscrow Methods toBuiltinData :: EscrowParams -> BuiltinData Source #
Lift DefaultUni EscrowParams Source #
Instance details Defined in Plutus.Contracts.SimpleEscrow Methods lift :: EscrowParams -> RTCompile DefaultUni fun (Term TyName Name DefaultUni fun ()) Source #
Typeable DefaultUni EscrowParams Source #
Instance details Defined in Plutus.Contracts.SimpleEscrow Methods typeRep :: Proxy EscrowParams -> RTCompile DefaultUni fun (Type TyName DefaultUni ()) Source #
type Rep EscrowParams Source #
Instance details Defined in Plutus.Contracts.SimpleEscrow type Rep EscrowParams = D1 ('MetaData "EscrowParams" "Plutus.Contracts.SimpleEscrow" "plutus-use-cases-1.1.0.0-9kk4ZO09YVFKU77qwQaRsf" 'False) (C1 ('MetaCons "EscrowParams" 'PrefixI 'True) ((S1 ('MetaSel ('Just "payee") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 PaymentPubKeyHash) :: S1 ('MetaSel ('Just "paying") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Value)) :: (S1 ('MetaSel ('Just "expecting") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Value) :*: S1 ('MetaSel ('Just "deadline") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 POSIXTime))))

type EscrowSchema = (Endpoint "lock" EscrowParams .\/ Endpoint "refund" EscrowParams) .\/ Endpoint "redeem" EscrowParams Source #

data Action Source #

Constructors

Redeem
Refund

Instances

Instances details

UnsafeFromData Action Source #
Instance details Defined in Plutus.Contracts.SimpleEscrow Methods unsafeFromBuiltinData :: BuiltinData -> Action Source #
FromData Action Source #
Instance details Defined in Plutus.Contracts.SimpleEscrow Methods fromBuiltinData :: BuiltinData -> Maybe Action Source #
ToData Action Source #
Instance details Defined in Plutus.Contracts.SimpleEscrow Methods toBuiltinData :: Action -> BuiltinData Source #
Lift DefaultUni Action Source #
Instance details Defined in Plutus.Contracts.SimpleEscrow Methods lift :: Action -> RTCompile DefaultUni fun (Term TyName Name DefaultUni fun ()) Source #
Typeable DefaultUni Action Source #
Instance details Defined in Plutus.Contracts.SimpleEscrow Methods typeRep :: Proxy Action -> RTCompile DefaultUni fun (Type TyName DefaultUni ()) Source #

data RedeemFailReason Source #

Constructors

DeadlinePassed

Instances

Instances details

Eq RedeemFailReason Source #
Instance details Defined in Plutus.Contracts.SimpleEscrow Methods (==) :: RedeemFailReason -> RedeemFailReason -> Bool Source # (/=) :: RedeemFailReason -> RedeemFailReason -> Bool Source #
Show RedeemFailReason Source #
Instance details Defined in Plutus.Contracts.SimpleEscrow Methods showsPrec :: Int -> RedeemFailReason -> ShowS Source # show :: RedeemFailReason -> String Source # showList :: [RedeemFailReason] -> ShowS Source #
Generic RedeemFailReason Source #
Instance details Defined in Plutus.Contracts.SimpleEscrow Associated Types type Rep RedeemFailReason :: Type -> Type Source # Methods from :: RedeemFailReason -> Rep RedeemFailReason x Source # to :: Rep RedeemFailReason x -> RedeemFailReason Source #
ToJSON RedeemFailReason Source #
Instance details Defined in Plutus.Contracts.SimpleEscrow Methods toJSON :: RedeemFailReason -> Value Source # toEncoding :: RedeemFailReason -> Encoding Source # toJSONList :: [RedeemFailReason] -> Value Source # toEncodingList :: [RedeemFailReason] -> Encoding Source #
FromJSON RedeemFailReason Source #
Instance details Defined in Plutus.Contracts.SimpleEscrow Methods parseJSON :: Value -> Parser RedeemFailReason Source # parseJSONList :: Value -> Parser [RedeemFailReason] Source #
type Rep RedeemFailReason Source #
Instance details Defined in Plutus.Contracts.SimpleEscrow type Rep RedeemFailReason = D1 ('MetaData "RedeemFailReason" "Plutus.Contracts.SimpleEscrow" "plutus-use-cases-1.1.0.0-9kk4ZO09YVFKU77qwQaRsf" 'False) (C1 ('MetaCons "DeadlinePassed" 'PrefixI 'False) (U1 :: Type -> Type))

data EscrowError Source #

Constructors

RedeemFailed RedeemFailReason
RefundFailed
EContractError ContractError

Instances

Instances details

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

class AsEscrowError r where Source #

Minimal complete definition

_EscrowError

Methods

_EscrowError :: Prism' r EscrowError Source #

_RedeemFailed :: Prism' r RedeemFailReason Source #

_RefundFailed :: Prism' r () Source #

_EContractError :: Prism' r ContractError Source #

Instances

Instances details

AsEscrowError EscrowError Source #
Instance details Defined in Plutus.Contracts.SimpleEscrow Methods _EscrowError :: Prism' EscrowError EscrowError Source # _RedeemFailed :: Prism' EscrowError RedeemFailReason Source # _RefundFailed :: Prism' EscrowError () Source # _EContractError :: Prism' EscrowError ContractError Source #

newtype RefundSuccess Source #

Constructors

RefundSuccess TxId

Instances

Instances details

Eq RefundSuccess Source #
Instance details Defined in Plutus.Contracts.SimpleEscrow Methods (==) :: RefundSuccess -> RefundSuccess -> Bool Source # (/=) :: RefundSuccess -> RefundSuccess -> Bool Source #
Show RefundSuccess Source #
Instance details Defined in Plutus.Contracts.SimpleEscrow Methods showsPrec :: Int -> RefundSuccess -> ShowS Source # show :: RefundSuccess -> String Source # showList :: [RefundSuccess] -> ShowS Source #
Generic RefundSuccess Source #
Instance details Defined in Plutus.Contracts.SimpleEscrow Associated Types type Rep RefundSuccess :: Type -> Type Source # Methods from :: RefundSuccess -> Rep RefundSuccess x Source # to :: Rep RefundSuccess x -> RefundSuccess Source #
ToJSON RefundSuccess Source #
Instance details Defined in Plutus.Contracts.SimpleEscrow Methods toJSON :: RefundSuccess -> Value Source # toEncoding :: RefundSuccess -> Encoding Source # toJSONList :: [RefundSuccess] -> Value Source # toEncodingList :: [RefundSuccess] -> Encoding Source #
FromJSON RefundSuccess Source #
Instance details Defined in Plutus.Contracts.SimpleEscrow Methods parseJSON :: Value -> Parser RefundSuccess Source # parseJSONList :: Value -> Parser [RefundSuccess] Source #
type Rep RefundSuccess Source #
Instance details Defined in Plutus.Contracts.SimpleEscrow type Rep RefundSuccess = Rep TxId

newtype RedeemSuccess Source #

Constructors

RedeemSuccess TxId

Instances

Instances details

Eq RedeemSuccess Source #
Instance details Defined in Plutus.Contracts.SimpleEscrow Methods (==) :: RedeemSuccess -> RedeemSuccess -> Bool Source # (/=) :: RedeemSuccess -> RedeemSuccess -> Bool Source #
Show RedeemSuccess Source #
Instance details Defined in Plutus.Contracts.SimpleEscrow Methods showsPrec :: Int -> RedeemSuccess -> ShowS Source # show :: RedeemSuccess -> String Source # showList :: [RedeemSuccess] -> ShowS Source #

data Escrow Source #

Instances

Instances details

ValidatorTypes Escrow Source #
Instance details Defined in Plutus.Contracts.SimpleEscrow Associated Types type RedeemerType Escrow Source # type DatumType Escrow Source #
type RedeemerType Escrow Source #
Instance details Defined in Plutus.Contracts.SimpleEscrow type RedeemerType Escrow = Action
type DatumType Escrow Source #
Instance details Defined in Plutus.Contracts.SimpleEscrow type DatumType Escrow = EscrowParams

escrowAddress :: CardanoAddress Source #

escrowInstance :: TypedValidator Escrow Source #

validate :: EscrowParams -> Action -> ScriptContext -> Bool Source #

lockEp :: Promise () EscrowSchema EscrowError () Source #

Lock the paying Value in the output of this script, with the requirement that the transaction validates before the deadline.

redeemEp :: Promise () EscrowSchema EscrowError RedeemSuccess Source #

Attempts to redeem the Value locked into this script by paying in from the callers address to the payee.

refundEp :: Promise () EscrowSchema EscrowError RefundSuccess Source #

Refunds the locked amount back to the payee.