Morley.Client.RPC.Types

This module contains various types which are used in tezos-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

• arConsumedGas :: TezosInt64
• arStorageSize :: TezosInt64
• arPaidStorageDiff :: TezosInt64
• arOriginatedContracts :: [Address]
• arAllocatedDestinationContracts :: TezosInt64

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

Instances

Show AppliedResult

Defined in Morley.Client.RPC.Types

Methods

showsPrec :: Int -> AppliedResult -> ShowS

show :: AppliedResult -> String

showList :: [AppliedResult] -> ShowS

Semigroup AppliedResult

Defined in Morley.Client.RPC.Types

Methods

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

sconcat :: NonEmpty AppliedResult -> AppliedResult

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

Monoid AppliedResult

Defined in Morley.Client.RPC.Types

Methods

mempty :: AppliedResult

mappend :: AppliedResult -> AppliedResult -> AppliedResult

mconcat :: [AppliedResult] -> AppliedResult

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

ToJSON BlockHash

Defined in Morley.Client.RPC.Types

Methods

toJSON :: BlockHash -> Value

toEncoding :: BlockHash -> Encoding

toJSONList :: [BlockHash] -> Value

toEncodingList :: [BlockHash] -> Encoding

FromJSON BlockHash

Defined in Morley.Client.RPC.Types

Methods

parseJSON :: Value -> Parser BlockHash

parseJSONList :: Value -> Parser [BlockHash]

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

ToJSON BlockHeader

Defined in Morley.Client.RPC.Types

Methods

toJSON :: BlockHeader -> Value

toEncoding :: BlockHeader -> Encoding

toJSONList :: [BlockHeader] -> Value

toEncodingList :: [BlockHeader] -> Encoding

FromJSON BlockHeader

Defined in Morley.Client.RPC.Types

Methods

parseJSON :: Value -> Parser BlockHeader

parseJSONList :: Value -> Parser [BlockHeader]

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 Text

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

AtDepthId Natural

Identifier of a block at specific depth relative to head.

Instances

Eq BlockId

Defined in Morley.Client.RPC.Types

Methods

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

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

Show BlockId

Defined in Morley.Client.RPC.Types

Methods

showsPrec :: Int -> BlockId -> ShowS

show :: BlockId -> String

showList :: [BlockId] -> ShowS

Buildable BlockId

Defined in Morley.Client.RPC.Types

Methods

build :: BlockId -> Builder

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

data BlockOperation

$operation in Tezos docs.

Constructors

BlockOperation

Fields

• boHash :: Text
• boContents :: [OperationResp]

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 :: Address
• codFee :: TezosMutez
• codCounter :: TezosInt64
• codGasLimit :: TezosInt64
• codStorageLimit :: TezosInt64

Instances

ToJSON CommonOperationData

Defined in Morley.Client.RPC.Types

Methods

toJSON :: CommonOperationData -> Value

toEncoding :: CommonOperationData -> Encoding

toJSONList :: [CommonOperationData] -> Value

toEncodingList :: [CommonOperationData] -> Encoding

FromJSON CommonOperationData

Defined in Morley.Client.RPC.Types

Methods

parseJSON :: Value -> Parser CommonOperationData

parseJSONList :: Value -> Parser [CommonOperationData]

data ForgeOperation

Constructors

ForgeOperation

Fields

• foBranch :: Text
• 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 GetBigMapResult

Constructors

GetBigMapResult Expression

GetBigMapNotFound

Instances

FromJSON GetBigMapResult

Defined in Morley.Client.RPC.Types

Methods

parseJSON :: Value -> Parser GetBigMapResult

parseJSONList :: Value -> Parser [GetBigMapResult]

newtype InternalOperation

Constructors

InternalOperation

Fields

• unInternalOperation :: OperationResult

Instances

FromJSON InternalOperation

Defined in Morley.Client.RPC.Types

Methods

parseJSON :: Value -> Parser InternalOperation

parseJSONList :: Value -> Parser [InternalOperation]

data OperationContent

Constructors

OperationContent 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

Eq OperationHash

Defined in Morley.Client.RPC.Types

Methods

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

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

Show OperationHash

Defined in Morley.Client.RPC.Types

Methods

showsPrec :: Int -> OperationHash -> ShowS

show :: OperationHash -> String

showList :: [OperationHash] -> ShowS

FromJSON OperationHash

Defined in Morley.Client.RPC.Types

Methods

parseJSON :: Value -> Parser OperationHash

parseJSONList :: Value -> Parser [OperationHash]

Buildable OperationHash

Defined in Morley.Client.RPC.Types

Methods

build :: OperationHash -> Builder

CmdArg OperationHash

Defined in Morley.Client.TezosClient.Types

Methods

toCmdArg :: OperationHash -> String

data OperationInput

Constructors

OperationInput

Fields

• oiCommonData :: CommonOperationData
• oiCustom :: OperationInfo RPCInput

Instances

ToJSON OperationInput

Defined in Morley.Client.RPC.Types

Methods

toJSON :: OperationInput -> Value

toEncoding :: OperationInput -> Encoding

toJSONList :: [OperationInput] -> Value

toEncodingList :: [OperationInput] -> Encoding

data OperationResp

Contents of an operation that can appear in RPC responses.

Constructors

TransactionOpResp TransactionOperation

Operation with kind transaction.

OtherOpResp

Operation with kind that we don't support yet (but need to parse to something).

Instances

FromJSON OperationResp

Defined in Morley.Client.RPC.Types

Methods

parseJSON :: Value -> Parser OperationResp

parseJSONList :: Value -> Parser [OperationResp]

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
• ooScript :: OriginationScript

Instances

ToJSON OriginationOperation

Defined in Morley.Client.RPC.Types

Methods

toJSON :: OriginationOperation -> Value

toEncoding :: OriginationOperation -> Encoding

toJSONList :: [OriginationOperation] -> Value

toEncodingList :: [OriginationOperation] -> Encoding

data OriginationScript

Constructors

OriginationScript

Fields

• osCode :: Expression
• osStorage :: Expression

Instances

ToJSON OriginationScript

Defined in Morley.Client.RPC.Types

Methods

toJSON :: OriginationScript -> Value

toEncoding :: OriginationScript -> Encoding

toJSONList :: [OriginationScript] -> Value

toEncodingList :: [OriginationScript] -> Encoding

FromJSON OriginationScript

Defined in Morley.Client.RPC.Types

Methods

parseJSON :: Value -> Parser OriginationScript

parseJSONList :: Value -> Parser [OriginationScript]

data ParametersInternal

Constructors

ParametersInternal

Fields

• piEntrypoint :: Text
• piValue :: Expression

Instances

ToJSON ParametersInternal

Defined in Morley.Client.RPC.Types

Methods

toJSON :: ParametersInternal -> Value

toEncoding :: ParametersInternal -> Encoding

toJSONList :: [ParametersInternal] -> Value

toEncodingList :: [ParametersInternal] -> Encoding

FromJSON ParametersInternal

Defined in Morley.Client.RPC.Types

Methods

parseJSON :: Value -> Parser ParametersInternal

parseJSONList :: Value -> Parser [ParametersInternal]

data PreApplyOperation

Constructors

PreApplyOperation

Fields

• paoProtocol :: Text
• paoBranch :: Text
• 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

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

ToJSON RevealOperation

Defined in Morley.Client.RPC.Types

Methods

toJSON :: RevealOperation -> Value

toEncoding :: RevealOperation -> Encoding

toJSONList :: [RevealOperation] -> Value

toEncodingList :: [RevealOperation] -> Encoding

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
• rcSource :: Maybe Address
• rcPayer :: Maybe Address

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 :: Text
• 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 OriginationInfo RPCInput

type RevealInfo RPCInput

ToJSON (OperationInfo RPCInput)

Defined in Morley.Client.RPC.Types

Methods

toJSON :: OperationInfo RPCInput -> Value

toEncoding :: OperationInfo RPCInput -> Encoding

toJSONList :: [OperationInfo RPCInput] -> Value

toEncodingList :: [OperationInfo RPCInput] -> Encoding

type TransferInfo RPCInput

Defined in Morley.Client.RPC.Types

type TransferInfo RPCInput = TransactionOperation

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

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

ToJSON TransactionOperation

Defined in Morley.Client.RPC.Types

Methods

toJSON :: TransactionOperation -> Value

toEncoding :: TransactionOperation -> Encoding

toJSONList :: [TransactionOperation] -> Value

toEncodingList :: [TransactionOperation] -> Encoding

FromJSON TransactionOperation

Defined in Morley.Client.RPC.Types

Methods

parseJSON :: Value -> Parser TransactionOperation

parseJSONList :: Value -> Parser [TransactionOperation]

combineResults :: OperationResult -> OperationResult -> OperationResult

mkCommonOperationData :: Address -> TezosInt64 -> ProtocolParameters -> CommonOperationData

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

Fee isn't accounted during operation simulation, so it's safe to use zero amount. Real operation fee is calculated later using 'tezos-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 Address

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

• Address

  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 Address

NonExistingContract Address

Instances

Show RunError

Defined in Morley.Client.RPC.Types

Methods

showsPrec :: Int -> RunError -> ShowS

show :: RunError -> String

showList :: [RunError] -> ShowS

FromJSON RunError

Defined in Morley.Client.RPC.Types

Methods

parseJSON :: Value -> Parser RunError

parseJSONList :: Value -> Parser [RunError]

Buildable RunError

Defined in Morley.Client.RPC.Types

Methods

build :: RunError -> Builder

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

• Address

  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

• Address

  Manager address.

Failure Text

Failure reported without specific id

Instances

Show InternalError

Defined in Morley.Client.RPC.Types

Methods

showsPrec :: Int -> InternalError -> ShowS

show :: InternalError -> String

showList :: [InternalError] -> ShowS

FromJSON InternalError

Defined in Morley.Client.RPC.Types

Methods

parseJSON :: Value -> Parser InternalError

parseJSONList :: Value -> Parser [InternalError]

Buildable InternalError

Defined in Morley.Client.RPC.Types

Methods

build :: InternalError -> Builder

Prisms

_RuntimeError :: Prism' RunError Address

_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 Address

_ScriptOverflow :: Prism' RunError ()

_PreviouslyRevealedKey :: Prism' RunError Address

_GasExhaustedOperation :: Prism' RunError ()

Lenses

oiCommonDataL :: Lens' OperationInput CommonOperationData