Safe Haskell	None
Language	Haskell2010

Cardano.CLI.Byron.Genesis

Synopsis

data ByronGenesisError
data GenesisParameters = GenesisParameters {
- gpStartTime :: !UTCTime
- gpProtocolParamsFile :: !FilePath
- gpK :: !BlockCount
- gpProtocolMagic :: !ProtocolMagic
- gpTestnetBalance :: !TestnetBalanceOptions
- gpFakeAvvmOptions :: !FakeAvvmOptions
- gpAvvmBalanceFactor :: !LovelacePortion
- gpSeed :: !(Maybe Integer)
}
newtype NewDirectory = NewDirectory FilePath
dumpGenesis :: NewDirectory -> GenesisData -> GeneratedSecrets -> ExceptT ByronGenesisError IO ()
mkGenesis :: GenesisParameters -> CIO e (GenesisData, GeneratedSecrets)
readGenesis :: GenesisFile -> NetworkId -> ExceptT ByronGenesisError IO Config
renderByronGenesisError :: ByronGenesisError -> Doc ann

Documentation

data ByronGenesisError Source #

Constructors

GenesisOutputDirAlreadyExists FilePath
GenesisReadError !FilePath !GenesisDataError
GenesisSpecError !Text
MakeGenesisDelegationError !GenesisDelegationError
NoGenesisDelegationForKey !Text
ProtocolParametersParseFailed !FilePath !Text

Instances

Instances details

Show ByronGenesisError Source #
Instance details Defined in Cardano.CLI.Byron.Genesis Methods showsPrec :: Int -> ByronGenesisError -> ShowS Source # show :: ByronGenesisError -> String Source # showList :: [ByronGenesisError] -> ShowS Source #
Error ByronGenesisError Source #
Instance details Defined in Cardano.CLI.Byron.Genesis Methods prettyError :: ByronGenesisError -> Doc ann Source #

data GenesisParameters Source #

Parameters required for generation of new genesis.

Constructors

GenesisParameters
Fields gpStartTime :: !UTCTime gpProtocolParamsFile :: !FilePath gpK :: !BlockCount gpProtocolMagic :: !ProtocolMagic gpTestnetBalance :: !TestnetBalanceOptions gpFakeAvvmOptions :: !FakeAvvmOptions gpAvvmBalanceFactor :: !LovelacePortion gpSeed :: !(Maybe Integer)

Instances

Instances details

Show GenesisParameters Source #
Instance details Defined in Cardano.CLI.Byron.Genesis Methods showsPrec :: Int -> GenesisParameters -> ShowS Source # show :: GenesisParameters -> String Source # showList :: [GenesisParameters] -> ShowS Source #

newtype NewDirectory Source #

Constructors

NewDirectory FilePath

Instances

Instances details

IsString NewDirectory Source #
Instance details Defined in Cardano.CLI.Byron.Genesis Methods fromString :: String -> NewDirectory Source #
Show NewDirectory Source #
Instance details Defined in Cardano.CLI.Byron.Genesis Methods showsPrec :: Int -> NewDirectory -> ShowS Source # show :: NewDirectory -> String Source # showList :: [NewDirectory] -> ShowS Source #
Eq NewDirectory Source #
Instance details Defined in Cardano.CLI.Byron.Genesis Methods (==) :: NewDirectory -> NewDirectory -> Bool Source # (/=) :: NewDirectory -> NewDirectory -> Bool Source #
Ord NewDirectory Source #
Instance details Defined in Cardano.CLI.Byron.Genesis Methods compare :: NewDirectory -> NewDirectory -> Ordering Source # (<) :: NewDirectory -> NewDirectory -> Bool Source # (<=) :: NewDirectory -> NewDirectory -> Bool Source # (>) :: NewDirectory -> NewDirectory -> Bool Source # (>=) :: NewDirectory -> NewDirectory -> Bool Source # max :: NewDirectory -> NewDirectory -> NewDirectory Source # min :: NewDirectory -> NewDirectory -> NewDirectory Source #

dumpGenesis :: NewDirectory -> GenesisData -> GeneratedSecrets -> ExceptT ByronGenesisError IO () Source #

Write out genesis into a directory that must not yet exist. An error is thrown if the directory already exists, or the genesis has delegate keys that are not delegated to.

mkGenesis :: GenesisParameters -> CIO e (GenesisData, GeneratedSecrets) Source #

Generate a genesis, for given blockchain start time, protocol parameters, security parameter, protocol magic, testnet balance options, fake AVVM options, AVVM balance factor and seed. Throw an error in the following cases: if the protocol parameters file can't be read or fails parse, if genesis delegation couldn't be generated, if the parameter-derived genesis specification is wrong, or if the genesis fails generation.

readGenesis :: GenesisFile -> NetworkId -> ExceptT ByronGenesisError IO Config Source #

Read genesis from a file.

renderByronGenesisError :: ByronGenesisError -> Doc ann Source #