Changelog for morley-1.20.0

1.20.0

!1364 Update to LTS-21.4 (GHC 9.4.5)
!1358 Make missing Generic errors more readable
!1356 Optimize SizedList Monad instance
- Avoid unnecessary traversals
- Make SizedList lazy in both head and tail
!1367 Replace HaveCommonTypeCtor class with a type family
!1368 Remove deprecated types and functions

1.19.2

!1365 Split optimizer module
- More utilities for writing rules are now exported from Morley.Michelson.Optimizer.Utils;
- Fixed a bug with missing pattern in the Buildable OptimizationStage instance.
!1352 Clean-up Buildable ExecutorOp implementation
- Add Buildable instances for OriginationOperation, TransferOperation, SetDelegateOperation, EmitOperation;
- Rewrite Buildable ExecutorOp to delegate to these new instances.
!1357 Better tests for PACK
- Fix an issue when untyping CREATE_CONTRACT instruction -- morley would always use Readable representation for its contents;
- Fix an issue in typechecking CREATE_CONTRACT instruction -- morley SELF inside CREATE_CONTRACT inside lambdas was rejected.
!1349 Improve morley compilation time
- Forbid* constraints are no longer carried as superclasses of Comparable. Match on comparableImplies to bring those into scope. In case of impossible patterns, empty case with checkComparability should do the trick.
!1351 Fix and improve Buildable MichelsonFailureWithStack
!1346 Use proper datatype for Micheline primitives, refactor some FromExp instances
- Replace a list of strings with a proper datatype for Micheline primitives
- Refactor FromExp instances to make pattern-matches (more) total and reduce redundancy
- Make FromExp exceptions more structured
- Other minor refactoring
!1342 Replace fmt with prettyprinter
- Introduce overlappable Buildable instance for anything RenderDoc to avoid proliferation of trivial instances
- Deprecate buildRenderDoc and buildRenderDocExtended
- Replace unnecessary RenderDoc instances with Buildable (this refers to various error types)
- printDoc, printDocB, printDocS deprecated in favor of printRenderDoc
- Redundant forceSingleLine parameter to renderType removed
- Obsolete Prettier newtype deprecated
- Improve NotWellTyped error formatting
- Improve formatting for Buildable ExecutorOp
!1347 Better errors for missing contract fields
- Improve efficiency when constructing untyped contract from list of contract blocks
- Rename UnsafeViewsSet to ViewsSet, as there's nothing inherently unsafe about this constructor any more (old name is left as a pattern synonym, but deprecated)
!1343 Fix optimizer dipSwapDrop regression
- Fixed a bug where DIP n code would be deoptimized into DIP (n - 1) { SWAP; code }
- While at it, DUP; DUG (m + 1); DROP is now optimized to DUG m
!1344 Typecheck recursive lambda values
!1323 Trace called contracts on error
- Trace operations in the Morley emulator
!1310 Various parser fixes
- Make parser stricter wrt braces around code blocks. Now things like DIP DROP are rejected (as per reference), but DIP FAIL are allowed (as FAIL is a macro)
- Properly handle braced code blocks in typechecker's verbose error messages
- Use optimized untyped contract representation in toExpression
- Fix macro expansion rules to match reference; add macro expansion tests against reference
!1341 Refactor scope constraints
- Unified all check*Presence functions into checkTPresence
- Unified all *Absense (sic) and check*Presence into tAbsence and tPresence
- Unified all Contains* type families, plus IsComparable into ContainsT
- All now-redundant synonyms are deprecated
- Deprecate HasNo* and Proper*BetterErrors in favor of Forbid* and *Scope respectively.
- Simplify WithDeMorganScope
- Avoid unnecessary singleton traversals using checkTPresence, remove where possible, use de Morgan laws otherwise.
- Improve Forbid* error messages
- Improve *Scope error messages with the suggestion to add the corresponding scope constraint
- Improve error messages on stuck type families with Forbid* and *Scope
- Drop redundant uses of (:-) implication in AsRPC, use constraints explicitly
!1293 Add extensible metadata field to StkEl
!1335 Include morley CLI commands with morley-client
- Moved morley CLI parser and REPL to library under Morley.App
!1333 Improve typechecker error rendering
- Switched to prettyprinter from wl-pprint-text
- Introduced Morley.Michelson.Printer.Compat as a thin compatibility layer
!1336 Improve non-recursive deriveRPC errors
- Print human-readable error messages when required HasRPCRepr instances are missing in non-recursive mode (i.e. droRecursive=False)
!1340 Remove deprecated types and functions
- haskellRepStripFieldPrefix
- Morley.Michelson.Typed.Contract.mapEntriesOrdered
- Morley.Michelson.Untyped.Contract.mapContractCode
- linearizeRightCombValuePair
- expandList
- (|-)
- MockableConstraint and unsafeProvideConstraint
- failUnlessEvi
- failWhenEvi
- ConcatListOfTypesAssociativity and listOfTypesConcatAssociativityAxiom

1.19.1

!1325 Add AND, NOT, OR, XOR, LSL and LSR operations support on bytes
!1326 Add support for bytes to nat and int conversions
- Support NAT and BYTES instructions, and the new operands to INT instruction.
!1331 Support implicit account tickets
- New emulate transfer-ticket CLI command
- Add CheckScope instance for constraint pairs
!1330 Support ticket balance queries in morley-client and Cleveland.
- Add HasCLReader instance for Ty.
!1328 Kill support for TORUs, minimal sr1 address support, tz4 address support
- txr1 addresses and tx_rollup_l2_address are no longer parsable;
- sr1 addresses can be parsed and typechecked, but sending transfers to sr1 is not yet supported in the Morley runtime;
- Full support for tz4 addresses.
!1322 Various optimizer improvements
- Reapply optimizer stages until fixpoint (up to a configurable maximum of iterations);
- Rework optimizer ruleset architecture;
- Drop Meta and WithLoc during optimization;
- Apply dipDrop2swapDrop in a separate stage;
- More complete optimization for DROPN, PAIRN, UNPAIRN, DIPN and nested DIPs;
- Optimize DIG 1 and DUG 1 to SWAP;
- Optimize NOT; IF a b to IF b a;
- The last one requires carrying SingI constraint on the argument of NOT, so do that.
!1298 Handle view ordering properly
- Also deprecates some unused functions and cleans up macro expansion code
- Specifically, typed mapEntriesOrdered; mapContractCode, and expandList are deprecated
!1313 Generalize ceContracts to a function
- Allows performing arbitrary actions to fetch contracts
- ContractEnv is now parametrized by the interpreter monad
- As a side effect, interpreter monad needs to be a newtype now
!1315 Slightly generalize L1AddressKind type synonym
!1295 Replace FrameInstr with a function
- Also:
- Move instruction constraints to Morley.Michelson.Typed.Instr.Constraints;
- Add utilities for stubbing proofs;
- Deprecate unused and unsafe things: (|-), failUnlessEvi, failWhenEvi, unsafeProvideConstraint, listOfTypesConcatAssociativityAxiom;
- General cleanup.
!1312 Add WellTyped constraint to sampleTypedValue
!1311 Add missing HasCLReader instances for address types
!1309 Don't render untyped pairs as sequences
!1308 Improve contract rendering
- If the type fits into the column width, print it in one line.
- If it doesn't, print arguments on separate lines with indent 2.
- For types with very short prefix before arguments, render the first argument on the current line, and align all the rest with the first.
- Apply the same basic rules to instructions and on-chain views.
!1182 Add metaWrapper to ContractEnv which build a wrapper attaching Meta and WithLoc along the way. This wrapper the is used when it meets loop instruction.
!1305 Add a recommendation to morley's README.md for the user to include the extra-deps if they have difficulty building morley.
!1299 Fix recursive deriveRPC for Address, Lorentz Hash and other types with phantom arguments.
!1239 Give Seq a fixity declaration
- The same as :#, i.e. infixr 8.
!1235 Make it easier to have consistent field naming between HasAnnotation and TypeHasDoc
- Move all casing manipulation to Morley.Util.Text.
- Use new casing manipulation functions everywhere.
- Introduce TypeHasFieldNamingStrategy -- a typeclass with a catchall overlappable instance, which defines the strategy to use. Strategy being a function Text -> Text modifying field names.
- Require TypeHasFieldNamingStrategy constraint in the default implementation of typeDocHaskellRep. Apply the strategy as appropriate.
- See also the corresponding lorentz changelog.
!1280 Export everything from internal modules
- That includes Morley.Micheline.Binary.Internal and Morley.Util.Interpolate.Internal.
!1264 Add view calling to morley runtime and CLI (plus some chores)
- Add HasCLReader ViewName instance
- Refactor Morley.Michelson.Runtime interface to reduce the number of arguments functions take in favor of records and/or Named arguments.
- Refactor Morley.Michelson.Interpret, replacing InterpretResult/ContractReturn system with ResultStateLogs and a hierarchy of synonyms built on top. See this commit description for more information.
- As a chore, add Default instance for Named parameters, so that def can be used in place of Named.defaults.

1.19.0

!1273 Add LAMBDA_REC and Lambda_rec support
- Typed instructions AnnLAMBDA and newly introduced AnnLAMBDA_REC do not carry VLam any more, instead they carry RemFail directly.
- New data type LambdaCode' introduced, with two constructors, for plain and recursive lambdas, respecively.
- VLam now contains LambdaCode' instead of RemFail.
- New function mkVLamRec for constructing recursive lambda values introduced.
!1278 Deprecate OPEN_CHEST, related types and values
!1281 Use the new binaries names, octez-client and octez-node
!1270 Add lima protocol TICKET instruction, rename old one to TICKET_DEPRECATED
- The TICKET instruction was renamed to TICKET_DEPRECATED
- A new TICKET instruction was added which no longer allows zero amount tickets. It now returns Some Ticket and None in case of zero amount supplied.
!1288 Fix toExpression in nested right pair combs with variable annotations
- Conversion to Micheline would lose variable annotations on nested right pair combs. This issue has been fixed.
!1271 Deprecate AssertTypesEqual
- Use FailUnlessEqual instead.
!1193 Use nest from Text.PrettyPrint.Leijen in instructions rendering instead of Morley.Michelson.Printer.Util.spaces
!1265 Add parser for ConstrainedAddress parseConstrainedAddress
- Better address parser error reporting
- Added FromJSON instance for ConstrainedAddress
!1248 Add HasAnnotation deriving to deriveRPC
- New datatype Morley.AsRPC.DeriveRPCOptions
- New helper Morley.AsRPC.deriveRPCWithOptions
- deriveRPCWithStrategy, deriveManyRPC, deriveManyRPCWithStrategy are deprecated in favor of deriveRPCWithOptions
- deriveRPC now behaves as deriveManyRPC, and additionally tries to derive HasAnnotation. It will error out if HasAnnotation is not in scope.
!1258 Support implicit delegation in interpreter
- Reworked delegate tracking in morley interpreter.
- Added unImplicitAddress :: ImplicitAddress -> KeyHash utility to Morley.Tezos.Address.
!1188 Straighten out detSecretKey's behavior
- Add Morley.Tezos.Crypto.KeyType enum type encoding secret/public key type.
- Refactor HashTag to use KeyType.
- detSecretKey now chooses key type based on the seed, not seed length.
- Add detSecretKey' allowing to choose what key type to use.
!1230 Fix secp256k1 signatures
- Roughly half of all secp256k1 created by Morley were rejected by network due to an implementation mismatch. This has been fixed.
!1260 Refactor SomeAddressOrAlias
- Changed the definition of SomeAddressOrAlias to be able to parse address/aliases of a contract, implicit account, or both. A prefix of implicit: or contract: can be used to disambiguate.
- Changed the parser of AddressOrAlias kind to accept the implicit: and contract: prefixes.
- Replaced the morley transfer --to-implicit and --to-contract options with a single --to option.
!1255 Simplify some machinery using instances from some
!1138 Generalize typechecking to work with arbitrary instruction wrapper instead of ExpandedOp.
- Renames:
  - TcInstrHandler to TcInstr;
  - typeCheckOpImpl to typeCheckExpandedOp;
  - TCError to TcError and TCTypeError to TcTypeError;
  - SomeInstr to SomeTcInstr;
- Some functions/types (TCError, typeCheck*) now have primed (') versions that are generalized over ExpandedOp. Those functions now accept the typechecker for ExpandedOp.
!1240 Add MichelsonExt to MichelsonFailed to allow extensible failure.
!1206 Add tupleFromRec
!1243 Add run_code emulation to Morley
- Morley.Michelson.Runtime now provides runCode function, mimicing the functionality of RPC run_code endpoint
!1241 Add classified typed instruction machinery
- See Morley.Michelson.Typed.ClassifiedInstr haddocks for more information.
!1242 Add Constrained utility existential
- New utility module Morley.Util.Constrained introduced, defining an existential Constrained, similar to Some from some, but capturing additional constraints on the GADT argument
- ConstrainedAddress reimplemented in terms of Constrained
- MkConstrainedAddress kept as a pattern synonym, but deprecated
- Types and pattern synonyms from Morley.Michelson.Typed.Existential reimplemented in terms of Constrained
!1245 Remove Guard from Morley.Util.Type
- See #865 for an alternative
!1237 Track delegate registration in interpreter
!1178 Add HasNoNestedBigMaps t constraint to WellTyped requirement for Contract t.
- This is indirectly enforced by the network, but was missing. Useful to avoid redundant checks.
!1228 Handle implicit default entrypoint in mkEntrypointsMap
- Add a new enum type HandleImplicitDefaultEp to signal how to handle implicit default entrypoint.
- Change mkEntrypointsMap to accept HandleImplicitDefaultEp as its first argument. The old behaviour corresponds to calling it with WithoutImplicitDefaultEp.
- Change flattenEntrypoints to accept HandleImplicitDefaultEp, similar to mkEntrypointsMap.
!1195 Improve Forbid constraints to carry type equality evidence
!1222 Change the constraints on instrCase in Morley.Michelson.Typed.Haskell.Instr.Sum and on instrConstruct, instrConstructStack, and instrDeconstruct in Morley.Michelson.Typed.Haskell.Instr.Product. Code using these functions in surprisingly polymorphic ways may need minor adjustments. Applications of these functions should now be faster to typecheck and also faster to run.
!1216 Add LazyTake, a "lazier" version of Take
- Use LazyTake to improve type inference for various functions.
- Rearrange ConstraintDIG' and ConstraintDUG' to reveal a bidirectional functional dependency.
- Remove the KnownList inp constraint from ConstraintDig'.
!1215 Output values associated with operations in emulate transfer etc
!1198 Add equalities to ConstraintDIPN' to offer more fundeps.

1.18.0

!1212 Implement EMIT and other Kathmandu changes
- Update michelson primitives for the new protocol
- Add support for parsing/typechecking/serializing EMIT instruction
- Support EMIT on the emulator
!1202 Make error messages less confusing when types are ambiguous.
- Use FailUnless and similar rather than If to reduce the prevalence of confusing type errors.
- Remove TypeErrorUnless in favor of FailUnless.
!1207 Rename our custom SingI1 to SingIOne to avoid confusion with singletons, remove its method, and reduce it to just one polymorphic instance.
!1203 Remove Morley.Util.Type.reifyTypeEquality
!1185 Refactor typechecker monad
!1192 Refactor aliases storage in Cleveland
- Added Morley.Util.Bimap.Bimap
- Changed the type of GState.gsImplicitAddressAliases to Bimap ImplicitAlias Address
- Changed the type of GState.gsContractAddressAliases to Bimap ContractAlias Address
- Deleted GSAddImplicitAddressAlias
!1177 Distinguish implicit/contract aliases and addresses on the type level
!1190 Remove some SingI constraints from some WithDeMorganScope instances.
!1186 Make ITER{FAILWITH;} typecheck
!1176 Render Michelson values on multiple lines
!1168 Support a mix of RPC and non-RPC representations in runCode
- Deleted WellTypedIsoValue
- Added IsoValue constraint to WellTypedToT, HasNoOpToT, HasNoBigMapToT, KnownIsoT.
- Added typeCheckValueRunCodeCompat to simulate the typechecking behavior of the tezos RPC's run_code endpoint.
- Changed the return type of typeCheckValue from TypeCheckInstr to TypeCheckResult.
- Delete runTypeCheckInstrIsolated
- Restrict the type of runTypeCheckIsolated
- Delete MaybeRPC
!1137 Support a delimiting but otherwise empty escape \& in Morley.Util.Interpolate
!1175 Use tagged decoder for Address

1.17.0

!1173 Typechecker fixes
- Remove unused TypeCheckPack typechecker mode
- Do not throw error in the typechecker
- Set typecheck mode in typeCheckValue (don't accept SELF inside a pushed lambda)
- Hotfix: Give IsNotInView in TypeCheckTest mode (fix morley repl confusingly complaining about views)
!1123 Remove deprecated exports
!1161 Remove support for AliasHint
!1169 Support MIN_BLOCK_TIME instruction
- Add MIN_BLOCK_TIME typed and untyped instructions.
- MIN_BLOCK_TIME accepts any number of any annotations, introduce AnyAnn type for arbitrary annotations.
- Remove unused SomeAnn and SomeTag.
- Add ceMinBlockTime to ContractEnv and eeMinBlockTime to ExecutorEnv.
- Add a corresponding CLI option.
!1166 Support transaction rollup jakarta changes.
- Refactor address hash parsing/printing.
  - HashKind datakind introduced;
  - KeyHash and ContractHash are replaced by Hash (a :: HashKind),
  - KeyHashTag replaced by HashTag (a :: HashKind);
  - KeyHash, KeyHashTag and ContractHash compatibility type synonyms introduced,
  - formatKeyHash, mformatKeyHash, parseKeyHash, parseKeyHashRaw, keyHashLengthBytes are renamed to formatHash, mformatHash, parseHash, hashLengthBytes, respectively,
  - contractHashLengthBytes, formatContractHash, parseContractHash are removed (use generic hashLengthBytes, formatHash and parseHash)
  - Use Hash HashContract instead of ContractHash pattern/constructor.
- Add typechecking support for tx_rollup_l2_address Michelson type.
  - TxRollupL2Address type introduced, isomorphic to tx_rollup_l2_address.
  - HashBLS hash kind introduced; KeyHashL2 convenience type synonym introduced.
- Add parsing/printing for tz4 addresses.
- Add typechecking support and parsing/printing for txr1 addresses.
  - TransactionRollupAddress data constructor for Address is introduced;
  - HashKindTxRollup hash kind and TxRollupHash type synonym introduced.
- NB: emulator support for transaction rollups is not yet implemented.
!1167 Adjust to sapling changes in jakarta
- Update the type of the SAPLING_VERIFY_UPDATE instruction.
- Reject contracts with the sapling_transaction_deprecated type.
- Support deserializing the SAPLING_EMPTY_STATE, SAPLING_VERIFY_UPDATE, OPEN_CHEST instructions.
- Fix bug in the deserialization of the sapling_transaction type.
!1158 Refactor (out) annotation checking support
- Ignore annotations in the morley typechecker
- All typed instructions have AnnINSTR constructor, accepting a list of annotations, and a pattern synonym INSTR that ignores annotations.
- InstrWithVarAnns, InstrWithNotes, InstrWithVarNotes pseudo-constructors removed.
- (::&+) pattern synonym removed
- AnnConvergeError, converge, convergeAnns, convergeDestrAnns, deriveSpecialVN, deriveSpecialFNs, deriveVN, deriveNsOr, deriveNsOption, convergeHSTEl, convergeHST, hstToTs, matchHST1, onTypeCheckInstrAnnErr, matchTypes, WithAnn pattern, orAnn, unifyAnn, unifyPairFieldAnn, convergeVarAnns, ifAnnUnified, convAnn, starNotesStkEl, matchTypes removed.
- SomeAnns and instrAnns utility functions to extract annotations of an instruction added.
- Optimizations will now strip annotations.
!1160 Forbid parameter prefix root annotations
!1163 Prohibit some operations in views
- New class IsNotInView, which is conjured into existence where appropriate.
- ContractCode is now a newtype wrapper instead of type synonym; this is required to avoid accidentally pasting contract code in views.
- New "smart" constructors mkContractCode and mkVLam which conjure IsNotInView constraint (mkLam is needed because operations forbidden in views are allowed in lambdas inside views)
!1088 Add options to specify convenient human-readable contract names for originate, transfer commands in Morley CLI.
!1153 Remove 'OpSize' modules.
!1139 Various small improvements.
- Export eqInstrExt.
- Add ConcreteMeta pattern synonym.
!1114 Update to ghc-9.0.2
!1108 Remove support for the deprecated morley extensions
!1148 Fix deriveRPC's call to customGeneric' so that field ordering is maintained
!1141 Forbid transfers from empty sender on emulator
- This brings the emulator into closer correspondence with the network
- New ExecutorError constructor, EEEmptyImplicitContract.
!1131 Make dfsTraverseValue parameterized by DfsSettings
!1130 Fix deriveRPCWithStrategy on data with type variables

1.16.4

!1135 Use DeriveLift instead of th-lift deriving.
!1017 Resolve some TODOs and link TODOs without issue id to the corresponding gitlab tickets.
!1082 Fix/drop/comment noncanonical Show instances
!1115 Add better error messages when typechecking sapling values.

1.16.3

!1113 Remove uses of Parser LetEnv due to redundant constraint.
!1092 Add quasiquoter for Notes t
!1094 Deprecate morley language extensions
- Morley language extensions now require --deprecated-morley-extensions flag to parse.
- AST constructors corresponding to the Morley language extensions are deprecated
- Functions for parsing Michelson with Morley extensions are added and marked as deprecated: parseContractExt, parseExpandContractExt, readAndParseContractExt, prepareContractExt.
!1100 Support MAP instruction over option type
- Add instance SingI1 'TOption
- Add instance MapOp ('TOption e)
!1084 Switch to the new mutez subtraction operation
!1107 Fix redundant SDecide Nat constraint warning
!1099 Update utils for Instr type further.
- CtorEffectsApp is now applied to the leaves in the Instr tree.
!1083 Add typechecking and better errors for sapling
!965 Add fixed-size lists to Morley
- Add Morley.Util.SizedList introducing Peano-based fixed-size homogenous lists.
- Use SizedList for genesisAddressN.
- Use SizedList to simplify Morley.Util.Interpolate.
- Add instance ToBigMap (SizedList' n (k, v))
- Add Morley.Michelson.Parser.Helpers.count, a fixed-size list version of Text.Megaparsec.count.
!1042 Amend Morley.Util.Named
- Re-export arg and argF
- Deprecate N, M, SomeArg, NoArg patterns due to potential for abuse (use arg or argF with view patterns instead)
- Do not re-export Name data constructor (use fromLabel with a type annotation/application instead)
!1089 Enhance and rename mutez quasiquote
- Remove mtzQ quasiquoter
- Add tz quasiquoter; units are XTZ by default, but can be changed with a suffix; use [tz|123u|], [tz|123μ] or [tz|123 micro|] for mutez.
!1095 Put run, transfer and originate commands under emulate parent command
!1072 Add runCode to Cleveland
- Morley.Michelson.Runtime:
  - Don't assign IDs to bigmaps that already have one.
  - Allow overriding a contract's balance during a transfer.
- Added MaybeRPC and replaceBigMapIds.
!1075 Handle oddly-sized integral types with the int-cast facilities
- Redefine Mutez, TLTime as newtype wrappers for Word63, Word62 types respectively.
- Implement toTLTime conversion function using fromIntegralNoOverflow.
- Delegate mkMutez, toMutez, mkTLTime conversion functions to convenient and safe fromIntegral and fromIntegralNoOverflow.
- Implement safe mtzQ quasiquoter for creating Mutez values.
!1071 Add HasRPCRepr typeclass
!1068 Update some utils for Instr type.
- dfsInstr itself got deprecated in favor of other variations of this function.
- CtorEffectsApp setting in dfsInstr-like functions now works differently. Instead of specifying complex combining function as the second ceaApplyEffects field, now you should specify how to transform the monadic action (and the field is now called ceaPostStep). Please create an issue if this change does not work for you.
- Added isMichelsonInstr.
- Now exporing analyzeInstrFailure.
!1076 Fix escaping in haddock for Morley.Util.Interpolate
!1025 Reduce the number of unsafe functions at the call site
- Remove the following unsafeFName constructors/converters that are used as counter-parts of safe functions and replaced with unsafe . fName:
  - unsafeMkMText
  - unsafeMkPos
  - unsafeParseEpAddress
  - unsafeMkMutez
  - unsafeMkAnnotation
  - unsafeMkViewName
  - unsafeFromMichelsonBytes
  - unsafeParseAddressRaw
  - unsafeBuildEpName
  - unsafeMkSomeParamType
  - unsafeParseKeyHash
  - unsafeParseEpAddressRaw
  - unsafeMkTLTime
  - unsafeParseAddress
  - unsafeParseContractHash
  - unsafeMkChainId
- Refactor mkPos and mkChainId to return Either instead of Maybe.
!1063 Remove redundant SingI constraints
!1060 Add Morley.AsRPC module for mapping types to their Tezos RPC representations
!978 Make it difficult to misuse 'Show'
- Use Buildable and pretty preferrentially.
- Add Buildable instances to that effect for ArithError, StackSize, CtorEffectsApp, ContractBlock,
- Avoid using (+||) and (||+).
- Use Debug.show where we can't use pretty for some reason.
!1057 Fix Show, RenderDoc, Builder instances of Annotation t, AnnotationSet, Notes t, InstrAbstract op
!997 Check necessity in initial cast automatically in Lorentz contracts
!1043 Extract actual + expected pattern into a datatype and show diff in type mismatch
!1055 Add more optimization rules
- Rules added: DUP 1 -> DUP, IF x x -> x, DIP n { } -> Nop, DIG n ; DUG n -> Nop.
- TestEquality instance added for Morley.Util.Peano.SingNat.
- Morley.Util.PeanoNatural exports two new utility functions, eqPeanoNat and singPeanoNat.
- Morley.Util.Type exports a new utility function, knownListFromSingI
!1013 Add WellTyped to complex scope constraints
- Make WellTyped constraint a part of complex constraints, namely ParameterScope, StorageScope, ConstantScope, PackedValScope, UnpackedValScope.
!987 Make parser's separators between values and instructions mandatory
- Add spaces parser which doesn't accept zero white spaces
- Change ops', that parses sequence of operations, to accept absence of ; separator after code in brackets a; {b; c; ...} d
- Add backtracking with try to symbol1
!1037 Add synonyms for SomeConstrainedValue
- Reimplement SomeConstant, SomeValue, SomeStorage via SomeConstrainedValue.
!1035 Better type errors on invalid int casts

1.16.2

!1045
- Add optics:
  - Ixed and At instances for Value t and BigMap k v.
  - isoValue.
  - prisms for Expression.
  - lenses for MichelinePrimAp.
- Add SomeAnnotatedValue and AnnotatedValue.
- Add Lift instance for Expression.
!1040 Add missing FromExpression conversions
- Chest and ChestKey cases were missing in FromExpression conversions.

1.16.1

!1016
- Add support for on-chain views.
- The old VIEW macro for A1 (aka TZIP-4) views support was renamed to VIEW_ (A1/TZIP-4).
!1010 Add timelock puzzle support.
- Binary encoding primitives moved to Morley.Micheline.Binary.Internal and exposed from there.
- Added binary encoding primitives for nonnegative integers buildNatural and getNatural.
- Added timelock puzzle algorithms to Morley.Tezos.Crypto.Timelock
- Added support for chest and chest_key types. Those are represented by TChest and TChestKey in Haskell.
- Added support for OPEN_CHEST instruction
- Added create_chest command to Morley CLI to create a timelocked chest from user-supplied parameters. This isn't necessarily cryptographically safe (it was neither written nor audited by security experts), and is primarily intended for testing purposes.

1.16.0

!1011 Support working with delegates in the morley interpreter
- SET_DELEGATE previously was a no-op. Now it emits an operation, which is then interpreted to set a field in the contract state.
!989 Switch from interpolate to home-grown string interpolation module
- Adds Morley.Util.StringInterpolation module to morley.
- Note this changes the syntax of slices in md quasiquoter. Before we could use expressions #{expression}, now we can only use variable names #{name}.
!909
- Add new patterns to Morley.Util.Named allowing to pattern-match more easily on named variables
- Replaced import of Named package with Morley.Util.Named
!995 Allow users to save meta instructions in the typed representation.
- New typed instruction: Meta, which takes some existential value that can be matched and tested with cast.
!851
- Make source argument optional in readValue, readContract and similar functions.
- Rename ImportContractError and ImportValueError types to ContractReadError and ValueReadError respectively. Their constructors (starting from ICE and VCE are updated accordingly).
!971 Fix exponential backtracking when parsing Michelson tuple values
- New helpers in "Morley.Michelson.Parser.Helpers": sepBy1 and some', which are versions of Megaparsec's sepBy1 and some returning a NonEmpty instead of [].
- Removed mparens from "Morley.Michelson.Parser.Helpers": it happens to be unused now, and can be pretty dangerous.
- Removed typeWithParen from "Morley.Michelson.Parser.Type", since it was completely equivalent to just type_, but its performance was slightly worse.
!941 Use pretty-printer in PRINT instruction
- New RenderDoc instance for typed Values without operations
- Some places that were using Buildable Value instance changed to use buildRenderDoc to preserve HasNoOp constraint (where it makes sense, i.e. outside of other Buildable instances)
- New Buildable instance for typed Values, closely mirroring the behaviour of the old one, but able to print opreations via Buildable Operation instance.
- Use Fmt.pretty instead of show in PRINT implementation
- Use Buildable Operation pretty-printer for Michelson failure reports (i.e. in Buildable MichelsonFailed instance, used for FAILWITH)
!943
- Place modules below a top-level Morley name.
!918
- Add pairMisc rule which handles PAIR :# CDR and PAIR :# CAR to Optimizer
- Add justDoubleDrops rule optimizing i :# DROP where i :: a : b : s -> c : s to Optimizer
- Make optimize function several-staged: flatten the sequence to right-combed firstly, then apply default rules and finally perform adjacentDrops
- Update documentation of Optimizer
!937 Attach source code location to interpreter error messages
- New Buildable InstrCallStack instance
- New ceInstrCallStack :: InstrCallStack field in ContractEnv
- New MichelsonFailureWithStack type which is a product of MichelsonFailed and InstrCallStack, with a Buidlable instance
- Changed interpreter error type from MichelsonFailed to MichelsonFailureWithStack
!945
- Bump Stackage LTS version from 17.9 to 18.10.
!908
- Remove NFData instance for Rec and require vinyl ≥ 0.13.1.
!881
- Rename PrintedValScope to UntypedValScope with related types and functions.

1.15.1

!908
- Remove NFData constrains from Instr constructors
!879
- Add Buildable and RenderDoc instances for Instr inp out type.
- Instances are based on transforming Instr inp out to list of ExpandedOp and using its instance
!900
- Added clarification that "OCaml reference client" is tezos-client.

1.15.0

!896
- Move MorleyLogs in interpreter monad to a dedicated WriterT layer.
!878
- Fixed behavior of packValue to match the tezos-client hash data behavior.
- Pair conversion in instance ToExpression Untyped.Value always produces ExpressionPrim instead ExpressionSeq. Optimization of right-combed pairs moved to Michelson.Typed.Convert and depends on UntypingOptions.
!880
- Fixed loss of type annotations in serialization of right-combed pairs.
!795
- Changed typecheck exception messages.
- Changed Buildable instances for several datatypes to be based on RenderDoc instances.
- Changed the regexp in scripts/regenerate-gold-files-for-verbose-typechecking.sh so it does not ommit extra space in .gold files on MacOS.
!863
- Removed conversion from variable anotations to field anontations in PAIRN instruction.
!856
- Removed Typeable constrains from singletons generated by T.
- Added the Util.Sing module with functions that allow equality comparison using SDecide.
!858
- Added SomeStorage type.
- Modified runContract to return SomeStorage.
!833
- Fixed ContainsBigMap and ContainsNestedBigMaps instances for TContract.
- Added Data instance to BigMap and BigMapId.
- Added requireEqT, castM and gcastM to Util.Typeable.
!859
- Added BigMapId type.
- Added ID to VBigMap and BigMap.
- Updated interpreter to assign a unique big_map ID to each big_map, and keep track of how many big_maps have been created with a BigMapCounter.
- Deleted dfsValue.
- Renamed dfsModifyValue and dfsFoldValue to dfsMapValue and dfsFoldMapValue.
- Added dfsTraverseValue and dfsFoldMapValueM.
!840
- Changed behaviour of deserializer: it fails if the expression contains more annotations than expected instead of ignoring them.
- Changed behaviour of serializer: it uses list notation for all pair values, not just for right-combed ones.
!816
- Removed the SingI and KnownPeano constraints by introducting the PeanoNatural data type.
- The similar updates for SingT. Removed the SingI constraints in the constructors of SingT
!855
- Fix custom error arguments comparison in nettest by converting them to Value t before checking for equality.
!830
- Added the contract's address to some of the ExecutorError' constructors: EEIllTypedParameter and EEUnexpectedParameterType.
!820
- Moved functions for contract importing (like importContract) from cleveland.
- Added functions for values importing (readValue, importValue and others).
!832
- Add tickets feature.
- Add dupable restriction to DUP-like instructions.
!838
- All unsafe functions and data constructors now contain "unsafe" word at prefix position. E.g UnsafeUParam, unsafeParseKeyHash.
!828
- Fix bug in serialization of instructions with variable annotations: EMPTY_SET, EMPTY_MAP, PUSH, LAMBDA, CAST, CONTRACT.
!770
- Added Fn meta-instruction to support Morley's typed stack function in typed form.
- Added STACKTYPE as a typed ExtInstr.
!822
- Add new edo instruction: UNPAIR.
- Rename UNPAIR macro to UNPAPAIR.
- Expand UNPAPAIR macros to UNPAIR instructions.
- The Seq constructor can now be used as a right-associative operator.
- Optimize DUP; CAR; DIP { CDR } to UNPAIR
- Optimize DUP; CDR; DIP { CAR } to UNPAIR; SWAP
!825
- Fix bug in morley executable's repl command: consume the entire input when parsing an instruction.
- Fix bug in the handling of special annotations for CAR/CDR.
- Fix bug in parsing of PAIR instructions with exactly 1 field ann.
- Preserve CAR/CDR's original annotations when converting them back to michelson/binary/json.

1.14.0

!799
- Fix product type instances of 1-nary constructors and empty types (they could produce compilation error before).
!814
- Renamed Type from Michelson.Untyped.Type with Ty.
- Added the usage of Prelude.Type instead of Data.Kind.Type, as a result Kind.Type was replaced with just Type.
!733
- Added special annotations handling for LEFT and RIGHT instructions.
!787
- Added support for CAR k and CDR k macros.
!747
- Fix ligoLayout not working for alphabetically unordered sum types.
!798
- Added helper functions for recent Peano utility types.
!815
- Added IsList and Buildable instances to BigMap.

1.13.0

!796
- Generalized InstrWithNotes to handle instructions that put more than one value at the top of the stack.
- Added support for GET_AND_UPDATE instructions.
!774
- Added support for BLS12-381 crypto primitives.
!776
- Added support for DUP n instruction.
!755 Restricted FAILWITH only to packable values, except CONTRACTs
!781
- Replaced mixins and dependency on base with base-noprelude.
- Added doctest examples and enabled doctest tests in morley:lib.
!764
- Added support for never type.
!750 !769 !786 !791
- Added support for PAIR n, UNPAIR n, GET n and UPDATE n instructions.
!778
- Added support for VOTING_POWER and TOTAL_VOTING_POWER instructions.
!767 Made unit, key, signature, chain_id, option, or types comparable in preparation for edo switch.

1.12.0

!751
- Added support for LEVEL instruction.
- Added --level parameter to morley executable
!753 !754
- edo changes:
  - Ability to parse right-combed types (e.g. pair int nat string) from all 3 formats (binary, micheline, michelson)
  - Ability to parse right-combed values (e.g. Pair 1 2 "a") from all 3 formats (binary, micheline, michelson)
!742 Allowed parsing single field annotations for LEFT and RIGHT instructions.
!744
- Added reifyDataType and deriveFullType to Util.CustomGeneric.
- Added lookupTypeNameOrFail to Util.TH.
!741
- Added support for SHA3 and KECCAK instructions.

1.11.1

!740 Fixed morley print to correctly render PUSH instructions that previously caused contracts to be misaligned and rejected by tezos-client.

1.11.0

!731
- Added opportunity to reorder fields in GenericStrategy.
- Added GenericStrategy-ies for compatibility with LIGO.
!724 Fixed UNPACK to accept pairs of comparable types.
!712
- In optimizer, by default lambdas are now also handled.
- Field names in optimizer config are changed (prefix added).
!726 Added Data and Plated instances to Morley.Micheline.Expression.
!723
- Splitted class ContainsDoc into ContainsDoc and ContainsUpdateableDoc;
- Allow avoiding explicit DName call (now docGroup "Title" works).
!684 Simplify working with autodoc in contracts. (follow the deprecation warnings in case this hits you).

1.10.0

!692 The ToJSON instance for Micheline Expression now produces more compact JSON values, by omitting the "annots" and "args" fields when these lists are empty.
!673
- Removed TextException. Migration guide: use StringException or throwString from safe-exceptions.
- Removed displayUncaughtException. Migration guide: use uncaught-exception library.
- Added Util.Main module, consider using it in your Main.hs.
!657 Make namedParser handle complex-worded options neatly.
!678 Added FromExpression instances for Michelson.Untyped.Type, Michelson.Typed.T, and Michelson.Typed.Instr.
!607 Removed parse from the executable.
!659 Remove Michelson.Interpret.MichelsonAmbigousEpRef exception constructor.
!664 Added Tezos.Crypto.Sign.
!638 Added Morley.Micheline.Json.TezosMutez.
!638 Added Tezos.Core.prettyTez.

1.9

!653
- Michelson.OpSize module is moved to Michelson.Untyped.OpSize.
- Added primitives for evaluating OpSize in typed Michelson.
- Added instance Buildable OpSize.
!633 Added Tezos.Core.timestampToUTCTime.

1.8.1

!613 Added HasCLReader instances for Word16 and String.

1.8.0

!610 Remove Arbitrary instances and everything else that depends on QuickCheck.
!616 Make RootAnn a mere type alias of FieldAnn.
!615 Make mkEntrypointsMap accept ParameterType instead of Type.
!567 Add DConversionInfo that describes Haskell <-> Michelson conversion mechanism.
!585 Add Exception instance for ParseChainIdError.
!598 Fix bug: correct processing of EDIV of negative Integer and Natural.
!574 Implement a verbose switch for morley typecheck. It allows to print a stack type after every well-typed instruction, even if a contract as a whole is ill-typed.

1.7.1

!549 Add instance Buildable TezosInt64.

1.7.0

!565 Remove useless error entities from Michelson.Interpret.
!563 Fix handling of Natural numbers.
!554 Fix 'SELF' instruction packing.
!548
- The interpreter now takes a typed contract and storage value for origination operations.
- Use binary serialization to compute operation hashes and addresses.
- Add typeCheckContractAndStorage to Michelson.TypeCheck
- Remove withGlobalOperation from Michelson.Runtime
- Remove EEIllTypedContract and EEIllTypedStorage constructors from ExecutorError'

1.6.0

!323 Add parseSecretKey which allows parsing all types of SecretKey.
!537 Permit SELF %default instruction.
!522 Allow calling the interpreter with a typed transfer parameter and avoid unnecessary typechecking.
!495 Add source location to typed Instr AST.
!521 Document generater can now generate table of contents.

1.5.0

!509 Implement missing parts of secp256k1 and P256.
- checkSignature now works correctly with all signature formats.
!511 Add zeroMutez and oneMutez for safe initial values.
!500 Add ability to parse optimized formats of signature, contract, key, and key_hash.
!486 Add Util.CustomGeneric to derive Generic instances with a custom tree structure.
!466 Add sub-command 'repl' to Morley executable which starts an REPL that can execute Morley instructions.
!492
- TypeHasDoc instance for newtype now has its field remove by default without having to use haskellRepNoFields.
- Add haskellAddNewtypeField function to add field name for newtype if desired.
!487 Fix typechecking error message pointing to the whole map unit nat as not comprable.
- It now only points to unit type as not comparable.
!457
- Allow using the same position when defining DocItem.
- When two DocItems have the same position, they will be sorted alphabetically by their names.
!480 Arithmetic instructions (ADD, MUL, EDIV, LSL, ...) now take annotations into account.
- Results from the instructions are also properly annotated.
!470 Move Michelson.Doc.Test, Michelson.Test and Hedgehog generators to a new package: cleveland.
!453 Order of top-level entries in contract are now preserved.
- PACK/UNPACK now serialize contracts according their top-level entries order.
- Pretty printer now display contracts according to their given top-level entries order.
!445 Remove unnecessary TcOriginatedContracts usages and split typeCheckTopLevelValue to typeCheckParameter (the only case where TcOriginatedContracts is useful) and typeCheckStorage.

1.4.0

!446 Include source locations and let-binding stacks into typecheck errors.
!449
- Improve Michelson.Test.Integrational interface.
- Remove IntegrationalValidator, SuccessValidator, validate, composeValidators, composeValidatorsList, expectAnySuccess.
- Add unexpectedInterpreterError, attempt, catchExpectedError.
- Change type of expect*/tExpect* functions. They now return IntegrationalScenario instead of SuccessValidator / Bool.
- Rename ValidationError to TestError
- Replace TestError's UnexpectedExecutorError constructor with InterpreterError and UnexpectedInterpreterError.
!441 Remove tezos-bake-monitor-lib dependency, and define value to json conversion using binary round trip locally instead.
!448 Remove base-noprelude dependency and use mixins to hide Prelude instead.
!367 Values and instructions now carry some extra constraints in order to avoid construction of illegally typed values from within Haskell. WellTyped now also requires Typeable and SingI constraints.
!409
- Add hedgehog support
!438
- Fixed parsing bug: support semicolons after block comments.
!424 Changed contract address computation logic in the interpreter to match the reference implementation a bit more closely by including a global counter and an origination index (nonce) to contract's hash. Specifically, now the same contract may be originated several times, leading to different addresses, just like in Tezos.

1.3.0

!417 Change the license to MIT.
!386
- Add a way to describe constructors and fields of ADTs in Markdown documentation.
- Require that all contracts include documentation for the storage type.
!396 Fixed typed Notes to permit pair annotations for container keys.
!359 Renamed 'FullContract' to 'Contract', removed the prefix f from its record fields and removed "Full" from the names of the functions: convertFullContract, printTypedFullContract and mapFullContractCode.
!354
- Fix bug: add ChainId to IsPrimitiveValue type family.
- Add GInstrDeconstruct type class and related functions which serve to deconstruct datatype into its fields on the stack.
- Add gInstrConstructStack to GInstrConstruct type class that serves to construct a datatype from its fields on the stack.
- Add GFieldNames type family returning list of Symbols: the names of direct fields of datatype.

1.2.0

!343
- Make pairs comparable and available to use as map keys and in sets.
- CT type has been integrated into T.
- A WellTyped type class has been added to ensure that a type represented by T is valid as per Michelson's rules.
!358 Remove deprecated STEPS_TO_QUOTA instruction.
!368
- Update JSON encoding of types.
- Rename fields of the untyped Contract'.
!286 Morley supports field annotations for parameter root now.
!344 Fixed a bug in Michelson.Analyzer and added linearizeLeftDeep.

1.1.0

!337 Added an extension for Michelson comment to typed and untyped contract representation.
!306 Added PAIR/UNPAIR rule to optimizer.
!314 Fixed a bug in the implementation of MAP operation: it did not preserve modifications to stack.
!261 Slightly modified interpreter API.
!313 Made typeCheckValue polymorphic in desired type, instead of using existential wrappers.
!310
- Add DGeneralInfoSection documentation section with git revision and potentially other info.
- Add buildLorentzDocWithGitRev and buildInstrDocWithGitRev to API to add a git revision to contract docs from the executable.
!121 BALANCE instruction now returns the balance with funds from incoming transaction.
!294
- Added Paths_* modules to autogen-modules in cabal files. Removed -O0
- from default GHC options. Please set ghc-options in your stack.yaml or cabal.project.local.
!271 Renamed 'Contract' to 'ContractCode', and appended "Code" to the names of two functions: 'convertContract' and 'printTypedContract'
!278 Added some utilities for command line option parsing, see Util.CLI and Morley.CLI modules.
!268 Test functions which import typed contract now return FullContract instead of Contract, thus preserving parameter and storage annotations. In case you don't need this behaviour, use fcCode for conversion. Test functions which import Lorentz contracts have been removed because they cannot be implemented sanely, and Lorentz is assumed to be used to generate code, do not use it for work with textual Michelson contracts.
!212
- Fix AND instruction return type.
- Add DUP n macro support.
- Fix LAMBDA instruction printer.
!265 The semicolons between instructions are now optional.

1.0.0

!215 Major change: all Lorentz functionality was moved into lorentz package. A small portion of testing library code was moved around (from Lorentz.* to Michelson.* or vice versa).

0.7.0

!237 The option (nat %foo) is now accepted syntax. The %foo is ignored.
!241 Derive Show instance for Void_.
!238
- NoExplicitDefaultEntrypoint is now GHC-understandable constraint, for previous behaviour with nice error message use ForbidExplicitDefaultEntrypoint.
- CanHaveEntrypoints is made stricter, now it returns true only for Michelson sum types. If that's a problem for you, consider using ShouldHaveEntrypoints wrapper.
- Added pseudo Empty type.
!219 Various entrypoints-related updates.
- Integrational tests now carry TAddress as a reference to contract. Make sure that parameters of the originated contracts are clear; e.g. origination of consumer contract may require explicit type annotation to specify parameter type. If you passed a reference to the originated contract to View constructor, consider using mkView instead or applying callingDefTAddress to the reference.
- Generally it is encouraged to use TAddress instead of Address where it is used to refer to a contract.
- fromContractAddr renamed to fromContractRef.
- Default instances for {Some,}EntrypointCall are removed, use one of explicit versions: epcPrimitive, epcCallRootUnsafe.
- Reworked FutureContract type.

0.6.0

!127 Limit annotations' allowed characters
!184 Fix LAMBDA instruction type converter bug
!173 !197 Add support for lightweight entrypoints in Lorentz, as well as in the interpreter runner and morley executable. Support entrypoint references in SELF instruction. Minor refactorings related to entrypoints.
!201
- Add entrypoint argument to methods in testing eDSL. Preserve the existing type of lCall and deprecate it.
- Deprecate Lorentz.TestScenario.
!208 Resolve an ambiguity within integrational and unit interpreters by renaming interpreter in Michelson.Runtime to executor.
!180 Remove coerce_ in favor of more safe variants. Migration guide: pick one of the functions from 'Lorentz.Coercions' module. In most cases you need one of the following ones:
- checkedCoerce_
- coerceWrap / coerceUnwrap
- forcedCoerce_ (aka old coerce_ - this variant provides the least safety).
!180 Type arguments of coerceWrap and coerceUnwrap are flipped. This change concerns you if you used type application on these functions.

0.5.0

Require morley-prelude to be ≥ 0.3.0 to make Hackage happy.
!156 Consider annotations in PACK and UNPACK.

0.4.0

Implemented most of Babylon changes: new instructions, elimination of big_map restructions, new restrictions for the contract type, partial support for entrypoints. Some instructions have been removed/deprecated.
Many updates of helper data types for upgradeable contracts: UParam and UStore.
Michelson printer can produce pretty output, not just one line.
Added utilities for contract processing and analysis: optimizer, string transformer, errors transformer, analyzer.
Added tasty helpers to the testing engine.
Added annotations to typed representation and Lorentz.
Added automatic documentation generator.
Modified standard errors in Lorentz: now they are based on CustomError.
Added unpacking from readable representation.
Removed parameter and storage aliases, they were not very useful and complicated the code.
Extended cryptographic types and Address to work with other curves (tz2 and tz3 addresses).
Made it nearly impossible to generate dead code (which is illegal in Michelson) using Lorentz.
Various bug fixes.

0.3.0.1

Update maintainer.

0.3.0

TM-68 Lorentz DSL which allows one to write contracts directly in Haskell. May be moved to a separate package later.
TM-132 Names for contracts in integrational tests.
TM-35 PACK and UNPACK instructions.
TM-27 Proper handling of FAILWITH.
TM-44 TM-124 Reorganization of modules.
Bug fixes.

0.2.0.1

Update documentation and metadata.

0.2.0

Initial release.

Typechecker and interpreter for Michelson.
Morley extensions:
- syntax sugar
- let-blocks
- inline assertions
EDSL for unit testing and integrational testing