Safe Haskell	None
Language	GHC2021

Hydra.API.HTTPServer

Contents

Handlers

Synopsis

newtype DraftCommitTxResponse tx = DraftCommitTxResponse {
- commitTx :: tx
}
data DraftCommitTxRequest tx
- = SimpleCommitRequest {
  - utxoToCommit :: UTxOType tx
  }
- | FullCommitRequest {
  - blueprintTx :: tx
  - utxo :: UTxOType tx
  }
newtype SubmitTxRequest tx = SubmitTxRequest {
- txToSubmit :: tx
}
data TransactionSubmitted = TransactionSubmitted
newtype SideLoadSnapshotRequest tx = SideLoadSnapshotRequest {
- snapshot :: ConfirmedSnapshot tx
}
newtype SubmitL2TxRequest tx = SubmitL2TxRequest {
- submitL2Tx :: tx
}
data SubmitL2TxResponse
jsonContent :: ResponseHeaders
httpApp :: forall tx. IsChainState tx => Tracer IO APIServerLog -> Chain tx IO -> Environment -> PParams LedgerEra -> IO (HeadState tx) -> IO CommitInfo -> IO [TxIdType tx] -> (ClientInput tx -> IO ()) -> ApiTransactionTimeout -> TChan (Either (TimedServerOutput tx) (ClientMessage tx)) -> Application
handleDraftCommitUtxo :: forall tx. IsChainState tx => Environment -> PParams LedgerEra -> Chain tx IO -> IO CommitInfo -> ByteString -> IO Response
handleRecoverCommitUtxo :: forall tx. IsChainState tx => (ClientInput tx -> IO ()) -> Text -> ByteString -> IO Response
handleSubmitUserTx :: forall tx. FromJSON tx => Chain tx IO -> ByteString -> IO Response
handleDecommit :: forall tx. FromJSON tx => (ClientInput tx -> IO ()) -> ByteString -> IO Response
handleSideLoadSnapshot :: forall tx. IsChainState tx => (ClientInput tx -> IO ()) -> ByteString -> IO Response
handleSubmitL2Tx :: forall tx. IsChainState tx => (ClientInput tx -> IO ()) -> ApiTransactionTimeout -> TChan (Either (TimedServerOutput tx) (ClientMessage tx)) -> ByteString -> IO Response
badRequest :: IsChainState tx => PostTxError tx -> Response
notFound :: Response
okJSON :: ToJSON a => a -> Response

Documentation

newtype DraftCommitTxResponse tx Source #

Constructors

DraftCommitTxResponse
Fields commitTx :: tx

Instances

Instances details

Arbitrary tx => Arbitrary (DraftCommitTxResponse tx) Source #
Instance details Defined in Hydra.API.HTTPServer Methods arbitrary :: Gen (DraftCommitTxResponse tx) shrink :: DraftCommitTxResponse tx -> [DraftCommitTxResponse tx]
IsTx tx => FromJSON (DraftCommitTxResponse tx) Source #
Instance details Defined in Hydra.API.HTTPServer Methods parseJSON :: Value -> Parser (DraftCommitTxResponse tx) parseJSONList :: Value -> Parser [DraftCommitTxResponse tx] omittedField :: Maybe (DraftCommitTxResponse tx)
IsTx tx => ToJSON (DraftCommitTxResponse tx) Source #
Instance details Defined in Hydra.API.HTTPServer Methods toJSON :: DraftCommitTxResponse tx -> Value toEncoding :: DraftCommitTxResponse tx -> Encoding toJSONList :: [DraftCommitTxResponse tx] -> Value toEncodingList :: [DraftCommitTxResponse tx] -> Encoding omitField :: DraftCommitTxResponse tx -> Bool
Generic (DraftCommitTxResponse tx) Source #
Instance details Defined in Hydra.API.HTTPServer Associated Types type Rep (DraftCommitTxResponse tx) :: Type -> Type Source # Methods from :: DraftCommitTxResponse tx -> Rep (DraftCommitTxResponse tx) x Source # to :: Rep (DraftCommitTxResponse tx) x -> DraftCommitTxResponse tx Source #
Show tx => Show (DraftCommitTxResponse tx) Source #
Instance details Defined in Hydra.API.HTTPServer Methods showsPrec :: Int -> DraftCommitTxResponse tx -> ShowS Source # show :: DraftCommitTxResponse tx -> String Source # showList :: [DraftCommitTxResponse tx] -> ShowS Source #
type Rep (DraftCommitTxResponse tx) Source #
Instance details Defined in Hydra.API.HTTPServer type Rep (DraftCommitTxResponse tx) = D1 ('MetaData "DraftCommitTxResponse" "Hydra.API.HTTPServer" "hydra-node-0.22.2-8OGyeIUSe0Q4Djdh0bRuph" 'True) (C1 ('MetaCons "DraftCommitTxResponse" 'PrefixI 'True) (S1 ('MetaSel ('Just "commitTx") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 tx)))

data DraftCommitTxRequest tx Source #

Constructors

SimpleCommitRequest
Fields utxoToCommit :: UTxOType tx
FullCommitRequest
Fields blueprintTx :: tx utxo :: UTxOType tx

Instances

Instances details

(Arbitrary tx, Arbitrary (UTxOType tx)) => Arbitrary (DraftCommitTxRequest tx) Source #
Instance details Defined in Hydra.API.HTTPServer Methods arbitrary :: Gen (DraftCommitTxRequest tx) shrink :: DraftCommitTxRequest tx -> [DraftCommitTxRequest tx]
(FromJSON tx, FromJSON (UTxOType tx)) => FromJSON (DraftCommitTxRequest tx) Source #
Instance details Defined in Hydra.API.HTTPServer Methods parseJSON :: Value -> Parser (DraftCommitTxRequest tx) parseJSONList :: Value -> Parser [DraftCommitTxRequest tx] omittedField :: Maybe (DraftCommitTxRequest tx)
(ToJSON tx, ToJSON (UTxOType tx)) => ToJSON (DraftCommitTxRequest tx) Source #
Instance details Defined in Hydra.API.HTTPServer Methods toJSON :: DraftCommitTxRequest tx -> Value toEncoding :: DraftCommitTxRequest tx -> Encoding toJSONList :: [DraftCommitTxRequest tx] -> Value toEncodingList :: [DraftCommitTxRequest tx] -> Encoding omitField :: DraftCommitTxRequest tx -> Bool
Generic (DraftCommitTxRequest tx) Source #
Instance details Defined in Hydra.API.HTTPServer Associated Types type Rep (DraftCommitTxRequest tx) :: Type -> Type Source # Methods from :: DraftCommitTxRequest tx -> Rep (DraftCommitTxRequest tx) x Source # to :: Rep (DraftCommitTxRequest tx) x -> DraftCommitTxRequest tx Source #
(Show tx, Show (UTxOType tx)) => Show (DraftCommitTxRequest tx) Source #
Instance details Defined in Hydra.API.HTTPServer Methods showsPrec :: Int -> DraftCommitTxRequest tx -> ShowS Source # show :: DraftCommitTxRequest tx -> String Source # showList :: [DraftCommitTxRequest tx] -> ShowS Source #
(Eq tx, Eq (UTxOType tx)) => Eq (DraftCommitTxRequest tx) Source #
Instance details Defined in Hydra.API.HTTPServer Methods (==) :: DraftCommitTxRequest tx -> DraftCommitTxRequest tx -> Bool Source # (/=) :: DraftCommitTxRequest tx -> DraftCommitTxRequest tx -> Bool Source #
type Rep (DraftCommitTxRequest tx) Source #
Instance details Defined in Hydra.API.HTTPServer type Rep (DraftCommitTxRequest tx) = D1 ('MetaData "DraftCommitTxRequest" "Hydra.API.HTTPServer" "hydra-node-0.22.2-8OGyeIUSe0Q4Djdh0bRuph" 'False) (C1 ('MetaCons "SimpleCommitRequest" 'PrefixI 'True) (S1 ('MetaSel ('Just "utxoToCommit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (UTxOType tx))) :+: C1 ('MetaCons "FullCommitRequest" 'PrefixI 'True) (S1 ('MetaSel ('Just "blueprintTx") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 tx) :*: S1 ('MetaSel ('Just "utxo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (UTxOType tx))))

newtype SubmitTxRequest tx Source #

Constructors

SubmitTxRequest
Fields txToSubmit :: tx

Instances

Instances details

Arbitrary tx => Arbitrary (SubmitTxRequest tx) Source #
Instance details Defined in Hydra.API.HTTPServer Methods arbitrary :: Gen (SubmitTxRequest tx) shrink :: SubmitTxRequest tx -> [SubmitTxRequest tx]
FromJSON tx => FromJSON (SubmitTxRequest tx) Source #
Instance details Defined in Hydra.API.HTTPServer Methods parseJSON :: Value -> Parser (SubmitTxRequest tx) parseJSONList :: Value -> Parser [SubmitTxRequest tx] omittedField :: Maybe (SubmitTxRequest tx)
ToJSON tx => ToJSON (SubmitTxRequest tx) Source #
Instance details Defined in Hydra.API.HTTPServer Methods toJSON :: SubmitTxRequest tx -> Value toEncoding :: SubmitTxRequest tx -> Encoding toJSONList :: [SubmitTxRequest tx] -> Value toEncodingList :: [SubmitTxRequest tx] -> Encoding omitField :: SubmitTxRequest tx -> Bool
Show tx => Show (SubmitTxRequest tx) Source #
Instance details Defined in Hydra.API.HTTPServer Methods showsPrec :: Int -> SubmitTxRequest tx -> ShowS Source # show :: SubmitTxRequest tx -> String Source # showList :: [SubmitTxRequest tx] -> ShowS Source #
Eq tx => Eq (SubmitTxRequest tx) Source #
Instance details Defined in Hydra.API.HTTPServer Methods (==) :: SubmitTxRequest tx -> SubmitTxRequest tx -> Bool Source # (/=) :: SubmitTxRequest tx -> SubmitTxRequest tx -> Bool Source #

data TransactionSubmitted Source #

Constructors

TransactionSubmitted

Instances

Instances details

Arbitrary TransactionSubmitted Source #
Instance details Defined in Hydra.API.HTTPServer Methods arbitrary :: Gen TransactionSubmitted shrink :: TransactionSubmitted -> [TransactionSubmitted]
FromJSON TransactionSubmitted Source #
Instance details Defined in Hydra.API.HTTPServer Methods parseJSON :: Value -> Parser TransactionSubmitted parseJSONList :: Value -> Parser [TransactionSubmitted] omittedField :: Maybe TransactionSubmitted
ToJSON TransactionSubmitted Source #
Instance details Defined in Hydra.API.HTTPServer Methods toJSON :: TransactionSubmitted -> Value toEncoding :: TransactionSubmitted -> Encoding toJSONList :: [TransactionSubmitted] -> Value toEncodingList :: [TransactionSubmitted] -> Encoding omitField :: TransactionSubmitted -> Bool
Generic TransactionSubmitted Source #
Instance details Defined in Hydra.API.HTTPServer Associated Types type Rep TransactionSubmitted :: Type -> Type Source # Methods from :: TransactionSubmitted -> Rep TransactionSubmitted x Source # to :: Rep TransactionSubmitted x -> TransactionSubmitted Source #
Show TransactionSubmitted Source #
Instance details Defined in Hydra.API.HTTPServer Methods showsPrec :: Int -> TransactionSubmitted -> ShowS Source # show :: TransactionSubmitted -> String Source # showList :: [TransactionSubmitted] -> ShowS Source #
Eq TransactionSubmitted Source #
Instance details Defined in Hydra.API.HTTPServer Methods (==) :: TransactionSubmitted -> TransactionSubmitted -> Bool Source # (/=) :: TransactionSubmitted -> TransactionSubmitted -> Bool Source #
type Rep TransactionSubmitted Source #
Instance details Defined in Hydra.API.HTTPServer type Rep TransactionSubmitted = D1 ('MetaData "TransactionSubmitted" "Hydra.API.HTTPServer" "hydra-node-0.22.2-8OGyeIUSe0Q4Djdh0bRuph" 'False) (C1 ('MetaCons "TransactionSubmitted" 'PrefixI 'False) (U1 :: Type -> Type))

newtype SideLoadSnapshotRequest tx Source #

Constructors

SideLoadSnapshotRequest
Fields snapshot :: ConfirmedSnapshot tx

Instances

Instances details

(Arbitrary tx, Arbitrary (UTxOType tx), IsTx tx) => Arbitrary (SideLoadSnapshotRequest tx) Source #
Instance details Defined in Hydra.API.HTTPServer Methods arbitrary :: Gen (SideLoadSnapshotRequest tx) shrink :: SideLoadSnapshotRequest tx -> [SideLoadSnapshotRequest tx]
IsTx tx => FromJSON (SideLoadSnapshotRequest tx) Source #
Instance details Defined in Hydra.API.HTTPServer Methods parseJSON :: Value -> Parser (SideLoadSnapshotRequest tx) parseJSONList :: Value -> Parser [SideLoadSnapshotRequest tx] omittedField :: Maybe (SideLoadSnapshotRequest tx)
IsTx tx => ToJSON (SideLoadSnapshotRequest tx) Source #
Instance details Defined in Hydra.API.HTTPServer Methods toJSON :: SideLoadSnapshotRequest tx -> Value toEncoding :: SideLoadSnapshotRequest tx -> Encoding toJSONList :: [SideLoadSnapshotRequest tx] -> Value toEncodingList :: [SideLoadSnapshotRequest tx] -> Encoding omitField :: SideLoadSnapshotRequest tx -> Bool
Generic (SideLoadSnapshotRequest tx) Source #
Instance details Defined in Hydra.API.HTTPServer Associated Types type Rep (SideLoadSnapshotRequest tx) :: Type -> Type Source # Methods from :: SideLoadSnapshotRequest tx -> Rep (SideLoadSnapshotRequest tx) x Source # to :: Rep (SideLoadSnapshotRequest tx) x -> SideLoadSnapshotRequest tx Source #
IsTx tx => Show (SideLoadSnapshotRequest tx) Source #
Instance details Defined in Hydra.API.HTTPServer Methods showsPrec :: Int -> SideLoadSnapshotRequest tx -> ShowS Source # show :: SideLoadSnapshotRequest tx -> String Source # showList :: [SideLoadSnapshotRequest tx] -> ShowS Source #
IsTx tx => Eq (SideLoadSnapshotRequest tx) Source #
Instance details Defined in Hydra.API.HTTPServer Methods (==) :: SideLoadSnapshotRequest tx -> SideLoadSnapshotRequest tx -> Bool Source # (/=) :: SideLoadSnapshotRequest tx -> SideLoadSnapshotRequest tx -> Bool Source #
type Rep (SideLoadSnapshotRequest tx) Source #
Instance details Defined in Hydra.API.HTTPServer type Rep (SideLoadSnapshotRequest tx) = Rep (ConfirmedSnapshot tx)

newtype SubmitL2TxRequest tx Source #

Request to submit a transaction to the head

Constructors

SubmitL2TxRequest
Fields submitL2Tx :: tx

Instances

Instances details

Arbitrary tx => Arbitrary (SubmitL2TxRequest tx) Source #
Instance details Defined in Hydra.API.HTTPServer Methods arbitrary :: Gen (SubmitL2TxRequest tx) shrink :: SubmitL2TxRequest tx -> [SubmitL2TxRequest tx]
FromJSON tx => FromJSON (SubmitL2TxRequest tx) Source #
Instance details Defined in Hydra.API.HTTPServer Methods parseJSON :: Value -> Parser (SubmitL2TxRequest tx) parseJSONList :: Value -> Parser [SubmitL2TxRequest tx] omittedField :: Maybe (SubmitL2TxRequest tx)
ToJSON tx => ToJSON (SubmitL2TxRequest tx) Source #
Instance details Defined in Hydra.API.HTTPServer Methods toJSON :: SubmitL2TxRequest tx -> Value toEncoding :: SubmitL2TxRequest tx -> Encoding toJSONList :: [SubmitL2TxRequest tx] -> Value toEncodingList :: [SubmitL2TxRequest tx] -> Encoding omitField :: SubmitL2TxRequest tx -> Bool
Show tx => Show (SubmitL2TxRequest tx) Source #
Instance details Defined in Hydra.API.HTTPServer Methods showsPrec :: Int -> SubmitL2TxRequest tx -> ShowS Source # show :: SubmitL2TxRequest tx -> String Source # showList :: [SubmitL2TxRequest tx] -> ShowS Source #
Eq tx => Eq (SubmitL2TxRequest tx) Source #
Instance details Defined in Hydra.API.HTTPServer Methods (==) :: SubmitL2TxRequest tx -> SubmitL2TxRequest tx -> Bool Source # (/=) :: SubmitL2TxRequest tx -> SubmitL2TxRequest tx -> Bool Source #

data SubmitL2TxResponse Source #

Response for transaction submission

Constructors

SubmitTxConfirmed Integer	Transaction was included in a confirmed snapshot
SubmitTxInvalidResponse Text	Transaction was rejected due to validation errors
SubmitTxSubmitted	Transaction was accepted but not yet confirmed

Instances

Instances details

Arbitrary SubmitL2TxResponse Source #
Instance details Defined in Hydra.API.HTTPServer Methods arbitrary :: Gen SubmitL2TxResponse shrink :: SubmitL2TxResponse -> [SubmitL2TxResponse]
FromJSON SubmitL2TxResponse Source #
Instance details Defined in Hydra.API.HTTPServer Methods parseJSON :: Value -> Parser SubmitL2TxResponse parseJSONList :: Value -> Parser [SubmitL2TxResponse] omittedField :: Maybe SubmitL2TxResponse
ToJSON SubmitL2TxResponse Source #
Instance details Defined in Hydra.API.HTTPServer Methods toJSON :: SubmitL2TxResponse -> Value toEncoding :: SubmitL2TxResponse -> Encoding toJSONList :: [SubmitL2TxResponse] -> Value toEncodingList :: [SubmitL2TxResponse] -> Encoding omitField :: SubmitL2TxResponse -> Bool
Generic SubmitL2TxResponse Source #
Instance details Defined in Hydra.API.HTTPServer Associated Types type Rep SubmitL2TxResponse :: Type -> Type Source # Methods from :: SubmitL2TxResponse -> Rep SubmitL2TxResponse x Source # to :: Rep SubmitL2TxResponse x -> SubmitL2TxResponse Source #
Show SubmitL2TxResponse Source #
Instance details Defined in Hydra.API.HTTPServer Methods showsPrec :: Int -> SubmitL2TxResponse -> ShowS Source # show :: SubmitL2TxResponse -> String Source # showList :: [SubmitL2TxResponse] -> ShowS Source #
Eq SubmitL2TxResponse Source #
Instance details Defined in Hydra.API.HTTPServer Methods (==) :: SubmitL2TxResponse -> SubmitL2TxResponse -> Bool Source # (/=) :: SubmitL2TxResponse -> SubmitL2TxResponse -> Bool Source #
type Rep SubmitL2TxResponse Source #
Instance details Defined in Hydra.API.HTTPServer type Rep SubmitL2TxResponse = D1 ('MetaData "SubmitL2TxResponse" "Hydra.API.HTTPServer" "hydra-node-0.22.2-8OGyeIUSe0Q4Djdh0bRuph" 'False) (C1 ('MetaCons "SubmitTxConfirmed" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Integer)) :+: (C1 ('MetaCons "SubmitTxInvalidResponse" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :+: C1 ('MetaCons "SubmitTxSubmitted" 'PrefixI 'False) (U1 :: Type -> Type)))

jsonContent :: ResponseHeaders Source #

httpApp Source #

Arguments

:: forall tx. IsChainState tx
=> Tracer IO APIServerLog
-> Chain tx IO
-> Environment
-> PParams LedgerEra
-> IO (HeadState tx)	Get latest `HeadState`.
-> IO CommitInfo	A means to get commit info.
-> IO [TxIdType tx]	Get the pending commits (deposits)
-> (ClientInput tx -> IO ())	Callback to yield a `ClientInput` to the main event loop.
-> ApiTransactionTimeout	Timeout for transaction submission
-> TChan (Either (TimedServerOutput tx) (ClientMessage tx))	Channel to listen for events
-> Application

Hydra HTTP server

Handlers

handleDraftCommitUtxo Source #

Arguments

:: forall tx. IsChainState tx
=> Environment
-> PParams LedgerEra
-> Chain tx IO
-> IO CommitInfo	A means to get commit info.
-> ByteString	Request body.
-> IO Response

Handle request to obtain a draft commit tx.

handleRecoverCommitUtxo :: forall tx. IsChainState tx => (ClientInput tx -> IO ()) -> Text -> ByteString -> IO Response Source #

Handle request to recover a pending deposit.

handleSubmitUserTx Source #

Arguments

:: forall tx. FromJSON tx
=> Chain tx IO
-> ByteString	Request body.
-> IO Response

Handle request to submit a cardano transaction.

handleDecommit :: forall tx. FromJSON tx => (ClientInput tx -> IO ()) -> ByteString -> IO Response Source #

handleSideLoadSnapshot :: forall tx. IsChainState tx => (ClientInput tx -> IO ()) -> ByteString -> IO Response Source #

Handle request to side load confirmed snapshot.

handleSubmitL2Tx :: forall tx. IsChainState tx => (ClientInput tx -> IO ()) -> ApiTransactionTimeout -> TChan (Either (TimedServerOutput tx) (ClientMessage tx)) -> ByteString -> IO Response Source #

Handle request to submit a transaction to the head.

badRequest :: IsChainState tx => PostTxError tx -> Response Source #

notFound :: Response Source #

okJSON :: ToJSON a => a -> Response Source #