Morley.Client.RPC.AsRPC

This module contains a type family for converting a type to its RPC representation, and TemplateHaskell functions for deriving RPC representations for custom types.

Documentation

type family AsRPC (a :: k) :: k

A type-level function that maps a type to its Tezos RPC representation.

For example, when we retrieve a contract's storage using the Tezos RPC, all its BigMaps will be replaced by BigMapIds.

So if a contract has a storage of type T, when we call the Tezos RPC to retrieve it, we must deserialize the micheline expression to the type AsRPC T.

AsRPC (BigMap Integer MText) ~ BigMapId Integer MText
AsRPC [BigMap Integer MText] ~ [BigMapId Integer MText]
AsRPC (MText, (Address, BigMap Integer MText)) ~ (MText, (Address, BigMapId Integer MText))

The following law holds IFF a type t has an IsoValue instance:

ToT (AsRPC t) ~ AsRPC (ToT t)

Instances

type AsRPC 'TNat

Defined in Morley.Client.RPC.AsRPC

type AsRPC 'TNat = 'TNat

type AsRPC 'TBytes

Defined in Morley.Client.RPC.AsRPC

type AsRPC 'TBytes = 'TBytes

type AsRPC 'TAddress

Defined in Morley.Client.RPC.AsRPC

type AsRPC 'TAddress = 'TAddress

type AsRPC 'TBls12381Fr

Defined in Morley.Client.RPC.AsRPC

type AsRPC 'TBls12381Fr = 'TBls12381Fr

type AsRPC 'TBls12381G1

Defined in Morley.Client.RPC.AsRPC

type AsRPC 'TBls12381G1 = 'TBls12381G1

type AsRPC 'TBls12381G2

Defined in Morley.Client.RPC.AsRPC

type AsRPC 'TBls12381G2 = 'TBls12381G2

type AsRPC 'TBool

Defined in Morley.Client.RPC.AsRPC

type AsRPC 'TBool = 'TBool

type AsRPC 'TChainId

Defined in Morley.Client.RPC.AsRPC

type AsRPC 'TChainId = 'TChainId

type AsRPC 'TChest

Defined in Morley.Client.RPC.AsRPC

type AsRPC 'TChest = 'TChest

type AsRPC 'TChestKey

Defined in Morley.Client.RPC.AsRPC

type AsRPC 'TChestKey = 'TChestKey

type AsRPC 'TInt

Defined in Morley.Client.RPC.AsRPC

type AsRPC 'TInt = 'TInt

type AsRPC 'TKey

Defined in Morley.Client.RPC.AsRPC

type AsRPC 'TKey = 'TKey

type AsRPC 'TKeyHash

Defined in Morley.Client.RPC.AsRPC

type AsRPC 'TKeyHash = 'TKeyHash

type AsRPC 'TMutez

Defined in Morley.Client.RPC.AsRPC

type AsRPC 'TMutez = 'TMutez

type AsRPC 'TNever

Defined in Morley.Client.RPC.AsRPC

type AsRPC 'TNever = 'TNever

type AsRPC 'TOperation

Defined in Morley.Client.RPC.AsRPC

type AsRPC 'TOperation = 'TOperation

type AsRPC 'TSignature

Defined in Morley.Client.RPC.AsRPC

type AsRPC 'TSignature = 'TSignature

type AsRPC 'TString

Defined in Morley.Client.RPC.AsRPC

type AsRPC 'TString = 'TString

type AsRPC 'TTimestamp

Defined in Morley.Client.RPC.AsRPC

type AsRPC 'TTimestamp = 'TTimestamp

type AsRPC 'TUnit

Defined in Morley.Client.RPC.AsRPC

type AsRPC 'TUnit = 'TUnit

type AsRPC ('TContract t :: T)

Defined in Morley.Client.RPC.AsRPC

type AsRPC ('TContract t :: T) = 'TContract t

type AsRPC ('TList t :: T)

Defined in Morley.Client.RPC.AsRPC

type AsRPC ('TList t :: T) = 'TList (AsRPC t)

type AsRPC ('TOption t :: T)

Defined in Morley.Client.RPC.AsRPC

type AsRPC ('TOption t :: T) = 'TOption (AsRPC t)

type AsRPC ('TSet t :: T)

Defined in Morley.Client.RPC.AsRPC

type AsRPC ('TSet t :: T) = 'TSet t

type AsRPC ('TTicket t :: T)

Defined in Morley.Client.RPC.AsRPC

type AsRPC ('TTicket t :: T) = 'TTicket t

type AsRPC ('TPair t1 t2 :: T)

Defined in Morley.Client.RPC.AsRPC

type AsRPC ('TPair t1 t2 :: T) = 'TPair (AsRPC t1) (AsRPC t2)

type AsRPC ('TBigMap _1 _2 :: T)

Defined in Morley.Client.RPC.AsRPC

type AsRPC ('TBigMap _1 _2 :: T) = 'TNat

type AsRPC ('TLambda t1 t2 :: T)

Defined in Morley.Client.RPC.AsRPC

type AsRPC ('TLambda t1 t2 :: T) = 'TLambda t1 t2

type AsRPC ('TMap k v :: T)

Defined in Morley.Client.RPC.AsRPC

type AsRPC ('TMap k v :: T) = 'TMap k (AsRPC v)

type AsRPC ('TOr t1 t2 :: T)

Defined in Morley.Client.RPC.AsRPC

type AsRPC ('TOr t1 t2 :: T) = 'TOr (AsRPC t1) (AsRPC t2)

type AsRPC Bool

Defined in Morley.Client.RPC.AsRPC

type AsRPC Bool = Bool

type AsRPC Integer

Defined in Morley.Client.RPC.AsRPC

type AsRPC Integer = Integer

type AsRPC Natural

Defined in Morley.Client.RPC.AsRPC

type AsRPC Natural = Natural

type AsRPC ()

Defined in Morley.Client.RPC.AsRPC

type AsRPC () = ()

type AsRPC ByteString

Defined in Morley.Client.RPC.AsRPC

type AsRPC ByteString = ByteString

type AsRPC Empty

Defined in Morley.Client.RPC.AsRPC

type AsRPC Empty = Empty

type AsRPC Never

Defined in Morley.Client.RPC.AsRPC

type AsRPC Never = Never

type AsRPC OpenChest

Defined in Morley.Client.RPC.AsRPC

type AsRPC OpenChest = OpenChest

type AsRPC MText

Defined in Morley.Client.RPC.AsRPC

type AsRPC MText = MText

type AsRPC Operation

Defined in Morley.Client.RPC.AsRPC

type AsRPC Operation = Operation

type AsRPC EpAddress

Defined in Morley.Client.RPC.AsRPC

type AsRPC EpAddress = EpAddress

type AsRPC Address

Defined in Morley.Client.RPC.AsRPC

type AsRPC Address = Address

type AsRPC ChainId

Defined in Morley.Client.RPC.AsRPC

type AsRPC ChainId = ChainId

type AsRPC Mutez

Defined in Morley.Client.RPC.AsRPC

type AsRPC Mutez = Mutez

type AsRPC Timestamp

Defined in Morley.Client.RPC.AsRPC

type AsRPC Timestamp = Timestamp

type AsRPC KeyHash

Defined in Morley.Client.RPC.AsRPC

type AsRPC KeyHash = KeyHash

type AsRPC PublicKey

Defined in Morley.Client.RPC.AsRPC

type AsRPC PublicKey = PublicKey

type AsRPC Signature

Defined in Morley.Client.RPC.AsRPC

type AsRPC Signature = Signature

type AsRPC Bls12381Fr

Defined in Morley.Client.RPC.AsRPC

type AsRPC Bls12381Fr = Bls12381Fr

type AsRPC Bls12381G1

Defined in Morley.Client.RPC.AsRPC

type AsRPC Bls12381G1 = Bls12381G1

type AsRPC Bls12381G2

Defined in Morley.Client.RPC.AsRPC

type AsRPC Bls12381G2 = Bls12381G2

type AsRPC Chest

Defined in Morley.Client.RPC.AsRPC

type AsRPC Chest = Chest

type AsRPC ChestKey

Defined in Morley.Client.RPC.AsRPC

type AsRPC ChestKey = ChestKey

type AsRPC ([a] :: Type)

Defined in Morley.Client.RPC.AsRPC

type AsRPC ([a] :: Type) = [AsRPC a]

type AsRPC (Maybe a :: Type)

Defined in Morley.Client.RPC.AsRPC

type AsRPC (Maybe a :: Type) = Maybe (AsRPC a)

type AsRPC (Identity a :: Type)

Defined in Morley.Client.RPC.AsRPC

type AsRPC (Identity a :: Type) = Identity (AsRPC a)

type AsRPC (Set a :: Type)

Defined in Morley.Client.RPC.AsRPC

type AsRPC (Set a :: Type) = Set a

type AsRPC (FutureContract p :: Type)

Defined in Morley.Client.RPC.AsRPC

type AsRPC (FutureContract p :: Type) = FutureContract p

type AsRPC (ChestT a :: Type)

Defined in Morley.Client.RPC.AsRPC

type AsRPC (ChestT a :: Type) = ChestT a

type AsRPC (OpenChestT a :: Type)

Defined in Morley.Client.RPC.AsRPC

type AsRPC (OpenChestT a :: Type) = OpenChestT a

type AsRPC (Packed a :: Type)

Defined in Morley.Client.RPC.AsRPC

type AsRPC (Packed a :: Type) = Packed a

type AsRPC (TSignature a :: Type)

Defined in Morley.Client.RPC.AsRPC

type AsRPC (TSignature a :: Type) = TSignature a

type AsRPC (ShouldHaveEntrypoints a :: Type)

Defined in Morley.Client.RPC.AsRPC

type AsRPC (ShouldHaveEntrypoints a :: Type) = ShouldHaveEntrypoints a

type AsRPC (UParam entries :: Type)

Defined in Morley.Client.RPC.AsRPC

type AsRPC (UParam entries :: Type) = UParam entries

type AsRPC (ContractRef arg :: Type)

Defined in Morley.Client.RPC.AsRPC

type AsRPC (ContractRef arg :: Type) = ContractRef arg

type AsRPC (Either l r :: Type)

Defined in Morley.Client.RPC.AsRPC

type AsRPC (Either l r :: Type) = Either (AsRPC l) (AsRPC r)

type AsRPC ((a, b) :: Type)

Defined in Morley.Client.RPC.AsRPC

type AsRPC ((a, b) :: Type) = (AsRPC a, AsRPC b)

type AsRPC (Map k v :: Type)

Defined in Morley.Client.RPC.AsRPC

type AsRPC (Map k v :: Type) = Map k (AsRPC v)

type AsRPC (TAddress p vd :: Type)

Defined in Morley.Client.RPC.AsRPC

type AsRPC (TAddress p vd :: Type) = TAddress p vd

type AsRPC (inp :-> out :: Type)

Defined in Morley.Client.RPC.AsRPC

type AsRPC (inp :-> out :: Type) = inp :-> out

type AsRPC (Hash alg a :: Type)

Defined in Morley.Client.RPC.AsRPC

type AsRPC (Hash alg a :: Type) = Hash alg a

type AsRPC (ParameterWrapper deriv cp :: Type)

Defined in Morley.Client.RPC.AsRPC

type AsRPC (ParameterWrapper deriv cp :: Type) = ParameterWrapper deriv (AsRPC cp)

type AsRPC (View_ a r :: Type)

Defined in Morley.Client.RPC.AsRPC

type AsRPC (View_ a r :: Type) = View_ a r

type AsRPC (Void_ a r :: Type)

Defined in Morley.Client.RPC.AsRPC

type AsRPC (Void_ a r :: Type) = Void_ a r

type AsRPC (BigMap k v :: Type)

Defined in Morley.Client.RPC.AsRPC

type AsRPC (BigMap k v :: Type) = BigMapId k v

type AsRPC (Extensible x :: Type)

Defined in Morley.Client.RPC.AsRPC

type AsRPC (Extensible x :: Type) = Extensible x

type AsRPC (Value' instr t :: Type)

Defined in Morley.Client.RPC.AsRPC

type AsRPC (Value' instr t :: Type) = Value' instr (AsRPC t)

type AsRPC ((a, b, c) :: Type)

Defined in Morley.Client.RPC.AsRPC

type AsRPC ((a, b, c) :: Type) = (AsRPC a, AsRPC b, AsRPC c)

type AsRPC (NamedF Maybe a name :: Type)

Defined in Morley.Client.RPC.AsRPC

type AsRPC (NamedF Maybe a name :: Type) = NamedF Maybe (AsRPC a) name

type AsRPC (NamedF Identity a name :: Type)

Defined in Morley.Client.RPC.AsRPC

type AsRPC (NamedF Identity a name :: Type) = NamedF Identity (AsRPC a) name

type AsRPC ((a, b, c, d) :: Type)

Defined in Morley.Client.RPC.AsRPC

type AsRPC ((a, b, c, d) :: Type) = (AsRPC a, AsRPC b, AsRPC c, AsRPC d)

type AsRPC ((a, b, c, d, e) :: Type)

Defined in Morley.Client.RPC.AsRPC

type AsRPC ((a, b, c, d, e) :: Type) = (AsRPC a, AsRPC b, AsRPC c, AsRPC d, AsRPC e)

type AsRPC ((a, b, c, d, e, f) :: Type)

Defined in Morley.Client.RPC.AsRPC

type AsRPC ((a, b, c, d, e, f) :: Type) = (AsRPC a, AsRPC b, AsRPC c, AsRPC d, AsRPC e, AsRPC f)

type AsRPC ((a, b, c, d, e, f, g) :: Type)

Defined in Morley.Client.RPC.AsRPC

type AsRPC ((a, b, c, d, e, f, g) :: Type) = (AsRPC a, AsRPC b, AsRPC c, AsRPC d, AsRPC e, AsRPC f, AsRPC g)

type AsRPC (TAddress cp :: Type -> Type)

Defined in Morley.Client.RPC.AsRPC

type AsRPC (TAddress cp :: Type -> Type) = TAddress cp

deriveRPC :: String -> Q [Dec]

Derive an RPC representation for a type, as well as instances for Generic, IsoValue and AsRPC.

data ExampleStorage a b = ExampleStorage
  { esField1 :: Integer
  , esField2 :: [BigMap Integer MText]
  , esField3 :: a
  }
  deriving stock Generic
  deriving anyclass IsoValue

deriveRPC "ExampleStorage"

Will generate:

data ExampleStorageRPC a b = ExampleStorageRPC
  { esField1RPC :: AsRPC Integer
  , esField2RPC :: AsRPC [BigMap Integer MText]
  , esField3RPC :: AsRPC a
  }

type instance AsRPC (ExampleStorage a b) = ExampleStorageRPC a b
deriving anyclass instance (IsoValue (AsRPC a), IsoValue (AsRPC b)) => IsoValue (ExampleStorageRPC a b)
instance Generic (ExampleStorageRPC a b) where
  ...

deriveRPCWithStrategy :: String -> GenericStrategy -> Q [Dec]

Same as deriveRPC, but uses a custom strategy for deriving a Generic instance.

deriveManyRPC :: String -> [String] -> Q [Dec]

Recursively enumerate data, newtype and type declarations, and derives an RPC representation for each type that doesn't yet have one.

You can also pass in a list of types for which you _don't_ want an RPC representation to be derived.

In this example, deriveManyRPC will generate an RPC representation for A and B, but not for C (because we explicitly said we don't want one) or D (because it already has one).

data B = B
data C = C
data D = D
deriveRPC "D"

data A = A B C D
deriveManyRPC "A" ["C"]

deriveManyRPCWithStrategy :: String -> [String] -> GenericStrategy -> Q [Dec]

Same as deriveManyRPC, but uses a custom strategy for deriving a Generic instance.

Conversions

valueAsRPC :: HasCallStack => Value t -> Value (AsRPC t)

Replace all big_maps in a value with the respective big_map IDs.

Throws an error if it finds a big_map without an ID.

notesAsRPC :: Notes t -> Notes (AsRPC t)

Replace all big_map annotations in a value with nat annotations.

Entailments

rpcSingIEvi :: forall (t :: T). SingI t :- SingI (AsRPC t)

A proof that if a singleton exists for t, then so it does for AsRPC t.

rpcHasNoOpEvi :: forall (t :: T). (SingI t, HasNoOp t) => HasNoOp t :- HasNoOp (AsRPC t)

A proof that if t does not contain any operations, then neither does AsRPC t.

rpcHasNoBigMapEvi :: forall (t :: T). SingI t => Dict (HasNoBigMap (AsRPC t))

A proof that AsRPC (Value t) does not contain big_maps.

rpcHasNoNestedBigMapsEvi :: forall (t :: T). SingI t => Dict (HasNoNestedBigMaps (AsRPC t))

A proof that AsRPC (Value t) does not contain big_maps.

rpcHasNoContractEvi :: forall (t :: T). (SingI t, HasNoContract t) => HasNoContract t :- HasNoContract (AsRPC t)

A proof that if t does not contain any contract values, then neither does AsRPC t.

rpcStorageScopeEvi :: forall (t :: T). StorageScope t :- StorageScope (AsRPC t)

A proof that if t is a valid storage type, then so is AsRPC t.