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 :: Type) (vd :: Type)

Address which remembers the parameter and views types 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

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

Defined in Lorentz.Address

Methods

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

(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 vd)

Defined in Lorentz.Address

Methods

toContractRef :: TAddress cp vd -> ContractRef arg

CanCastTo Address (TAddress p vd :: Type)

Defined in Lorentz.Coercions

Methods

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

CanCastTo (TAddress p vd :: Type) Address

Defined in Lorentz.Coercions

Methods

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

Generic (TAddress p vd)

Defined in Lorentz.Address

Associated Types

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

Methods

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

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

Show (TAddress p vd)

Defined in Lorentz.Address

Methods

showsPrec :: Int -> TAddress p vd -> ShowS

show :: TAddress p vd -> String

showList :: [TAddress p vd] -> ShowS

Buildable (TAddress p vd)

Defined in Lorentz.Address

Methods

build :: TAddress p vd -> Builder

Eq (TAddress p vd)

Defined in Lorentz.Address

Methods

(==) :: TAddress p vd -> TAddress p vd -> Bool

(/=) :: TAddress p vd -> TAddress p vd -> Bool

Ord (TAddress p vd)

Defined in Lorentz.Address

Methods

compare :: TAddress p vd -> TAddress p vd -> Ordering

(<) :: TAddress p vd -> TAddress p vd -> Bool

(<=) :: TAddress p vd -> TAddress p vd -> Bool

(>) :: TAddress p vd -> TAddress p vd -> Bool

(>=) :: TAddress p vd -> TAddress p vd -> Bool

max :: TAddress p vd -> TAddress p vd -> TAddress p vd

min :: TAddress p vd -> TAddress p vd -> TAddress p vd

ToAddress (TAddress cp vd)

Defined in Lorentz.Address

Methods

toAddress :: TAddress cp vd -> Address

HasAnnotation (TAddress p vd)

Defined in Lorentz.Address

Methods

getAnnotation :: FollowEntrypointFlag -> Notes (ToT (TAddress p vd))

annOptions :: AnnOptions

HasRPCRepr (TAddress cp vd)

Defined in Lorentz.Address

Associated Types

type AsRPC (TAddress cp vd)

(TypeHasDoc p, ViewsDescriptorHasDoc vd) => TypeHasDoc (TAddress p vd)

Defined in Lorentz.Doc

Associated Types

type TypeDocFieldDescriptions (TAddress p vd) :: FieldDescriptions

Methods

typeDocName :: Proxy (TAddress p vd) -> Text

typeDocMdDescription :: Markdown

typeDocMdReference :: Proxy (TAddress p vd) -> WithinParens -> Markdown

typeDocDependencies :: Proxy (TAddress p vd) -> [SomeDocDefinitionItem]

typeDocHaskellRep :: TypeDocHaskellRep (TAddress p vd)

typeDocMichelsonRep :: TypeDocMichelsonRep (TAddress p vd)

IsoValue (TAddress p vd)

Defined in Lorentz.Address

Associated Types

type ToT (TAddress p vd) :: T

Methods

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

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

type Rep (TAddress p vd)

Defined in Lorentz.Address

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

type AsRPC (TAddress cp vd)

Defined in Lorentz.Address

type AsRPC (TAddress cp vd) = TAddress cp vd

type TypeDocFieldDescriptions (TAddress p vd)

Defined in Lorentz.Doc

type TypeDocFieldDescriptions (TAddress p vd) = '[] :: [(Symbol, (Maybe Symbol, [(Symbol, Symbol)]))]

type ToT (TAddress p vd)

Defined in Lorentz.Address

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

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

ToAddress (FutureContract cp)

Defined in Lorentz.Address

Methods

toAddress :: FutureContract cp -> Address

HasAnnotation (FutureContract a)

Defined in Lorentz.Address

Methods

getAnnotation :: FollowEntrypointFlag -> Notes (ToT (FutureContract a))

annOptions :: AnnOptions

HasRPCRepr (FutureContract p)

Defined in Lorentz.Address

Associated Types

type AsRPC (FutureContract p)

TypeHasDoc p => TypeHasDoc (FutureContract p)

Defined in Lorentz.Doc

Associated Types

type TypeDocFieldDescriptions (FutureContract p) :: FieldDescriptions

Methods

typeDocName :: Proxy (FutureContract p) -> Text

typeDocMdDescription :: Markdown

typeDocMdReference :: Proxy (FutureContract p) -> WithinParens -> Markdown

typeDocDependencies :: Proxy (FutureContract p) -> [SomeDocDefinitionItem]

typeDocHaskellRep :: TypeDocHaskellRep (FutureContract p)

typeDocMichelsonRep :: TypeDocMichelsonRep (FutureContract p)

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

CanCastTo (FutureContract p :: Type) EpAddress

Defined in Lorentz.Coercions

Methods

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

type AsRPC (FutureContract p)

Defined in Lorentz.Address

type AsRPC (FutureContract p) = FutureContract p

type TypeDocFieldDescriptions (FutureContract p)

Defined in Lorentz.Doc

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

type ToT (FutureContract arg)

Defined in Lorentz.Address

type ToT (FutureContract arg) = ToT EpAddress

Conversions

asAddressOf :: contract cp st vd -> Address -> TAddress cp vd

For a contract and an address of its instance, construct a typed address.

asAddressOf_ :: contract cp st vd -> (Address ': s) :-> (TAddress cp vd ': s)

callingAddress :: forall cp vd addr mname. (ToTAddress cp vd addr, NiceParameterFull cp) => addr -> EntrypointRef mname -> ContractRef (GetEntrypointArgCustom cp mname)

Turn any typed address 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).

callingDefAddress :: forall cp vd addr. (ToTAddress cp vd addr, NiceParameterFull cp) => addr -> ContractRef (GetDefaultEntrypointArg cp)

Specialization of callingAddress 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 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

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

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

Methods

toTAddress :: a -> TAddress cp vd

Instances

ToTAddress cp vd Address

Defined in Lorentz.Address

Methods

toTAddress :: Address -> TAddress cp vd

ToTAddress cp vd ContractAddress

Defined in Lorentz.Address

Methods

toTAddress :: ContractAddress -> TAddress cp vd

(cp ~ (), vd ~ ()) => ToTAddress cp vd ImplicitAddress

Defined in Lorentz.Address

Methods

toTAddress :: ImplicitAddress -> TAddress cp vd

ToTAddress cp vd L1Address

Defined in Lorentz.Address

Methods

toTAddress :: L1Address -> TAddress cp vd

(cp ~ Txr1CallParam a, vd ~ ()) => ToTAddress cp vd TxRollupAddress

Defined in Lorentz.Txr1Call

Methods

toTAddress :: TxRollupAddress -> TAddress cp vd

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

Defined in Lorentz.Address

Methods

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

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

Something coercible to 'TAddress cp'.

toTAddress_ :: forall cp addr vd s. ToTAddress_ cp vd addr => (addr ': s) :-> (TAddress cp vd ': 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 vd)

Defined in Lorentz.Address

Methods

toContractRef :: TAddress cp vd -> ContractRef arg

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

Convert something from ContractRef in Haskell world.

Methods

fromContractRef :: ContractRef cp -> contract

Instances

FromContractRef cp EpAddress

Defined in Lorentz.Address

Methods

fromContractRef :: ContractRef cp -> EpAddress

FromContractRef cp Address

Defined in Lorentz.Address

Methods

fromContractRef :: ContractRef cp -> Address

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

type Address = ConstrainedAddress '['AddressKindImplicit, 'AddressKindContract, 'AddressKindTxRollup]

data EpAddress

Constructors

EpAddress'

Fields

• eaAddress :: Address
• eaEntrypoint :: EpName

Bundled Patterns

pattern EpAddress :: forall (kind :: AddressKind). () => KindedAddress kind -> EpName -> EpAddress

Instances

Generic EpAddress

Defined in Morley.Michelson.Typed.Entrypoints

Associated Types

type Rep EpAddress :: Type -> Type

Methods

from :: EpAddress -> Rep EpAddress x

to :: Rep EpAddress x -> EpAddress

Show EpAddress

Defined in Morley.Michelson.Typed.Entrypoints

Methods

showsPrec :: Int -> EpAddress -> ShowS

show :: EpAddress -> String

showList :: [EpAddress] -> ShowS

NFData EpAddress

Defined in Morley.Michelson.Typed.Entrypoints

Methods

rnf :: EpAddress -> ()

Buildable EpAddress

Defined in Morley.Michelson.Typed.Entrypoints

Methods

build :: EpAddress -> Builder

Eq EpAddress

Defined in Morley.Michelson.Typed.Entrypoints

Methods

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

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

Ord EpAddress

Defined in Morley.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

ToAddress EpAddress

Defined in Lorentz.Address

Methods

toAddress :: EpAddress -> Address

HasAnnotation EpAddress

Defined in Lorentz.Annotation

Methods

getAnnotation :: FollowEntrypointFlag -> Notes (ToT EpAddress)

annOptions :: AnnOptions

HasRPCRepr EpAddress

Defined in Morley.AsRPC

Associated Types

type AsRPC EpAddress

TypeHasDoc EpAddress

Defined in Morley.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 Morley.Michelson.Typed.Haskell.Value

Associated Types

type ToT EpAddress :: T

Methods

toVal :: EpAddress -> Value (ToT EpAddress)

fromVal :: Value (ToT EpAddress) -> EpAddress

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 Morley.Michelson.Typed.Entrypoints

type Rep EpAddress = D1 ('MetaData "EpAddress" "Morley.Michelson.Typed.Entrypoints" "morley-1.18.0-inplace" '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 AsRPC EpAddress

Defined in Morley.AsRPC

type AsRPC EpAddress = EpAddress

type TypeDocFieldDescriptions EpAddress

Defined in Morley.Michelson.Typed.Haskell.Doc

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

type ToT EpAddress

Defined in Morley.Michelson.Typed.Haskell.Value

type ToT EpAddress = 'TAddress

data ContractRef arg

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

Show (ContractRef arg)

Defined in Morley.Michelson.Typed.Haskell.Value

Methods

showsPrec :: Int -> ContractRef arg -> ShowS

show :: ContractRef arg -> String

showList :: [ContractRef arg] -> ShowS

IsoValue (ContractRef arg) => Buildable (ContractRef arg)

Defined in Morley.Michelson.Typed.Haskell.Value

Methods

build :: ContractRef arg -> Builder

Eq (ContractRef arg)

Defined in Morley.Michelson.Typed.Haskell.Value

Methods

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

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

ToAddress (ContractRef cp)

Defined in Lorentz.Address

Methods

toAddress :: ContractRef cp -> Address

HasAnnotation a => HasAnnotation (ContractRef a)

Defined in Lorentz.Annotation

Methods

getAnnotation :: FollowEntrypointFlag -> Notes (ToT (ContractRef a))

annOptions :: AnnOptions

HasRPCRepr (ContractRef arg)

Defined in Morley.AsRPC

Associated Types

type AsRPC (ContractRef arg)

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

Defined in Morley.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)

(HasNoOpToT arg, WellTypedToT arg) => IsoValue (ContractRef arg)

Defined in Morley.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

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

Defined in Lorentz.Coercions

Methods

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

type AsRPC (ContractRef arg)

Defined in Morley.AsRPC

type AsRPC (ContractRef arg) = ContractRef arg

type TypeDocFieldDescriptions (ContractRef cp)

Defined in Morley.Michelson.Typed.Haskell.Doc

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

type ToT (ContractRef arg)

Defined in Morley.Michelson.Typed.Haskell.Value

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

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