Safe Haskell	Safe-Inferred
Language	Haskell2010

Convex.Devnet.CardanoNode

Description

Startup cardano nodes programmatically

Synopsis

newtype NodeId = NodeId Int
data NodeLog
- = MsgNodeCmdSpec Text
- | MsgCLI [Text]
- | MsgCLIStatus Text Text
- | MsgCLIRetry Text
- | MsgCLIRetryResult Text Int
- | MsgNodeStarting {
  - stateDirectory ∷ FilePath
  }
- | MsgSocketIsReady FilePath
- | MsgSynchronizing {
  - percentDone ∷ Centi
  }
- | MsgNodeIsReady
data RunningNode = RunningNode {
- rnNodeSocket ∷ FilePath
- rnNetworkId ∷ NetworkId
- rnNodeConfigFile ∷ FilePath
- rnConnectInfo ∷ (LocalNodeConnectInfo CardanoMode, Env)
}
data DevnetConfig = DevnetConfig {
- dcStateDirectory ∷ FilePath
- dcSystemStart ∷ UTCTime
- dcPorts ∷ PortsConfig
}
data CardanoNodeArgs = CardanoNodeArgs {
- nodeSocket ∷ FilePath
- nodeConfigFile ∷ FilePath
- nodeByronGenesisFile ∷ FilePath
- nodeShelleyGenesisFile ∷ FilePath
- nodeAlonzoGenesisFile ∷ FilePath
- nodeConwayGenesisFile ∷ FilePath
- nodeTopologyFile ∷ FilePath
- nodeDatabaseDir ∷ FilePath
- nodeDlgCertFile ∷ Maybe FilePath
- nodeSignKeyFile ∷ Maybe FilePath
- nodeOpCertFile ∷ Maybe FilePath
- nodeKesKeyFile ∷ Maybe FilePath
- nodeVrfKeyFile ∷ Maybe FilePath
- nodePort ∷ Maybe Port
}
defaultCardanoNodeArgs ∷ CardanoNodeArgs
withCardanoNode ∷ Tracer IO NodeLog → NetworkId → FilePath → CardanoNodeArgs → (RunningNode → IO a) → IO a
getCardanoNodeVersion ∷ IO String
waitForFullySynchronized ∷ Tracer IO NodeLog → RunningNode → IO ()
waitForBlock ∷ RunningNode → IO BlockNo
waitForSocket ∷ RunningNode → IO ()
withCardanoNodeDevnet ∷ Tracer IO NodeLog → FilePath → (RunningNode → IO a) → IO a
data GenesisConfigChanges = GenesisConfigChanges {
- cfShelley ∷ ShelleyGenesis StandardCrypto → ShelleyGenesis StandardCrypto
- cfAlonzo ∷ AlonzoGenesis → AlonzoGenesis
- cfConway ∷ ConwayGenesis StandardCrypto → ConwayGenesis StandardCrypto
}
allowLargeTransactions ∷ GenesisConfigChanges
withCardanoNodeDevnetConfig ∷ Tracer IO NodeLog → FilePath → GenesisConfigChanges → (RunningNode → IO a) → IO a

Documentation

newtype NodeId Source #

Constructors

NodeId Int

Instances

Instances details

FromJSON NodeId Source #
Instance details Defined in Convex.Devnet.CardanoNode Methods parseJSON ∷ Value → Parser NodeId Source # parseJSONList ∷ Value → Parser [NodeId] Source #
ToJSON NodeId Source #
Instance details Defined in Convex.Devnet.CardanoNode Methods toJSON ∷ NodeId → Value Source # toEncoding ∷ NodeId → Encoding Source # toJSONList ∷ [NodeId] → Value Source # toEncodingList ∷ [NodeId] → Encoding Source #
Num NodeId Source #
Instance details Defined in Convex.Devnet.CardanoNode Methods (+) ∷ NodeId → NodeId → NodeId Source # (-) ∷ NodeId → NodeId → NodeId Source # (*) ∷ NodeId → NodeId → NodeId Source # negate ∷ NodeId → NodeId Source # abs ∷ NodeId → NodeId Source # signum ∷ NodeId → NodeId Source # fromInteger ∷ Integer → NodeId Source #
Show NodeId Source #
Instance details Defined in Convex.Devnet.CardanoNode Methods showsPrec ∷ Int → NodeId → ShowS Source # show ∷ NodeId → String Source # showList ∷ [NodeId] → ShowS Source #
Eq NodeId Source #
Instance details Defined in Convex.Devnet.CardanoNode Methods (==) ∷ NodeId → NodeId → Bool Source # (/=) ∷ NodeId → NodeId → Bool Source #

data NodeLog Source #

Constructors

MsgNodeCmdSpec Text
MsgCLI [Text]
MsgCLIStatus Text Text
MsgCLIRetry Text
MsgCLIRetryResult Text Int
MsgNodeStarting
Fields stateDirectory ∷ FilePath
MsgSocketIsReady FilePath
MsgSynchronizing
Fields percentDone ∷ Centi
MsgNodeIsReady

Instances

Instances details

FromJSON NodeLog Source #
Instance details Defined in Convex.Devnet.CardanoNode Methods parseJSON ∷ Value → Parser NodeLog Source # parseJSONList ∷ Value → Parser [NodeLog] Source #
ToJSON NodeLog Source #
Instance details Defined in Convex.Devnet.CardanoNode Methods toJSON ∷ NodeLog → Value Source # toEncoding ∷ NodeLog → Encoding Source # toJSONList ∷ [NodeLog] → Value Source # toEncodingList ∷ [NodeLog] → Encoding Source #
Generic NodeLog Source #
Instance details Defined in Convex.Devnet.CardanoNode Associated Types type Rep NodeLog ∷ Type → Type Source # Methods from ∷ NodeLog → Rep NodeLog x Source # to ∷ Rep NodeLog x → NodeLog Source #
Show NodeLog Source #
Instance details Defined in Convex.Devnet.CardanoNode Methods showsPrec ∷ Int → NodeLog → ShowS Source # show ∷ NodeLog → String Source # showList ∷ [NodeLog] → ShowS Source #
Eq NodeLog Source #
Instance details Defined in Convex.Devnet.CardanoNode Methods (==) ∷ NodeLog → NodeLog → Bool Source # (/=) ∷ NodeLog → NodeLog → Bool Source #
type Rep NodeLog Source #
Instance details Defined in Convex.Devnet.CardanoNode type Rep NodeLog = D1 ('MetaData "NodeLog" "Convex.Devnet.CardanoNode" "convex-devnet-0.2.0.0-inplace" 'False) (((C1 ('MetaCons "MsgNodeCmdSpec" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :+: C1 ('MetaCons "MsgCLI" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Text]))) :+: (C1 ('MetaCons "MsgCLIStatus" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :: S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :+: C1 ('MetaCons "MsgCLIRetry" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))) :+: ((C1 ('MetaCons "MsgCLIRetryResult" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :: S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int)) :+: C1 ('MetaCons "MsgNodeStarting" 'PrefixI 'True) (S1 ('MetaSel ('Just "stateDirectory") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 FilePath))) :+: (C1 ('MetaCons "MsgSocketIsReady" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 FilePath)) :+: (C1 ('MetaCons "MsgSynchronizing" 'PrefixI 'True) (S1 ('MetaSel ('Just "percentDone") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Centi)) :+: C1 ('MetaCons "MsgNodeIsReady" 'PrefixI 'False) (U1 ∷ Type → Type)))))

data RunningNode Source #

Constructors

RunningNode
Fields rnNodeSocket ∷ FilePath Cardano node socket rnNetworkId ∷ NetworkId Network ID used by the cardano node rnNodeConfigFile ∷ FilePath Cardano node config file (JSON) rnConnectInfo ∷ (LocalNodeConnectInfo CardanoMode, Env) Connection info for node queries

data DevnetConfig Source #

Configuration parameters for a single node devnet

Constructors

DevnetConfig
Fields dcStateDirectory ∷ FilePath Parent state directory dcSystemStart ∷ UTCTime Blockchain start time dcPorts ∷ PortsConfig A list of port

Instances

Instances details

FromJSON DevnetConfig Source #
Instance details Defined in Convex.Devnet.CardanoNode Methods parseJSON ∷ Value → Parser DevnetConfig Source # parseJSONList ∷ Value → Parser [DevnetConfig] Source #
ToJSON DevnetConfig Source #
Instance details Defined in Convex.Devnet.CardanoNode Methods toJSON ∷ DevnetConfig → Value Source # toEncoding ∷ DevnetConfig → Encoding Source # toJSONList ∷ [DevnetConfig] → Value Source # toEncodingList ∷ [DevnetConfig] → Encoding Source #
Generic DevnetConfig Source #
Instance details Defined in Convex.Devnet.CardanoNode Associated Types type Rep DevnetConfig ∷ Type → Type Source # Methods from ∷ DevnetConfig → Rep DevnetConfig x Source # to ∷ Rep DevnetConfig x → DevnetConfig Source #
Show DevnetConfig Source #
Instance details Defined in Convex.Devnet.CardanoNode Methods showsPrec ∷ Int → DevnetConfig → ShowS Source # show ∷ DevnetConfig → String Source # showList ∷ [DevnetConfig] → ShowS Source #
Eq DevnetConfig Source #
Instance details Defined in Convex.Devnet.CardanoNode Methods (==) ∷ DevnetConfig → DevnetConfig → Bool Source # (/=) ∷ DevnetConfig → DevnetConfig → Bool Source #
type Rep DevnetConfig Source #
Instance details Defined in Convex.Devnet.CardanoNode type Rep DevnetConfig

data CardanoNodeArgs Source #

Arguments given to the 'cardano-node' command-line to run a node.

Constructors

CardanoNodeArgs

Fields

nodeSocket ∷ FilePath
nodeConfigFile ∷ FilePath
nodeByronGenesisFile ∷ FilePath
nodeShelleyGenesisFile ∷ FilePath
nodeAlonzoGenesisFile ∷ FilePath
nodeConwayGenesisFile ∷ FilePath
nodeTopologyFile ∷ FilePath
nodeDatabaseDir ∷ FilePath
nodeDlgCertFile ∷ Maybe FilePath
nodeSignKeyFile ∷ Maybe FilePath
nodeOpCertFile ∷ Maybe FilePath
nodeKesKeyFile ∷ Maybe FilePath
nodeVrfKeyFile ∷ Maybe FilePath
nodePort ∷ Maybe Port

defaultCardanoNodeArgs ∷ CardanoNodeArgs Source #

withCardanoNode ∷ Tracer IO NodeLog → NetworkId → FilePath → CardanoNodeArgs → (RunningNode → IO a) → IO a Source #

getCardanoNodeVersion ∷ IO String Source #

waitForFullySynchronized ∷ Tracer IO NodeLog → RunningNode → IO () Source #

Wait until the node is fully caught up with the network. This can take a while!

waitForBlock ∷ RunningNode → IO BlockNo Source #

Wait until at least one block has been produced (ie. the tip is not genesis)

waitForSocket ∷ RunningNode → IO () Source #

Wait for the node socket file to become available.

withCardanoNodeDevnet Source #

Arguments

∷ Tracer IO NodeLog
→ FilePath	State directory in which credentials, db & logs are persisted.
→ (RunningNode → IO a)
→ IO a

Start a single cardano-node devnet using the config from config/ and credentials from configcredentials. Only the Faucet actor will receive "initialFunds". Use seedFromFaucet to distribute funds other wallets.

data GenesisConfigChanges Source #

Modifications to apply to the default genesis configurations

Constructors

GenesisConfigChanges
Fields cfShelley ∷ ShelleyGenesis StandardCrypto → ShelleyGenesis StandardCrypto cfAlonzo ∷ AlonzoGenesis → AlonzoGenesis cfConway ∷ ConwayGenesis StandardCrypto → ConwayGenesis StandardCrypto

Instances

Instances details

Monoid GenesisConfigChanges Source #
Instance details Defined in Convex.Devnet.CardanoNode Methods mempty ∷ GenesisConfigChanges Source # mappend ∷ GenesisConfigChanges → GenesisConfigChanges → GenesisConfigChanges Source # mconcat ∷ [GenesisConfigChanges] → GenesisConfigChanges Source #
Semigroup GenesisConfigChanges Source #
Instance details Defined in Convex.Devnet.CardanoNode Methods (<>) ∷ GenesisConfigChanges → GenesisConfigChanges → GenesisConfigChanges Source # sconcat ∷ NonEmpty GenesisConfigChanges → GenesisConfigChanges Source # stimes ∷ Integral b ⇒ b → GenesisConfigChanges → GenesisConfigChanges Source #

allowLargeTransactions ∷ GenesisConfigChanges Source #

withCardanoNodeDevnetConfig Source #

Arguments

∷ Tracer IO NodeLog
→ FilePath	State directory in which credentials, db & logs are persisted.
→ GenesisConfigChanges	Changes to apply to the default genesis configurations
→ (RunningNode → IO a)
→ IO a

Start a single cardano-node devnet using the config from config/ and credentials from configcredentials. Only the Faucet actor will receive "initialFunds". Use seedFromFaucet to distribute funds other wallets.