hydra-node-0.16.0: The Hydra node
Safe HaskellSafe-Inferred
LanguageGHC2021

Hydra.API.HTTPServer

Contents

Synopsis

Documentation

newtype DraftCommitTxResponse Source #

Constructors

DraftCommitTxResponse 

Fields

Instances

Instances details
Arbitrary DraftCommitTxResponse Source # 
Instance details

Defined in Hydra.API.HTTPServer

Methods

arbitrary :: Gen DraftCommitTxResponse

shrink :: DraftCommitTxResponse -> [DraftCommitTxResponse]

FromJSON DraftCommitTxResponse Source # 
Instance details

Defined in Hydra.API.HTTPServer

Methods

parseJSON :: Value -> Parser DraftCommitTxResponse

parseJSONList :: Value -> Parser [DraftCommitTxResponse]

omittedField :: Maybe DraftCommitTxResponse

ToJSON DraftCommitTxResponse Source # 
Instance details

Defined in Hydra.API.HTTPServer

Methods

toJSON :: DraftCommitTxResponse -> Value

toEncoding :: DraftCommitTxResponse -> Encoding

toJSONList :: [DraftCommitTxResponse] -> Value

toEncodingList :: [DraftCommitTxResponse] -> Encoding

omitField :: DraftCommitTxResponse -> Bool

Generic DraftCommitTxResponse Source # 
Instance details

Defined in Hydra.API.HTTPServer

Associated Types

type Rep DraftCommitTxResponse :: Type -> Type Source #

Methods

from :: DraftCommitTxResponse -> Rep DraftCommitTxResponse x Source #

to :: Rep DraftCommitTxResponse x -> DraftCommitTxResponse Source #

Show DraftCommitTxResponse Source # 
Instance details

Defined in Hydra.API.HTTPServer

Methods

showsPrec :: Int -> DraftCommitTxResponse -> ShowS Source #

show :: DraftCommitTxResponse -> String Source #

showList :: [DraftCommitTxResponse] -> ShowS Source #

type Rep DraftCommitTxResponse Source # 
Instance details

Defined in Hydra.API.HTTPServer

type Rep DraftCommitTxResponse = D1 ('MetaData "DraftCommitTxResponse" "Hydra.API.HTTPServer" "hydra-node-0.16.0-C0XGScKIquG5I6dPp21445" 'True) (C1 ('MetaCons "DraftCommitTxResponse" 'PrefixI 'True) (S1 ('MetaSel ('Just "commitTx") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Tx)))

data ScriptInfo Source #

Constructors

ScriptInfo 

Fields

Instances

Instances details
Arbitrary ScriptInfo Source # 
Instance details

Defined in Hydra.API.HTTPServer

Methods

arbitrary :: Gen ScriptInfo

shrink :: ScriptInfo -> [ScriptInfo]

FromJSON ScriptInfo Source # 
Instance details

Defined in Hydra.API.HTTPServer

Methods

parseJSON :: Value -> Parser ScriptInfo

parseJSONList :: Value -> Parser [ScriptInfo]

omittedField :: Maybe ScriptInfo

ToJSON ScriptInfo Source # 
Instance details

Defined in Hydra.API.HTTPServer

Methods

toJSON :: ScriptInfo -> Value

toEncoding :: ScriptInfo -> Encoding

toJSONList :: [ScriptInfo] -> Value

toEncodingList :: [ScriptInfo] -> Encoding

omitField :: ScriptInfo -> Bool

Generic ScriptInfo Source # 
Instance details

Defined in Hydra.API.HTTPServer

Associated Types

type Rep ScriptInfo :: Type -> Type Source #

Methods

from :: ScriptInfo -> Rep ScriptInfo x Source #

to :: Rep ScriptInfo x -> ScriptInfo Source #

Show ScriptInfo Source # 
Instance details

Defined in Hydra.API.HTTPServer

Methods

showsPrec :: Int -> ScriptInfo -> ShowS Source #

show :: ScriptInfo -> String Source #

showList :: [ScriptInfo] -> ShowS Source #

Eq ScriptInfo Source # 
Instance details

Defined in Hydra.API.HTTPServer

Methods

(==) :: ScriptInfo -> ScriptInfo -> Bool Source #

(/=) :: ScriptInfo -> ScriptInfo -> Bool Source #

type Rep ScriptInfo Source # 
Instance details

Defined in Hydra.API.HTTPServer

type Rep ScriptInfo = D1 ('MetaData "ScriptInfo" "Hydra.API.HTTPServer" "hydra-node-0.16.0-C0XGScKIquG5I6dPp21445" 'False) (C1 ('MetaCons "ScriptInfo" 'PrefixI 'True) (S1 ('MetaSel ('Just "redeemer") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 HashableScriptData) :*: (S1 ('MetaSel ('Just "datum") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe HashableScriptData)) :*: S1 ('MetaSel ('Just "plutusV2Script") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 PlutusScript))))

data TxOutWithWitness Source #

Constructors

TxOutWithWitness 

Fields

Instances

Instances details
Arbitrary TxOutWithWitness Source # 
Instance details

Defined in Hydra.API.HTTPServer

Methods

arbitrary :: Gen TxOutWithWitness

shrink :: TxOutWithWitness -> [TxOutWithWitness]

FromJSON TxOutWithWitness Source # 
Instance details

Defined in Hydra.API.HTTPServer

Methods

parseJSON :: Value -> Parser TxOutWithWitness

parseJSONList :: Value -> Parser [TxOutWithWitness]

omittedField :: Maybe TxOutWithWitness

ToJSON TxOutWithWitness Source # 
Instance details

Defined in Hydra.API.HTTPServer

Methods

toJSON :: TxOutWithWitness -> Value

toEncoding :: TxOutWithWitness -> Encoding

toJSONList :: [TxOutWithWitness] -> Value

toEncodingList :: [TxOutWithWitness] -> Encoding

omitField :: TxOutWithWitness -> Bool

Generic TxOutWithWitness Source # 
Instance details

Defined in Hydra.API.HTTPServer

Associated Types

type Rep TxOutWithWitness :: Type -> Type Source #

Methods

from :: TxOutWithWitness -> Rep TxOutWithWitness x Source #

to :: Rep TxOutWithWitness x -> TxOutWithWitness Source #

Show TxOutWithWitness Source # 
Instance details

Defined in Hydra.API.HTTPServer

Methods

showsPrec :: Int -> TxOutWithWitness -> ShowS Source #

show :: TxOutWithWitness -> String Source #

showList :: [TxOutWithWitness] -> ShowS Source #

Eq TxOutWithWitness Source # 
Instance details

Defined in Hydra.API.HTTPServer

Methods

(==) :: TxOutWithWitness -> TxOutWithWitness -> Bool Source #

(/=) :: TxOutWithWitness -> TxOutWithWitness -> Bool Source #

Arbitrary (UTxO' TxOutWithWitness) Source # 
Instance details

Defined in Hydra.API.HTTPServer

Methods

arbitrary :: Gen (UTxO' TxOutWithWitness)

shrink :: UTxO' TxOutWithWitness -> [UTxO' TxOutWithWitness]

type Rep TxOutWithWitness Source # 
Instance details

Defined in Hydra.API.HTTPServer

type Rep TxOutWithWitness = D1 ('MetaData "TxOutWithWitness" "Hydra.API.HTTPServer" "hydra-node-0.16.0-C0XGScKIquG5I6dPp21445" 'False) (C1 ('MetaCons "TxOutWithWitness" 'PrefixI 'True) (S1 ('MetaSel ('Just "txOut") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (TxOut CtxUTxO)) :*: S1 ('MetaSel ('Just "witness") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe ScriptInfo))))

newtype DraftCommitTxRequest Source #

Constructors

DraftCommitTxRequest 

Fields

Instances

Instances details
Arbitrary DraftCommitTxRequest Source # 
Instance details

Defined in Hydra.API.HTTPServer

Methods

arbitrary :: Gen DraftCommitTxRequest

shrink :: DraftCommitTxRequest -> [DraftCommitTxRequest]

FromJSON DraftCommitTxRequest Source # 
Instance details

Defined in Hydra.API.HTTPServer

Methods

parseJSON :: Value -> Parser DraftCommitTxRequest

parseJSONList :: Value -> Parser [DraftCommitTxRequest]

omittedField :: Maybe DraftCommitTxRequest

ToJSON DraftCommitTxRequest Source # 
Instance details

Defined in Hydra.API.HTTPServer

Methods

toJSON :: DraftCommitTxRequest -> Value

toEncoding :: DraftCommitTxRequest -> Encoding

toJSONList :: [DraftCommitTxRequest] -> Value

toEncodingList :: [DraftCommitTxRequest] -> Encoding

omitField :: DraftCommitTxRequest -> Bool

Generic DraftCommitTxRequest Source # 
Instance details

Defined in Hydra.API.HTTPServer

Associated Types

type Rep DraftCommitTxRequest :: Type -> Type Source #

Methods

from :: DraftCommitTxRequest -> Rep DraftCommitTxRequest x Source #

to :: Rep DraftCommitTxRequest x -> DraftCommitTxRequest Source #

Show DraftCommitTxRequest Source # 
Instance details

Defined in Hydra.API.HTTPServer

Methods

showsPrec :: Int -> DraftCommitTxRequest -> ShowS Source #

show :: DraftCommitTxRequest -> String Source #

showList :: [DraftCommitTxRequest] -> ShowS Source #

Eq DraftCommitTxRequest Source # 
Instance details

Defined in Hydra.API.HTTPServer

Methods

(==) :: DraftCommitTxRequest -> DraftCommitTxRequest -> Bool Source #

(/=) :: DraftCommitTxRequest -> DraftCommitTxRequest -> Bool Source #

type Rep DraftCommitTxRequest Source # 
Instance details

Defined in Hydra.API.HTTPServer

type Rep DraftCommitTxRequest = D1 ('MetaData "DraftCommitTxRequest" "Hydra.API.HTTPServer" "hydra-node-0.16.0-C0XGScKIquG5I6dPp21445" 'True) (C1 ('MetaCons "DraftCommitTxRequest" 'PrefixI 'True) (S1 ('MetaSel ('Just "utxoToCommit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (UTxO' TxOutWithWitness))))

newtype SubmitTxRequest tx Source #

Constructors

SubmitTxRequest 

Fields

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.16.0-C0XGScKIquG5I6dPp21445" 'False) (C1 ('MetaCons "TransactionSubmitted" 'PrefixI 'False) (U1 :: Type -> Type))

httpApp Source #

Arguments

:: Tracer IO APIServerLog 
-> Chain tx IO 
-> PParams LedgerEra 
-> STM IO (Maybe HeadId)

A means to get the HeadId if initializing the Head.

-> Application 

Hydra HTTP server

Handlers

handleDraftCommitUtxo Source #

Arguments

:: Chain tx IO 
-> STM IO (Maybe HeadId)

A means to get the HeadId if initializing the Head.

-> ByteString

Request body.

-> IO Response 

Handle request to obtain a draft commit tx.

Users can decide to commit a public key as well as script outputs.

Request body examples:

Expand
// Committing public key output

{
 "0406060506030602040508060506060306050406020207000508040704040203#89": {
    "address": "addr_test1vz66ue36465w2qq40005h2hadad6pnjht8mu6sgplsfj74q9pm4f4",
    "value": {
      "lovelace": 7620669
    }
}


// Committing a script output

{
 "6f066e0f6ba373c0ea7d8b47aefd7e14d1a781698cd052d0254afe65e039b083#0": {
  "address": "addr_test1wqv4z4hc0u5e2c3sppfdu8ckn82hfegpkjagsm4t8ttvlycg9mkca",
  "datum": null,
  "datumhash": "bb30a42c1e62f0afda5f0a4e8a562f7a13a24cea00ee81917b86b89e801314aa",
  "inlineDatum": null,
  "referenceScript": null,
  "value": {
    "lovelace": 1034400
  },
  "witness": {
    "datum": "02",
    "plutusV2Script": {
      "cborHex": "484701000022200101",
      "description": "",
      "type": PlutusScriptV2
    },
    "redeemer": "01"
  }
}


// Committing a script output using inline datum

{

"87a0c1e14be2cd8c385b6fe5a40b024b7201da9df375542029d91ccaba01ac82#0": {
    "address": "addr_test1wqv4z4hc0u5e2c3sppfdu8ckn82hfegpkjagsm4t8ttvlycg9mkca",
    "datum": null,
    "inlineDatum": {
      "int": 2
    },
    "inlineDatumhash": "bb30a42c1e62f0afda5f0a4e8a562f7a13a24cea00ee81917b86b89e801314aa",
    "referenceScript": null,
    "value": {
      "lovelace": 905100
    },
    "witness": {
      "datum": null,
      "plutusV2Script": {
        "cborHex": "484701000022200101",
        "description": "",
        "type": PlutusScriptV2
      },
      "redeemer": "01"
    }
  }

handleSubmitUserTx Source #

Arguments

:: Chain tx IO 
-> ByteString

Request body.

-> IO Response 

Handle request to submit a cardano transaction.

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