Morley.Client

Morley client that connects with real Tezos network through RPC and the octez-client binary. For more information please refer to README.

Command line parser

parserInfo :: ("usage" :! Doc) -> ("description" :! String) -> ("header" :! String) -> ("parser" :! Parser s) -> ParserInfo s

clientConfigParser :: Parser MorleyClientConfig

Full client monad and environment

data MorleyClientM a

Instances

MonadIO MorleyClientM

Defined in Morley.Client.Full

Methods

liftIO :: IO a -> MorleyClientM a

Applicative MorleyClientM

Defined in Morley.Client.Full

Methods

pure :: a -> MorleyClientM a

(<*>) :: MorleyClientM (a -> b) -> MorleyClientM a -> MorleyClientM b

liftA2 :: (a -> b -> c) -> MorleyClientM a -> MorleyClientM b -> MorleyClientM c

(*>) :: MorleyClientM a -> MorleyClientM b -> MorleyClientM b

(<*) :: MorleyClientM a -> MorleyClientM b -> MorleyClientM a

Functor MorleyClientM

Defined in Morley.Client.Full

Methods

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

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

Monad MorleyClientM

Defined in Morley.Client.Full

Methods

(>>=) :: MorleyClientM a -> (a -> MorleyClientM b) -> MorleyClientM b

(>>) :: MorleyClientM a -> MorleyClientM b -> MorleyClientM b

return :: a -> MorleyClientM a

MonadCatch MorleyClientM

Defined in Morley.Client.Full

Methods

catch :: Exception e => MorleyClientM a -> (e -> MorleyClientM a) -> MorleyClientM a

MonadMask MorleyClientM

Defined in Morley.Client.Full

Methods

mask :: ((forall a. MorleyClientM a -> MorleyClientM a) -> MorleyClientM b) -> MorleyClientM b

uninterruptibleMask :: ((forall a. MorleyClientM a -> MorleyClientM a) -> MorleyClientM b) -> MorleyClientM b

generalBracket :: MorleyClientM a -> (a -> ExitCase b -> MorleyClientM c) -> (a -> MorleyClientM b) -> MorleyClientM (b, c)

MonadThrow MorleyClientM

Defined in Morley.Client.Full

Methods

throwM :: Exception e => e -> MorleyClientM a

HasTezosRpc MorleyClientM

Defined in Morley.Client.Full

Methods

getBlockHash :: BlockId -> MorleyClientM BlockHash

getCounterAtBlock :: BlockId -> ImplicitAddress -> MorleyClientM TezosInt64

getBlockHeader :: BlockId -> MorleyClientM BlockHeader

getScriptSizeAtBlock :: BlockId -> CalcSize -> MorleyClientM ScriptSize

getBlockConstants :: BlockId -> MorleyClientM BlockConstants

getBlockOperations :: BlockId -> MorleyClientM [[BlockOperation]]

getBlockOperationHashes :: BlockId -> MorleyClientM [[OperationHash]]

getProtocolParametersAtBlock :: BlockId -> MorleyClientM ProtocolParameters

runOperationAtBlock :: BlockId -> RunOperation -> MorleyClientM RunOperationResult

preApplyOperationsAtBlock :: BlockId -> [PreApplyOperation] -> MorleyClientM [RunOperationResult]

forgeOperationAtBlock :: BlockId -> ForgeOperation -> MorleyClientM HexJSONByteString

injectOperation :: HexJSONByteString -> MorleyClientM OperationHash

getContractScriptAtBlock :: BlockId -> ContractAddress -> MorleyClientM OriginationScript

getContractStorageAtBlock :: BlockId -> ContractAddress -> MorleyClientM Expression

getContractBigMapAtBlock :: BlockId -> ContractAddress -> GetBigMap -> MorleyClientM GetBigMapResult

getBigMapValueAtBlock :: BlockId -> Natural -> Text -> MorleyClientM Expression

getBigMapValuesAtBlock :: BlockId -> Natural -> Maybe Natural -> Maybe Natural -> MorleyClientM Expression

getBalanceAtBlock :: BlockId -> Address -> MorleyClientM Mutez

getDelegateAtBlock :: BlockId -> L1Address -> MorleyClientM (Maybe KeyHash)

runCodeAtBlock :: BlockId -> RunCode -> MorleyClientM RunCodeResult

getChainId :: MorleyClientM ChainId

getManagerKeyAtBlock :: BlockId -> ImplicitAddress -> MorleyClientM (Maybe PublicKey)

waitForOperation :: MorleyClientM OperationHash -> MorleyClientM OperationHash

getTicketBalanceAtBlock :: BlockId -> Address -> GetTicketBalance -> MorleyClientM Natural

getAllTicketBalancesAtBlock :: BlockId -> ContractAddress -> MorleyClientM [GetAllTicketBalancesResponse]

HasTezosClient MorleyClientM

Defined in Morley.Client.Full

Methods

signBytes :: ImplicitAddressWithAlias -> Maybe ScrubbedBytes -> ByteString -> MorleyClientM Signature

genKey :: ImplicitAlias -> MorleyClientM ImplicitAddressWithAlias

genFreshKey :: ImplicitAlias -> MorleyClientM ImplicitAddressWithAlias

rememberContract :: AliasBehavior -> ContractAddress -> ContractAlias -> MorleyClientM ()

getAliasesAndAddresses :: MorleyClientM [(Text, Text)]

getKeyPassword :: ImplicitAddressWithAlias -> MorleyClientM (Maybe ScrubbedBytes)

getPublicKey :: ImplicitAddressWithAlias -> MorleyClientM PublicKey

RunClient MorleyClientM

Defined in Morley.Client.Full

Methods

runRequestAcceptStatus :: Maybe [Status] -> Request -> MorleyClientM Response

throwClientError :: ClientError -> MorleyClientM a

MonadUnliftIO MorleyClientM

Defined in Morley.Client.Full

Methods

withRunInIO :: ((forall a. MorleyClientM a -> IO a) -> IO b) -> MorleyClientM b

MonadReader MorleyClientEnv MorleyClientM

Defined in Morley.Client.Full

Methods

ask :: MorleyClientM MorleyClientEnv

local :: (MorleyClientEnv -> MorleyClientEnv) -> MorleyClientM a -> MorleyClientM a

reader :: (MorleyClientEnv -> a) -> MorleyClientM a

HasLog MorleyClientEnv Message MorleyClientM

Defined in Morley.Client.Full

Methods

getLogAction :: MorleyClientEnv -> LogAction MorleyClientM Message

setLogAction :: LogAction MorleyClientM Message -> MorleyClientEnv -> MorleyClientEnv

overLogAction :: (LogAction MorleyClientM Message -> LogAction MorleyClientM Message) -> MorleyClientEnv -> MorleyClientEnv

logActionL :: Lens' MorleyClientEnv (LogAction MorleyClientM Message)

data MorleyClientConfig

Data necessary for morley client initialization.

Constructors

MorleyClientConfig

Fields

• mccEndpointUrl :: Maybe BaseUrl

  URL of tezos endpoint on which operations are performed

• mccTezosClientPath :: FilePath

  Path to octez-client binary through which operations are performed

• mccMbTezosClientDataDir :: Maybe FilePath

  Path to octez-client data directory.

• mccVerbosity :: Word

  Verbosity level. 0 means that only important messages will be printed. The greater this value is, the more messages will be printed during execution. After some small unspecified limit increasing this value does not change anything.

• mccSecretKey :: Maybe SecretKey

  Custom secret key to use for signing.

Instances

Show MorleyClientConfig

Defined in Morley.Client.Init

Methods

showsPrec :: Int -> MorleyClientConfig -> ShowS

show :: MorleyClientConfig -> String

showList :: [MorleyClientConfig] -> ShowS

data MorleyClientEnv

Runtime environment for morley client.

Constructors

MorleyClientEnv

Fields

• mceTezosClient :: TezosClientEnv

  Environment for octez-client.

• mceLogAction :: ClientLogAction MorleyClientM

  Action used to log messages.

• mceSecretKey :: Maybe SecretKey

  Pass if you want to sign operations manually or leave it to octez-client.

• mceClientEnv :: ClientEnv

  Environment necessary to make HTTP calls.

Instances

HasTezosClientEnv MorleyClientEnv

Defined in Morley.Client.Full

Methods

tezosClientEnvL :: Lens' MorleyClientEnv TezosClientEnv

MonadReader MorleyClientEnv MorleyClientM

Defined in Morley.Client.Full

Methods

ask :: MorleyClientM MorleyClientEnv

local :: (MorleyClientEnv -> MorleyClientEnv) -> MorleyClientM a -> MorleyClientM a

reader :: (MorleyClientEnv -> a) -> MorleyClientM a

HasLog MorleyClientEnv Message MorleyClientM

Defined in Morley.Client.Full

Methods

getLogAction :: MorleyClientEnv -> LogAction MorleyClientM Message

setLogAction :: LogAction MorleyClientM Message -> MorleyClientEnv -> MorleyClientEnv

overLogAction :: (LogAction MorleyClientM Message -> LogAction MorleyClientM Message) -> MorleyClientEnv -> MorleyClientEnv

logActionL :: Lens' MorleyClientEnv (LogAction MorleyClientM Message)

runMorleyClientM :: MorleyClientEnv -> MorleyClientM a -> IO a

Run MorleyClientM action within given MorleyClientEnv. Retry action in case of invalid counter error.

mkMorleyClientEnv :: MorleyClientConfig -> IO MorleyClientEnv

Construct MorleyClientEnv.

• octez-client path is taken from MorleyClientConfig, but can be overridden using MORLEY_TEZOS_CLIENT environment variable.
• Node data is taken from octez-client config and can be overridden by MorleyClientConfig.
• The rest is taken from MorleyClientConfig as is.

Lens

mceTezosClientL :: Lens' MorleyClientEnv TezosClientEnv

mceLogActionL :: Lens' MorleyClientEnv (ClientLogAction MorleyClientM)

mceSecretKeyL :: Lens' MorleyClientEnv (Maybe SecretKey)

mceClientEnvL :: Lens' MorleyClientEnv ClientEnv

Only-RPC client monad and environment

newtype MorleyOnlyRpcM a

Monad that implements HasTezosClient and HasTezosRpc classes and can be used for high-level actions as an alternative to MorleyClientM.

Constructors

MorleyOnlyRpcM

Fields

• unMorleyOnlyRpcM :: ReaderT MorleyOnlyRpcEnv IO a

Instances

MonadIO MorleyOnlyRpcM

Defined in Morley.Client.OnlyRPC

Methods

liftIO :: IO a -> MorleyOnlyRpcM a

Applicative MorleyOnlyRpcM

Defined in Morley.Client.OnlyRPC

Methods

pure :: a -> MorleyOnlyRpcM a

(<*>) :: MorleyOnlyRpcM (a -> b) -> MorleyOnlyRpcM a -> MorleyOnlyRpcM b

liftA2 :: (a -> b -> c) -> MorleyOnlyRpcM a -> MorleyOnlyRpcM b -> MorleyOnlyRpcM c

(*>) :: MorleyOnlyRpcM a -> MorleyOnlyRpcM b -> MorleyOnlyRpcM b

(<*) :: MorleyOnlyRpcM a -> MorleyOnlyRpcM b -> MorleyOnlyRpcM a

Functor MorleyOnlyRpcM

Defined in Morley.Client.OnlyRPC

Methods

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

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

Monad MorleyOnlyRpcM

Defined in Morley.Client.OnlyRPC

Methods

(>>=) :: MorleyOnlyRpcM a -> (a -> MorleyOnlyRpcM b) -> MorleyOnlyRpcM b

(>>) :: MorleyOnlyRpcM a -> MorleyOnlyRpcM b -> MorleyOnlyRpcM b

return :: a -> MorleyOnlyRpcM a

MonadCatch MorleyOnlyRpcM

Defined in Morley.Client.OnlyRPC

Methods

catch :: Exception e => MorleyOnlyRpcM a -> (e -> MorleyOnlyRpcM a) -> MorleyOnlyRpcM a

MonadMask MorleyOnlyRpcM

Defined in Morley.Client.OnlyRPC

Methods

mask :: ((forall a. MorleyOnlyRpcM a -> MorleyOnlyRpcM a) -> MorleyOnlyRpcM b) -> MorleyOnlyRpcM b

uninterruptibleMask :: ((forall a. MorleyOnlyRpcM a -> MorleyOnlyRpcM a) -> MorleyOnlyRpcM b) -> MorleyOnlyRpcM b

generalBracket :: MorleyOnlyRpcM a -> (a -> ExitCase b -> MorleyOnlyRpcM c) -> (a -> MorleyOnlyRpcM b) -> MorleyOnlyRpcM (b, c)

MonadThrow MorleyOnlyRpcM

Defined in Morley.Client.OnlyRPC

Methods

throwM :: Exception e => e -> MorleyOnlyRpcM a

HasTezosRpc MorleyOnlyRpcM

Defined in Morley.Client.OnlyRPC

Methods

getBlockHash :: BlockId -> MorleyOnlyRpcM BlockHash

getCounterAtBlock :: BlockId -> ImplicitAddress -> MorleyOnlyRpcM TezosInt64

getBlockHeader :: BlockId -> MorleyOnlyRpcM BlockHeader

getScriptSizeAtBlock :: BlockId -> CalcSize -> MorleyOnlyRpcM ScriptSize

getBlockConstants :: BlockId -> MorleyOnlyRpcM BlockConstants

getBlockOperations :: BlockId -> MorleyOnlyRpcM [[BlockOperation]]

getBlockOperationHashes :: BlockId -> MorleyOnlyRpcM [[OperationHash]]

getProtocolParametersAtBlock :: BlockId -> MorleyOnlyRpcM ProtocolParameters

runOperationAtBlock :: BlockId -> RunOperation -> MorleyOnlyRpcM RunOperationResult

preApplyOperationsAtBlock :: BlockId -> [PreApplyOperation] -> MorleyOnlyRpcM [RunOperationResult]

forgeOperationAtBlock :: BlockId -> ForgeOperation -> MorleyOnlyRpcM HexJSONByteString

injectOperation :: HexJSONByteString -> MorleyOnlyRpcM OperationHash

getContractScriptAtBlock :: BlockId -> ContractAddress -> MorleyOnlyRpcM OriginationScript

getContractStorageAtBlock :: BlockId -> ContractAddress -> MorleyOnlyRpcM Expression

getContractBigMapAtBlock :: BlockId -> ContractAddress -> GetBigMap -> MorleyOnlyRpcM GetBigMapResult

getBigMapValueAtBlock :: BlockId -> Natural -> Text -> MorleyOnlyRpcM Expression

getBigMapValuesAtBlock :: BlockId -> Natural -> Maybe Natural -> Maybe Natural -> MorleyOnlyRpcM Expression

getBalanceAtBlock :: BlockId -> Address -> MorleyOnlyRpcM Mutez

getDelegateAtBlock :: BlockId -> L1Address -> MorleyOnlyRpcM (Maybe KeyHash)

runCodeAtBlock :: BlockId -> RunCode -> MorleyOnlyRpcM RunCodeResult

getChainId :: MorleyOnlyRpcM ChainId

getManagerKeyAtBlock :: BlockId -> ImplicitAddress -> MorleyOnlyRpcM (Maybe PublicKey)

waitForOperation :: MorleyOnlyRpcM OperationHash -> MorleyOnlyRpcM OperationHash

getTicketBalanceAtBlock :: BlockId -> Address -> GetTicketBalance -> MorleyOnlyRpcM Natural

getAllTicketBalancesAtBlock :: BlockId -> ContractAddress -> MorleyOnlyRpcM [GetAllTicketBalancesResponse]

HasTezosClient MorleyOnlyRpcM

Defined in Morley.Client.OnlyRPC

Methods

signBytes :: ImplicitAddressWithAlias -> Maybe ScrubbedBytes -> ByteString -> MorleyOnlyRpcM Signature

genKey :: ImplicitAlias -> MorleyOnlyRpcM ImplicitAddressWithAlias

genFreshKey :: ImplicitAlias -> MorleyOnlyRpcM ImplicitAddressWithAlias

rememberContract :: AliasBehavior -> ContractAddress -> ContractAlias -> MorleyOnlyRpcM ()

getAliasesAndAddresses :: MorleyOnlyRpcM [(Text, Text)]

getKeyPassword :: ImplicitAddressWithAlias -> MorleyOnlyRpcM (Maybe ScrubbedBytes)

getPublicKey :: ImplicitAddressWithAlias -> MorleyOnlyRpcM PublicKey

RunClient MorleyOnlyRpcM

Defined in Morley.Client.OnlyRPC

Methods

runRequestAcceptStatus :: Maybe [Status] -> Request -> MorleyOnlyRpcM Response

throwClientError :: ClientError -> MorleyOnlyRpcM a

MonadUnliftIO MorleyOnlyRpcM

Defined in Morley.Client.OnlyRPC

Methods

withRunInIO :: ((forall a. MorleyOnlyRpcM a -> IO a) -> IO b) -> MorleyOnlyRpcM b

MonadReader MorleyOnlyRpcEnv MorleyOnlyRpcM

Defined in Morley.Client.OnlyRPC

Methods

ask :: MorleyOnlyRpcM MorleyOnlyRpcEnv

local :: (MorleyOnlyRpcEnv -> MorleyOnlyRpcEnv) -> MorleyOnlyRpcM a -> MorleyOnlyRpcM a

reader :: (MorleyOnlyRpcEnv -> a) -> MorleyOnlyRpcM a

HasLog MorleyOnlyRpcEnv Message MorleyOnlyRpcM

Defined in Morley.Client.OnlyRPC

Methods

getLogAction :: MorleyOnlyRpcEnv -> LogAction MorleyOnlyRpcM Message

setLogAction :: LogAction MorleyOnlyRpcM Message -> MorleyOnlyRpcEnv -> MorleyOnlyRpcEnv

overLogAction :: (LogAction MorleyOnlyRpcM Message -> LogAction MorleyOnlyRpcM Message) -> MorleyOnlyRpcEnv -> MorleyOnlyRpcEnv

logActionL :: Lens' MorleyOnlyRpcEnv (LogAction MorleyOnlyRpcM Message)

data MorleyOnlyRpcEnv

Environment used by MorleyOnlyRpcM.

Constructors

MorleyOnlyRpcEnv

Fields

• moreLogAction :: ClientLogAction MorleyOnlyRpcM

  Action used to log messages.

• moreClientEnv :: ClientEnv

  Environment necessary to make HTTP calls.

• moreSecretKeys :: Map ImplicitAddress SecretKey

  In-memory secret keys that can be used for signing.

Instances

MonadReader MorleyOnlyRpcEnv MorleyOnlyRpcM

Defined in Morley.Client.OnlyRPC

Methods

ask :: MorleyOnlyRpcM MorleyOnlyRpcEnv

local :: (MorleyOnlyRpcEnv -> MorleyOnlyRpcEnv) -> MorleyOnlyRpcM a -> MorleyOnlyRpcM a

reader :: (MorleyOnlyRpcEnv -> a) -> MorleyOnlyRpcM a

HasLog MorleyOnlyRpcEnv Message MorleyOnlyRpcM

Defined in Morley.Client.OnlyRPC

Methods

getLogAction :: MorleyOnlyRpcEnv -> LogAction MorleyOnlyRpcM Message

setLogAction :: LogAction MorleyOnlyRpcM Message -> MorleyOnlyRpcEnv -> MorleyOnlyRpcEnv

overLogAction :: (LogAction MorleyOnlyRpcM Message -> LogAction MorleyOnlyRpcM Message) -> MorleyOnlyRpcEnv -> MorleyOnlyRpcEnv

logActionL :: Lens' MorleyOnlyRpcEnv (LogAction MorleyOnlyRpcM Message)

mkMorleyOnlyRpcEnv :: [SecretKey] -> BaseUrl -> Word -> IO MorleyOnlyRpcEnv

Construct MorleyOnlyRpcEnv.

• Full MorleyClientConfig is not passed because we need just 2 things from it.
• Log action is built the same way as for MorleyClientEnv.
• All secret keys are passed as an argument.

runMorleyOnlyRpcM :: MorleyOnlyRpcEnv -> MorleyOnlyRpcM a -> IO a

Run MorleyOnlyRpcM action within given MorleyOnlyRpcEnv. Retry action in case of invalid counter error.

High-level actions

module Morley.Client.Action

RPC

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

Buildable BlockId

Defined in Morley.Client.RPC.Types

Methods

build :: BlockId -> Builder

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

class (Monad m, MonadCatch m) => HasTezosRpc m where

Type class that provides interaction with tezos node via RPC

Methods

getBlockHash :: BlockId -> m BlockHash

Get hash of the given BlockId, mostly used to get hash of HeadId

getCounterAtBlock :: BlockId -> ImplicitAddress -> m TezosInt64

Get address counter, which is required for both transaction sending and contract origination.

getBlockHeader :: BlockId -> m BlockHeader

Get the whole header of a block.

getScriptSizeAtBlock :: BlockId -> CalcSize -> m ScriptSize

Get the script size at block.

getBlockConstants :: BlockId -> m BlockConstants

Get block constants that are required by other RPC calls.

getBlockOperations :: BlockId -> m [[BlockOperation]]

Get all operations from the block with specified ID.

getBlockOperationHashes :: BlockId -> m [[OperationHash]]

Get all operation hashes from the block with specified ID.

getProtocolParametersAtBlock :: BlockId -> m ProtocolParameters

Get protocol parameters that are for limits calculations.

runOperationAtBlock :: BlockId -> RunOperation -> m RunOperationResult

Perform operation run, this operation doesn't require proper signing. As a result it returns burned gas and storage diff (also list of originated contracts but their addresses are incorrect due to the fact that operation could be not signed properly) or indicates about operation failure.

preApplyOperationsAtBlock :: BlockId -> [PreApplyOperation] -> m [RunOperationResult]

Preapply list of operations, each operation has to be signed with sender secret key. As a result it returns list of results each of which has information about burned gas, storage diff size and originated contracts.

forgeOperationAtBlock :: BlockId -> ForgeOperation -> m HexJSONByteString

Forge operation in order to receive its hexadecimal representation.

injectOperation :: HexJSONByteString -> m OperationHash

Inject operation, note that this operation has to be signed before injection. As a result it returns operation hash.

getContractScriptAtBlock :: BlockId -> ContractAddress -> m OriginationScript

Get code and storage of the desired contract. Note that both code and storage are presented in low-level Micheline representation. If the storage contains a big_map, then the expression will contain the big_map's ID, not its contents.

getContractStorageAtBlock :: BlockId -> ContractAddress -> m Expression

Get storage of the desired contract at some block. Note that storage is presented in low-level Micheline representation. If the storage contains a big_map, then the expression will contain the big_map's ID, not its contents.

getContractBigMapAtBlock :: BlockId -> ContractAddress -> GetBigMap -> m GetBigMapResult

Get big map value by contract address.

getBigMapValueAtBlock :: BlockId -> Natural -> Text -> m Expression

Get big map value at some block by the big map's ID and the hashed entry key.

getBigMapValuesAtBlock :: BlockId -> Natural -> Maybe Natural -> Maybe Natural -> m Expression

Get all big map values at some block by the big map's ID and the optional offset and length.

getBalanceAtBlock :: BlockId -> Address -> m Mutez

Get balance for given address.

getDelegateAtBlock :: BlockId -> L1Address -> m (Maybe KeyHash)

Get delegate for given address.

runCodeAtBlock :: BlockId -> RunCode -> m RunCodeResult

Emulate contract call. This RPC endpoint does the same as octez-client run script command does.

getChainId :: m ChainId

Get current ChainId

getManagerKeyAtBlock :: BlockId -> ImplicitAddress -> m (Maybe PublicKey)

Get manager key for given address. Returns Nothing if this key wasn't revealed.

waitForOperation :: m OperationHash -> m OperationHash

Blocks until an operation with the given hash is included into the chain. The first argument is the action that puts the operation on the chain. Returns the hash of the included operation.

getTicketBalanceAtBlock :: BlockId -> Address -> GetTicketBalance -> m Natural

Access the contract's or implicit account's balance of ticket with specified ticketer, content type, and content.

getAllTicketBalancesAtBlock :: BlockId -> ContractAddress -> m [GetAllTicketBalancesResponse]

Access the complete list of tickets owned by the given contract by scanning the contract's storage.

Instances

HasTezosRpc MorleyClientM

Defined in Morley.Client.Full

Methods

getBlockHash :: BlockId -> MorleyClientM BlockHash

getCounterAtBlock :: BlockId -> ImplicitAddress -> MorleyClientM TezosInt64

getBlockHeader :: BlockId -> MorleyClientM BlockHeader

getScriptSizeAtBlock :: BlockId -> CalcSize -> MorleyClientM ScriptSize

getBlockConstants :: BlockId -> MorleyClientM BlockConstants

getBlockOperations :: BlockId -> MorleyClientM [[BlockOperation]]

getBlockOperationHashes :: BlockId -> MorleyClientM [[OperationHash]]

getProtocolParametersAtBlock :: BlockId -> MorleyClientM ProtocolParameters

runOperationAtBlock :: BlockId -> RunOperation -> MorleyClientM RunOperationResult

preApplyOperationsAtBlock :: BlockId -> [PreApplyOperation] -> MorleyClientM [RunOperationResult]

forgeOperationAtBlock :: BlockId -> ForgeOperation -> MorleyClientM HexJSONByteString

injectOperation :: HexJSONByteString -> MorleyClientM OperationHash

getContractScriptAtBlock :: BlockId -> ContractAddress -> MorleyClientM OriginationScript

getContractStorageAtBlock :: BlockId -> ContractAddress -> MorleyClientM Expression

getContractBigMapAtBlock :: BlockId -> ContractAddress -> GetBigMap -> MorleyClientM GetBigMapResult

getBigMapValueAtBlock :: BlockId -> Natural -> Text -> MorleyClientM Expression

getBigMapValuesAtBlock :: BlockId -> Natural -> Maybe Natural -> Maybe Natural -> MorleyClientM Expression

getBalanceAtBlock :: BlockId -> Address -> MorleyClientM Mutez

getDelegateAtBlock :: BlockId -> L1Address -> MorleyClientM (Maybe KeyHash)

runCodeAtBlock :: BlockId -> RunCode -> MorleyClientM RunCodeResult

getChainId :: MorleyClientM ChainId

getManagerKeyAtBlock :: BlockId -> ImplicitAddress -> MorleyClientM (Maybe PublicKey)

waitForOperation :: MorleyClientM OperationHash -> MorleyClientM OperationHash

getTicketBalanceAtBlock :: BlockId -> Address -> GetTicketBalance -> MorleyClientM Natural

getAllTicketBalancesAtBlock :: BlockId -> ContractAddress -> MorleyClientM [GetAllTicketBalancesResponse]

HasTezosRpc MorleyOnlyRpcM

Defined in Morley.Client.OnlyRPC

Methods

getBlockHash :: BlockId -> MorleyOnlyRpcM BlockHash

getCounterAtBlock :: BlockId -> ImplicitAddress -> MorleyOnlyRpcM TezosInt64

getBlockHeader :: BlockId -> MorleyOnlyRpcM BlockHeader

getScriptSizeAtBlock :: BlockId -> CalcSize -> MorleyOnlyRpcM ScriptSize

getBlockConstants :: BlockId -> MorleyOnlyRpcM BlockConstants

getBlockOperations :: BlockId -> MorleyOnlyRpcM [[BlockOperation]]

getBlockOperationHashes :: BlockId -> MorleyOnlyRpcM [[OperationHash]]

getProtocolParametersAtBlock :: BlockId -> MorleyOnlyRpcM ProtocolParameters

runOperationAtBlock :: BlockId -> RunOperation -> MorleyOnlyRpcM RunOperationResult

preApplyOperationsAtBlock :: BlockId -> [PreApplyOperation] -> MorleyOnlyRpcM [RunOperationResult]

forgeOperationAtBlock :: BlockId -> ForgeOperation -> MorleyOnlyRpcM HexJSONByteString

injectOperation :: HexJSONByteString -> MorleyOnlyRpcM OperationHash

getContractScriptAtBlock :: BlockId -> ContractAddress -> MorleyOnlyRpcM OriginationScript

getContractStorageAtBlock :: BlockId -> ContractAddress -> MorleyOnlyRpcM Expression

getContractBigMapAtBlock :: BlockId -> ContractAddress -> GetBigMap -> MorleyOnlyRpcM GetBigMapResult

getBigMapValueAtBlock :: BlockId -> Natural -> Text -> MorleyOnlyRpcM Expression

getBigMapValuesAtBlock :: BlockId -> Natural -> Maybe Natural -> Maybe Natural -> MorleyOnlyRpcM Expression

getBalanceAtBlock :: BlockId -> Address -> MorleyOnlyRpcM Mutez

getDelegateAtBlock :: BlockId -> L1Address -> MorleyOnlyRpcM (Maybe KeyHash)

runCodeAtBlock :: BlockId -> RunCode -> MorleyOnlyRpcM RunCodeResult

getChainId :: MorleyOnlyRpcM ChainId

getManagerKeyAtBlock :: BlockId -> ImplicitAddress -> MorleyOnlyRpcM (Maybe PublicKey)

waitForOperation :: MorleyOnlyRpcM OperationHash -> MorleyOnlyRpcM OperationHash

getTicketBalanceAtBlock :: BlockId -> Address -> GetTicketBalance -> MorleyOnlyRpcM Natural

getAllTicketBalancesAtBlock :: BlockId -> ContractAddress -> MorleyOnlyRpcM [GetAllTicketBalancesResponse]

data OperationInfo i

Constructors

OpTransfer (TransferInfo i)

OpTransferTicket (TransferTicketInfo i)

OpOriginate (OriginationInfo i)

OpReveal (RevealInfo i)

OpDelegation (DelegationInfo i)

Instances

Each '[ToJSONObject] '[TransferInfo i, TransferTicketInfo i, OriginationInfo i, RevealInfo i, DelegationInfo i] => ToJSON (OperationInfo i)

Defined in Morley.Client.Types

Methods

toJSON :: OperationInfo i -> Value

toEncoding :: OperationInfo i -> Encoding

toJSONList :: [OperationInfo i] -> Value

toEncodingList :: [OperationInfo i] -> Encoding

ToJSON (OperationInfo i) => ToJSONObject (OperationInfo i)

Defined in Morley.Client.Types

class OperationInfoDescriptor (i :: Type)

Associated Types

type TransferInfo i :: Type

type TransferTicketInfo i :: Type

type OriginationInfo i :: Type

type RevealInfo i :: Type

type DelegationInfo i :: Type

Instances

OperationInfoDescriptor ClientInput

Defined in Morley.Client.Action.Common

Associated Types

type TransferInfo ClientInput

type TransferTicketInfo ClientInput

type OriginationInfo ClientInput

type RevealInfo ClientInput

type DelegationInfo ClientInput

OperationInfoDescriptor Result

Defined in Morley.Client.Action.Operation

Associated Types

type TransferInfo Result

type TransferTicketInfo Result

type OriginationInfo Result

type RevealInfo Result

type DelegationInfo Result

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

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

getContract :: HasTezosRpc m => ContractAddress -> m Contract

Get originated Contract for some address.

getImplicitContractCounter :: HasTezosRpc m => ImplicitAddress -> m TezosInt64

Get counter value for given implicit address.

getContractStorage :: HasTezosRpc m => ContractAddress -> m Expression

getContractStorageAtBlock applied to the head block.

getBigMapValue :: HasTezosRpc m => Natural -> Text -> m Expression

getBigMapValueAtBlock applied to the head block.

getHeadBlock :: HasTezosRpc m => m BlockHash

Get hash of the current head block, this head hash is used in other RPC calls.

getCounter :: HasTezosRpc m => ImplicitAddress -> m TezosInt64

getCounterAtBlock applied to the head block.

getProtocolParameters :: HasTezosRpc m => m ProtocolParameters

getProtocolParametersAtBlock applied to the head block.

runOperation :: HasTezosRpc m => RunOperation -> m RunOperationResult

runOperationAtBlock applied to the head block.

preApplyOperations :: HasTezosRpc m => [PreApplyOperation] -> m [RunOperationResult]

preApplyOperationsAtBlock applied to the head block.

forgeOperation :: HasTezosRpc m => ForgeOperation -> m HexJSONByteString

forgeOperationAtBlock applied to the head block.

getContractScript :: HasTezosRpc m => ContractAddress -> m OriginationScript

getContractScriptAtBlock applied to the head block.

getContractBigMap :: HasTezosRpc m => ContractAddress -> GetBigMap -> m GetBigMapResult

getContractBigMapAtBlock applied to the head block.

getBalance :: forall kind m. (HasTezosRpc m, L1AddressKind kind) => KindedAddress kind -> m Mutez

getBalanceAtBlock applied to the head block.

getDelegate :: HasTezosRpc m => L1Address -> m (Maybe KeyHash)

getDelegateAtBlock applied to the head block.

runCode :: HasTezosRpc m => RunCode -> m RunCodeResult

runCodeAtBlock applied to the head block.

getManagerKey :: HasTezosRpc m => ImplicitAddress -> m (Maybe PublicKey)

getTicketBalance

Arguments

:: HasTezosRpc m

=> L1Address

Ticket owner

-> GetTicketBalance

Ticket description

-> m Natural

getAllTicketBalances

Arguments

:: HasTezosRpc m

=> ContractAddress

Ticket owner

-> m [GetAllTicketBalancesResponse]

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]

Errors

data ClientRpcError

Errors that can happen in the RPC part when a user tries to make failing actions.

Constructors

ContractFailed

Smart contract execution has failed.

Fields

• ContractAddress

  Smart contract address.

• Expression

  Value the contract has failed with.

BadParameter

Parameter passed to a contract does not match its type.

Fields

• Address

  Smart or implicit contract address.

• Expression

  Value passed as parameter.

EmptyTransaction

Transfer of 0 to an implicit account.

Fields

• ImplicitAddress

  Receiver address.

ShiftOverflow

A smart contract execution failed due to a shift overflow.

Fields

• ContractAddress

  Smart contract address.

GasExhaustion

A smart contract execution failed due gas exhaustion.

Fields

• ContractAddress

  Smart contract address.

KeyAlreadyRevealed

A key has already been revealed.

Fields

• ImplicitAddress

  The address corresponding to the key.

DelegateNotRegistered

Address not registered as delegate

Fields

• ImplicitAddress

  The address in question.

ClientInternalError InternalError

An error that RPC considers internal occurred. These errors are considered internal by mistake, they are actually quite realistic and normally indicate bad user action. Currently we put InternalError here as is, because it's easy for a user of morley-client to work with this type. In #284 we will consider more errors and maybe some of them will need to be mapped into something more user-friendly, then we will reconsider this approach.

Instances

Exception ClientRpcError

Defined in Morley.Client.RPC.Error

Methods

toException :: ClientRpcError -> SomeException

fromException :: SomeException -> Maybe ClientRpcError

displayException :: ClientRpcError -> String

Show ClientRpcError

Defined in Morley.Client.RPC.Error

Methods

showsPrec :: Int -> ClientRpcError -> ShowS

show :: ClientRpcError -> String

showList :: [ClientRpcError] -> ShowS

Buildable ClientRpcError

Defined in Morley.Client.RPC.Error

Methods

build :: ClientRpcError -> Builder

data UnexpectedErrors

Errors that we don't expect to happen, but they can be reported by the server.

Constructors

UnexpectedRunErrors [RunError]

UnexpectedInternalErrors [InternalError]

Instances

Exception UnexpectedErrors

Defined in Morley.Client.RPC.Error

Methods

toException :: UnexpectedErrors -> SomeException

fromException :: SomeException -> Maybe UnexpectedErrors

displayException :: UnexpectedErrors -> String

Show UnexpectedErrors

Defined in Morley.Client.RPC.Error

Methods

showsPrec :: Int -> UnexpectedErrors -> ShowS

show :: UnexpectedErrors -> String

showList :: [UnexpectedErrors] -> ShowS

Buildable UnexpectedErrors

Defined in Morley.Client.RPC.Error

Methods

build :: UnexpectedErrors -> Builder

data IncorrectRpcResponse

Errors that we can throw when we get a response from a node that doesn't match our expectations. It means that either the node we are talking to misbehaves or our code is incorrect.

Constructors

RpcUnexpectedSize Int Int

RpcOriginatedNoContracts

RpcOriginatedMoreContracts [ContractAddress]

Instances

Exception IncorrectRpcResponse

Defined in Morley.Client.RPC.Error

Methods

toException :: IncorrectRpcResponse -> SomeException

fromException :: SomeException -> Maybe IncorrectRpcResponse

displayException :: IncorrectRpcResponse -> String

Show IncorrectRpcResponse

Defined in Morley.Client.RPC.Error

Methods

showsPrec :: Int -> IncorrectRpcResponse -> ShowS

show :: IncorrectRpcResponse -> String

showList :: [IncorrectRpcResponse] -> ShowS

Buildable IncorrectRpcResponse

Defined in Morley.Client.RPC.Error

Methods

build :: IncorrectRpcResponse -> Builder

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 -> Builder

Getters

data ValueDecodeFailure

Failed to decode received value to the given type.

Constructors

ValueDecodeFailure Text T

Instances

Exception ValueDecodeFailure

Defined in Morley.Client.RPC.Getters

Methods

toException :: ValueDecodeFailure -> SomeException

fromException :: SomeException -> Maybe ValueDecodeFailure

displayException :: ValueDecodeFailure -> String

Show ValueDecodeFailure

Defined in Morley.Client.RPC.Getters

Methods

showsPrec :: Int -> ValueDecodeFailure -> ShowS

show :: ValueDecodeFailure -> String

showList :: [ValueDecodeFailure] -> ShowS

Buildable ValueDecodeFailure

Defined in Morley.Client.RPC.Getters

Methods

build :: ValueDecodeFailure -> Builder

data ValueNotFound

Constructors

ValueNotFound

Instances

Exception ValueNotFound

Defined in Morley.Client.RPC.Getters

Methods

toException :: ValueNotFound -> SomeException

fromException :: SomeException -> Maybe ValueNotFound

displayException :: ValueNotFound -> String

Show ValueNotFound

Defined in Morley.Client.RPC.Getters

Methods

showsPrec :: Int -> ValueNotFound -> ShowS

show :: ValueNotFound -> String

showList :: [ValueNotFound] -> ShowS

Buildable ValueNotFound

Defined in Morley.Client.RPC.Getters

Methods

build :: ValueNotFound -> Builder

readAllBigMapValues :: forall v k m. (NiceUnpackedValue v, HasTezosRpc m) => BigMapId k v -> m [v]

Read all big_map values, given it's ID. If the values are not of the expected type, a ValueDecodeFailure will be thrown.

readAllBigMapValuesMaybe :: forall v k m. (NiceUnpackedValue v, HasTezosRpc m) => BigMapId k v -> m (Maybe [v])

Read all big_map values, given it's ID. If the values are not of the expected type, a ValueDecodeFailure will be thrown.

Returns Nothing if a big_map with the given ID does not exist.

readContractBigMapValue :: forall k v m. (PackedValScope k, HasTezosRpc m, SingI v) => ContractAddress -> Value k -> m (Value v)

Read big_map value of given contract by key.

If the contract contains several big_maps with given key type, only one of them will be considered.

readBigMapValueMaybe :: forall v k m. (NicePackedValue k, NiceUnpackedValue v, HasTezosRpc m) => BigMapId k v -> k -> m (Maybe v)

Read big_map value, given it's ID and a key. If the value is not of the expected type, a ValueDecodeFailure will be thrown.

Returns Nothing if a big_map with the given ID does not exist, or it does exist but does not contain the given key.

readBigMapValue :: forall v k m. (NicePackedValue k, NiceUnpackedValue v, HasTezosRpc m) => BigMapId k v -> k -> m v

Read big_map value, given it's ID and a key. If the value is not of the expected type, a ValueDecodeFailure will be thrown.

octez-client

class Monad m => HasTezosClient m where

Type class that provides interaction with octez-client binary

Methods

signBytes :: ImplicitAddressWithAlias -> Maybe ScrubbedBytes -> ByteString -> m Signature

Sign an operation with octez-client.

genKey :: ImplicitAlias -> m ImplicitAddressWithAlias

Generate a secret key and store it with given alias. If a key with this alias already exists, the corresponding address will be returned and no state will be changed.

genFreshKey :: ImplicitAlias -> m ImplicitAddressWithAlias

Generate a secret key and store it with given alias. Unlike genKey this function overwrites the existing key when given alias is already stored.

rememberContract :: AliasBehavior -> ContractAddress -> ContractAlias -> m ()

Associate the given contract with alias. The Bool variable indicates whether or not we should replace already existing contract alias or not.

getAliasesAndAddresses :: m [(Text, Text)]

Retrieves a list with all known aliases and respective addresses.

Note that an alias can be ambiguous: it can refer to BOTH a contract and an implicit account. When an alias "abc" is ambiguous, the list will contain two entries:

("abc", "KT1...")
("key:abc", "tz1...")

TODO [#910]: Cache this and turn it into a Bimap.

getKeyPassword :: ImplicitAddressWithAlias -> m (Maybe ScrubbedBytes)

Get password for secret key associated with given address in case this key is password-protected. Obtained password is used in two places: * 1) In signBytes call. * 2) in revealKey call.

getPublicKey :: ImplicitAddressWithAlias -> m PublicKey

Get a public key for an implicit address or alias.

Instances

HasTezosClient MorleyClientM

Defined in Morley.Client.Full

Methods

signBytes :: ImplicitAddressWithAlias -> Maybe ScrubbedBytes -> ByteString -> MorleyClientM Signature

genKey :: ImplicitAlias -> MorleyClientM ImplicitAddressWithAlias

genFreshKey :: ImplicitAlias -> MorleyClientM ImplicitAddressWithAlias

rememberContract :: AliasBehavior -> ContractAddress -> ContractAlias -> MorleyClientM ()

getAliasesAndAddresses :: MorleyClientM [(Text, Text)]

getKeyPassword :: ImplicitAddressWithAlias -> MorleyClientM (Maybe ScrubbedBytes)

getPublicKey :: ImplicitAddressWithAlias -> MorleyClientM PublicKey

HasTezosClient MorleyOnlyRpcM

Defined in Morley.Client.OnlyRPC

Methods

signBytes :: ImplicitAddressWithAlias -> Maybe ScrubbedBytes -> ByteString -> MorleyOnlyRpcM Signature

genKey :: ImplicitAlias -> MorleyOnlyRpcM ImplicitAddressWithAlias

genFreshKey :: ImplicitAlias -> MorleyOnlyRpcM ImplicitAddressWithAlias

rememberContract :: AliasBehavior -> ContractAddress -> ContractAlias -> MorleyOnlyRpcM ()

getAliasesAndAddresses :: MorleyOnlyRpcM [(Text, Text)]

getKeyPassword :: ImplicitAddressWithAlias -> MorleyOnlyRpcM (Maybe ScrubbedBytes)

getPublicKey :: ImplicitAddressWithAlias -> MorleyOnlyRpcM PublicKey

class Resolve addressOrAlias

Minimal complete definition

resolveAddressEither, getAliasEither, resolveAddressWithAliasEither

Associated Types

type ResolvedAddress addressOrAlias :: Type

type ResolvedAlias addressOrAlias :: Type

Instances

Resolve SomeAddressOrAlias

Defined in Morley.Client.TezosClient.Impl

Associated Types

type ResolvedAddress SomeAddressOrAlias

type ResolvedAlias SomeAddressOrAlias

type ResolvedAddressAndAlias SomeAddressOrAlias

Methods

resolveAddressEither :: (HasTezosClient m, MonadThrow m, WithClientLog env m) => SomeAddressOrAlias -> m (Either ResolveError (ResolvedAddress SomeAddressOrAlias))

getAliasEither :: (HasTezosClient m, MonadThrow m, WithClientLog env m) => SomeAddressOrAlias -> m (Either ResolveError (ResolvedAlias SomeAddressOrAlias))

resolveAddressWithAliasEither :: (HasTezosClient m, MonadThrow m, WithClientLog env m) => SomeAddressOrAlias -> m (Either ResolveError (ResolvedAddressAndAlias SomeAddressOrAlias))

Resolve (AddressOrAlias kind)

Defined in Morley.Client.TezosClient.Impl

Associated Types

type ResolvedAddress (AddressOrAlias kind)

type ResolvedAlias (AddressOrAlias kind)

type ResolvedAddressAndAlias (AddressOrAlias kind)

Methods

resolveAddressEither :: (HasTezosClient m, MonadThrow m, WithClientLog env m) => AddressOrAlias kind -> m (Either ResolveError (ResolvedAddress (AddressOrAlias kind)))

getAliasEither :: (HasTezosClient m, MonadThrow m, WithClientLog env m) => AddressOrAlias kind -> m (Either ResolveError (ResolvedAlias (AddressOrAlias kind)))

resolveAddressWithAliasEither :: (HasTezosClient m, MonadThrow m, WithClientLog env m) => AddressOrAlias kind -> m (Either ResolveError (ResolvedAddressAndAlias (AddressOrAlias kind)))

data ResolveError where

Constructors

REAliasNotFound

Fields

• :: Text
• -> ResolveError

  Could not find an address with given alias.

REWrongKind

Fields

• :: Alias expectedKind
• -> Address
• -> ResolveError

  Expected an alias to be associated with an implicit address, but it was associated with a contract address, or vice-versa.

REAddressNotFound

Fields

• :: KindedAddress kind
• -> ResolveError

  Could not find an alias with given address.

Instances

Show ResolveError

Defined in Morley.Client.TezosClient.Impl

Methods

showsPrec :: Int -> ResolveError -> ShowS

show :: ResolveError -> String

showList :: [ResolveError] -> ShowS

Buildable ResolveError

Defined in Morley.Client.TezosClient.Impl

Methods

build :: ResolveError -> Builder

getAlias :: forall addressOrAlias m env. (HasTezosClient m, WithClientLog env m, MonadThrow m, Resolve addressOrAlias) => addressOrAlias -> m (ResolvedAlias addressOrAlias)

Looks up the alias associated with the given addressOrAlias.

Will throw a TezosClientError if addressOrAlias:

• is an address that is not associated with any alias.
• is an alias that does not exist.
• is an alias that exists but its address is of the wrong kind.

When the alias is associated with both an implicit and a contract address:

• The SomeAddressOrAlias instance will throw a TezosClientError, unless the alias is prefixed with implicit: or contract: to disambiguate.
• The AddressOrAlias instance will return the alias.

getAliasMaybe :: forall addressOrAlias m env. (HasTezosClient m, WithClientLog env m, MonadThrow m, Resolve addressOrAlias) => addressOrAlias -> m (Maybe (ResolvedAlias addressOrAlias))

Looks up the alias associated with the given addressOrAlias.

Will return Nothing if addressOrAlias:

• is an address that is not associated with any alias.
• is an alias that does not exist.
• is an alias that exists but its address is of the wrong kind.

When the alias is associated with both an implicit and a contract address:

• The SomeAddressOrAlias instance will throw a TezosClientError, unless the alias is prefixed with implicit: or contract: to disambiguate.
• The AddressOrAlias instance will return the alias.

resolveAddress :: forall addressOrAlias m env. (HasTezosClient m, MonadThrow m, WithClientLog env m, Resolve addressOrAlias) => addressOrAlias -> m (ResolvedAddress addressOrAlias)

Looks up the address associated with the given addressOrAlias.

Will throw a TezosClientError if addressOrAlias is an alias and:

• the alias does not exist.
• the alias exists but its address is of the wrong kind.

When the alias is associated with both an implicit and a contract address:

• The SomeAddressOrAlias instance will throw a TezosClientError, unless the alias is prefixed with implicit: or contract: to disambiguate.
• The AddressOrAlias instance will return the address with the requested kind.

resolveAddressMaybe :: forall addressOrAlias m env. (HasTezosClient m, MonadThrow m, WithClientLog env m, Resolve addressOrAlias) => addressOrAlias -> m (Maybe (ResolvedAddress addressOrAlias))

Looks up the address associated with the given addressOrAlias.

Will return Nothing if addressOrAlias is an alias and:

• the alias does not exist.
• the alias exists but its address is of the wrong kind.

When the alias is associated with both an implicit and a contract address:

• The SomeAddressOrAlias instance will throw a TezosClientError, unless the alias is prefixed with implicit: or contract: to disambiguate.
• The AddressOrAlias instance will return the address with the requested kind.

resolveAddressWithAlias :: forall addressOrAlias m env. (HasTezosClient m, MonadThrow m, WithClientLog env m, Resolve addressOrAlias) => addressOrAlias -> m (ResolvedAddressAndAlias addressOrAlias)

Looks up the address and alias with the given addressOrAlias.

resolveAddressWithAliasMaybe :: forall addressOrAlias m env. (HasTezosClient m, MonadThrow m, WithClientLog env m, Resolve addressOrAlias) => addressOrAlias -> m (Maybe (ResolvedAddressAndAlias addressOrAlias))

Looks up the address and alias with the given addressOrAlias.

data TezosClientError

A data type for all predicatable errors that can happen during octez-client usage.

Constructors

UnexpectedClientFailure

octez-client call unexpectedly failed (returned non-zero exit code). The error contains the error code, stdout and stderr contents.

Fields

• Int

  Exit code

• Text

  stdout

• Text

  stderr

AlreadyRevealed

Public key of the given address is already revealed.

Fields

• ImplicitAlias

  Address alias that has already revealed its key

InvalidOperationHash OperationHash

Can't wait for inclusion of operation with given hash because the hash is invalid.

CounterIsAlreadyUsed

Error that indicates when given counter is already used for given contract.

Fields

• Text

  Raw counter

• Text

  Raw address

EConnreset

Network error with which octez-client fails from time to time.

ConfigParseError String

A parse error occurred during config parsing.

TezosClientCryptoParseError Text CryptoParseError

octez-client produced a cryptographic primitive that we can't parse.

TezosClientParseAddressError Text ParseAddressError

octez-client produced an address that we can't parse.

TezosClientParseFeeError Text Text

octez-client produced invalid output for parsing baker fee

TezosClientUnexpectedOutputFormat Text

octez-client printed a string that doesn't match the format we expect.

CantRevealContract

Given alias is a contract and cannot be revealed.

Fields

• ImplicitAlias

  Address alias of implicit account

ContractSender ContractAddress Text

Given contract is a source of a transfer or origination operation.

EmptyImplicitContract

Given alias is an empty implicit contract.

Fields

• ImplicitAlias

  Address alias of implicit contract

TezosClientUnexpectedSignatureOutput Text

octez-client sign bytes produced unexpected output format

TezosClientParseEncryptionTypeError Text Text

octez-client produced invalid output for parsing secret key encryption type.

DuplicateAlias Text

Tried to save alias, but such alias already exists.

AmbiguousAlias Text ContractAddress ImplicitAddress

Expected an alias to be associated with either an implicit address or a contract address, but it was associated with both.

ResolveError ResolveError

Instances

Exception TezosClientError

Defined in Morley.Client.TezosClient.Impl

Methods

toException :: TezosClientError -> SomeException

fromException :: SomeException -> Maybe TezosClientError

displayException :: TezosClientError -> String

Show TezosClientError

Defined in Morley.Client.TezosClient.Impl

Methods

showsPrec :: Int -> TezosClientError -> ShowS

show :: TezosClientError -> String

showList :: [TezosClientError] -> ShowS

Buildable TezosClientError

Defined in Morley.Client.TezosClient.Impl

Methods

build :: TezosClientError -> Builder

data AliasBehavior

How to save the originated contract address.

Constructors

DontSaveAlias

Don't save the newly originated contract address.

KeepDuplicateAlias

If an alias already exists, keep it, don't save the newly originated contract address.

OverwriteDuplicateAlias

If an alias already exists, replace it with the address of the newly originated contract.

ForbidDuplicateAlias

If an alias already exists, throw an exception without doing the origination

Instances

Enum AliasBehavior

Defined in Morley.Client.TezosClient.Class

Methods

succ :: AliasBehavior -> AliasBehavior

pred :: AliasBehavior -> AliasBehavior

toEnum :: Int -> AliasBehavior

fromEnum :: AliasBehavior -> Int

enumFrom :: AliasBehavior -> [AliasBehavior]

enumFromThen :: AliasBehavior -> AliasBehavior -> [AliasBehavior]

enumFromTo :: AliasBehavior -> AliasBehavior -> [AliasBehavior]

enumFromThenTo :: AliasBehavior -> AliasBehavior -> AliasBehavior -> [AliasBehavior]

Eq AliasBehavior

Defined in Morley.Client.TezosClient.Class

Methods

(==) :: AliasBehavior -> AliasBehavior -> Bool

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

Ord AliasBehavior

Defined in Morley.Client.TezosClient.Class

Methods

compare :: AliasBehavior -> AliasBehavior -> Ordering

(<) :: AliasBehavior -> AliasBehavior -> Bool

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

(>) :: AliasBehavior -> AliasBehavior -> Bool

(>=) :: AliasBehavior -> AliasBehavior -> Bool

max :: AliasBehavior -> AliasBehavior -> AliasBehavior

min :: AliasBehavior -> AliasBehavior -> AliasBehavior

Util

disableAlphanetWarning :: IO ()

Sets the environment variable for disabling octez-client's "not a mainnet" warning

data AddressWithAlias kind

Constructors

AddressWithAlias

Fields

• awaAddress :: KindedAddress kind
• awaAlias :: Alias kind

Instances

ToTAddress cp vd (KindedAddress kind) => ToTAddress cp vd (AddressWithAlias kind)

Defined in Morley.Client.Types

Methods

toTAddress :: AddressWithAlias kind -> TAddress cp vd

Show (AddressWithAlias kind)

Defined in Morley.Client.Types

Methods

showsPrec :: Int -> AddressWithAlias kind -> ShowS

show :: AddressWithAlias kind -> String

showList :: [AddressWithAlias kind] -> ShowS

Buildable (AddressWithAlias kind)

Defined in Morley.Client.Types

Methods

build :: AddressWithAlias kind -> Builder

Eq (AddressWithAlias kind)

Defined in Morley.Client.Types

Methods

(==) :: AddressWithAlias kind -> AddressWithAlias kind -> Bool

(/=) :: AddressWithAlias kind -> AddressWithAlias kind -> Bool

ToAddress (AddressWithAlias kind)

Defined in Morley.Client.Types

Methods

toAddress :: AddressWithAlias kind -> Address

type ImplicitAddressWithAlias = AddressWithAlias 'AddressKindImplicit

type ContractAddressWithAlias = AddressWithAlias 'AddressKindContract

Reexports

data ParserInfo a

A full description for a runnable Parser for a program.

Instances

Functor ParserInfo

Defined in Options.Applicative.Types

Methods

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

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