Michelson.Typed.Instr

Module, containing data types for Michelson value.

Documentation

data Instr (inp :: [T]) (out :: [T]) where

Representation of Michelson instruction or sequence of instructions.

Each Michelson instruction is represented by exactly one constructor of this data type. Sequence of instructions is represented with use of Seq constructor in following way: SWAP; DROP ; DUP; -> SWAP Instr DROP Instr DUP. Special case where there are no instructions is represented by constructor Nop, e.g. IF_NONE {} { SWAP; DROP; } -> IF_NONE Nop (SWAP Instr DROP).

Type parameter inp states for input stack type. That is, type of the stack that is required for operation to execute.

Type parameter out states for output stack type or type of stack that will be left after instruction's execution.

Constructors

InstrWithNotes :: PackedNotes b -> Instr a b -> Instr a b

A wrapper for instruction that also contain annotations for the top type on the result stack.

As of now, when converting from untyped representation, we only preserve field annotations and type annotations. Variable annotations are not preserved.

This can wrap only instructions with at least one non-failing execution branch.

InstrWithVarNotes :: NonEmpty VarAnn -> Instr a b -> Instr a b

A wrapper for instruction with variable annotations.

FrameInstr :: forall a b s. (KnownList a, KnownList b) => Proxy s -> Instr a b -> Instr (a ++ s) (b ++ s)

Execute given instruction on truncated stack.

This can wrap only instructions with at least one non-failing execution branch.

Morley has no such instruction, it is used solely in eDSLs. This instruction is sound because for all Michelson instructions the following property holds: if some code accepts stack i and produces stack o, when it can also be run on stack i + s producing stack o + s; and also because Michelson never makes implicit assumptions on types, rather you have to express all "yet ambiguous" type information in code. We could make this not an instruction but rather a function which modifies an instruction (this would also automatically prove soundness of used transformation), but it occured to be tricky (in particular for TestAssert and DipN and family), so let's leave this for future work.

Seq :: Instr a b -> Instr b c -> Instr a c

Nop :: Instr s s

Nop operation. Missing in Michelson spec, added to parse construction like `IF {} { SWAP; DROP; }`.

Ext :: ExtInstr s -> Instr s s

Nested :: Instr inp out -> Instr inp out

Nested wrapper is going to wrap a sequence of instructions with { }. It is crucial because serialisation of a contract depends on precise structure of its code.

DocGroup :: DocGrouping -> Instr inp out -> Instr inp out

Places documentation generated for given instruction under some group. This is not part of ExtInstr because it does not behave like Nop; instead, it inherits behaviour of instruction put within it.

AnnCAR :: FieldAnn -> Instr (TPair a b ': s) (a ': s)

Variants of CAR/CDR to retain field annotations as they relate to the input stack, and hence won't be available from the annotation notes from the result stack we pack with the instructions during type check.

AnnCDR :: FieldAnn -> Instr (TPair a b ': s) (b ': s)

DROP :: Instr (a ': s) s

DROPN :: forall (n :: Peano) s. (SingI n, KnownPeano n, RequireLongerOrSameLength s n) => Sing n -> Instr s (Drop n s)

DUP :: Instr (a ': s) (a ': (a ': s))

SWAP :: Instr (a ': (b ': s)) (b ': (a ': s))

DIG :: forall (n :: Peano) inp out a. ConstraintDIG n inp out a => Sing n -> Instr inp out

DUG :: forall (n :: Peano) inp out a. ConstraintDUG n inp out a => Sing n -> Instr inp out

PUSH :: forall t s. ConstantScope t => Value' Instr t -> Instr s (t ': s)

SOME :: Instr (a ': s) (TOption a ': s)

NONE :: forall a s. SingI a => Instr s (TOption a ': s)

UNIT :: Instr s (TUnit ': s)

IF_NONE :: Instr s s' -> Instr (a ': s) s' -> Instr (TOption a ': s) s'

PAIR :: Instr (a ': (b ': s)) (TPair a b ': s)

LEFT :: forall b a s. SingI b => Instr (a ': s) (TOr a b ': s)

RIGHT :: forall a b s. SingI a => Instr (b ': s) (TOr a b ': s)

IF_LEFT :: Instr (a ': s) s' -> Instr (b ': s) s' -> Instr (TOr a b ': s) s'

NIL :: SingI p => Instr s (TList p ': s)

CONS :: Instr (a ': (TList a ': s)) (TList a ': s)

IF_CONS :: Instr (a ': (TList a ': s)) s' -> Instr s s' -> Instr (TList a ': s) s'

SIZE :: SizeOp c => Instr (c ': s) (Tc CNat ': s)

EMPTY_SET :: (Typeable e, SingI e) => Instr s (TSet e ': s)

EMPTY_MAP :: (Typeable a, Typeable b, SingI a, SingI b) => Instr s (TMap a b ': s)

EMPTY_BIG_MAP :: (Typeable a, Typeable b, SingI a, SingI b) => Instr s (TBigMap a b ': s)

MAP :: MapOp c => Instr (MapOpInp c ': s) (b ': s) -> Instr (c ': s) (MapOpRes c b ': s)

ITER :: IterOp c => Instr (IterOpEl c ': s) s -> Instr (c ': s) s

MEM :: MemOp c => Instr (Tc (MemOpKey c) ': (c ': s)) (Tc CBool ': s)

GET :: GetOp c => Instr (Tc (GetOpKey c) ': (c ': s)) (TOption (GetOpVal c) ': s)

UPDATE :: UpdOp c => Instr (Tc (UpdOpKey c) ': (UpdOpParams c ': (c ': s))) (c ': s)

IF :: Instr s s' -> Instr s s' -> Instr (Tc CBool ': s) s'

LOOP :: Instr s (Tc CBool ': s) -> Instr (Tc CBool ': s) s

LOOP_LEFT :: Instr (a ': s) (TOr a b ': s) -> Instr (TOr a b ': s) (b ': s)

LAMBDA :: forall i o s. Each [Typeable, SingI] [i, o] => Value' Instr (TLambda i o) -> Instr s (TLambda i o ': s)

EXEC :: Instr (t1 ': (TLambda t1 t2 ': s)) (t2 ': s)

APPLY :: forall a b c s. ConstantScope a => Instr (a ': (TLambda (TPair a b) c ': s)) (TLambda b c ': s)

DIP :: Instr a c -> Instr (b ': a) (b ': c)

DIPN :: forall (n :: Peano) inp out s s'. ConstraintDIPN n inp out s s' => Sing n -> Instr s s' -> Instr inp out

FAILWITH :: (Typeable a, SingI a) => Instr (a ': s) t

CAST :: forall a s. SingI a => Instr (a ': s) (a ': s)

RENAME :: Instr (a ': s) (a ': s)

PACK :: PackedValScope a => Instr (a ': s) (Tc CBytes ': s)

UNPACK :: UnpackedValScope a => Instr (Tc CBytes ': s) (TOption a ': s)

CONCAT :: ConcatOp c => Instr (c ': (c ': s)) (c ': s)

CONCAT' :: ConcatOp c => Instr (TList c ': s) (c ': s)

SLICE :: SliceOp c => Instr (Tc CNat ': (Tc CNat ': (c ': s))) (TOption c ': s)

ISNAT :: Instr (Tc CInt ': s) (TOption (Tc CNat) ': s)

ADD :: (ArithOp Add n m, Typeable n, Typeable m) => Instr (Tc n ': (Tc m ': s)) (Tc (ArithRes Add n m) ': s)

SUB :: (ArithOp Sub n m, Typeable n, Typeable m) => Instr (Tc n ': (Tc m ': s)) (Tc (ArithRes Sub n m) ': s)

MUL :: (ArithOp Mul n m, Typeable n, Typeable m) => Instr (Tc n ': (Tc m ': s)) (Tc (ArithRes Mul n m) ': s)

EDIV :: EDivOp n m => Instr (Tc n ': (Tc m ': s)) (TOption (TPair (Tc (EDivOpRes n m)) (Tc (EModOpRes n m))) ': s)

ABS :: UnaryArithOp Abs n => Instr (Tc n ': s) (Tc (UnaryArithRes Abs n) ': s)

NEG :: UnaryArithOp Neg n => Instr (Tc n ': s) (Tc (UnaryArithRes Neg n) ': s)

LSL :: (ArithOp Lsl n m, Typeable n, Typeable m) => Instr (Tc n ': (Tc m ': s)) (Tc (ArithRes Lsl n m) ': s)

LSR :: (ArithOp Lsr n m, Typeable n, Typeable m) => Instr (Tc n ': (Tc m ': s)) (Tc (ArithRes Lsr n m) ': s)

OR :: (ArithOp Or n m, Typeable n, Typeable m) => Instr (Tc n ': (Tc m ': s)) (Tc (ArithRes Or n m) ': s)

AND :: (ArithOp And n m, Typeable n, Typeable m) => Instr (Tc n ': (Tc m ': s)) (Tc (ArithRes And n m) ': s)

XOR :: (ArithOp Xor n m, Typeable n, Typeable m) => Instr (Tc n ': (Tc m ': s)) (Tc (ArithRes Xor n m) ': s)

NOT :: UnaryArithOp Not n => Instr (Tc n ': s) (Tc (UnaryArithRes Not n) ': s)

COMPARE :: (Comparable n, Typeable n, SingI n) => Instr (n ': (n ': s)) (Tc CInt ': s)

EQ :: UnaryArithOp Eq' n => Instr (Tc n ': s) (Tc (UnaryArithRes Eq' n) ': s)

NEQ :: UnaryArithOp Neq n => Instr (Tc n ': s) (Tc (UnaryArithRes Neq n) ': s)

LT :: UnaryArithOp Lt n => Instr (Tc n ': s) (Tc (UnaryArithRes Lt n) ': s)

GT :: UnaryArithOp Gt n => Instr (Tc n ': s) (Tc (UnaryArithRes Gt n) ': s)

LE :: UnaryArithOp Le n => Instr (Tc n ': s) (Tc (UnaryArithRes Le n) ': s)

GE :: UnaryArithOp Ge n => Instr (Tc n ': s) (Tc (UnaryArithRes Ge n) ': s)

INT :: Instr (Tc CNat ': s) (Tc CInt ': s)

SELF :: forall (arg :: T) s. ParameterScope arg => SomeEntryPointCallT arg -> Instr s (TContract arg ': s)

CONTRACT :: ParameterScope p => Notes p -> EpName -> Instr (Tc CAddress ': s) (TOption (TContract p) ': s)

TRANSFER_TOKENS :: ParameterScope p => Instr (p ': (Tc CMutez ': (TContract p ': s))) (TOperation ': s)

SET_DELEGATE :: Instr (TOption (Tc CKeyHash) ': s) (TOperation ': s)

CREATE_CONTRACT :: (ParameterScope p, StorageScope g) => FullContract p g -> Instr (TOption (Tc CKeyHash) ': (Tc CMutez ': (g ': s))) (TOperation ': (Tc CAddress ': s))

IMPLICIT_ACCOUNT :: Instr (Tc CKeyHash ': s) (TContract TUnit ': s)

NOW :: Instr s (Tc CTimestamp ': s)

AMOUNT :: Instr s (Tc CMutez ': s)

BALANCE :: Instr s (Tc CMutez ': s)

CHECK_SIGNATURE :: Instr (TKey ': (TSignature ': (Tc CBytes ': s))) (Tc CBool ': s)

SHA256 :: Instr (Tc CBytes ': s) (Tc CBytes ': s)

SHA512 :: Instr (Tc CBytes ': s) (Tc CBytes ': s)

BLAKE2B :: Instr (Tc CBytes ': s) (Tc CBytes ': s)

HASH_KEY :: Instr (TKey ': s) (Tc CKeyHash ': s)

STEPS_TO_QUOTA :: Instr s (Tc CNat ': s)

SOURCE :: Instr s (Tc CAddress ': s)

SENDER :: Instr s (Tc CAddress ': s)

ADDRESS :: Instr (TContract a ': s) (Tc CAddress ': s)

CHAIN_ID :: Instr s (TChainId ': s)

Instances

IsoValue Operation

Defined in Michelson.Typed.Haskell.Value

Associated Types

type ToT Operation :: T

Methods

toVal :: Operation -> Value (ToT Operation)

fromVal :: Value (ToT Operation) -> Operation

TypeHasDoc Operation

Defined in Michelson.Typed.Haskell.Doc

Methods

typeDocName :: Proxy Operation -> Text

typeDocMdDescription :: Markdown

typeDocMdReference :: Proxy Operation -> WithinParens -> Markdown

typeDocDependencies :: Proxy Operation -> [SomeTypeWithDoc]

typeDocHaskellRep :: TypeDocHaskellRep Operation

typeDocMichelsonRep :: TypeDocMichelsonRep Operation

Eq (Instr inp out)

Defined in Michelson.Typed.Convert

Methods

(==) :: Instr inp out -> Instr inp out -> Bool

(/=) :: Instr inp out -> Instr inp out -> Bool

Show (Instr inp out)

Defined in Michelson.Typed.Instr

Methods

showsPrec :: Int -> Instr inp out -> ShowS

show :: Instr inp out -> String

showList :: [Instr inp out] -> ShowS

Semigroup (Instr s s)

Defined in Michelson.Typed.Instr

Methods

(<>) :: Instr s s -> Instr s s -> Instr s s

sconcat :: NonEmpty (Instr s s) -> Instr s s

stimes :: Integral b => b -> Instr s s -> Instr s s

Monoid (Instr s s)

Defined in Michelson.Typed.Instr

Methods

mempty :: Instr s s

mappend :: Instr s s -> Instr s s -> Instr s s

mconcat :: [Instr s s] -> Instr s s

NFData (Instr inp out)

Defined in Michelson.Typed.Instr

Methods

rnf :: Instr inp out -> ()

(SingI t, HasNoOp t) => Buildable (Value' Instr t)

Defined in Michelson.Typed.Convert

Methods

build :: Value' Instr t -> Builder

type ToT Operation

Defined in Michelson.Typed.Haskell.Value

type ToT Operation = TOperation

data ExtInstr s

Constructors

TEST_ASSERT (TestAssert s)

PRINT (PrintComment s)

DOC_ITEM SomeDocItem

Instances

Show (ExtInstr s)

Defined in Michelson.Typed.Instr

Methods

showsPrec :: Int -> ExtInstr s -> ShowS

show :: ExtInstr s -> String

showList :: [ExtInstr s] -> ShowS

data StackRef (st :: [T]) where

A reference into the stack of a given type.

Constructors

StackRef :: (KnownPeano idx, SingI idx, RequireLongerThan st idx) => Sing (idx :: Peano) -> StackRef st

Keeps 0-based index to a stack element counting from the top.

Instances

Eq (StackRef st)

Defined in Michelson.Typed.Instr

Methods

(==) :: StackRef st -> StackRef st -> Bool

(/=) :: StackRef st -> StackRef st -> Bool

Show (StackRef st)

Defined in Michelson.Typed.Instr

Methods

showsPrec :: Int -> StackRef st -> ShowS

show :: StackRef st -> String

showList :: [StackRef st] -> ShowS

mkStackRef :: forall (gn :: Nat) st n. (n ~ ToPeano gn, SingI n, KnownPeano n, RequireLongerThan st n) => StackRef st

Create a stack reference, performing checks at compile time.

newtype PrintComment (st :: [T])

A print format with references into the stack

Constructors

PrintComment

Fields

• unPrintComment :: [Either Text (StackRef st)]

Instances

Eq (PrintComment st)

Defined in Michelson.Typed.Instr

Methods

(==) :: PrintComment st -> PrintComment st -> Bool

(/=) :: PrintComment st -> PrintComment st -> Bool

Show (PrintComment st)

Defined in Michelson.Typed.Instr

Methods

showsPrec :: Int -> PrintComment st -> ShowS

show :: PrintComment st -> String

showList :: [PrintComment st] -> ShowS

IsString (PrintComment st)

Defined in Michelson.Typed.Instr

Methods

fromString :: String -> PrintComment st

Generic (PrintComment st)

Defined in Michelson.Typed.Instr

Associated Types

type Rep (PrintComment st) :: Type -> Type

Methods

from :: PrintComment st -> Rep (PrintComment st) x

to :: Rep (PrintComment st) x -> PrintComment st

Semigroup (PrintComment st)

Defined in Michelson.Typed.Instr

Methods

(<>) :: PrintComment st -> PrintComment st -> PrintComment st

sconcat :: NonEmpty (PrintComment st) -> PrintComment st

stimes :: Integral b => b -> PrintComment st -> PrintComment st

Monoid (PrintComment st)

Defined in Michelson.Typed.Instr

Methods

mempty :: PrintComment st

mappend :: PrintComment st -> PrintComment st -> PrintComment st

mconcat :: [PrintComment st] -> PrintComment st

type Rep (PrintComment st)

Defined in Michelson.Typed.Instr

type Rep (PrintComment st) = D1 (MetaData "PrintComment" "Michelson.Typed.Instr" "morley-1.0.0-Jo9z4xumEmKBIsSgg9Z0MH" True) (C1 (MetaCons "PrintComment" PrefixI True) (S1 (MetaSel (Just "unPrintComment") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Either Text (StackRef st)])))

data TestAssert (s :: [T]) where

Constructors

TestAssert :: Typeable out => Text -> PrintComment inp -> Instr inp (Tc CBool ': out) -> TestAssert inp

Instances

Typeable s => Eq (TestAssert s)

Defined in Michelson.Typed.Convert

Methods

(==) :: TestAssert s -> TestAssert s -> Bool

(/=) :: TestAssert s -> TestAssert s -> Bool

Show (TestAssert s)

Defined in Michelson.Typed.Instr

Methods

showsPrec :: Int -> TestAssert s -> ShowS

show :: TestAssert s -> String

showList :: [TestAssert s] -> ShowS

type Contract cp st = Instr (ContractInp cp st) (ContractOut st)

data FullContract cp st

Typed contract and information about annotations which is not present in the contract code. TODO [#12]: rename this to Contract and the current Contract to ContractCode?

Constructors

(ParameterScope cp, StorageScope st) => FullContract

Fields

• fcCode :: Contract cp st
• fcParamNotesSafe :: ParamNotes cp
• fcStoreNotes :: Notes st

Instances

Show (FullContract cp st)

Defined in Michelson.Typed.Instr

Methods

showsPrec :: Int -> FullContract cp st -> ShowS

show :: FullContract cp st -> String

showList :: [FullContract cp st] -> ShowS

fcParamNotes :: FullContract cp st -> Notes cp

mapFullContractCode :: (Contract cp st -> Contract cp st) -> FullContract cp st -> FullContract cp st

pattern CAR :: Instr (TPair a b ': s) (a ': s)

pattern CDR :: Instr (TPair a b ': s) (b ': s)

data PackedNotes a where

A wrapper to wrap annotations and corresponding singleton. Apart from packing notes along with the corresponding Singleton, this wrapper type, when included with Instr also helps to derive the Show instance for Instr as `Sing a` does not have a Show instance on its own.

Constructors

PackedNotes :: Notes a -> Sing a -> PackedNotes (a ': s)

Instances

Show (PackedNotes a)

Defined in Michelson.Typed.Instr

Methods

showsPrec :: Int -> PackedNotes a -> ShowS

show :: PackedNotes a -> String

showList :: [PackedNotes a] -> ShowS

type ConstraintDIPN n inp out s s' = ConstraintDIPN' T n inp out s s'

type ConstraintDIPN' kind (n :: Peano) (inp :: [kind]) (out :: [kind]) (s :: [kind]) (s' :: [kind]) = (SingI n, KnownPeano n, RequireLongerOrSameLength inp n, (Take n inp ++ s) ~ inp, (Take n inp ++ s') ~ out)

Constraint that is used in DIPN, we want to share it with typechecking code and eDSL code.

type ConstraintDIG n inp out a = ConstraintDIG' T n inp out a

type ConstraintDIG' kind (n :: Peano) (inp :: [kind]) (out :: [kind]) (a :: kind) = (SingI n, KnownPeano n, RequireLongerThan inp n, inp ~ (Take n inp ++ (a ': Drop (S n) inp)), out ~ (a ': (Take n inp ++ Drop (S n) inp)))

type ConstraintDUG n inp out a = ConstraintDUG' T n inp out a

type ConstraintDUG' kind (n :: Peano) (inp :: [kind]) (out :: [kind]) (a :: kind) = (SingI n, KnownPeano n, RequireLongerThan out n, inp ~ (a ': Drop (S Z) inp), out ~ (Take n (Drop (S Z) inp) ++ (a ': Drop (S n) inp)))