Michelson.Runtime.Import

Read, parse, typecheck contract

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

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

readSomeContract :: FilePath -> Text -> Either ImportContractError SomeContract

Purely read a typed contract from Michelson textual representation.

readUntypedContract :: FilePath -> Text -> Either ImportContractError 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 ImportContractError.

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 ImportContractError.

data ImportContractError

Error type for importContract function.

Constructors

ICEParse FilePath ParserException

ICETypeCheck FilePath TCError

Instances

Eq ImportContractError

Defined in Michelson.Runtime.Import

Methods

(==) :: ImportContractError -> ImportContractError -> Bool

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

Show ImportContractError

Defined in Michelson.Runtime.Import

Methods

showsPrec :: Int -> ImportContractError -> ShowS

show :: ImportContractError -> String

showList :: [ImportContractError] -> ShowS

Exception ImportContractError

Defined in Michelson.Runtime.Import

Methods

toException :: ImportContractError -> SomeException

fromException :: SomeException -> Maybe ImportContractError

displayException :: ImportContractError -> String

Buildable ImportContractError

Defined in Michelson.Runtime.Import

Methods

build :: ImportContractError -> Builder

Read, parse, typecheck value

readValue :: forall t. SingI t => FilePath -> Text -> Either ImportValueError (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 ImportValueError

Error type for importValue function.

Constructors

IVEParse FilePath ParserException

IVETypeCheck FilePath TCError

Instances

Eq ImportValueError

Defined in Michelson.Runtime.Import

Methods

(==) :: ImportValueError -> ImportValueError -> Bool

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

Show ImportValueError

Defined in Michelson.Runtime.Import

Methods

showsPrec :: Int -> ImportValueError -> ShowS

show :: ImportValueError -> String

showList :: [ImportValueError] -> ShowS

Exception ImportValueError

Defined in Michelson.Runtime.Import

Methods

toException :: ImportValueError -> SomeException

fromException :: SomeException -> Maybe ImportValueError

displayException :: ImportValueError -> String

Buildable ImportValueError

Defined in Michelson.Runtime.Import

Methods

build :: ImportValueError -> Builder

Generic helpers

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

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