plutus-pab-0.1.0.0
Safe HaskellNone
LanguageHaskell2010

Plutus.PAB.Webserver.Types

Synopsis

Documentation

data ContractReport t Source #

Instances

Instances details
Eq t => Eq (ContractReport t) Source # 
Instance details

Defined in Plutus.PAB.Webserver.Types

Show t => Show (ContractReport t) Source # 
Instance details

Defined in Plutus.PAB.Webserver.Types

Generic (ContractReport t) Source # 
Instance details

Defined in Plutus.PAB.Webserver.Types

Associated Types

type Rep (ContractReport t) :: Type -> Type Source #

ToJSON t => ToJSON (ContractReport t) Source # 
Instance details

Defined in Plutus.PAB.Webserver.Types

FromJSON t => FromJSON (ContractReport t) Source # 
Instance details

Defined in Plutus.PAB.Webserver.Types

ToSchema t => ToSchema (ContractReport t) Source # 
Instance details

Defined in Plutus.PAB.Webserver.Types

type Rep (ContractReport t) Source # 
Instance details

Defined in Plutus.PAB.Webserver.Types

type Rep (ContractReport t) = D1 ('MetaData "ContractReport" "Plutus.PAB.Webserver.Types" "plutus-pab-0.1.0.0-1vc1rt5g5zvBlHvXKfwLQ7" 'False) (C1 ('MetaCons "ContractReport" 'PrefixI 'True) (S1 ('MetaSel ('Just "crAvailableContracts") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [ContractSignatureResponse t]) :*: S1 ('MetaSel ('Just "crActiveContractStates") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [(ContractInstanceId, PartiallyDecodedResponse PABReq)])))

data ChainReport Source #

Instances

Instances details
Eq ChainReport Source # 
Instance details

Defined in Plutus.PAB.Webserver.Types

Show ChainReport Source # 
Instance details

Defined in Plutus.PAB.Webserver.Types

Generic ChainReport Source # 
Instance details

Defined in Plutus.PAB.Webserver.Types

Associated Types

type Rep ChainReport :: Type -> Type Source #

ToJSON ChainReport Source # 
Instance details

Defined in Plutus.PAB.Webserver.Types

FromJSON ChainReport Source # 
Instance details

Defined in Plutus.PAB.Webserver.Types

ToSchema ChainReport Source # 
Instance details

Defined in Plutus.PAB.Webserver.Types

type Rep ChainReport Source # 
Instance details

Defined in Plutus.PAB.Webserver.Types

type Rep ChainReport = D1 ('MetaData "ChainReport" "Plutus.PAB.Webserver.Types" "plutus-pab-0.1.0.0-1vc1rt5g5zvBlHvXKfwLQ7" 'False) (C1 ('MetaCons "ChainReport" 'PrefixI 'True) (S1 ('MetaSel ('Just "transactionMap") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Map TxId Tx)) :*: (S1 ('MetaSel ('Just "utxoIndex") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 UtxoIndex) :*: S1 ('MetaSel ('Just "annotatedBlockchain") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [[AnnotatedTx]]))))

data FullReport t Source #

Instances

Instances details
Eq t => Eq (FullReport t) Source # 
Instance details

Defined in Plutus.PAB.Webserver.Types

Show t => Show (FullReport t) Source # 
Instance details

Defined in Plutus.PAB.Webserver.Types

Generic (FullReport t) Source # 
Instance details

Defined in Plutus.PAB.Webserver.Types

Associated Types

type Rep (FullReport t) :: Type -> Type Source #

Methods

from :: FullReport t -> Rep (FullReport t) x Source #

to :: Rep (FullReport t) x -> FullReport t Source #

ToJSON t => ToJSON (FullReport t) Source # 
Instance details

Defined in Plutus.PAB.Webserver.Types

FromJSON t => FromJSON (FullReport t) Source # 
Instance details

Defined in Plutus.PAB.Webserver.Types

ToSchema t => ToSchema (FullReport t) Source # 
Instance details

Defined in Plutus.PAB.Webserver.Types

type Rep (FullReport t) Source # 
Instance details

Defined in Plutus.PAB.Webserver.Types

type Rep (FullReport t) = D1 ('MetaData "FullReport" "Plutus.PAB.Webserver.Types" "plutus-pab-0.1.0.0-1vc1rt5g5zvBlHvXKfwLQ7" 'False) (C1 ('MetaCons "FullReport" 'PrefixI 'True) (S1 ('MetaSel ('Just "contractReport") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (ContractReport t)) :*: S1 ('MetaSel ('Just "chainReport") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ChainReport)))

data ContractSignatureResponse t Source #

Instances

Instances details
Eq t => Eq (ContractSignatureResponse t) Source # 
Instance details

Defined in Plutus.PAB.Webserver.Types

Show t => Show (ContractSignatureResponse t) Source # 
Instance details

Defined in Plutus.PAB.Webserver.Types

Generic (ContractSignatureResponse t) Source # 
Instance details

Defined in Plutus.PAB.Webserver.Types

Associated Types

type Rep (ContractSignatureResponse t) :: Type -> Type Source #

ToJSON t => ToJSON (ContractSignatureResponse t) Source # 
Instance details

Defined in Plutus.PAB.Webserver.Types

FromJSON t => FromJSON (ContractSignatureResponse t) Source # 
Instance details

Defined in Plutus.PAB.Webserver.Types

ToSchema t => ToSchema (ContractSignatureResponse t) Source # 
Instance details

Defined in Plutus.PAB.Webserver.Types

type Rep (ContractSignatureResponse t) Source # 
Instance details

Defined in Plutus.PAB.Webserver.Types

type Rep (ContractSignatureResponse t) = D1 ('MetaData "ContractSignatureResponse" "Plutus.PAB.Webserver.Types" "plutus-pab-0.1.0.0-1vc1rt5g5zvBlHvXKfwLQ7" 'False) (C1 ('MetaCons "ContractSignatureResponse" 'PrefixI 'True) (S1 ('MetaSel ('Just "csrDefinition") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 t) :*: S1 ('MetaSel ('Just "csrSchemas") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [FunctionSchema FormSchema])))

data ContractActivationArgs t Source #

Data needed to start a new instance of a contract.

Constructors

ContractActivationArgs 

Fields

  • caID :: t

    ID of the contract

  • caWallet :: Maybe Wallet

    Wallet that should be used for this instance, `knownWallet 1` is used in the Nothing case.

Instances

Instances details
Eq t => Eq (ContractActivationArgs t) Source # 
Instance details

Defined in Plutus.PAB.Webserver.Types

Show t => Show (ContractActivationArgs t) Source # 
Instance details

Defined in Plutus.PAB.Webserver.Types

Generic (ContractActivationArgs t) Source # 
Instance details

Defined in Plutus.PAB.Webserver.Types

Associated Types

type Rep (ContractActivationArgs t) :: Type -> Type Source #

ToJSON t => ToJSON (ContractActivationArgs t) Source # 
Instance details

Defined in Plutus.PAB.Webserver.Types

FromJSON t => FromJSON (ContractActivationArgs t) Source # 
Instance details

Defined in Plutus.PAB.Webserver.Types

ToSchema t => ToSchema (ContractActivationArgs t) Source # 
Instance details

Defined in Plutus.PAB.Webserver.Types

Pretty t => Pretty (ContractActivationArgs t) Source # 
Instance details

Defined in Plutus.PAB.Webserver.Types

type Rep (ContractActivationArgs t) Source # 
Instance details

Defined in Plutus.PAB.Webserver.Types

type Rep (ContractActivationArgs t) = D1 ('MetaData "ContractActivationArgs" "Plutus.PAB.Webserver.Types" "plutus-pab-0.1.0.0-1vc1rt5g5zvBlHvXKfwLQ7" 'False) (C1 ('MetaCons "ContractActivationArgs" 'PrefixI 'True) (S1 ('MetaSel ('Just "caID") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 t) :*: S1 ('MetaSel ('Just "caWallet") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Wallet))))

data ContractInstanceClientState t Source #

Current state of a contract instance (to be sent to external clients)

Instances

Instances details
Eq t => Eq (ContractInstanceClientState t) Source # 
Instance details

Defined in Plutus.PAB.Webserver.Types

Show t => Show (ContractInstanceClientState t) Source # 
Instance details

Defined in Plutus.PAB.Webserver.Types

Generic (ContractInstanceClientState t) Source # 
Instance details

Defined in Plutus.PAB.Webserver.Types

Associated Types

type Rep (ContractInstanceClientState t) :: Type -> Type Source #

ToJSON t => ToJSON (ContractInstanceClientState t) Source # 
Instance details

Defined in Plutus.PAB.Webserver.Types

FromJSON t => FromJSON (ContractInstanceClientState t) Source # 
Instance details

Defined in Plutus.PAB.Webserver.Types

ToSchema t => ToSchema (ContractInstanceClientState t) Source # 
Instance details

Defined in Plutus.PAB.Webserver.Types

type Rep (ContractInstanceClientState t) Source # 
Instance details

Defined in Plutus.PAB.Webserver.Types

type Rep (ContractInstanceClientState t) = D1 ('MetaData "ContractInstanceClientState" "Plutus.PAB.Webserver.Types" "plutus-pab-0.1.0.0-1vc1rt5g5zvBlHvXKfwLQ7" 'False) (C1 ('MetaCons "ContractInstanceClientState" 'PrefixI 'True) ((S1 ('MetaSel ('Just "cicContract") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ContractInstanceId) :*: (S1 ('MetaSel ('Just "cicCurrentState") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (PartiallyDecodedResponse ActiveEndpoint)) :*: S1 ('MetaSel ('Just "cicWallet") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Wallet))) :*: (S1 ('MetaSel ('Just "cicDefinition") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 t) :*: (S1 ('MetaSel ('Just "cicStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ContractActivityStatus) :*: S1 ('MetaSel ('Just "cicYieldedExportTxs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [ExportTx])))))

data InstanceStatusToClient Source #

Status updates for contract instances streamed to client

Constructors

NewObservableState Value

The observable state of the contract has changed.

NewActiveEndpoints [ActiveEndpoint]

The set of active endpoints has changed.

NewYieldedExportTxs [ExportTx]

Partial txs that need to be balanced, signed and submitted by an external client.

ContractFinished (Maybe Value)

Contract instance is done with an optional error message.

Instances

Instances details
Eq InstanceStatusToClient Source # 
Instance details

Defined in Plutus.PAB.Webserver.Types

Show InstanceStatusToClient Source # 
Instance details

Defined in Plutus.PAB.Webserver.Types

Generic InstanceStatusToClient Source # 
Instance details

Defined in Plutus.PAB.Webserver.Types

Associated Types

type Rep InstanceStatusToClient :: Type -> Type Source #

ToJSON InstanceStatusToClient Source # 
Instance details

Defined in Plutus.PAB.Webserver.Types

FromJSON InstanceStatusToClient Source # 
Instance details

Defined in Plutus.PAB.Webserver.Types

type Rep InstanceStatusToClient Source # 
Instance details

Defined in Plutus.PAB.Webserver.Types

type Rep InstanceStatusToClient = D1 ('MetaData "InstanceStatusToClient" "Plutus.PAB.Webserver.Types" "plutus-pab-0.1.0.0-1vc1rt5g5zvBlHvXKfwLQ7" 'False) ((C1 ('MetaCons "NewObservableState" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Value)) :+: C1 ('MetaCons "NewActiveEndpoints" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [ActiveEndpoint]))) :+: (C1 ('MetaCons "NewYieldedExportTxs" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [ExportTx])) :+: C1 ('MetaCons "ContractFinished" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Value)))))

data CombinedWSStreamToClient Source #

Data sent to the client through the combined websocket API

Instances

Instances details
Eq CombinedWSStreamToClient Source # 
Instance details

Defined in Plutus.PAB.Webserver.Types

Show CombinedWSStreamToClient Source # 
Instance details

Defined in Plutus.PAB.Webserver.Types

Generic CombinedWSStreamToClient Source # 
Instance details

Defined in Plutus.PAB.Webserver.Types

Associated Types

type Rep CombinedWSStreamToClient :: Type -> Type Source #

ToJSON CombinedWSStreamToClient Source # 
Instance details

Defined in Plutus.PAB.Webserver.Types

FromJSON CombinedWSStreamToClient Source # 
Instance details

Defined in Plutus.PAB.Webserver.Types

type Rep CombinedWSStreamToClient Source # 
Instance details

Defined in Plutus.PAB.Webserver.Types

data CombinedWSStreamToServer Source #

Instructions sent to the server through the combined websocket API

Instances

Instances details
Eq CombinedWSStreamToServer Source # 
Instance details

Defined in Plutus.PAB.Webserver.Types

Show CombinedWSStreamToServer Source # 
Instance details

Defined in Plutus.PAB.Webserver.Types

Generic CombinedWSStreamToServer Source # 
Instance details

Defined in Plutus.PAB.Webserver.Types

Associated Types

type Rep CombinedWSStreamToServer :: Type -> Type Source #

ToJSON CombinedWSStreamToServer Source # 
Instance details

Defined in Plutus.PAB.Webserver.Types

FromJSON CombinedWSStreamToServer Source # 
Instance details

Defined in Plutus.PAB.Webserver.Types

type Rep CombinedWSStreamToServer Source # 
Instance details

Defined in Plutus.PAB.Webserver.Types

type Rep CombinedWSStreamToServer = D1 ('MetaData "CombinedWSStreamToServer" "Plutus.PAB.Webserver.Types" "plutus-pab-0.1.0.0-1vc1rt5g5zvBlHvXKfwLQ7" 'False) (C1 ('MetaCons "Subscribe" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Either ContractInstanceId PubKeyHash))) :+: C1 ('MetaCons "Unsubscribe" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Either ContractInstanceId PubKeyHash))))