Morley.Client.RPC.Types

This module contains various types which are used in octez-node RPC API.

Documentation for RPC API can be found e. g. here (010 is the protocol, change to the desired one).

Note that errors are reported a bit inconsistently by RPC. For more information see this question and this issue.

Documentation

data AppliedResult

Constructors

AppliedResult

Fields

• arConsumedMilliGas :: TezosInt64
• arStorageSize :: TezosInt64
• arPaidStorageDiff :: TezosInt64
• arOriginatedContracts :: [ContractAddress]
• arAllocatedDestinationContracts :: TezosInt64

  We need to count number of destination contracts that are new to the chain in order to calculate proper storage_limit

Instances

Monoid AppliedResult

Defined in Morley.Client.RPC.Types

Methods

mempty :: AppliedResult

mappend :: AppliedResult -> AppliedResult -> AppliedResult

mconcat :: [AppliedResult] -> AppliedResult

Semigroup AppliedResult

Defined in Morley.Client.RPC.Types

Methods

(<>) :: AppliedResult -> AppliedResult -> AppliedResult

sconcat :: NonEmpty AppliedResult -> AppliedResult

stimes :: Integral b => b -> AppliedResult -> AppliedResult

Show AppliedResult

Defined in Morley.Client.RPC.Types

Methods

showsPrec :: Int -> AppliedResult -> ShowS

show :: AppliedResult -> String

showList :: [AppliedResult] -> ShowS

data BlockConstants

Constructors

BlockConstants

Fields

• bcProtocol :: Text
• bcChainId :: Text
• bcHeader :: BlockHeaderNoHash
• bcHash :: BlockHash

Instances

FromJSON BlockConstants

Defined in Morley.Client.RPC.Types

Methods

parseJSON :: Value -> Parser BlockConstants

parseJSONList :: Value -> Parser [BlockConstants]

newtype BlockHash

Constructors

BlockHash

Fields

• unBlockHash :: Text

Instances

FromJSON BlockHash

Defined in Morley.Client.RPC.Types

Methods

parseJSON :: Value -> Parser BlockHash

parseJSONList :: Value -> Parser [BlockHash]

ToJSON BlockHash

Defined in Morley.Client.RPC.Types

Methods

toJSON :: BlockHash -> Value

toEncoding :: BlockHash -> Encoding

toJSONList :: [BlockHash] -> Value

toEncodingList :: [BlockHash] -> Encoding

Show BlockHash

Defined in Morley.Client.RPC.Types

Methods

showsPrec :: Int -> BlockHash -> ShowS

show :: BlockHash -> String

showList :: [BlockHash] -> ShowS

Eq BlockHash

Defined in Morley.Client.RPC.Types

Methods

(==) :: BlockHash -> BlockHash -> Bool

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

Ord BlockHash

Defined in Morley.Client.RPC.Types

Methods

compare :: BlockHash -> BlockHash -> Ordering

(<) :: BlockHash -> BlockHash -> Bool

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

(>) :: BlockHash -> BlockHash -> Bool

(>=) :: BlockHash -> BlockHash -> Bool

max :: BlockHash -> BlockHash -> BlockHash

min :: BlockHash -> BlockHash -> BlockHash

ToHttpApiData BlockHash

Defined in Morley.Client.RPC.Types

Methods

toUrlPiece :: BlockHash -> Text

toEncodedUrlPiece :: BlockHash -> Builder

toHeader :: BlockHash -> ByteString

toQueryParam :: BlockHash -> Text

Buildable BlockHash

Defined in Morley.Client.RPC.Types

Methods

build :: BlockHash -> Doc

buildList :: [BlockHash] -> Doc

data BlockHeaderNoHash

Constructors

BlockHeaderNoHash

Fields

• bhnhTimestamp :: UTCTime
• bhnhLevel :: Int64
• bhnhPredecessor :: BlockHash

Instances

FromJSON BlockHeaderNoHash

Defined in Morley.Client.RPC.Types

Methods

parseJSON :: Value -> Parser BlockHeaderNoHash

parseJSONList :: Value -> Parser [BlockHeaderNoHash]

data BlockHeader

The whole block header.

Constructors

BlockHeader

Fields

• bhTimestamp :: UTCTime
• bhLevel :: Int64
• bhPredecessor :: BlockHash
• bhHash :: BlockHash

Instances

FromJSON BlockHeader

Defined in Morley.Client.RPC.Types

Methods

parseJSON :: Value -> Parser BlockHeader

parseJSONList :: Value -> Parser [BlockHeader]

ToJSON BlockHeader

Defined in Morley.Client.RPC.Types

Methods

toJSON :: BlockHeader -> Value

toEncoding :: BlockHeader -> Encoding

toJSONList :: [BlockHeader] -> Value

toEncodingList :: [BlockHeader] -> Encoding

data FeeConstants

Constructors

FeeConstants

Fields

• fcBase :: Mutez
• fcMutezPerGas :: Milli
• fcMutezPerOpByte :: Milli

Instances

Default FeeConstants

At the moment of writing, Tezos always uses these constants.

Defined in Morley.Client.RPC.Types

Methods

def :: FeeConstants

data BlockId

A block identifier as submitted to RPC.

A block can be referenced by head, genesis, level or block hash

Constructors

HeadId

Identifier referring to the head block.

FinalHeadId

Identifier of the most recent block guaranteed to have been finalized. See: https://web.archive.org/web/20220305165609/https://tezos.gitlab.io/protocols/tenderbake.html#operations

GenesisId

Identifier referring to the genesis block.

LevelId Natural

Identifier referring to a block by its level.

BlockHashId BlockHash

Idenfitier referring to a block by its hash in Base58Check notation.

AtDepthId Natural

Identifier of a block at specific depth relative to head.

Instances

Show BlockId

Defined in Morley.Client.RPC.Types

Methods

showsPrec :: Int -> BlockId -> ShowS

show :: BlockId -> String

showList :: [BlockId] -> ShowS

Eq BlockId

Defined in Morley.Client.RPC.Types

Methods

(==) :: BlockId -> BlockId -> Bool

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

ToHttpApiData BlockId

Defined in Morley.Client.RPC.Types

Methods

toUrlPiece :: BlockId -> Text

toEncodedUrlPiece :: BlockId -> Builder

toHeader :: BlockId -> ByteString

toQueryParam :: BlockId -> Text

HasCLReader BlockId

Defined in Morley.Client.RPC.Types

Methods

getReader :: ReadM BlockId

getMetavar :: String

Buildable BlockId

Defined in Morley.Client.RPC.Types

Methods

build :: BlockId -> Doc

buildList :: [BlockId] -> Doc

data BlockOperation

$operation in Tezos docs.

Constructors

BlockOperation

Fields

• boHash :: Text
• boContents :: [OperationRespWithMeta]

Instances

FromJSON BlockOperation

Defined in Morley.Client.RPC.Types

Methods

parseJSON :: Value -> Parser BlockOperation

parseJSONList :: Value -> Parser [BlockOperation]

data CommonOperationData

Data that is common for transaction and origination operations.

Constructors

CommonOperationData

Fields

• codSource :: ImplicitAddress
• codFee :: TezosMutez
• codCounter :: TezosInt64
• codGasLimit :: TezosInt64
• codStorageLimit :: TezosInt64

Instances

FromJSON CommonOperationData

Defined in Morley.Client.RPC.Types

Methods

parseJSON :: Value -> Parser CommonOperationData

parseJSONList :: Value -> Parser [CommonOperationData]

ToJSON CommonOperationData

Defined in Morley.Client.RPC.Types

Methods

toJSON :: CommonOperationData -> Value

toEncoding :: CommonOperationData -> Encoding

toJSONList :: [CommonOperationData] -> Value

toEncodingList :: [CommonOperationData] -> Encoding

data DelegationOperation

Constructors

DelegationOperation

Fields

• doDelegate :: Maybe KeyHash

  Nothing removes delegate, Just sets it

Instances

FromJSON DelegationOperation

Defined in Morley.Client.RPC.Types

Methods

parseJSON :: Value -> Parser DelegationOperation

parseJSONList :: Value -> Parser [DelegationOperation]

ToJSON DelegationOperation

Defined in Morley.Client.RPC.Types

Methods

toJSON :: DelegationOperation -> Value

toEncoding :: DelegationOperation -> Encoding

toJSONList :: [DelegationOperation] -> Value

toEncodingList :: [DelegationOperation] -> Encoding

Generic DelegationOperation

Defined in Morley.Client.RPC.Types

Associated Types

type Rep DelegationOperation :: Type -> Type

Methods

from :: DelegationOperation -> Rep DelegationOperation x

to :: Rep DelegationOperation x -> DelegationOperation

Show DelegationOperation

Defined in Morley.Client.RPC.Types

Methods

showsPrec :: Int -> DelegationOperation -> ShowS

show :: DelegationOperation -> String

showList :: [DelegationOperation] -> ShowS

ToJSONObject DelegationOperation

Defined in Morley.Client.RPC.Types

Buildable DelegationOperation

Defined in Morley.Client.RPC.Types

Methods

build :: DelegationOperation -> Doc

buildList :: [DelegationOperation] -> Doc

type Rep DelegationOperation

Defined in Morley.Client.RPC.Types

type Rep DelegationOperation = D1 ('MetaData "DelegationOperation" "Morley.Client.RPC.Types" "morley-client-0.4.0-inplace" 'False) (C1 ('MetaCons "DelegationOperation" 'PrefixI 'True) (S1 ('MetaSel ('Just "doDelegate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe KeyHash))))

data ForgeOperation

Constructors

ForgeOperation

Fields

• foBranch :: BlockHash
• foContents :: NonEmpty OperationInput

Instances

ToJSON ForgeOperation

Defined in Morley.Client.RPC.Types

Methods

toJSON :: ForgeOperation -> Value

toEncoding :: ForgeOperation -> Encoding

toJSONList :: [ForgeOperation] -> Value

toEncodingList :: [ForgeOperation] -> Encoding

data GetBigMap

Constructors

GetBigMap

Fields

• bmKey :: Expression
• bmType :: Expression

Instances

ToJSON GetBigMap

Defined in Morley.Client.RPC.Types

Methods

toJSON :: GetBigMap -> Value

toEncoding :: GetBigMap -> Encoding

toJSONList :: [GetBigMap] -> Value

toEncodingList :: [GetBigMap] -> Encoding

data CalcSize

Constructors

CalcSize

Fields

• csProgram :: Expression
• csStorage :: Expression
• csGas :: TezosInt64
• csLegacy :: Bool

Instances

ToJSON CalcSize

Defined in Morley.Client.RPC.Types

Methods

toJSON :: CalcSize -> Value

toEncoding :: CalcSize -> Encoding

toJSONList :: [CalcSize] -> Value

toEncodingList :: [CalcSize] -> Encoding

newtype ScriptSize

Constructors

ScriptSize

Fields

• ssScriptSize :: Natural

Instances

FromJSON ScriptSize

Defined in Morley.Client.RPC.Types

Methods

parseJSON :: Value -> Parser ScriptSize

parseJSONList :: Value -> Parser [ScriptSize]

data GetBigMapResult

Constructors

GetBigMapResult Expression

GetBigMapNotFound

Instances

FromJSON GetBigMapResult

Defined in Morley.Client.RPC.Types

Methods

parseJSON :: Value -> Parser GetBigMapResult

parseJSONList :: Value -> Parser [GetBigMapResult]

data InternalOperation

Constructors

InternalOperation

Fields

• ioData :: OperationResp WithSource
• ioResult :: OperationResult

Instances

FromJSON InternalOperation

Defined in Morley.Client.RPC.Types

Methods

parseJSON :: Value -> Parser InternalOperation

parseJSONList :: Value -> Parser [InternalOperation]

data WithSource a

Constructors

WithSource

Fields

• wsSource :: Address
• wsOtherData :: a

Instances

Functor WithSource

Defined in Morley.Client.RPC.Types

Methods

fmap :: (a -> b) -> WithSource a -> WithSource b

(<$) :: a -> WithSource b -> WithSource a

FromJSON a => FromJSON (WithSource a)

Defined in Morley.Client.RPC.Types

Methods

parseJSON :: Value -> Parser (WithSource a)

parseJSONList :: Value -> Parser [WithSource a]

Show a => Show (WithSource a)

Defined in Morley.Client.RPC.Types

Methods

showsPrec :: Int -> WithSource a -> ShowS

show :: WithSource a -> String

showList :: [WithSource a] -> ShowS

Buildable a => Buildable (WithSource a)

Defined in Morley.Client.RPC.Types

Methods

build :: WithSource a -> Doc

buildList :: [WithSource a] -> Doc

data OperationContent

Constructors

OperationContent

Fields

• ocOperation :: OperationResp WithSource
• ocMetadata :: RunMetadata

Instances

FromJSON OperationContent

Defined in Morley.Client.RPC.Types

Methods

parseJSON :: Value -> Parser OperationContent

parseJSONList :: Value -> Parser [OperationContent]

newtype OperationHash

Constructors

OperationHash

Fields

• unOperationHash :: Text

Instances

FromJSON OperationHash

Defined in Morley.Client.RPC.Types

Methods

parseJSON :: Value -> Parser OperationHash

parseJSONList :: Value -> Parser [OperationHash]

Show OperationHash

Defined in Morley.Client.RPC.Types

Methods

showsPrec :: Int -> OperationHash -> ShowS

show :: OperationHash -> String

showList :: [OperationHash] -> ShowS

Eq OperationHash

Defined in Morley.Client.RPC.Types

Methods

(==) :: OperationHash -> OperationHash -> Bool

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

CmdArg OperationHash

Defined in Morley.Client.TezosClient.Types

Methods

toCmdArg :: OperationHash -> String

Buildable OperationHash

Defined in Morley.Client.RPC.Types

Methods

build :: OperationHash -> Doc

buildList :: [OperationHash] -> Doc

type OperationInput = WithCommonOperationData (OperationInfo RPCInput)

data OperationResp f

Contents of an operation that can appear in RPC responses.

Constructors

TransactionOpResp (f TransactionOperation)

Operation with kind transaction.

TransferTicketOpResp (f TransferTicketOperation)

Operation with kind transfer_ticket.

OriginationOpResp (f OriginationOperation)

Operation with kind origination.

DelegationOpResp (f DelegationOperation)

Operation with kind delegation.

RevealOpResp (f RevealOperation)

Operation with kind reveal.

EventOpResp (f EventOperation)

Operation with kind event.

OtherOpResp Text

Response we don't handle yet.

Instances

(forall a. FromJSON a => FromJSON (f a)) => FromJSON (OperationResp f)

Defined in Morley.Client.RPC.Types

Methods

parseJSON :: Value -> Parser (OperationResp f)

parseJSONList :: Value -> Parser [OperationResp f]

(forall a. Show a => Show (f a)) => Show (OperationResp f)

Defined in Morley.Client.RPC.Types

Methods

showsPrec :: Int -> OperationResp f -> ShowS

show :: OperationResp f -> String

showList :: [OperationResp f] -> ShowS

(forall a. Buildable a => Buildable (f a)) => Buildable (OperationResp f)

Defined in Morley.Client.RPC.Types

Methods

build :: OperationResp f -> Doc

buildList :: [OperationResp f] -> Doc

data OperationRespWithMeta

Constructors

OperationRespWithMeta

Fields

• orwmResponse :: OperationResp WithCommonOperationData
• orwmMetadata :: Maybe OperationMetadata

Instances

FromJSON OperationRespWithMeta

Defined in Morley.Client.RPC.Types

Methods

parseJSON :: Value -> Parser OperationRespWithMeta

parseJSONList :: Value -> Parser [OperationRespWithMeta]

newtype OperationMetadata

Constructors

OperationMetadata

Fields

• unOperationMetadata :: Maybe OperationResult

Instances

FromJSON OperationMetadata

Defined in Morley.Client.RPC.Types

Methods

parseJSON :: Value -> Parser OperationMetadata

parseJSONList :: Value -> Parser [OperationMetadata]

data OperationResult

Constructors

OperationApplied AppliedResult

OperationFailed [RunError]

Instances

FromJSON OperationResult

Defined in Morley.Client.RPC.Types

Methods

parseJSON :: Value -> Parser OperationResult

parseJSONList :: Value -> Parser [OperationResult]

data OriginationOperation

All the data needed to perform contract origination through Tezos RPC interface

Constructors

OriginationOperation

Fields

• ooBalance :: TezosMutez
• ooDelegate :: Maybe KeyHash
• ooScript :: OriginationScript

Instances

FromJSON OriginationOperation

Defined in Morley.Client.RPC.Types

Methods

parseJSON :: Value -> Parser OriginationOperation

parseJSONList :: Value -> Parser [OriginationOperation]

ToJSON OriginationOperation

Defined in Morley.Client.RPC.Types

Methods

toJSON :: OriginationOperation -> Value

toEncoding :: OriginationOperation -> Encoding

toJSONList :: [OriginationOperation] -> Value

toEncodingList :: [OriginationOperation] -> Encoding

Generic OriginationOperation

Defined in Morley.Client.RPC.Types

Associated Types

type Rep OriginationOperation :: Type -> Type

Methods

from :: OriginationOperation -> Rep OriginationOperation x

to :: Rep OriginationOperation x -> OriginationOperation

Show OriginationOperation

Defined in Morley.Client.RPC.Types

Methods

showsPrec :: Int -> OriginationOperation -> ShowS

show :: OriginationOperation -> String

showList :: [OriginationOperation] -> ShowS

ToJSONObject OriginationOperation

Defined in Morley.Client.RPC.Types

Buildable OriginationOperation

Defined in Morley.Client.RPC.Types

Methods

build :: OriginationOperation -> Doc

buildList :: [OriginationOperation] -> Doc

type Rep OriginationOperation

Defined in Morley.Client.RPC.Types

type Rep OriginationOperation = D1 ('MetaData "OriginationOperation" "Morley.Client.RPC.Types" "morley-client-0.4.0-inplace" 'False) (C1 ('MetaCons "OriginationOperation" 'PrefixI 'True) (S1 ('MetaSel ('Just "ooBalance") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 TezosMutez) :*: (S1 ('MetaSel ('Just "ooDelegate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe KeyHash)) :*: S1 ('MetaSel ('Just "ooScript") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 OriginationScript))))

data OriginationScript

Constructors

OriginationScript

Fields

• osCode :: Expression
• osStorage :: Expression

Instances

FromJSON OriginationScript

Defined in Morley.Client.RPC.Types

Methods

parseJSON :: Value -> Parser OriginationScript

parseJSONList :: Value -> Parser [OriginationScript]

ToJSON OriginationScript

Defined in Morley.Client.RPC.Types

Methods

toJSON :: OriginationScript -> Value

toEncoding :: OriginationScript -> Encoding

toJSONList :: [OriginationScript] -> Value

toEncodingList :: [OriginationScript] -> Encoding

Generic OriginationScript

Defined in Morley.Client.RPC.Types

Associated Types

type Rep OriginationScript :: Type -> Type

Methods

from :: OriginationScript -> Rep OriginationScript x

to :: Rep OriginationScript x -> OriginationScript

Show OriginationScript

Defined in Morley.Client.RPC.Types

Methods

showsPrec :: Int -> OriginationScript -> ShowS

show :: OriginationScript -> String

showList :: [OriginationScript] -> ShowS

type Rep OriginationScript

Defined in Morley.Client.RPC.Types

type Rep OriginationScript = D1 ('MetaData "OriginationScript" "Morley.Client.RPC.Types" "morley-client-0.4.0-inplace" 'False) (C1 ('MetaCons "OriginationScript" 'PrefixI 'True) (S1 ('MetaSel ('Just "osCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Expression) :*: S1 ('MetaSel ('Just "osStorage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Expression)))

data ParametersInternal

Constructors

ParametersInternal

Fields

• piEntrypoint :: Text
• piValue :: Expression

Instances

FromJSON ParametersInternal

Defined in Morley.Client.RPC.Types

Methods

parseJSON :: Value -> Parser ParametersInternal

parseJSONList :: Value -> Parser [ParametersInternal]

ToJSON ParametersInternal

Defined in Morley.Client.RPC.Types

Methods

toJSON :: ParametersInternal -> Value

toEncoding :: ParametersInternal -> Encoding

toJSONList :: [ParametersInternal] -> Value

toEncodingList :: [ParametersInternal] -> Encoding

Generic ParametersInternal

Defined in Morley.Client.RPC.Types

Associated Types

type Rep ParametersInternal :: Type -> Type

Methods

from :: ParametersInternal -> Rep ParametersInternal x

to :: Rep ParametersInternal x -> ParametersInternal

Show ParametersInternal

Defined in Morley.Client.RPC.Types

Methods

showsPrec :: Int -> ParametersInternal -> ShowS

show :: ParametersInternal -> String

showList :: [ParametersInternal] -> ShowS

Buildable ParametersInternal

Defined in Morley.Client.RPC.Types

Methods

build :: ParametersInternal -> Doc

buildList :: [ParametersInternal] -> Doc

type Rep ParametersInternal

Defined in Morley.Client.RPC.Types

type Rep ParametersInternal = D1 ('MetaData "ParametersInternal" "Morley.Client.RPC.Types" "morley-client-0.4.0-inplace" 'False) (C1 ('MetaCons "ParametersInternal" 'PrefixI 'True) (S1 ('MetaSel ('Just "piEntrypoint") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "piValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Expression)))

data PreApplyOperation

Constructors

PreApplyOperation

Fields

• paoProtocol :: Text
• paoBranch :: BlockHash
• paoContents :: NonEmpty OperationInput
• paoSignature :: Signature

Instances

ToJSON PreApplyOperation

Defined in Morley.Client.RPC.Types

Methods

toJSON :: PreApplyOperation -> Value

toEncoding :: PreApplyOperation -> Encoding

toJSONList :: [PreApplyOperation] -> Value

toEncodingList :: [PreApplyOperation] -> Encoding

data ProtocolParameters

Protocol-wide constants.

There are more constants, but currently, we are using only these in our code.

Constructors

ProtocolParameters

Fields

• ppOriginationSize :: Int

  Byte size cost for originating new contract.

• ppHardGasLimitPerOperation :: TezosInt64

  Gas limit for a single operation.

• ppHardStorageLimitPerOperation :: TezosInt64

  Storage limit for a single operation.

• ppMinimalBlockDelay :: TezosNat

  Minimal delay between two blocks, this constant is new in V010.

• ppCostPerByte :: TezosMutez

  Burn cost per storage byte

• ppHardGasLimitPerBlock :: TezosInt64

  Gas limit for a single block.

Instances

FromJSON ProtocolParameters

Defined in Morley.Client.RPC.Types

Methods

parseJSON :: Value -> Parser ProtocolParameters

parseJSONList :: Value -> Parser [ProtocolParameters]

data RevealOperation

All the data needed to perform key revealing through Tezos RPC interface

Constructors

RevealOperation

Fields

• roPublicKey :: PublicKey

Instances

FromJSON RevealOperation

Defined in Morley.Client.RPC.Types

Methods

parseJSON :: Value -> Parser RevealOperation

parseJSONList :: Value -> Parser [RevealOperation]

ToJSON RevealOperation

Defined in Morley.Client.RPC.Types

Methods

toJSON :: RevealOperation -> Value

toEncoding :: RevealOperation -> Encoding

toJSONList :: [RevealOperation] -> Value

toEncodingList :: [RevealOperation] -> Encoding

Generic RevealOperation

Defined in Morley.Client.RPC.Types

Associated Types

type Rep RevealOperation :: Type -> Type

Methods

from :: RevealOperation -> Rep RevealOperation x

to :: Rep RevealOperation x -> RevealOperation

Show RevealOperation

Defined in Morley.Client.RPC.Types

Methods

showsPrec :: Int -> RevealOperation -> ShowS

show :: RevealOperation -> String

showList :: [RevealOperation] -> ShowS

ToJSONObject RevealOperation

Defined in Morley.Client.RPC.Types

Buildable RevealOperation

Defined in Morley.Client.RPC.Types

Methods

build :: RevealOperation -> Doc

buildList :: [RevealOperation] -> Doc

type Rep RevealOperation

Defined in Morley.Client.RPC.Types

type Rep RevealOperation = D1 ('MetaData "RevealOperation" "Morley.Client.RPC.Types" "morley-client-0.4.0-inplace" 'False) (C1 ('MetaCons "RevealOperation" 'PrefixI 'True) (S1 ('MetaSel ('Just "roPublicKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 PublicKey)))

data RunCode

Data required for calling run_code RPC endpoint.

Constructors

RunCode

Fields

• rcScript :: Expression
• rcStorage :: Expression
• rcInput :: Expression
• rcAmount :: TezosMutez
• rcBalance :: TezosMutez
• rcChainId :: Text
• rcNow :: Maybe TezosNat
• rcLevel :: Maybe TezosNat
• rcSource :: Maybe ImplicitAddress
• rcPayer :: Maybe ImplicitAddress

Instances

ToJSON RunCode

Defined in Morley.Client.RPC.Types

Methods

toJSON :: RunCode -> Value

toEncoding :: RunCode -> Encoding

toJSONList :: [RunCode] -> Value

toEncodingList :: [RunCode] -> Encoding

data RunCodeResult

Result storage of run_code RPC endpoint call.

Actual resulting JSON has more contents, but currently we're interested only in resulting storage.

Constructors

RunCodeResult

Fields

• rcrStorage :: Expression

Instances

FromJSON RunCodeResult

Defined in Morley.Client.RPC.Types

Methods

parseJSON :: Value -> Parser RunCodeResult

parseJSONList :: Value -> Parser [RunCodeResult]

data RunMetadata

Constructors

RunMetadata

Fields

• rmOperationResult :: OperationResult
• rmInternalOperationResults :: [InternalOperation]

Instances

FromJSON RunMetadata

Defined in Morley.Client.RPC.Types

Methods

parseJSON :: Value -> Parser RunMetadata

parseJSONList :: Value -> Parser [RunMetadata]

data RunOperation

Constructors

RunOperation

Fields

• roOperation :: RunOperationInternal
• roChainId :: Text

Instances

ToJSON RunOperation

Defined in Morley.Client.RPC.Types

Methods

toJSON :: RunOperation -> Value

toEncoding :: RunOperation -> Encoding

toJSONList :: [RunOperation] -> Value

toEncodingList :: [RunOperation] -> Encoding

data RunOperationInternal

Constructors

RunOperationInternal

Fields

• roiBranch :: BlockHash
• roiContents :: NonEmpty OperationInput
• roiSignature :: Signature

Instances

ToJSON RunOperationInternal

Defined in Morley.Client.RPC.Types

Methods

toJSON :: RunOperationInternal -> Value

toEncoding :: RunOperationInternal -> Encoding

toJSONList :: [RunOperationInternal] -> Value

toEncodingList :: [RunOperationInternal] -> Encoding

data RunOperationResult

Constructors

RunOperationResult

Fields

• rrOperationContents :: NonEmpty OperationContent

Instances

FromJSON RunOperationResult

Defined in Morley.Client.RPC.Types

Methods

parseJSON :: Value -> Parser RunOperationResult

parseJSONList :: Value -> Parser [RunOperationResult]

data RPCInput

Designates an input RPC data that we supply to perform an operation.

Instances

OperationInfoDescriptor RPCInput

Defined in Morley.Client.RPC.Types

Associated Types

type TransferInfo RPCInput

type TransferTicketInfo RPCInput

type OriginationInfo RPCInput

type RevealInfo RPCInput

type DelegationInfo RPCInput

type DelegationInfo RPCInput

Defined in Morley.Client.RPC.Types

type DelegationInfo RPCInput = DelegationOperation

type OriginationInfo RPCInput

Defined in Morley.Client.RPC.Types

type OriginationInfo RPCInput = OriginationOperation

type RevealInfo RPCInput

Defined in Morley.Client.RPC.Types

type RevealInfo RPCInput = RevealOperation

type TransferInfo RPCInput

Defined in Morley.Client.RPC.Types

type TransferInfo RPCInput = TransactionOperation

type TransferTicketInfo RPCInput

Defined in Morley.Client.RPC.Types

type TransferTicketInfo RPCInput = TransferTicketOperation

data TransactionOperation

All the data needed to perform a transaction through Tezos RPC interface. For additional information, please refer to RPC documentation http://tezos.gitlab.io/api/rpc.html

Constructors

TransactionOperation

Fields

• toAmount :: TezosMutez
• toDestination :: Address
• toParameters :: ParametersInternal

Instances

FromJSON TransactionOperation

Defined in Morley.Client.RPC.Types

Methods

parseJSON :: Value -> Parser TransactionOperation

parseJSONList :: Value -> Parser [TransactionOperation]

ToJSON TransactionOperation

Defined in Morley.Client.RPC.Types

Methods

toJSON :: TransactionOperation -> Value

toEncoding :: TransactionOperation -> Encoding

toJSONList :: [TransactionOperation] -> Value

toEncodingList :: [TransactionOperation] -> Encoding

Show TransactionOperation

Defined in Morley.Client.RPC.Types

Methods

showsPrec :: Int -> TransactionOperation -> ShowS

show :: TransactionOperation -> String

showList :: [TransactionOperation] -> ShowS

ToJSONObject TransactionOperation

Defined in Morley.Client.RPC.Types

Buildable TransactionOperation

Defined in Morley.Client.RPC.Types

Methods

build :: TransactionOperation -> Doc

buildList :: [TransactionOperation] -> Doc

data TransferTicketOperation

Constructors

TransferTicketOperation

Fields

• ttoTicketContents :: Expression
• ttoTicketTy :: Expression
• ttoTicketTicketer :: Address
• ttoTicketAmount :: TezosNat
• ttoDestination :: Address
• ttoEntrypoint :: Text

Instances

ToJSON TransferTicketOperation

Defined in Morley.Client.RPC.Types

Methods

toJSON :: TransferTicketOperation -> Value

toEncoding :: TransferTicketOperation -> Encoding

toJSONList :: [TransferTicketOperation] -> Value

toEncodingList :: [TransferTicketOperation] -> Encoding

Show TransferTicketOperation

Defined in Morley.Client.RPC.Types

Methods

showsPrec :: Int -> TransferTicketOperation -> ShowS

show :: TransferTicketOperation -> String

showList :: [TransferTicketOperation] -> ShowS

ToJSONObject TransferTicketOperation

Defined in Morley.Client.RPC.Types

Buildable TransferTicketOperation

Defined in Morley.Client.RPC.Types

Methods

build :: TransferTicketOperation -> Doc

buildList :: [TransferTicketOperation] -> Doc

data WithCommonOperationData a

Some operation data accompanied with common data.

Constructors

WithCommonOperationData

Fields

• wcoCommon :: CommonOperationData
• wcoCustom :: a

Instances

FromJSON a => FromJSON (WithCommonOperationData a)

Defined in Morley.Client.RPC.Types

Methods

parseJSON :: Value -> Parser (WithCommonOperationData a)

parseJSONList :: Value -> Parser [WithCommonOperationData a]

ToJSONObject a => ToJSON (WithCommonOperationData a)

Defined in Morley.Client.RPC.Types

Methods

toJSON :: WithCommonOperationData a -> Value

toEncoding :: WithCommonOperationData a -> Encoding

toJSONList :: [WithCommonOperationData a] -> Value

toEncodingList :: [WithCommonOperationData a] -> Encoding

data EventOperation

Constructors

EventOperation

Fields

• eoType :: Expression
• eoTag :: Maybe MText
• eoPayload :: Maybe Expression

Instances

FromJSON EventOperation

Defined in Morley.Client.RPC.Types

Methods

parseJSON :: Value -> Parser EventOperation

parseJSONList :: Value -> Parser [EventOperation]

ToJSON EventOperation

Defined in Morley.Client.RPC.Types

Methods

toJSON :: EventOperation -> Value

toEncoding :: EventOperation -> Encoding

toJSONList :: [EventOperation] -> Value

toEncodingList :: [EventOperation] -> Encoding

Generic EventOperation

Defined in Morley.Client.RPC.Types

Associated Types

type Rep EventOperation :: Type -> Type

Methods

from :: EventOperation -> Rep EventOperation x

to :: Rep EventOperation x -> EventOperation

Show EventOperation

Defined in Morley.Client.RPC.Types

Methods

showsPrec :: Int -> EventOperation -> ShowS

show :: EventOperation -> String

showList :: [EventOperation] -> ShowS

ToJSONObject EventOperation

Defined in Morley.Client.RPC.Types

Buildable EventOperation

Defined in Morley.Client.RPC.Types

Methods

build :: EventOperation -> Doc

buildList :: [EventOperation] -> Doc

type Rep EventOperation

Defined in Morley.Client.RPC.Types

type Rep EventOperation = D1 ('MetaData "EventOperation" "Morley.Client.RPC.Types" "morley-client-0.4.0-inplace" 'False) (C1 ('MetaCons "EventOperation" 'PrefixI 'True) (S1 ('MetaSel ('Just "eoType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Expression) :*: (S1 ('MetaSel ('Just "eoTag") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MText)) :*: S1 ('MetaSel ('Just "eoPayload") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Expression)))))

data MonitorHeadsStep a

Constructors

MonitorHeadsStop a

MonitorHeadsContinue

data GetTicketBalance

Constructors

GetTicketBalance

Fields

• gtbTicketer :: ContractAddress
• gtbContentType :: Expression
• gtbContent :: Expression

Instances

ToJSON GetTicketBalance

Defined in Morley.Client.RPC.Types

Methods

toJSON :: GetTicketBalance -> Value

toEncoding :: GetTicketBalance -> Encoding

toJSONList :: [GetTicketBalance] -> Value

toEncodingList :: [GetTicketBalance] -> Encoding

data GetAllTicketBalancesResponse

Constructors

GetAllTicketBalancesResponse

Fields

• gatbrTicketer :: ContractAddress
• gatbrContentType :: Expression
• gatbrContent :: Expression
• gatbrAmount :: TezosNat

Instances

FromJSON GetAllTicketBalancesResponse

Defined in Morley.Client.RPC.Types

Methods

parseJSON :: Value -> Parser GetAllTicketBalancesResponse

parseJSONList :: Value -> Parser [GetAllTicketBalancesResponse]

data PackData

Constructors

PackData

Fields

• pdData :: Expression
• pdType :: Expression
• pdGas :: Maybe TezosBigNum

Instances

ToJSON PackData

Defined in Morley.Client.RPC.Types

Methods

toJSON :: PackData -> Value

toEncoding :: PackData -> Encoding

toJSONList :: [PackData] -> Value

toEncodingList :: [PackData] -> Encoding

Buildable PackData

Defined in Morley.Client.RPC.Types

Methods

build :: PackData -> Doc

buildList :: [PackData] -> Doc

data PackDataResult

Constructors

PackDataResult

Fields

• pdrPacked :: Text
• pdrGas :: PackDataResultGas

Instances

FromJSON PackDataResult

Defined in Morley.Client.RPC.Types

Methods

parseJSON :: Value -> Parser PackDataResult

parseJSONList :: Value -> Parser [PackDataResult]

Buildable PackDataResult

Defined in Morley.Client.RPC.Types

Methods

build :: PackDataResult -> Doc

buildList :: [PackDataResult] -> Doc

mkCommonOperationData :: ProtocolParameters -> ("sender" :! ImplicitAddress) -> ("counter" :! TezosInt64) -> ("num_operations" :? Int64) -> CommonOperationData

Create CommonOperationData based on current blockchain protocol parameters and sender info. This data is used for operation simulation.

num_operations parameter can be used for smarter gas limit estimation. If Nothing, the gas limit is set to ppHardGasLimitPerOperation, but that puts a hard low limit on the number of operations that will fit into one batch. If num_operations is set, then gas limit is estimated as

\[ \mathrm{min}\left(\mathbf{hard\_gas\_limit\_per\_operation}, \left\lfloor \frac{\mathbf{hard\_gas\_limit\_per\_block}} {num\_operations}\right\rfloor\right) \]

This works well enough for the case of many small operations, but will break when there is one big one and a lot of small ones. That said, specifying num_operations will work in all cases where not specifying it would, and then some, so it's recommended to specify it whenever possible.

num_operations is assumed to be greater than 0, otherwise it'll be silently ignored.

Fee isn't accounted during operation simulation, so it's safe to use zero amount. Real operation fee is calculated later using octez-client.

Errors

data RunError

Errors that are sent as part of operation result in an OK response (status 200). They are semi-formally defined as errors that can happen when a contract is executed and something goes wrong.

Constructors

RuntimeError ContractAddress

ScriptRejected Expression

BadContractParameter Address

InvalidConstant Expression Expression

InvalidContract Address

InconsistentTypes Expression Expression

InvalidPrimitive [Text] Text

InvalidSyntacticConstantError Expression Expression

InvalidExpressionKind [Text] Text

InvalidContractNotation Text

UnexpectedContract

IllFormedType Expression

UnexpectedOperation

REEmptyTransaction

Transfer of 0 to an implicit account.

Fields

• ImplicitAddress

  Receiver address.

ScriptOverflow

A contract failed due to the detection of an overflow. It seems to happen if a too big value is passed to shift instructions (as second argument).

GasExhaustedOperation

MutezAdditionOverflow [TezosInt64]

MutezSubtractionUnderflow [TezosInt64]

MutezMultiplicationOverflow TezosInt64 TezosInt64

CantPayStorageFee

BalanceTooLow ("balance" :! Mutez) ("required" :! Mutez)

PreviouslyRevealedKey ImplicitAddress

NonExistingContract Address

InvalidB58Check Text

UnregisteredDelegate ImplicitAddress

FailedUnDelegation ImplicitAddress

DelegateAlreadyActive

IllTypedContract Expression

IllTypedData Expression Expression

BadStack BadStackInformation

ForbiddenZeroAmountTicket

REEmptyImplicitContract ImplicitAddress

Instances

FromJSON RunError

Defined in Morley.Client.RPC.Types

Methods

parseJSON :: Value -> Parser RunError

parseJSONList :: Value -> Parser [RunError]

Show RunError

Defined in Morley.Client.RPC.Types

Methods

showsPrec :: Int -> RunError -> ShowS

show :: RunError -> String

showList :: [RunError] -> ShowS

Buildable RunError

Defined in Morley.Client.RPC.Types

Methods

build :: RunError -> Doc

buildList :: [RunError] -> Doc

data InternalError

Errors that are sent as part of an "Internal Server Error" response (HTTP code 500).

We call them internal because of the HTTP code, but we shouldn't treat them as internal. They can be easily triggered by making a failing operation.

Constructors

CounterInThePast

An operation assumed a contract counter in the past.

Fields

• ImplicitAddress

  Address whose counter is invalid.

• ("expected" :! Word)

  Expected counter.

• ("found" :! Word)

  Found counter.

UnrevealedKey

One tried to apply a manager operation without revealing the manager public key.

Fields

• ImplicitAddress

  Manager address.

Failure Text

Failure reported without specific id

Instances

FromJSON InternalError

Defined in Morley.Client.RPC.Types

Methods

parseJSON :: Value -> Parser InternalError

parseJSONList :: Value -> Parser [InternalError]

Show InternalError

Defined in Morley.Client.RPC.Types

Methods

showsPrec :: Int -> InternalError -> ShowS

show :: InternalError -> String

showList :: [InternalError] -> ShowS

Buildable InternalError

Defined in Morley.Client.RPC.Types

Methods

build :: InternalError -> Doc

buildList :: [InternalError] -> Doc

Prisms

_RuntimeError :: Prism' RunError ContractAddress

_ScriptRejected :: Prism' RunError Expression

_BadContractParameter :: Prism' RunError Address

_InvalidConstant :: Prism' RunError (Expression, Expression)

_InconsistentTypes :: Prism' RunError (Expression, Expression)

_InvalidPrimitive :: Prism' RunError ([Text], Text)

_InvalidSyntacticConstantError :: Prism' RunError (Expression, Expression)

_InvalidExpressionKind :: Prism' RunError ([Text], Text)

_InvalidContractNotation :: Prism' RunError Text

_UnexpectedContract :: Prism' RunError ()

_IllFormedType :: Prism' RunError Expression

_UnexpectedOperation :: Prism' RunError ()

_REEmptyTransaction :: Prism' RunError ImplicitAddress

_ScriptOverflow :: Prism' RunError ()

_PreviouslyRevealedKey :: Prism' RunError ImplicitAddress

_GasExhaustedOperation :: Prism' RunError ()

_UnregisteredDelegate :: Prism' RunError ImplicitAddress

Lenses

wcoCommonDataL :: Lens' (WithCommonOperationData a) CommonOperationData