lorentz-0.6.1: EDSL for the Michelson Language

Safe Haskell	None
Language	Haskell2010

Lorentz.ContractRegistry

Contents

Registry types
Things to do in main
Building blocks

Description

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

Synopsis

data ContractInfo = forall cp st.(NiceParameterFull cp, NiceStorage st) => ContractInfo {
- ciContract :: Contract cp st
- ciIsDocumented :: Bool
- ciStorageParser :: Maybe (Parser st)
- ciStorageNotes :: Maybe (Notes (ToT st))
}
newtype ContractRegistry = ContractRegistry {
- unContractRegistry :: Map Text ContractInfo
}
(?::) :: Text -> a -> (Text, a)
data CmdLnArgs
- = List
- | Print Text (Maybe FilePath) Bool Bool
- | Document Text (Maybe FilePath) DGitRevision
- | Analyze Text
- | PrintStorage SomeNiceStorage Bool
argParser :: ContractRegistry -> DGitRevision -> Parser CmdLnArgs
runContractRegistry :: ContractRegistry -> CmdLnArgs -> IO ()
printContractFromRegistryDoc :: Text -> ContractRegistry -> DGitRevision -> Maybe FilePath -> IO ()

Registry types

data ContractInfo Source #

Constructors

forall cp st.(NiceParameterFull cp, NiceStorage st) => ContractInfo

Fields

ciContract :: Contract cp st
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 Source #

Constructors

ContractRegistry
Fields unContractRegistry :: Map Text ContractInfo

Instances

Instances details

Buildable ContractRegistry Source #
Instance details Defined in Lorentz.ContractRegistry Methods build :: ContractRegistry -> Builder #

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

Things to do in `main`

data CmdLnArgs Source #

ContractRegistry actions parsed from CLI.

Constructors

List
Print Text (Maybe FilePath) Bool Bool
Document Text (Maybe FilePath) DGitRevision
Analyze Text
PrintStorage SomeNiceStorage Bool

argParser :: ContractRegistry -> DGitRevision -> Parser CmdLnArgs Source #

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

Run an action operating with ContractRegistry.

Building blocks

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