Test.Cleveland.Lorentz.Types

Basic types for the test framework.

Documentation

data ContractHandle (cp :: Type) (st :: Type) (vd :: Type)

Handle to a contract.

This is what you get when originating a contract and that allows further operations with the contract within the test framework.

Note that this is part of the testing framework and exists solely in Haskell world, so it has no IsoValue and related instances and cannot be used in Lorentz code.

Constructors

(NiceParameter cp, NiceStorage st, NiceViewsDescriptor vd) => ContractHandle

Fields

• chContractName :: ContractAlias
• chAddress :: ContractAddress

Instances

(cp' ~ cp, vd ~ vd') => ToTAddress cp' vd' (ContractHandle cp st vd)

Defined in Test.Cleveland.Lorentz.Types

Methods

toTAddress :: ContractHandle cp st vd -> TAddress cp' vd'

st ~ st' => ToStorageType st' (ContractHandle cp st vd)

Defined in Test.Cleveland.Lorentz.Types

Methods

pickNiceStorage :: ContractHandle cp st vd -> Dict (NiceStorage st')

ToContractRef arg (TAddress cp vd) => ToContractRef arg (ContractHandle cp st vd)

Defined in Test.Cleveland.Lorentz.Types

Methods

toContractRef :: ContractHandle cp st vd -> ContractRef arg

Show (ContractHandle cp st vd)

Defined in Test.Cleveland.Lorentz.Types

Methods

showsPrec :: Int -> ContractHandle cp st vd -> ShowS

show :: ContractHandle cp st vd -> String

showList :: [ContractHandle cp st vd] -> ShowS

ToContractAddress (ContractHandle cp st vd)

Defined in Test.Cleveland.Lorentz.Types

Methods

toContractAddress :: ContractHandle cp st vd -> ContractAddress

ToL1Address (ContractHandle cp st vd)

Defined in Test.Cleveland.Lorentz.Types

Methods

toL1Address :: ContractHandle cp st vd -> L1Address

Buildable (ContractHandle cp st vd)

Defined in Test.Cleveland.Lorentz.Types

Methods

build :: ContractHandle cp st vd -> Builder

ToAddress (ContractHandle cp st vd)

Defined in Test.Cleveland.Lorentz.Types

Methods

toAddress :: ContractHandle cp st vd -> Address

chNiceParameterEvi :: forall param st vd. ContractHandle param st vd -> Dict (ParameterScope $ ToT st)

Extract the evidence in typed Michelson that the parameter type is valid for such scope.

chNiceStorageEvi :: forall param st vd. ContractHandle param st vd -> Dict (StorageScope $ ToT st)

Extract the evidence in typed Michelson that the storage type is valid for such scope.

newtype L1TAddress cp vd

Counterpart of TAddress that contains L1Address instead of Address.

Constructors

L1TAddress

Fields

• unL1TAddress :: L1Address

Instances

(cp ~ cp', vd ~ vd') => ToTAddress cp' vd' (L1TAddress cp vd)

Defined in Test.Cleveland.Lorentz.Types

Methods

toTAddress :: L1TAddress cp vd -> TAddress cp' vd'

ToL1Address (L1TAddress cp vd)

Defined in Test.Cleveland.Lorentz.Types

Methods

toL1Address :: L1TAddress cp vd -> L1Address

class ToContractAddress addr where

Methods

toContractAddress :: addr -> ContractAddress

Instances

ToContractAddress ContractAddress

Defined in Test.Cleveland.Lorentz.Types

Methods

toContractAddress :: ContractAddress -> ContractAddress

ToContractAddress (ContractHandle cp st vd)

Defined in Test.Cleveland.Lorentz.Types

Methods

toContractAddress :: ContractHandle cp st vd -> ContractAddress

class ToL1Address addr where

Methods

toL1Address :: addr -> L1Address

Instances

ToL1Address L1Address

Defined in Test.Cleveland.Lorentz.Types

Methods

toL1Address :: L1Address -> L1Address

L1AddressKind kind => ToL1Address (KindedAddress kind)

Defined in Test.Cleveland.Lorentz.Types

Methods

toL1Address :: KindedAddress kind -> L1Address

ToL1Address (ContractHandle cp st vd)

Defined in Test.Cleveland.Lorentz.Types

Methods

toL1Address :: ContractHandle cp st vd -> L1Address

ToL1Address (L1TAddress cp vd)

Defined in Test.Cleveland.Lorentz.Types

Methods

toL1Address :: L1TAddress cp vd -> L1Address

class (ToTAddress cp vd addr, ToL1Address addr) => ToL1TAddress cp vd addr where

Counterpart of ToTAddress that converts to L1TAddress rather than TAddress.

Methods

toL1TAddress :: addr -> L1TAddress cp vd

Instances

(ToTAddress cp vd addr, ToL1Address addr) => ToL1TAddress cp vd addr

Defined in Test.Cleveland.Lorentz.Types

Methods

toL1TAddress :: addr -> L1TAddress cp vd

class ToContractAddress addr => ToStorageType st addr where

Declares that addr points to an entity with a storage.

addr may fix storage type or may not - in the latter case the caller has to specify the storage type explicitly via type annotation.

Methods

pickNiceStorage :: addr -> Dict (NiceStorage st)

Pick proof of that storage type is valid.

Instances

NiceStorage st => ToStorageType st ContractAddress

Defined in Test.Cleveland.Lorentz.Types

Methods

pickNiceStorage :: ContractAddress -> Dict (NiceStorage st)

st ~ st' => ToStorageType st' (ContractHandle cp st vd)

Defined in Test.Cleveland.Lorentz.Types

Methods

pickNiceStorage :: ContractHandle cp st vd -> Dict (NiceStorage st')

type NiceParameter a = (ProperParameterBetterErrors (ToT a), KnownValue a)

type NiceParameterFull cp = (Typeable cp, ParameterDeclaresEntrypoints cp)

type NiceStorage a = (ProperStorageBetterErrors (ToT a), KnownValue a)

type NicePackedValue a = (ProperPackedValBetterErrors (ToT a), KnownValue a)

type NiceUnpackedValue a = (ProperUnpackedValBetterErrors (ToT a), KnownValue a)

class ToAddress a

Minimal complete definition

toAddress

Instances

ToAddress EpAddress

Defined in Lorentz.Address

Methods

toAddress :: EpAddress -> Address

ToAddress Address

Defined in Lorentz.Address

Methods

toAddress :: Address -> Address

ToAddress L1Address

Defined in Lorentz.Address

Methods

toAddress :: L1Address -> Address

ToAddress (FutureContract cp)

Defined in Lorentz.Address

Methods

toAddress :: FutureContract cp -> Address

ToAddress (ContractRef cp)

Defined in Lorentz.Address

Methods

toAddress :: ContractRef cp -> Address

ToAddress (KindedAddress kind)

Defined in Lorentz.Address

Methods

toAddress :: KindedAddress kind -> Address

ToAddress (TAddress cp vd)

Defined in Lorentz.Address

Methods

toAddress :: TAddress cp vd -> Address

ToAddress (ContractHandle cp st vd)

Defined in Test.Cleveland.Lorentz.Types

Methods

toAddress :: ContractHandle cp st vd -> Address

toAddress :: ToAddress a => a -> Address

Notes

A note on TAddress instance for ToStorageType

TAddress isn't intended to be a part of the Cleveland API. In the absolute majority of cases, if one is interested in both parameter and storage, then they should use ContractHandle, as the storage type needs to be known either way. If one isn't interested in storage, they presumably wouldn't call functions to get storage. Hence, this instance wouldn't be particularly useful. Legacy code using TAddress instead of ContractHandle should be preferably updated, if possible. If nothing else, toAddress can be used as a stopgap measure.