Morley.Michelson.Runtime.Import

Read, parse, typecheck contract

readContract :: forall cp st. Each '[SingI] [cp, st] => MichelsonSource -> Text -> Either ContractReadError (Contract cp st)

Purely read a typed contract from Michelson textual representation, failing if parameter or storage types mismatch with the expected ones.

readSomeContract :: MichelsonSource -> Text -> Either ContractReadError SomeContract

Purely read a typed contract from Michelson textual representation.

readUntypedContract :: MichelsonSource -> Text -> Either ContractReadError Contract

Purely read an untyped contract from Michelson textual representation.

FilePath is accepted solely as a hint for error messages.

importContract :: forall cp st. Each '[SingI] [cp, st] => FilePath -> IO (Contract cp st)

Import contract from a given file path.

This function reads file, parses and type checks a contract. Within the typechecking we assume that no contracts are originated, otherwise a type checking error will be caused.

This function may throw IOException and ContractReadError.

importSomeContract :: FilePath -> IO SomeContract

Version of importContract that doesn't require you to know contract's parameter and storage types.

importUntypedContract :: FilePath -> IO Contract

Import untyped contract from a given file path.

This function reads file, and parses a contract.

This function may throw IOException and ContractReadError.

data ContractReadError

Error type for importContract function.

Constructors

CREParse MichelsonSource ParserException

CRETypeCheck MichelsonSource TCError

Instances

Eq ContractReadError

Defined in Morley.Michelson.Runtime.Import

Methods

(==) :: ContractReadError -> ContractReadError -> Bool

(/=) :: ContractReadError -> ContractReadError -> Bool

Show ContractReadError

Defined in Morley.Michelson.Runtime.Import

Methods

showsPrec :: Int -> ContractReadError -> ShowS

show :: ContractReadError -> String

showList :: [ContractReadError] -> ShowS

Exception ContractReadError

Defined in Morley.Michelson.Runtime.Import

Methods

toException :: ContractReadError -> SomeException

fromException :: SomeException -> Maybe ContractReadError

displayException :: ContractReadError -> String

Buildable ContractReadError

Defined in Morley.Michelson.Runtime.Import

Methods

build :: ContractReadError -> Builder

Read, parse, typecheck value

readValue :: forall t. SingI t => MichelsonSource -> Text -> Either ValueReadError (Value t)

Purely read a typed Michelson value from textual representation.

importValue :: forall t. SingI t => FilePath -> IO (Value t)

Import a typed value from a given file path.

importSomeValue :: Ty -> FilePath -> IO SomeValue

Import a typed value from a given file path.

Expected type is provided explicitly.

importUntypedValue :: FilePath -> IO Value

Import an untyped value from a given file path.

data ValueReadError

Error type for importValue function.

Constructors

VREParse MichelsonSource ParserException

VRETypeCheck MichelsonSource TCError

Instances

Eq ValueReadError

Defined in Morley.Michelson.Runtime.Import

Methods

(==) :: ValueReadError -> ValueReadError -> Bool

(/=) :: ValueReadError -> ValueReadError -> Bool

Show ValueReadError

Defined in Morley.Michelson.Runtime.Import

Methods

showsPrec :: Int -> ValueReadError -> ShowS

show :: ValueReadError -> String

showList :: [ValueReadError] -> ShowS

Exception ValueReadError

Defined in Morley.Michelson.Runtime.Import

Methods

toException :: ValueReadError -> SomeException

fromException :: SomeException -> Maybe ValueReadError

displayException :: ValueReadError -> String

Buildable ValueReadError

Defined in Morley.Michelson.Runtime.Import

Methods

build :: ValueReadError -> Builder

Generic helpers

data MichelsonSource

Where a contract or value in Michelson comes from.

Constructors

MSFile FilePath

From given file.

MSName Text

Only source name is known.

MSCode SrcLoc

Defined in Haskell code.

MSUnspecified

Some unknown source.

Bundled Patterns

pattern MSStdin :: MichelsonSource

Designates stdin source.

pattern MSCli :: MichelsonSource

Designates command line input source.

Instances

Eq MichelsonSource

Defined in Morley.Michelson.Parser.Types

Methods

(==) :: MichelsonSource -> MichelsonSource -> Bool

(/=) :: MichelsonSource -> MichelsonSource -> Bool

Show MichelsonSource

Defined in Morley.Michelson.Parser.Types

Methods

showsPrec :: Int -> MichelsonSource -> ShowS

show :: MichelsonSource -> String

showList :: [MichelsonSource] -> ShowS

IsString MichelsonSource

Defined in Morley.Michelson.Parser.Types

Methods

fromString :: String -> MichelsonSource

Buildable MichelsonSource

Defined in Morley.Michelson.Parser.Types

Methods

build :: MichelsonSource -> Builder

importUsing :: Exception e => (MichelsonSource -> Text -> Either e a) -> FilePath -> IO a

Read a thing from a file, using the provided parsing function.