| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
Lorentz.Address
Contents
Description
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.
Synopsis
- newtype TAddress p = TAddress {}
- newtype FutureContract arg = FutureContract {
- unFutureContract :: ContractRef arg
- callingTAddress :: forall cp mname. NiceParameterFull cp => TAddress cp -> EntrypointRef mname -> ContractRef (GetEntrypointArgCustom cp mname)
- callingDefTAddress :: forall cp. NiceParameterFull cp => TAddress cp -> ContractRef (GetDefaultEntrypointArg cp)
- class ToAddress a where
- class ToTAddress (cp :: Type) (a :: Type) where
- toTAddress :: a -> TAddress cp
- type ToTAddress_ cp addr = (ToTAddress cp addr, ToT addr ~ ToT Address)
- toTAddress_ :: forall cp addr s. ToTAddress_ cp addr => (addr ': s) :-> (TAddress cp ': s)
- class ToContractRef (cp :: Type) (contract :: Type) where
- toContractRef :: HasCallStack => contract -> ContractRef cp
- class FromContractRef (cp :: Type) (contract :: Type) where
- fromContractRef :: ContractRef cp -> contract
- convertContractRef :: forall cp contract2 contract1. (ToContractRef cp contract1, FromContractRef cp contract2) => contract1 -> contract2
- data Address
- data EpAddress = EpAddress {}
- data ContractRef arg = ContractRef {
- crAddress :: Address
- crEntrypoint :: SomeEntrypointCall arg
- coerceContractRef :: ToT a ~ ToT b => ContractRef a -> ContractRef b
Documentation
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 | |
Instances
newtype FutureContract arg Source #
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
| |
Instances
Conversions
callingTAddress :: forall cp mname. NiceParameterFull cp => TAddress cp -> EntrypointRef mname -> ContractRef (GetEntrypointArgCustom cp mname) Source #
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) Source #
Specification of callTAddress to call the default entrypoint.
class ToAddress a where Source #
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.
Instances
| ToAddress Address Source # | |
| ToAddress EpAddress Source # | |
| ToAddress (ContractRef cp) Source # | |
Defined in Lorentz.Address Methods toAddress :: ContractRef cp -> Address Source # | |
| ToAddress (FutureContract cp) Source # | |
Defined in Lorentz.Address Methods toAddress :: FutureContract cp -> Address Source # | |
| ToAddress (TAddress cp) Source # | |
class ToTAddress (cp :: Type) (a :: Type) where Source #
Convert something referring to a contract (not specific entrypoint)
to TAddress in Haskell world.
Methods
toTAddress :: a -> TAddress cp Source #
Instances
| ToTAddress cp Address Source # | |
Defined in Lorentz.Address Methods toTAddress :: Address -> TAddress cp Source # | |
| cp ~ cp' => ToTAddress cp (TAddress cp') Source # | |
Defined in Lorentz.Address Methods toTAddress :: TAddress cp' -> TAddress cp Source # | |
type ToTAddress_ cp addr = (ToTAddress cp addr, ToT addr ~ ToT Address) Source #
Something coercible to 'TAddress cp'.
toTAddress_ :: forall cp addr s. ToTAddress_ cp addr => (addr ': s) :-> (TAddress cp ': s) Source #
Cast something appropriate to TAddress.
class ToContractRef (cp :: Type) (contract :: Type) where Source #
Convert something to ContractRef in Haskell world.
Methods
toContractRef :: HasCallStack => contract -> ContractRef cp Source #
Instances
| (NiceParameter cp, cp ~ cp') => ToContractRef cp (FutureContract cp') Source # | |
Defined in Lorentz.Address Methods toContractRef :: FutureContract cp' -> ContractRef cp Source # | |
| cp ~ cp' => ToContractRef cp (ContractRef cp') Source # | |
Defined in Lorentz.Address Methods toContractRef :: ContractRef cp' -> ContractRef cp Source # | |
| (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) Source # | |
Defined in Lorentz.Address Methods toContractRef :: TAddress cp -> ContractRef arg Source # | |
class FromContractRef (cp :: Type) (contract :: Type) where Source #
Convert something from ContractAddr in Haskell world.
Methods
fromContractRef :: ContractRef cp -> contract Source #
Instances
| FromContractRef cp Address Source # | |
Defined in Lorentz.Address Methods fromContractRef :: ContractRef cp -> Address Source # | |
| FromContractRef cp EpAddress Source # | |
Defined in Lorentz.Address Methods fromContractRef :: ContractRef cp -> EpAddress Source # | |
| cp ~ cp' => FromContractRef cp (FutureContract cp') Source # | |
Defined in Lorentz.Address Methods fromContractRef :: ContractRef cp -> FutureContract cp' Source # | |
| cp ~ cp' => FromContractRef cp (ContractRef cp') Source # | |
Defined in Lorentz.Address Methods fromContractRef :: ContractRef cp -> ContractRef cp' Source # | |
convertContractRef :: forall cp contract2 contract1. (ToContractRef cp contract1, FromContractRef cp contract2) => contract1 -> contract2 Source #
Re-exports
Instances
Constructors
| EpAddress | |
Fields
| |
Instances
data ContractRef arg #
Constructors
| ContractRef | |
Fields
| |
Instances
coerceContractRef :: ToT a ~ ToT b => ContractRef a -> ContractRef b #