| Safe Haskell | None | 
|---|---|
| Language | Haskell2010 | 
Plutus.PAB.Webserver.Types
Contents
Synopsis
- data ContractReport t = ContractReport {}
 - data ChainReport = ChainReport {
- transactionMap :: Map TxId CardanoTx
 - utxoIndex :: UtxoIndex
 - annotatedBlockchain :: [[AnnotatedTx]]
 
 - emptyChainReport :: ChainReport
 - data FullReport t = FullReport {}
 - newtype ContractSignatureResponse t = ContractSignatureResponse {
- csrDefinition :: t
 
 - data ContractActivationArgs t = ContractActivationArgs {}
 - data ContractInstanceClientState t = ContractInstanceClientState {
- cicContract :: ContractInstanceId
 - cicCurrentState :: PartiallyDecodedResponse ActiveEndpoint
 - cicWallet :: Wallet
 - cicDefinition :: t
 - cicStatus :: ContractActivityStatus
 - cicYieldedExportTxs :: [ExportTx]
 
 - data InstanceStatusToClient
- = NewObservableState Value
 - | NewActiveEndpoints [ActiveEndpoint]
 - | NewYieldedExportTxs [ExportTx]
 - | ContractFinished (Maybe Value)
 
 - data CombinedWSStreamToClient
 - data CombinedWSStreamToServer
- = Subscribe (Either ContractInstanceId PubKeyHash)
 - | Unsubscribe (Either ContractInstanceId PubKeyHash)
 
 
Documentation
data ContractReport t Source #
Constructors
| ContractReport | |
Fields  | |
Instances
data ChainReport Source #
Constructors
| ChainReport | |
Fields 
  | |
Instances
data FullReport t Source #
Constructors
| FullReport | |
Fields  | |
Instances
newtype ContractSignatureResponse t Source #
Constructors
| ContractSignatureResponse | |
Fields 
  | |
Instances
data ContractActivationArgs t Source #
Data needed to start a new instance of a contract.
Constructors
| ContractActivationArgs | |
Instances
data ContractInstanceClientState t Source #
Current state of a contract instance (to be sent to external clients)
Constructors
| ContractInstanceClientState | |
Fields 
  | |
Instances
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
data CombinedWSStreamToClient Source #
Data sent to the client through the combined websocket API
Constructors
| InstanceUpdate ContractInstanceId InstanceStatusToClient | |
| SlotChange Slot | New slot number  | 
Instances
data CombinedWSStreamToServer Source #
Instructions sent to the server through the combined websocket API
Constructors
| Subscribe (Either ContractInstanceId PubKeyHash) | |
| Unsubscribe (Either ContractInstanceId PubKeyHash) | 
Instances
Orphan instances
| ToSchema UtxoIndex Source # | |
Methods declareNamedSchema :: Proxy UtxoIndex -> Declare (Definitions Schema) NamedSchema  | |
| ToSchema TxId Source # | |
Methods declareNamedSchema :: Proxy TxId -> Declare (Definitions Schema) NamedSchema  | |
| ToSchema TxIn Source # | |
Methods declareNamedSchema :: Proxy TxIn -> Declare (Definitions Schema) NamedSchema  | |
| ToSchema TxIx Source # | |
Methods declareNamedSchema :: Proxy TxIx -> Declare (Definitions Schema) NamedSchema  | |
| ToSchema AssetName Source # | |
Methods declareNamedSchema :: Proxy AssetName -> Declare (Definitions Schema) NamedSchema  | |
| ToSchema Lovelace Source # | |
Methods declareNamedSchema :: Proxy Lovelace -> Declare (Definitions Schema) NamedSchema  | |
| ToSchema PolicyId Source # | |
Methods declareNamedSchema :: Proxy PolicyId -> Declare (Definitions Schema) NamedSchema  | |
| ToSchema PaymentPubKeyHash Source # | |
Methods declareNamedSchema :: Proxy PaymentPubKeyHash -> Declare (Definitions Schema) NamedSchema  | |
| ToSchema PubKey Source # | |
Methods declareNamedSchema :: Proxy PubKey -> Declare (Definitions Schema) NamedSchema  | |
| ToSchema Signature Source # | |
Methods declareNamedSchema :: Proxy Signature -> Declare (Definitions Schema) NamedSchema  | |
| ToSchema Certificate Source # | |
Methods declareNamedSchema :: Proxy Certificate -> Declare (Definitions Schema) NamedSchema  | |
| ToSchema TxOut Source # | |
Methods declareNamedSchema :: Proxy TxOut -> Declare (Definitions Schema) NamedSchema  | |
| ToSchema Withdrawal Source # | |
Methods declareNamedSchema :: Proxy Withdrawal -> Declare (Definitions Schema) NamedSchema  | |
| ToSchema DCert Source # | |
Methods declareNamedSchema :: Proxy DCert -> Declare (Definitions Schema) NamedSchema  | |
| ToSchema POSIXTime Source # | |
Methods declareNamedSchema :: Proxy POSIXTime -> Declare (Definitions Schema) NamedSchema  | |
| ToSchema Quantity Source # | |
Methods declareNamedSchema :: Proxy Quantity -> Declare (Definitions Schema) NamedSchema  | |
| ToSchema CardanoBuildTx Source # | |
Methods declareNamedSchema :: Proxy CardanoBuildTx -> Declare (Definitions Schema) NamedSchema  | |
| ToSchema ScriptHash Source # | |
Methods declareNamedSchema :: Proxy ScriptHash -> Declare (Definitions Schema) NamedSchema  | |
| ToSchema LedgerBytes Source # | |
Methods declareNamedSchema :: Proxy LedgerBytes -> Declare (Definitions Schema) NamedSchema  | |
| ToSchema UnbalancedTx Source # | |
Methods declareNamedSchema :: Proxy UnbalancedTx -> Declare (Definitions Schema) NamedSchema  | |
| ToSchema ExportTxInput Source # | |
Methods declareNamedSchema :: Proxy ExportTxInput -> Declare (Definitions Schema) NamedSchema  | |
| ToSchema ExportTx Source # | |
Methods declareNamedSchema :: Proxy ExportTx -> Declare (Definitions Schema) NamedSchema  | |
| ToSchema ExportTxRedeemer Source # | |
Methods declareNamedSchema :: Proxy ExportTxRedeemer -> Declare (Definitions Schema) NamedSchema  | |
| ToSchema ActiveEndpoint Source # | |
Methods declareNamedSchema :: Proxy ActiveEndpoint -> Declare (Definitions Schema) NamedSchema  | |
| ToSchema ChainIndexQuery Source # | |
Methods declareNamedSchema :: Proxy ChainIndexQuery -> Declare (Definitions Schema) NamedSchema  | |
| ToSchema PABReq Source # | |
Methods declareNamedSchema :: Proxy PABReq -> Declare (Definitions Schema) NamedSchema  | |
| ToSchema EndpointDescription Source # | |
Methods declareNamedSchema :: Proxy EndpointDescription -> Declare (Definitions Schema) NamedSchema  | |
| ToSchema ContractInstanceId Source # | |
Methods declareNamedSchema :: Proxy ContractInstanceId -> Declare (Definitions Schema) NamedSchema  | |
| ToSchema ContractActivityStatus Source # | |
Methods declareNamedSchema :: Proxy ContractActivityStatus -> Declare (Definitions Schema) NamedSchema  | |
| ToSchema Wallet Source # | |
Methods declareNamedSchema :: Proxy Wallet -> Declare (Definitions Schema) NamedSchema  | |
| ToSchema WalletId Source # | |
Methods declareNamedSchema :: Proxy WalletId -> Declare (Definitions Schema) NamedSchema  | |
| ToSchema WalletId Source # | |
Methods declareNamedSchema :: Proxy WalletId -> Declare (Definitions Schema) NamedSchema  | |
| ToSchema AnnotatedTx Source # | |
Methods declareNamedSchema :: Proxy AnnotatedTx -> Declare (Definitions Schema) NamedSchema  | |
| ToSchema BeneficialOwner Source # | |
Methods declareNamedSchema :: Proxy BeneficialOwner -> Declare (Definitions Schema) NamedSchema  | |
| ToSchema DereferencedInput Source # | |
Methods declareNamedSchema :: Proxy DereferencedInput -> Declare (Definitions Schema) NamedSchema  | |
| ToSchema SequenceId Source # | |
Methods declareNamedSchema :: Proxy SequenceId -> Declare (Definitions Schema) NamedSchema  | |
| ToSchema (Hash ScriptData) Source # | |
Methods declareNamedSchema :: Proxy (Hash ScriptData) -> Declare (Definitions Schema) NamedSchema  | |
| ToSchema (Digest Blake2b_160) Source # | |
Methods declareNamedSchema :: Proxy (Digest Blake2b_160) -> Declare (Definitions Schema) NamedSchema  | |
| ToSchema (Hash Blake2b_256 EraIndependentTxBody) Source # | |
Methods declareNamedSchema :: Proxy (Hash Blake2b_256 EraIndependentTxBody) -> Declare (Definitions Schema) NamedSchema  | |