Lorentz.Address

This module introduces several types for safe work with address and contract types. All available types for that are represented in the following table:

Type	Type safe?	What it refers to	Michelson reflection
Address	No	Whole contract	address
EpAddress	No	Entrypoint	address
TAddress	Yes	Whole contract	address
FutureContract	Yes	Entrypoint	address
ContractRef	Yes	Entrypoint	contract

This module also provides functions for converting between these types in Haskell and Michelson worlds. In the latter you can additionally use coercions and dedicated instructions from Lorentz.Instr.

Documentation

newtype TAddress p

Address which remembers the parameter type of the contract it refers to.

It differs from Michelson's contract type because it cannot contain entrypoint, and it always refers to entire contract parameter even if this contract has explicit default entrypoint.

Constructors

TAddress

Fields

• unTAddress :: Address

Instances

(FailWhen cond msg, cond ~ (CanHaveEntryPoints cp && Not (ParameterEntryPointsDerivation cp == EpdNone)), msg ~ (((('Text "Cannot apply `ToContractRef` to `TAddress`" :$$: 'Text "Consider using call(Def)TAddress first`") :$$: 'Text "(or if you know your parameter type is primitive,") :$$: 'Text " make sure typechecker also knows about that)") :$$: (('Text "For parameter `" :<>: 'ShowType cp) :<>: 'Text "`")), cp ~ arg, NiceParameter arg, NiceParameterFull cp, GetDefaultEntryPointArg cp ~ cp) => ToContractRef arg (TAddress cp)

Defined in Lorentz.Address

Methods

toContractRef :: TAddress cp -> ContractRef arg

cp ~ cp' => ToTAddress cp (TAddress cp')

Defined in Lorentz.Address

Methods

toTAddress :: TAddress cp' -> TAddress cp

CanCastTo Address (TAddress p :: Type)

Defined in Lorentz.Coercions

Methods

castDummy :: Proxy Address -> Proxy (TAddress p) -> ()

CanCastTo (TAddress p :: Type) Address

Defined in Lorentz.Coercions

Methods

castDummy :: Proxy (TAddress p) -> Proxy Address -> ()

Generic (TAddress p)

Defined in Lorentz.Address

Associated Types

type Rep (TAddress p) :: Type -> Type

Methods

from :: TAddress p -> Rep (TAddress p) x

to :: Rep (TAddress p) x -> TAddress p

IsoValue (TAddress p)

Defined in Lorentz.Address

Associated Types

type ToT (TAddress p) :: T

Methods

toVal :: TAddress p -> Value (ToT (TAddress p))

fromVal :: Value (ToT (TAddress p)) -> TAddress p

HasTypeAnn (TAddress p)

Defined in Lorentz.Address

Methods

getTypeAnn :: Notes (ToT (TAddress p))

ToAddress (TAddress cp)

Defined in Lorentz.Address

Methods

toAddress :: TAddress cp -> Address

type Rep (TAddress p)

Defined in Lorentz.Address

type Rep (TAddress p) = D1 ('MetaData "TAddress" "Lorentz.Address" "lorentz-0.4.0-4bB2PLHB7038abCZLw1vnA" 'True) (C1 ('MetaCons "TAddress" 'PrefixI 'True) (S1 ('MetaSel ('Just "unTAddress") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Address)))

type ToT (TAddress p)

Defined in Lorentz.Address

type ToT (TAddress p) = GValueType (Rep (TAddress p))

newtype FutureContract arg

Address associated with value of contract arg type.

Places where ContractRef can appear are now severely limited, this type gives you type-safety of ContractRef but still can be used everywhere. This type is not a full-featured one rather a helper; in particular, once pushing it on stack, you cannot return it back to Haskell world.

Note that it refers to an entrypoint of the contract, not just the contract as a whole. In this sense this type differs from TAddress.

Unlike with ContractRef, having this type you still cannot be sure that the referred contract exists and need to perform a lookup before calling it.

Constructors

FutureContract

Fields

• unFutureContract :: ContractRef arg

Instances

cp ~ cp' => FromContractRef cp (FutureContract cp')

Defined in Lorentz.Address

Methods

fromContractRef :: ContractRef cp -> FutureContract cp'

(NiceParameter cp, cp ~ cp') => ToContractRef cp (FutureContract cp')

Defined in Lorentz.Address

Methods

toContractRef :: FutureContract cp' -> ContractRef cp

IsoValue (FutureContract arg)

Defined in Lorentz.Address

Associated Types

type ToT (FutureContract arg) :: T

Methods

toVal :: FutureContract arg -> Value (ToT (FutureContract arg))

fromVal :: Value (ToT (FutureContract arg)) -> FutureContract arg

HasTypeAnn (FutureContract a)

Defined in Lorentz.Address

Methods

getTypeAnn :: Notes (ToT (FutureContract a))

ToAddress (FutureContract cp)

Defined in Lorentz.Address

Methods

toAddress :: FutureContract cp -> Address

CanCastTo (FutureContract p :: Type) EpAddress

Defined in Lorentz.Coercions

Methods

castDummy :: Proxy (FutureContract p) -> Proxy EpAddress -> ()

type ToT (FutureContract arg)

Defined in Lorentz.Address

type ToT (FutureContract arg) = ToT EpAddress

Conversions

callingTAddress :: forall cp mname. NiceParameterFull cp => TAddress cp -> EntryPointRef mname -> ContractRef (GetEntryPointArgCustom cp mname)

Turn TAddress to ContractRef in Haskell world.

This is an analogy of address to contract convertion in Michelson world, thus you have to supply an entrypoint (or call the default one explicitly).

callingDefTAddress :: forall cp. NiceParameterFull cp => TAddress cp -> ContractRef (GetDefaultEntryPointArg cp)

Specification of callTAddress to call the default entrypoint.

class ToAddress a where

Convert something to Address in Haskell world.

Use this when you want to access state of the contract and are not interested in calling it.

Methods

toAddress :: a -> Address

Instances

ToAddress EpAddress

Defined in Lorentz.Address

Methods

toAddress :: EpAddress -> Address

ToAddress Address

Defined in Lorentz.Address

Methods

toAddress :: Address -> Address

ToAddress (ContractRef cp)

Defined in Lorentz.Address

Methods

toAddress :: ContractRef cp -> Address

ToAddress (FutureContract cp)

Defined in Lorentz.Address

Methods

toAddress :: FutureContract cp -> Address

ToAddress (TAddress cp)

Defined in Lorentz.Address

Methods

toAddress :: TAddress cp -> Address

class ToTAddress (cp :: Type) (a :: Type) where

Convert something referring to a contract (not specific entrypoint) to TAddress in Haskell world.

Methods

toTAddress :: a -> TAddress cp

Instances

ToTAddress cp Address

Defined in Lorentz.Address

Methods

toTAddress :: Address -> TAddress cp

cp ~ cp' => ToTAddress cp (TAddress cp')

Defined in Lorentz.Address

Methods

toTAddress :: TAddress cp' -> TAddress cp

type ToTAddress_ cp addr = (ToTAddress cp addr, ToT addr ~ ToT Address)

Something coercible to 'TAddress cp'.

toTAddress_ :: forall cp addr s. ToTAddress_ cp addr => (addr ': s) :-> (TAddress cp ': s)

Cast something appropriate to TAddress.

class ToContractRef (cp :: Type) (contract :: Type) where

Convert something to ContractRef in Haskell world.

Methods

toContractRef :: HasCallStack => contract -> ContractRef cp

Instances

(NiceParameter cp, cp ~ cp') => ToContractRef cp (FutureContract cp')

Defined in Lorentz.Address

Methods

toContractRef :: FutureContract cp' -> ContractRef cp

cp ~ cp' => ToContractRef cp (ContractRef cp')

Defined in Lorentz.Address

Methods

toContractRef :: ContractRef cp' -> ContractRef cp

(FailWhen cond msg, cond ~ (CanHaveEntryPoints cp && Not (ParameterEntryPointsDerivation cp == EpdNone)), msg ~ (((('Text "Cannot apply `ToContractRef` to `TAddress`" :$$: 'Text "Consider using call(Def)TAddress first`") :$$: 'Text "(or if you know your parameter type is primitive,") :$$: 'Text " make sure typechecker also knows about that)") :$$: (('Text "For parameter `" :<>: 'ShowType cp) :<>: 'Text "`")), cp ~ arg, NiceParameter arg, NiceParameterFull cp, GetDefaultEntryPointArg cp ~ cp) => ToContractRef arg (TAddress cp)

Defined in Lorentz.Address

Methods

toContractRef :: TAddress cp -> ContractRef arg

class FromContractRef (cp :: Type) (contract :: Type) where

Convert something from ContractAddr in Haskell world.

Methods

fromContractRef :: ContractRef cp -> contract

Instances

FromContractRef cp Address

Defined in Lorentz.Address

Methods

fromContractRef :: ContractRef cp -> Address

FromContractRef cp EpAddress

Defined in Lorentz.Address

Methods

fromContractRef :: ContractRef cp -> EpAddress

cp ~ cp' => FromContractRef cp (FutureContract cp')

Defined in Lorentz.Address

Methods

fromContractRef :: ContractRef cp -> FutureContract cp'

cp ~ cp' => FromContractRef cp (ContractRef cp')

Defined in Lorentz.Address

Methods

fromContractRef :: ContractRef cp -> ContractRef cp'

convertContractRef :: forall cp contract2 contract1. (ToContractRef cp contract1, FromContractRef cp contract2) => contract1 -> contract2

Re-exports

data Address

Data type corresponding to address structure in Tezos.

Instances

Eq Address

Defined in Tezos.Address

Methods

(==) :: Address -> Address -> Bool

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

Ord Address

Defined in Tezos.Address

Methods

compare :: Address -> Address -> Ordering

(<) :: Address -> Address -> Bool

(<=) :: Address -> Address -> Bool

(>) :: Address -> Address -> Bool

(>=) :: Address -> Address -> Bool

max :: Address -> Address -> Address

min :: Address -> Address -> Address

Show Address

Defined in Tezos.Address

Methods

showsPrec :: Int -> Address -> ShowS

show :: Address -> String

showList :: [Address] -> ShowS

Generic Address

Defined in Tezos.Address

Associated Types

type Rep Address :: Type -> Type

Methods

from :: Address -> Rep Address x

to :: Rep Address x -> Address

Arbitrary Address

Defined in Tezos.Address

Methods

arbitrary :: Gen Address

shrink :: Address -> [Address]

NFData Address

Defined in Tezos.Address

Methods

rnf :: Address -> ()

ToJSON Address

Defined in Tezos.Address

Methods

toJSON :: Address -> Value

toEncoding :: Address -> Encoding

toJSONList :: [Address] -> Value

toEncodingList :: [Address] -> Encoding

ToJSONKey Address

Defined in Tezos.Address

Methods

toJSONKey :: ToJSONKeyFunction Address

toJSONKeyList :: ToJSONKeyFunction [Address]

FromJSON Address

Defined in Tezos.Address

Methods

parseJSON :: Value -> Parser Address

parseJSONList :: Value -> Parser [Address]

FromJSONKey Address

Defined in Tezos.Address

Methods

fromJSONKey :: FromJSONKeyFunction Address

fromJSONKeyList :: FromJSONKeyFunction [Address]

Buildable Address

Defined in Tezos.Address

Methods

build :: Address -> Builder

TypeHasDoc Address

Defined in Michelson.Typed.Haskell.Doc

Associated Types

type TypeDocFieldDescriptions Address :: FieldDescriptions

Methods

typeDocName :: Proxy Address -> Text

typeDocMdDescription :: Markdown

typeDocMdReference :: Proxy Address -> WithinParens -> Markdown

typeDocDependencies :: Proxy Address -> [SomeDocDefinitionItem]

typeDocHaskellRep :: TypeDocHaskellRep Address

typeDocMichelsonRep :: TypeDocMichelsonRep Address

IsoValue Address

Defined in Michelson.Typed.Haskell.Value

Associated Types

type ToT Address :: T

Methods

toVal :: Address -> Value (ToT Address)

fromVal :: Value (ToT Address) -> Address

HasCLReader Address

Defined in Tezos.Address

Methods

getReader :: ReadM Address

getMetavar :: String

HasTypeAnn Address

Defined in Lorentz.TypeAnns

Methods

getTypeAnn :: Notes (ToT Address)

ToAddress Address

Defined in Lorentz.Address

Methods

toAddress :: Address -> Address

FromContractRef cp Address

Defined in Lorentz.Address

Methods

fromContractRef :: ContractRef cp -> Address

ToTAddress cp Address

Defined in Lorentz.Address

Methods

toTAddress :: Address -> TAddress cp

CanCastTo Address (TAddress p :: Type)

Defined in Lorentz.Coercions

Methods

castDummy :: Proxy Address -> Proxy (TAddress p) -> ()

CanCastTo (TAddress p :: Type) Address

Defined in Lorentz.Coercions

Methods

castDummy :: Proxy (TAddress p) -> Proxy Address -> ()

type Rep Address

Defined in Tezos.Address

type Rep Address = D1 ('MetaData "Address" "Tezos.Address" "morley-1.4.0-FPgS4VJ0cLmB07ubDf4i8P" 'False) (C1 ('MetaCons "KeyAddress" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 KeyHash)) :+: C1 ('MetaCons "ContractAddress" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ContractHash)))

type TypeDocFieldDescriptions Address

Defined in Michelson.Typed.Haskell.Doc

type TypeDocFieldDescriptions Address = '[] :: [(Symbol, (Maybe Symbol, [(Symbol, Symbol)]))]

type ToT Address

Defined in Michelson.Typed.Haskell.Value

type ToT Address = 'TAddress

data EpAddress

Address with optional entrypoint name attached to it. TODO: come up with better name?

Constructors

EpAddress

Fields

• eaAddress :: Address

  Address itself

• eaEntryPoint :: EpName

  Entrypoint name (might be empty)

Instances

Eq EpAddress

Defined in Michelson.Typed.EntryPoints

Methods

(==) :: EpAddress -> EpAddress -> Bool

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

Ord EpAddress

Defined in Michelson.Typed.EntryPoints

Methods

compare :: EpAddress -> EpAddress -> Ordering

(<) :: EpAddress -> EpAddress -> Bool

(<=) :: EpAddress -> EpAddress -> Bool

(>) :: EpAddress -> EpAddress -> Bool

(>=) :: EpAddress -> EpAddress -> Bool

max :: EpAddress -> EpAddress -> EpAddress

min :: EpAddress -> EpAddress -> EpAddress

Show EpAddress

Defined in Michelson.Typed.EntryPoints

Methods

showsPrec :: Int -> EpAddress -> ShowS

show :: EpAddress -> String

showList :: [EpAddress] -> ShowS

Generic EpAddress

Defined in Michelson.Typed.EntryPoints

Associated Types

type Rep EpAddress :: Type -> Type

Methods

from :: EpAddress -> Rep EpAddress x

to :: Rep EpAddress x -> EpAddress

Arbitrary FieldAnn => Arbitrary EpAddress

Defined in Michelson.Typed.EntryPoints

Methods

arbitrary :: Gen EpAddress

shrink :: EpAddress -> [EpAddress]

NFData EpAddress

Defined in Michelson.Typed.EntryPoints

Methods

rnf :: EpAddress -> ()

Buildable EpAddress

Defined in Michelson.Typed.EntryPoints

Methods

build :: EpAddress -> Builder

TypeHasDoc EpAddress

Defined in Michelson.Typed.Haskell.Doc

Associated Types

type TypeDocFieldDescriptions EpAddress :: FieldDescriptions

Methods

typeDocName :: Proxy EpAddress -> Text

typeDocMdDescription :: Markdown

typeDocMdReference :: Proxy EpAddress -> WithinParens -> Markdown

typeDocDependencies :: Proxy EpAddress -> [SomeDocDefinitionItem]

typeDocHaskellRep :: TypeDocHaskellRep EpAddress

typeDocMichelsonRep :: TypeDocMichelsonRep EpAddress

IsoValue EpAddress

Defined in Michelson.Typed.Haskell.Value

Associated Types

type ToT EpAddress :: T

Methods

toVal :: EpAddress -> Value (ToT EpAddress)

fromVal :: Value (ToT EpAddress) -> EpAddress

HasTypeAnn EpAddress

Defined in Lorentz.TypeAnns

Methods

getTypeAnn :: Notes (ToT EpAddress)

ToAddress EpAddress

Defined in Lorentz.Address

Methods

toAddress :: EpAddress -> Address

FromContractRef cp EpAddress

Defined in Lorentz.Address

Methods

fromContractRef :: ContractRef cp -> EpAddress

CanCastTo (FutureContract p :: Type) EpAddress

Defined in Lorentz.Coercions

Methods

castDummy :: Proxy (FutureContract p) -> Proxy EpAddress -> ()

type Rep EpAddress

Defined in Michelson.Typed.EntryPoints

type Rep EpAddress = D1 ('MetaData "EpAddress" "Michelson.Typed.EntryPoints" "morley-1.4.0-FPgS4VJ0cLmB07ubDf4i8P" 'False) (C1 ('MetaCons "EpAddress" 'PrefixI 'True) (S1 ('MetaSel ('Just "eaAddress") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Address) :*: S1 ('MetaSel ('Just "eaEntryPoint") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 EpName)))

type TypeDocFieldDescriptions EpAddress

Defined in Michelson.Typed.Haskell.Doc

type TypeDocFieldDescriptions EpAddress = '[] :: [(Symbol, (Maybe Symbol, [(Symbol, Symbol)]))]

type ToT EpAddress

Defined in Michelson.Typed.Haskell.Value

type ToT EpAddress = 'TAddress

data ContractRef arg

Since Contract name is used to designate contract code, lets call analogy of TContract type as follows.

Note that type argument always designates an argument of entrypoint. If a contract has explicit default entrypoint (and no root entrypoint), ContractRef referring to it can never have the entire parameter as its type argument.

Constructors

ContractRef

Fields

• crAddress :: Address
• crEntryPoint :: SomeEntryPointCall arg

Instances

cp ~ cp' => FromContractRef cp (ContractRef cp')

Defined in Lorentz.Address

Methods

fromContractRef :: ContractRef cp -> ContractRef cp'

cp ~ cp' => ToContractRef cp (ContractRef cp')

Defined in Lorentz.Address

Methods

toContractRef :: ContractRef cp' -> ContractRef cp

Eq (ContractRef arg)

Defined in Michelson.Typed.Haskell.Value

Methods

(==) :: ContractRef arg -> ContractRef arg -> Bool

(/=) :: ContractRef arg -> ContractRef arg -> Bool

Show (ContractRef arg)

Defined in Michelson.Typed.Haskell.Value

Methods

showsPrec :: Int -> ContractRef arg -> ShowS

show :: ContractRef arg -> String

showList :: [ContractRef arg] -> ShowS

WellTypedToT arg => Buildable (ContractRef arg)

Defined in Michelson.Typed.Haskell.Value

Methods

build :: ContractRef arg -> Builder

PolyTypeHasDocC '[cp] => TypeHasDoc (ContractRef cp)

Defined in Michelson.Typed.Haskell.Doc

Associated Types

type TypeDocFieldDescriptions (ContractRef cp) :: FieldDescriptions

Methods

typeDocName :: Proxy (ContractRef cp) -> Text

typeDocMdDescription :: Markdown

typeDocMdReference :: Proxy (ContractRef cp) -> WithinParens -> Markdown

typeDocDependencies :: Proxy (ContractRef cp) -> [SomeDocDefinitionItem]

typeDocHaskellRep :: TypeDocHaskellRep (ContractRef cp)

typeDocMichelsonRep :: TypeDocMichelsonRep (ContractRef cp)

WellTypedToT arg => IsoValue (ContractRef arg)

Defined in Michelson.Typed.Haskell.Value

Associated Types

type ToT (ContractRef arg) :: T

Methods

toVal :: ContractRef arg -> Value (ToT (ContractRef arg))

fromVal :: Value (ToT (ContractRef arg)) -> ContractRef arg

HasTypeAnn a => HasTypeAnn (ContractRef a)

Defined in Lorentz.TypeAnns

Methods

getTypeAnn :: Notes (ToT (ContractRef a))

ToAddress (ContractRef cp)

Defined in Lorentz.Address

Methods

toAddress :: ContractRef cp -> Address

CanCastTo a1 a2 => CanCastTo (ContractRef a1 :: Type) (ContractRef a2 :: Type)

Defined in Lorentz.Coercions

Methods

castDummy :: Proxy (ContractRef a1) -> Proxy (ContractRef a2) -> ()

type TypeDocFieldDescriptions (ContractRef cp)

Defined in Michelson.Typed.Haskell.Doc

type TypeDocFieldDescriptions (ContractRef cp) = '[] :: [(Symbol, (Maybe Symbol, [(Symbol, Symbol)]))]

type ToT (ContractRef arg)

Defined in Michelson.Typed.Haskell.Value

type ToT (ContractRef arg) = 'TContract (ToT arg)

coerceContractRef :: ToT a ~ ToT b => ContractRef a -> ContractRef b

Replace type argument of ContractAddr with isomorphic one.