Safe Haskell	None
Language	Haskell2010

Marconi.Api.Types

Contents

Orphan instances

Description

This module provides support for writing handlers for JSON-RPC endpoints

Synopsis

type TargetAddresses = NonEmpty (Address ShelleyAddr)
type RpcPortNumber = Int
data CliArgs = CliArgs {
- socket :: FilePath
- dbPath :: FilePath
- httpPort :: Maybe Int
- networkId :: NetworkId
- targetAddresses :: TargetAddresses
}
data DBQueryEnv = DBQueryEnv {
- _queryTMVar :: UtxoQueryTMVar
- _queryAddresses :: TargetAddresses
}
class HasDBQueryEnv c where
- dBQueryEnv :: Lens' c DBQueryEnv
- queryAddresses :: Lens' c TargetAddresses
- queryTMVar :: Lens' c UtxoQueryTMVar
data JsonRpcEnv = JsonRpcEnv {
- _httpSettings :: Settings
- _queryEnv :: DBQueryEnv
}
class HasJsonRpcEnv c where
- jsonRpcEnv :: Lens' c JsonRpcEnv
- httpSettings :: Lens' c Settings
- queryEnv :: Lens' c DBQueryEnv
newtype UtxoRowWrapper = UtxoRowWrapper UtxoRow
data UtxoTxOutReport = UtxoTxOutReport {
- bech32Address :: Text
- utxoReport :: [UtxoRow]
}
newtype UtxoQueryTMVar = UtxoQueryTMVar {
- unUtxoIndex :: TMVar UtxoIndex
}
data QueryExceptions

Documentation

type TargetAddresses = NonEmpty (Address ShelleyAddr) Source #

Typre represents non empty list of Bech32 Shelley compatable addresses

type RpcPortNumber = Int Source #

Type represents http port for JSON-RPC

data CliArgs Source #

Constructors

CliArgs
Fields socket :: FilePath POSIX socket file to communicate with cardano node dbPath :: FilePath filepath to local sqlite for utxo index table httpPort :: Maybe Int optional tcp/ip port number for JSON-RPC http server networkId :: NetworkId cardano network id targetAddresses :: TargetAddresses white-space sepparated list of Bech32 Cardano Shelley addresses

Instances

Instances details

Show CliArgs Source #
Instance details Defined in Marconi.Api.Types Methods showsPrec :: Int -> CliArgs -> ShowS Source # show :: CliArgs -> String Source # showList :: [CliArgs] -> ShowS Source #

data DBQueryEnv Source #

Constructors

DBQueryEnv
Fields _queryTMVar :: UtxoQueryTMVar _queryAddresses :: TargetAddresses user provided addresses to filter

Instances

Instances details

HasDBQueryEnv DBQueryEnv Source #
Instance details Defined in Marconi.Api.Types Methods dBQueryEnv :: Lens' DBQueryEnv DBQueryEnv Source # queryAddresses :: Lens' DBQueryEnv TargetAddresses Source # queryTMVar :: Lens' DBQueryEnv UtxoQueryTMVar Source #

class HasDBQueryEnv c where Source #

Minimal complete definition

dBQueryEnv

Methods

dBQueryEnv :: Lens' c DBQueryEnv Source #

queryAddresses :: Lens' c TargetAddresses Source #

queryTMVar :: Lens' c UtxoQueryTMVar Source #

Instances

Instances details

HasDBQueryEnv DBQueryEnv Source #
Instance details Defined in Marconi.Api.Types Methods dBQueryEnv :: Lens' DBQueryEnv DBQueryEnv Source # queryAddresses :: Lens' DBQueryEnv TargetAddresses Source # queryTMVar :: Lens' DBQueryEnv UtxoQueryTMVar Source #

data JsonRpcEnv Source #

JSON-RPC configuration

Constructors

JsonRpcEnv
Fields _httpSettings :: Settings HTTP server setting _queryEnv :: DBQueryEnv used for query sqlite

Instances

Instances details

HasJsonRpcEnv JsonRpcEnv Source #
Instance details Defined in Marconi.Api.Types Methods jsonRpcEnv :: Lens' JsonRpcEnv JsonRpcEnv Source # httpSettings :: Lens' JsonRpcEnv Settings Source # queryEnv :: Lens' JsonRpcEnv DBQueryEnv Source #

class HasJsonRpcEnv c where Source #

Minimal complete definition

jsonRpcEnv

Methods

jsonRpcEnv :: Lens' c JsonRpcEnv Source #

httpSettings :: Lens' c Settings Source #

queryEnv :: Lens' c DBQueryEnv Source #

Instances

Instances details

HasJsonRpcEnv JsonRpcEnv Source #
Instance details Defined in Marconi.Api.Types Methods jsonRpcEnv :: Lens' JsonRpcEnv JsonRpcEnv Source # httpSettings :: Lens' JsonRpcEnv Settings Source # queryEnv :: Lens' JsonRpcEnv DBQueryEnv Source #

newtype UtxoRowWrapper Source #

Constructors

UtxoRowWrapper UtxoRow

Instances

Instances details

Eq UtxoRowWrapper Source #
Instance details Defined in Marconi.Api.Types Methods (==) :: UtxoRowWrapper -> UtxoRowWrapper -> Bool Source # (/=) :: UtxoRowWrapper -> UtxoRowWrapper -> Bool Source #
Ord UtxoRowWrapper Source #
Instance details Defined in Marconi.Api.Types Methods compare :: UtxoRowWrapper -> UtxoRowWrapper -> Ordering Source # (<) :: UtxoRowWrapper -> UtxoRowWrapper -> Bool Source # (<=) :: UtxoRowWrapper -> UtxoRowWrapper -> Bool Source # (>) :: UtxoRowWrapper -> UtxoRowWrapper -> Bool Source # (>=) :: UtxoRowWrapper -> UtxoRowWrapper -> Bool Source # max :: UtxoRowWrapper -> UtxoRowWrapper -> UtxoRowWrapper Source # min :: UtxoRowWrapper -> UtxoRowWrapper -> UtxoRowWrapper Source #
Show UtxoRowWrapper Source #
Instance details Defined in Marconi.Api.Types Methods showsPrec :: Int -> UtxoRowWrapper -> ShowS Source # show :: UtxoRowWrapper -> String Source # showList :: [UtxoRowWrapper] -> ShowS Source #
Generic UtxoRowWrapper Source #
Instance details Defined in Marconi.Api.Types Associated Types type Rep UtxoRowWrapper :: Type -> Type Source # Methods from :: UtxoRowWrapper -> Rep UtxoRowWrapper x Source # to :: Rep UtxoRowWrapper x -> UtxoRowWrapper Source #
ToJSON UtxoRowWrapper Source #
Instance details Defined in Marconi.Api.Types Methods toJSON :: UtxoRowWrapper -> Value Source # toEncoding :: UtxoRowWrapper -> Encoding Source # toJSONList :: [UtxoRowWrapper] -> Value Source # toEncodingList :: [UtxoRowWrapper] -> Encoding Source #
type Rep UtxoRowWrapper Source #
Instance details Defined in Marconi.Api.Types type Rep UtxoRowWrapper = D1 ('MetaData "UtxoRowWrapper" "Marconi.Api.Types" "marconi-mamba-1.1.0.0-9W0BFghbh6nEGWbIewFwpQ" 'True) (C1 ('MetaCons "UtxoRowWrapper" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 UtxoRow)))

data UtxoTxOutReport Source #

Constructors

UtxoTxOutReport
Fields bech32Address :: Text utxoReport :: [UtxoRow]

Instances

Instances details

Eq UtxoTxOutReport Source #
Instance details Defined in Marconi.Api.Types Methods (==) :: UtxoTxOutReport -> UtxoTxOutReport -> Bool Source # (/=) :: UtxoTxOutReport -> UtxoTxOutReport -> Bool Source #
Ord UtxoTxOutReport Source #
Instance details Defined in Marconi.Api.Types Methods compare :: UtxoTxOutReport -> UtxoTxOutReport -> Ordering Source # (<) :: UtxoTxOutReport -> UtxoTxOutReport -> Bool Source # (<=) :: UtxoTxOutReport -> UtxoTxOutReport -> Bool Source # (>) :: UtxoTxOutReport -> UtxoTxOutReport -> Bool Source # (>=) :: UtxoTxOutReport -> UtxoTxOutReport -> Bool Source # max :: UtxoTxOutReport -> UtxoTxOutReport -> UtxoTxOutReport Source # min :: UtxoTxOutReport -> UtxoTxOutReport -> UtxoTxOutReport Source #
Generic UtxoTxOutReport Source #
Instance details Defined in Marconi.Api.Types Associated Types type Rep UtxoTxOutReport :: Type -> Type Source # Methods from :: UtxoTxOutReport -> Rep UtxoTxOutReport x Source # to :: Rep UtxoTxOutReport x -> UtxoTxOutReport Source #
ToJSON UtxoTxOutReport Source #
Instance details Defined in Marconi.Api.Types Methods toJSON :: UtxoTxOutReport -> Value Source # toEncoding :: UtxoTxOutReport -> Encoding Source # toJSONList :: [UtxoTxOutReport] -> Value Source # toEncodingList :: [UtxoTxOutReport] -> Encoding Source #
type Rep UtxoTxOutReport Source #
Instance details Defined in Marconi.Api.Types type Rep UtxoTxOutReport = D1 ('MetaData "UtxoTxOutReport" "Marconi.Api.Types" "marconi-mamba-1.1.0.0-9W0BFghbh6nEGWbIewFwpQ" 'False) (C1 ('MetaCons "UtxoTxOutReport" 'PrefixI 'True) (S1 ('MetaSel ('Just "bech32Address") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "utxoReport") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [UtxoRow])))

newtype UtxoQueryTMVar Source #

Constructors

UtxoQueryTMVar
Fields unUtxoIndex :: TMVar UtxoIndex for query thread to access in-memory utxos

data QueryExceptions Source #

Constructors

AddressNotInListError QueryExceptions
AddressConversionError QueryExceptions
TxRefConversionError QueryExceptions
QueryError String

Instances

Instances details

Show QueryExceptions Source #
Instance details Defined in Marconi.Api.Types Methods showsPrec :: Int -> QueryExceptions -> ShowS Source # show :: QueryExceptions -> String Source # showList :: [QueryExceptions] -> ShowS Source #
Exception QueryExceptions Source #
Instance details Defined in Marconi.Api.Types Methods toException :: QueryExceptions -> SomeException Source # fromException :: SomeException -> Maybe QueryExceptions Source # displayException :: QueryExceptions -> String Source #

Orphan instances

ToJSON ByteString Source #
Instance details Methods toJSON :: ByteString -> Value Source # toEncoding :: ByteString -> Encoding Source # toJSONList :: [ByteString] -> Value Source # toEncodingList :: [ByteString] -> Encoding Source #
ToJSON AddressAny Source #
Instance details Methods toJSON :: AddressAny -> Value Source # toEncoding :: AddressAny -> Encoding Source # toJSONList :: [AddressAny] -> Value Source # toEncodingList :: [AddressAny] -> Encoding Source #
ToJSON ScriptData Source #
Instance details Methods toJSON :: ScriptData -> Value Source # toEncoding :: ScriptData -> Encoding Source # toJSONList :: [ScriptData] -> Value Source # toEncodingList :: [ScriptData] -> Encoding Source #
ToJSON BlockNo Source #
Instance details Methods toJSON :: BlockNo -> Value Source # toEncoding :: BlockNo -> Encoding Source # toJSONList :: [BlockNo] -> Value Source # toEncodingList :: [BlockNo] -> Encoding Source #
ToJSON UtxoRow Source #
Instance details Methods toJSON :: UtxoRow -> Value Source # toEncoding :: UtxoRow -> Encoding Source # toJSONList :: [UtxoRow] -> Value Source # toEncodingList :: [UtxoRow] -> Encoding Source #
ToJSON Utxo Source #
Instance details Methods toJSON :: Utxo -> Value Source # toEncoding :: Utxo -> Encoding Source # toJSONList :: [Utxo] -> Value Source # toEncodingList :: [Utxo] -> Encoding Source #