Lorentz.ContractRegistry

This module contains various datatypes and functions which are common for contract registry packages (e.g. morley-ledgers).

Registry types

data ContractInfo

Constructors

forall cp st vd.NiceStorage st => ContractInfo

Fields

• ciContract :: Contract cp st vd
• ciIsDocumented :: Bool
• ciStorageParser :: Maybe (Parser st)

  Specifies how to parse initial storage value.

  Normally you pass some user data and call a function that constructs storage from that data.

  If storage is simple and can be easilly constructed manually, you can use Nothing.

• ciStorageNotes :: Maybe (Notes (ToT st))

  Rewrite annotations in storage. We don't won't to uncoditionally override storage notes since after #20 we require notes to be non-empty, so we wrap them into Maybe.

newtype ContractRegistry

Constructors

ContractRegistry

Fields

• unContractRegistry :: Map Text ContractInfo

Instances

Buildable ContractRegistry

Defined in Lorentz.ContractRegistry

Methods

build :: ContractRegistry -> Builder

(?::) :: Text -> a -> (Text, a)

Things to do in main

data CmdLnArgs

ContractRegistry actions parsed from CLI.

Constructors

List

Print (Maybe Text) (Maybe FilePath) Bool Bool

Document (Maybe Text) (Maybe FilePath) DGitRevision

Analyze (Maybe Text)

PrintStorage SomeNiceStorage Bool

argParser :: ContractRegistry -> DGitRevision -> Parser CmdLnArgs

runContractRegistry :: ContractRegistry -> CmdLnArgs -> IO ()

Run an action operating with ContractRegistry.

Building blocks

printContractFromRegistryDoc :: Maybe Text -> ContractRegistry -> DGitRevision -> Maybe FilePath -> IO ()