Safe Haskell	None
Language	Haskell2010

Wallet.Types

Description

Defines a number of types that are used in Wallet.XXX modules

Synopsis

newtype ContractInstanceId = ContractInstanceId {
- unContractInstanceId :: UUID
}
contractInstanceIDs :: [ContractInstanceId]
randomID :: IO ContractInstanceId
data ContractActivityStatus
- = Active
- | Stopped
- | Done
parseContractActivityStatus :: Text -> Maybe ContractActivityStatus
data Notification = Notification {
}
data NotificationError
newtype EndpointDescription = EndpointDescription {
- getEndpointDescription :: String
}
newtype EndpointValue a = EndpointValue {
- unEndpointValue :: a
}

Documentation

newtype ContractInstanceId Source #

Unique ID for contract instance

Constructors

ContractInstanceId
Fields unContractInstanceId :: UUID

Instances

Instances details

Eq ContractInstanceId Source #
Instance details Defined in Wallet.Types Methods (==) :: ContractInstanceId -> ContractInstanceId -> Bool Source # (/=) :: ContractInstanceId -> ContractInstanceId -> Bool Source #
Ord ContractInstanceId Source #
Instance details Defined in Wallet.Types Methods compare :: ContractInstanceId -> ContractInstanceId -> Ordering Source # (<) :: ContractInstanceId -> ContractInstanceId -> Bool Source # (<=) :: ContractInstanceId -> ContractInstanceId -> Bool Source # (>) :: ContractInstanceId -> ContractInstanceId -> Bool Source # (>=) :: ContractInstanceId -> ContractInstanceId -> Bool Source # max :: ContractInstanceId -> ContractInstanceId -> ContractInstanceId Source # min :: ContractInstanceId -> ContractInstanceId -> ContractInstanceId Source #
Show ContractInstanceId Source #
Instance details Defined in Wallet.Types Methods showsPrec :: Int -> ContractInstanceId -> ShowS Source # show :: ContractInstanceId -> String Source # showList :: [ContractInstanceId] -> ShowS Source #
Generic ContractInstanceId Source #
Instance details Defined in Wallet.Types Associated Types type Rep ContractInstanceId :: Type -> Type Source # Methods from :: ContractInstanceId -> Rep ContractInstanceId x Source # to :: Rep ContractInstanceId x -> ContractInstanceId Source #
FromJSON ContractInstanceId Source #
Instance details Defined in Wallet.Types Methods parseJSON :: Value -> Parser ContractInstanceId parseJSONList :: Value -> Parser [ContractInstanceId]
FromJSONKey ContractInstanceId Source #
Instance details Defined in Wallet.Types Methods fromJSONKey :: FromJSONKeyFunction ContractInstanceId fromJSONKeyList :: FromJSONKeyFunction [ContractInstanceId]
ToJSON ContractInstanceId Source #
Instance details Defined in Wallet.Types Methods toJSON :: ContractInstanceId -> Value toEncoding :: ContractInstanceId -> Encoding toJSONList :: [ContractInstanceId] -> Value toEncodingList :: [ContractInstanceId] -> Encoding
ToJSONKey ContractInstanceId Source #
Instance details Defined in Wallet.Types Methods toJSONKey :: ToJSONKeyFunction ContractInstanceId toJSONKeyList :: ToJSONKeyFunction [ContractInstanceId]
Pretty ContractInstanceId Source #
Instance details Defined in Wallet.Types Methods pretty :: ContractInstanceId -> Doc ann prettyList :: [ContractInstanceId] -> Doc ann
type Rep ContractInstanceId Source #
Instance details Defined in Wallet.Types type Rep ContractInstanceId = D1 ('MetaData "ContractInstanceId" "Wallet.Types" "plutus-contract-1.2.0.0-FH8LC9wh7UV4Nmv68NHXrC" 'True) (C1 ('MetaCons "ContractInstanceId" 'PrefixI 'True) (S1 ('MetaSel ('Just "unContractInstanceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 UUID)))

contractInstanceIDs :: [ContractInstanceId] Source #

A pure list of all ContractInstanceId values. To be used in testing.

randomID :: IO ContractInstanceId Source #

data ContractActivityStatus Source #

Constructors

Active
Stopped
Done

Instances

Instances details

Eq ContractActivityStatus Source #
Instance details Defined in Wallet.Types Methods (==) :: ContractActivityStatus -> ContractActivityStatus -> Bool Source # (/=) :: ContractActivityStatus -> ContractActivityStatus -> Bool Source #
Show ContractActivityStatus Source #
Instance details Defined in Wallet.Types Methods showsPrec :: Int -> ContractActivityStatus -> ShowS Source # show :: ContractActivityStatus -> String Source # showList :: [ContractActivityStatus] -> ShowS Source #
Generic ContractActivityStatus Source #
Instance details Defined in Wallet.Types Associated Types type Rep ContractActivityStatus :: Type -> Type Source # Methods from :: ContractActivityStatus -> Rep ContractActivityStatus x Source # to :: Rep ContractActivityStatus x -> ContractActivityStatus Source #
FromJSON ContractActivityStatus Source #
Instance details Defined in Wallet.Types Methods parseJSON :: Value -> Parser ContractActivityStatus parseJSONList :: Value -> Parser [ContractActivityStatus]
ToJSON ContractActivityStatus Source #
Instance details Defined in Wallet.Types Methods toJSON :: ContractActivityStatus -> Value toEncoding :: ContractActivityStatus -> Encoding toJSONList :: [ContractActivityStatus] -> Value toEncodingList :: [ContractActivityStatus] -> Encoding
type Rep ContractActivityStatus Source #
Instance details Defined in Wallet.Types type Rep ContractActivityStatus = D1 ('MetaData "ContractActivityStatus" "Wallet.Types" "plutus-contract-1.2.0.0-FH8LC9wh7UV4Nmv68NHXrC" 'False) (C1 ('MetaCons "Active" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "Stopped" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Done" 'PrefixI 'False) (U1 :: Type -> Type)))

parseContractActivityStatus :: Text -> Maybe ContractActivityStatus Source #

data Notification Source #

Constructors

Notification
Fields notificationContractID :: ContractInstanceId notificationContractEndpoint :: EndpointDescription notificationContractArg :: Value

Instances

Instances details

Eq Notification Source #
Instance details Defined in Wallet.Types Methods (==) :: Notification -> Notification -> Bool Source # (/=) :: Notification -> Notification -> Bool Source #
Show Notification Source #
Instance details Defined in Wallet.Types Methods showsPrec :: Int -> Notification -> ShowS Source # show :: Notification -> String Source # showList :: [Notification] -> ShowS Source #
Generic Notification Source #
Instance details Defined in Wallet.Types Associated Types type Rep Notification :: Type -> Type Source # Methods from :: Notification -> Rep Notification x Source # to :: Rep Notification x -> Notification Source #
FromJSON Notification Source #
Instance details Defined in Wallet.Types Methods parseJSON :: Value -> Parser Notification parseJSONList :: Value -> Parser [Notification]
ToJSON Notification Source #
Instance details Defined in Wallet.Types Methods toJSON :: Notification -> Value toEncoding :: Notification -> Encoding toJSONList :: [Notification] -> Value toEncodingList :: [Notification] -> Encoding
Pretty Notification Source #
Instance details Defined in Wallet.Types Methods pretty :: Notification -> Doc ann prettyList :: [Notification] -> Doc ann
type Rep Notification Source #
Instance details Defined in Wallet.Types type Rep Notification = D1 ('MetaData "Notification" "Wallet.Types" "plutus-contract-1.2.0.0-FH8LC9wh7UV4Nmv68NHXrC" 'False) (C1 ('MetaCons "Notification" 'PrefixI 'True) (S1 ('MetaSel ('Just "notificationContractID") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ContractInstanceId) :: (S1 ('MetaSel ('Just "notificationContractEndpoint") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 EndpointDescription) :: S1 ('MetaSel ('Just "notificationContractArg") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Value))))

data NotificationError Source #

Constructors

EndpointNotAvailable ContractInstanceId EndpointDescription
MoreThanOneEndpointAvailable ContractInstanceId EndpointDescription
InstanceDoesNotExist ContractInstanceId
NotificationJSONDecodeError EndpointDescription Value String	Indicates that the target contract does not have the expected schema TODO: SCP-2137 Not currently used. As endpoint parameter decoding happends inside the Contract and a throwError is used is decoding failed. However, still valuable to be used by the PAB to throw an error is an endpoint could not be decoded.

Instances

Instances details

Eq NotificationError Source #
Instance details Defined in Wallet.Types Methods (==) :: NotificationError -> NotificationError -> Bool Source # (/=) :: NotificationError -> NotificationError -> Bool Source #
Show NotificationError Source #
Instance details Defined in Wallet.Types Methods showsPrec :: Int -> NotificationError -> ShowS Source # show :: NotificationError -> String Source # showList :: [NotificationError] -> ShowS Source #
Generic NotificationError Source #
Instance details Defined in Wallet.Types Associated Types type Rep NotificationError :: Type -> Type Source # Methods from :: NotificationError -> Rep NotificationError x Source # to :: Rep NotificationError x -> NotificationError Source #
FromJSON NotificationError Source #
Instance details Defined in Wallet.Types Methods parseJSON :: Value -> Parser NotificationError parseJSONList :: Value -> Parser [NotificationError]
ToJSON NotificationError Source #
Instance details Defined in Wallet.Types Methods toJSON :: NotificationError -> Value toEncoding :: NotificationError -> Encoding toJSONList :: [NotificationError] -> Value toEncodingList :: [NotificationError] -> Encoding
Pretty NotificationError Source #
Instance details Defined in Wallet.Types Methods pretty :: NotificationError -> Doc ann prettyList :: [NotificationError] -> Doc ann
type Rep NotificationError Source #
Instance details Defined in Wallet.Types type Rep NotificationError = D1 ('MetaData "NotificationError" "Wallet.Types" "plutus-contract-1.2.0.0-FH8LC9wh7UV4Nmv68NHXrC" 'False) ((C1 ('MetaCons "EndpointNotAvailable" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ContractInstanceId) :: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 EndpointDescription)) :+: C1 ('MetaCons "MoreThanOneEndpointAvailable" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ContractInstanceId) :: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 EndpointDescription))) :+: (C1 ('MetaCons "InstanceDoesNotExist" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ContractInstanceId)) :+: C1 ('MetaCons "NotificationJSONDecodeError" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 EndpointDescription) :: (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Value) :: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 String)))))

newtype EndpointDescription Source #

Constructors

EndpointDescription
Fields getEndpointDescription :: String

Instances

Instances details

Eq EndpointDescription Source #
Instance details Defined in Wallet.Types Methods (==) :: EndpointDescription -> EndpointDescription -> Bool Source # (/=) :: EndpointDescription -> EndpointDescription -> Bool Source #
Ord EndpointDescription Source #
Instance details Defined in Wallet.Types Methods compare :: EndpointDescription -> EndpointDescription -> Ordering Source # (<) :: EndpointDescription -> EndpointDescription -> Bool Source # (<=) :: EndpointDescription -> EndpointDescription -> Bool Source # (>) :: EndpointDescription -> EndpointDescription -> Bool Source # (>=) :: EndpointDescription -> EndpointDescription -> Bool Source # max :: EndpointDescription -> EndpointDescription -> EndpointDescription Source # min :: EndpointDescription -> EndpointDescription -> EndpointDescription Source #
Show EndpointDescription Source #
Instance details Defined in Wallet.Types Methods showsPrec :: Int -> EndpointDescription -> ShowS Source # show :: EndpointDescription -> String Source # showList :: [EndpointDescription] -> ShowS Source #
IsString EndpointDescription Source #
Instance details Defined in Wallet.Types Methods fromString :: String -> EndpointDescription Source #
Generic EndpointDescription Source #
Instance details Defined in Wallet.Types Associated Types type Rep EndpointDescription :: Type -> Type Source # Methods from :: EndpointDescription -> Rep EndpointDescription x Source # to :: Rep EndpointDescription x -> EndpointDescription Source #
FromJSON EndpointDescription Source #
Instance details Defined in Wallet.Types Methods parseJSON :: Value -> Parser EndpointDescription parseJSONList :: Value -> Parser [EndpointDescription]
ToJSON EndpointDescription Source #
Instance details Defined in Wallet.Types Methods toJSON :: EndpointDescription -> Value toEncoding :: EndpointDescription -> Encoding toJSONList :: [EndpointDescription] -> Value toEncodingList :: [EndpointDescription] -> Encoding
Pretty EndpointDescription Source #
Instance details Defined in Wallet.Types Methods pretty :: EndpointDescription -> Doc ann prettyList :: [EndpointDescription] -> Doc ann
Lift EndpointDescription Source #
Instance details Defined in Wallet.Types Methods lift :: EndpointDescription -> Q Exp Source # liftTyped :: EndpointDescription -> Q (TExp EndpointDescription) Source #
type Rep EndpointDescription Source #
Instance details Defined in Wallet.Types type Rep EndpointDescription = D1 ('MetaData "EndpointDescription" "Wallet.Types" "plutus-contract-1.2.0.0-FH8LC9wh7UV4Nmv68NHXrC" 'True) (C1 ('MetaCons "EndpointDescription" 'PrefixI 'True) (S1 ('MetaSel ('Just "getEndpointDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 String)))

newtype EndpointValue a Source #

Constructors

EndpointValue
Fields unEndpointValue :: a

Instances

Instances details

Eq a => Eq (EndpointValue a) Source #
Instance details Defined in Wallet.Types Methods (==) :: EndpointValue a -> EndpointValue a -> Bool Source # (/=) :: EndpointValue a -> EndpointValue a -> Bool Source #
Ord a => Ord (EndpointValue a) Source #
Instance details Defined in Wallet.Types Methods compare :: EndpointValue a -> EndpointValue a -> Ordering Source # (<) :: EndpointValue a -> EndpointValue a -> Bool Source # (<=) :: EndpointValue a -> EndpointValue a -> Bool Source # (>) :: EndpointValue a -> EndpointValue a -> Bool Source # (>=) :: EndpointValue a -> EndpointValue a -> Bool Source # max :: EndpointValue a -> EndpointValue a -> EndpointValue a Source # min :: EndpointValue a -> EndpointValue a -> EndpointValue a Source #
Show a => Show (EndpointValue a) Source #
Instance details Defined in Wallet.Types Methods showsPrec :: Int -> EndpointValue a -> ShowS Source # show :: EndpointValue a -> String Source # showList :: [EndpointValue a] -> ShowS Source #
Generic (EndpointValue a) Source #
Instance details Defined in Wallet.Types Associated Types type Rep (EndpointValue a) :: Type -> Type Source # Methods from :: EndpointValue a -> Rep (EndpointValue a) x Source # to :: Rep (EndpointValue a) x -> EndpointValue a Source #
FromJSON a => FromJSON (EndpointValue a) Source #
Instance details Defined in Wallet.Types Methods parseJSON :: Value -> Parser (EndpointValue a) parseJSONList :: Value -> Parser [EndpointValue a]
ToJSON a => ToJSON (EndpointValue a) Source #
Instance details Defined in Wallet.Types Methods toJSON :: EndpointValue a -> Value toEncoding :: EndpointValue a -> Encoding toJSONList :: [EndpointValue a] -> Value toEncodingList :: [EndpointValue a] -> Encoding
Show a => Pretty (EndpointValue a) Source #
Instance details Defined in Wallet.Types Methods pretty :: EndpointValue a -> Doc ann prettyList :: [EndpointValue a] -> Doc ann
type Rep (EndpointValue a) Source #
Instance details Defined in Wallet.Types type Rep (EndpointValue a) = D1 ('MetaData "EndpointValue" "Wallet.Types" "plutus-contract-1.2.0.0-FH8LC9wh7UV4Nmv68NHXrC" 'True) (C1 ('MetaCons "EndpointValue" 'PrefixI 'True) (S1 ('MetaSel ('Just "unEndpointValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 a)))