Safe Haskell	None
Language	Haskell2010

Plutus.ChainIndex.Config

Contents

Lenses
Orphan instances

Synopsis

data ChainIndexConfig = ChainIndexConfig {
- cicSocketPath :: String
- cicDbPath :: String
- cicPort :: Int
- cicNetworkId :: NetworkId
- cicSecurityParam :: Int
- cicSlotConfig :: SlotConfig
- cicStoreFrom :: BlockNo
- cicAppendTransactionQueueSize :: Natural
}
newtype DecodeConfigException = DecodeConfigException String
defaultConfig :: ChainIndexConfig
socketPath :: Lens' ChainIndexConfig String
dbPath :: Lens' ChainIndexConfig String
port :: Lens' ChainIndexConfig Int
networkId :: Lens' ChainIndexConfig NetworkId
securityParam :: Lens' ChainIndexConfig Int
slotConfig :: Lens' ChainIndexConfig SlotConfig
storeFrom :: Lens' ChainIndexConfig BlockNo
appendTransactionQueueSize :: Lens' ChainIndexConfig Natural

Documentation

data ChainIndexConfig Source #

Constructors

ChainIndexConfig

Fields

cicSocketPath :: String
cicDbPath :: String
cicPort :: Int
cicNetworkId :: NetworkId
cicSecurityParam :: Int

The number of blocks after which a transaction cannot be rolled back anymore
cicSlotConfig :: SlotConfig
cicStoreFrom :: BlockNo

Only store transactions from this block number onward
cicAppendTransactionQueueSize :: Natural

The size of the queue and a number of transactions to collect before writing to the database

Instances

Instances details

Eq ChainIndexConfig Source #
Instance details Defined in Plutus.ChainIndex.Config Methods (==) :: ChainIndexConfig -> ChainIndexConfig -> Bool Source # (/=) :: ChainIndexConfig -> ChainIndexConfig -> Bool Source #
Show ChainIndexConfig Source #
Instance details Defined in Plutus.ChainIndex.Config Methods showsPrec :: Int -> ChainIndexConfig -> ShowS Source # show :: ChainIndexConfig -> String Source # showList :: [ ChainIndexConfig ] -> ShowS Source #
Generic ChainIndexConfig Source #
Instance details Defined in Plutus.ChainIndex.Config Associated Types type Rep ChainIndexConfig :: Type -> Type Source # Methods from :: ChainIndexConfig -> Rep ChainIndexConfig x Source # to :: Rep ChainIndexConfig x -> ChainIndexConfig Source #
ToJSON ChainIndexConfig Source #
Instance details Defined in Plutus.ChainIndex.Config Methods toJSON :: ChainIndexConfig -> Value Source # toEncoding :: ChainIndexConfig -> Encoding Source # toJSONList :: [ ChainIndexConfig ] -> Value Source # toEncodingList :: [ ChainIndexConfig ] -> Encoding Source #
FromJSON ChainIndexConfig Source #
Instance details Defined in Plutus.ChainIndex.Config Methods parseJSON :: Value -> Parser ChainIndexConfig Source # parseJSONList :: Value -> Parser [ ChainIndexConfig ] Source #
Pretty ChainIndexConfig Source #
Instance details Defined in Plutus.ChainIndex.Config Methods pretty :: ChainIndexConfig -> Doc ann Source # prettyList :: [ ChainIndexConfig ] -> Doc ann Source #
type Rep ChainIndexConfig Source #
Instance details Defined in Plutus.ChainIndex.Config type Rep ChainIndexConfig = D1 (' MetaData "ChainIndexConfig" "Plutus.ChainIndex.Config" "plutus-chain-index-1.2.0.0-3CbZJi76XkaE20yvLJVl75" ' False ) ( C1 (' MetaCons "ChainIndexConfig" ' PrefixI ' True ) ((( S1 (' MetaSel (' Just "cicSocketPath") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 String ) :: S1 (' MetaSel (' Just "cicDbPath") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 String )) :: ( S1 (' MetaSel (' Just "cicPort") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 Int ) :: S1 (' MetaSel (' Just "cicNetworkId") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 NetworkId ))) :: (( S1 (' MetaSel (' Just "cicSecurityParam") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 Int ) :: S1 (' MetaSel (' Just "cicSlotConfig") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 SlotConfig )) :: ( S1 (' MetaSel (' Just "cicStoreFrom") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 BlockNo ) :*: S1 (' MetaSel (' Just "cicAppendTransactionQueueSize") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 Natural )))))

newtype DecodeConfigException Source #

Constructors

DecodeConfigException String

Instances

Instances details

Show DecodeConfigException Source #
Instance details Defined in Plutus.ChainIndex.Config Methods showsPrec :: Int -> DecodeConfigException -> ShowS Source # show :: DecodeConfigException -> String Source # showList :: [ DecodeConfigException ] -> ShowS Source #
Exception DecodeConfigException Source #
Instance details Defined in Plutus.ChainIndex.Config Methods toException :: DecodeConfigException -> SomeException Source # fromException :: SomeException -> Maybe DecodeConfigException Source # displayException :: DecodeConfigException -> String Source #

defaultConfig :: ChainIndexConfig Source #

These settings work with the main testnet

Lenses

socketPath :: Lens' ChainIndexConfig String Source #

dbPath :: Lens' ChainIndexConfig String Source #

port :: Lens' ChainIndexConfig Int Source #

networkId :: Lens' ChainIndexConfig NetworkId Source #

securityParam :: Lens' ChainIndexConfig Int Source #

slotConfig :: Lens' ChainIndexConfig SlotConfig Source #

storeFrom :: Lens' ChainIndexConfig BlockNo Source #

appendTransactionQueueSize :: Lens' ChainIndexConfig Natural Source #

Orphan instances

ToJSON NetworkId Source #
Instance details Methods toJSON :: NetworkId -> Value Source # toEncoding :: NetworkId -> Encoding Source # toJSONList :: [ NetworkId ] -> Value Source # toEncodingList :: [ NetworkId ] -> Encoding Source #
ToJSON NetworkMagic Source #
Instance details Methods toJSON :: NetworkMagic -> Value Source # toEncoding :: NetworkMagic -> Encoding Source # toJSONList :: [ NetworkMagic ] -> Value Source # toEncodingList :: [ NetworkMagic ] -> Encoding Source #
ToJSON BlockNo Source #
Instance details Methods toJSON :: BlockNo -> Value Source # toEncoding :: BlockNo -> Encoding Source # toJSONList :: [ BlockNo ] -> Value Source # toEncodingList :: [ BlockNo ] -> Encoding Source #
FromJSON NetworkId Source #	For some reason these are not defined anywhere, and these are the reason for the -Wno-orphans option.
Instance details Methods parseJSON :: Value -> Parser NetworkId Source # parseJSONList :: Value -> Parser [ NetworkId ] Source #
FromJSON NetworkMagic Source #
Instance details Methods parseJSON :: Value -> Parser NetworkMagic Source # parseJSONList :: Value -> Parser [ NetworkMagic ] Source #
FromJSON BlockNo Source #
Instance details Methods parseJSON :: Value -> Parser BlockNo Source # parseJSONList :: Value -> Parser [ BlockNo ] Source #