Safe Haskell	Safe-Inferred
Language	Haskell2010

Morley.Client.TezosClient.Types.MorleyClientM

Contents

Lens

Description

Full-featured Morley client, backed by octez-client.

Synopsis

data MorleyClientEnv = MorleyClientEnv {
- mceTezosClient :: TezosClientEnv
- mceLogAction :: ClientLogAction MorleyClientM
- mceSecretKey :: Maybe SecretKey
- mceClientEnv :: ClientEnv
}
data MorleyClientConfig = MorleyClientConfig {
- mccEndpointUrl :: Maybe BaseUrl
- mccTezosClientPath :: FilePath
- mccMbTezosClientDataDir :: Maybe FilePath
- mccVerbosity :: Word
- mccSecretKey :: Maybe SecretKey
}
data MorleyClientM a
runMorleyClientM :: MorleyClientEnv -> MorleyClientM a -> IO a
mkMorleyClientEnv :: MorleyClientConfig -> IO MorleyClientEnv
mkLogAction :: MonadIO m => Word -> ClientLogAction m
mceTezosClientL :: Lens' MorleyClientEnv TezosClientEnv
mceLogActionL :: Lens' MorleyClientEnv (ClientLogAction MorleyClientM)
mceSecretKeyL :: Lens' MorleyClientEnv (Maybe SecretKey)
mceClientEnvL :: Lens' MorleyClientEnv ClientEnv
mccEndpointUrlL :: Lens' MorleyClientConfig (Maybe BaseUrl)
mccTezosClientPathL :: Lens' MorleyClientConfig FilePath
mccMbTezosClientDataDirL :: Lens' MorleyClientConfig (Maybe FilePath)
mccVerbosityL :: Lens' MorleyClientConfig Word
mccSecretKeyL :: Lens' MorleyClientConfig (Maybe SecretKey)

Documentation

data MorleyClientEnv Source #

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

Instances details

HasTezosClientEnv MorleyClientEnv Source #
Instance details Defined in Morley.Client.TezosClient.Types.MorleyClientM Methods tezosClientEnvL :: Lens' MorleyClientEnv TezosClientEnv Source #
MonadReader MorleyClientEnv MorleyClientM Source #
Instance details Defined in Morley.Client.TezosClient.Types.MorleyClientM Methods ask :: MorleyClientM MorleyClientEnv # local :: (MorleyClientEnv -> MorleyClientEnv) -> MorleyClientM a -> MorleyClientM a # reader :: (MorleyClientEnv -> a) -> MorleyClientM a #
HasLog MorleyClientEnv Message MorleyClientM Source #
Instance details Defined in Morley.Client.TezosClient.Types.MorleyClientM 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 Source #

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

Instances details

Show MorleyClientConfig Source #
Instance details Defined in Morley.Client.Init Methods showsPrec :: Int -> MorleyClientConfig -> ShowS # show :: MorleyClientConfig -> String # showList :: [MorleyClientConfig] -> ShowS #

data MorleyClientM a Source #

Instances

Instances details

MonadIO MorleyClientM Source #
Instance details Defined in Morley.Client.TezosClient.Types.MorleyClientM Methods liftIO :: IO a -> MorleyClientM a #
Applicative MorleyClientM Source #
Instance details Defined in Morley.Client.TezosClient.Types.MorleyClientM 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 Source #
Instance details Defined in Morley.Client.TezosClient.Types.MorleyClientM Methods fmap :: (a -> b) -> MorleyClientM a -> MorleyClientM b # (<$) :: a -> MorleyClientM b -> MorleyClientM a #
Monad MorleyClientM Source #
Instance details Defined in Morley.Client.TezosClient.Types.MorleyClientM Methods (>>=) :: MorleyClientM a -> (a -> MorleyClientM b) -> MorleyClientM b # (>>) :: MorleyClientM a -> MorleyClientM b -> MorleyClientM b # return :: a -> MorleyClientM a #
MonadCatch MorleyClientM Source #
Instance details Defined in Morley.Client.TezosClient.Types.MorleyClientM Methods catch :: Exception e => MorleyClientM a -> (e -> MorleyClientM a) -> MorleyClientM a #
MonadMask MorleyClientM Source #
Instance details Defined in Morley.Client.TezosClient.Types.MorleyClientM 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 Source #
Instance details Defined in Morley.Client.TezosClient.Types.MorleyClientM Methods throwM :: Exception e => e -> MorleyClientM a #
HasTezosRpc MorleyClientM Source #
Instance details Defined in Morley.Client.TezosClient.Types.MorleyClientM Methods getBlockHash :: BlockId -> MorleyClientM BlockHash Source # getCounterAtBlock :: BlockId -> ImplicitAddress -> MorleyClientM TezosInt64 Source # getBlockHeader :: BlockId -> MorleyClientM BlockHeader Source # getScriptSizeAtBlock :: BlockId -> CalcSize -> MorleyClientM ScriptSize Source # getBlockConstants :: BlockId -> MorleyClientM BlockConstants Source # getBlockOperations :: BlockId -> MorleyClientM [[BlockOperation]] Source # getBlockOperationHashes :: BlockId -> MorleyClientM [[OperationHash]] Source # getProtocolParametersAtBlock :: BlockId -> MorleyClientM ProtocolParameters Source # runOperationAtBlock :: BlockId -> RunOperation -> MorleyClientM RunOperationResult Source # preApplyOperationsAtBlock :: BlockId -> [PreApplyOperation] -> MorleyClientM [RunOperationResult] Source # forgeOperationAtBlock :: BlockId -> ForgeOperation -> MorleyClientM HexJSONByteString Source # injectOperation :: HexJSONByteString -> MorleyClientM OperationHash Source # getContractScriptAtBlock :: BlockId -> ContractAddress -> MorleyClientM OriginationScript Source # getContractStorageAtBlock :: BlockId -> ContractAddress -> MorleyClientM Expression Source # getContractBigMapAtBlock :: BlockId -> ContractAddress -> GetBigMap -> MorleyClientM GetBigMapResult Source # getBigMapValueAtBlock :: BlockId -> Natural -> Text -> MorleyClientM Expression Source # getBigMapValuesAtBlock :: BlockId -> Natural -> Maybe Natural -> Maybe Natural -> MorleyClientM Expression Source # getBalanceAtBlock :: BlockId -> Address -> MorleyClientM Mutez Source # getDelegateAtBlock :: BlockId -> L1Address -> MorleyClientM (Maybe KeyHash) Source # runCodeAtBlock :: BlockId -> RunCode -> MorleyClientM RunCodeResult Source # getChainId :: MorleyClientM ChainId Source # getManagerKeyAtBlock :: BlockId -> ImplicitAddress -> MorleyClientM (Maybe PublicKey) Source # waitForOperation :: MorleyClientM OperationHash -> MorleyClientM OperationHash Source # getTicketBalanceAtBlock :: BlockId -> Address -> GetTicketBalance -> MorleyClientM Natural Source # getAllTicketBalancesAtBlock :: BlockId -> ContractAddress -> MorleyClientM [GetAllTicketBalancesResponse] Source # packData :: forall (t :: T). ForbidOp t => BlockId -> Value t -> Notes t -> MorleyClientM Text Source #
HasTezosClient MorleyClientM Source #
Instance details Defined in Morley.Client.TezosClient.Impl Methods signBytes :: ImplicitAddressWithAlias -> Maybe ScrubbedBytes -> ByteString -> MorleyClientM Signature Source # genKey :: ImplicitAlias -> MorleyClientM ImplicitAddressWithAlias Source # genFreshKey :: ImplicitAlias -> MorleyClientM ImplicitAddressWithAlias Source # rememberContract :: AliasBehavior -> ContractAddress -> ContractAlias -> MorleyClientM () Source # getAliasesAndAddresses :: MorleyClientM AliasesAndAddresses Source # getKeyPassword :: ImplicitAddressWithAlias -> MorleyClientM (Maybe ScrubbedBytes) Source # getPublicKey :: ImplicitAddressWithAlias -> MorleyClientM PublicKey Source #
RunClient MorleyClientM Source #
Instance details Defined in Morley.Client.TezosClient.Types.MorleyClientM Methods runRequestAcceptStatus :: Maybe [Status] -> Request -> MorleyClientM Response # throwClientError :: ClientError -> MorleyClientM a #
MonadUnliftIO MorleyClientM Source #
Instance details Defined in Morley.Client.TezosClient.Types.MorleyClientM Methods withRunInIO :: ((forall a. MorleyClientM a -> IO a) -> IO b) -> MorleyClientM b #
MonadReader MorleyClientEnv MorleyClientM Source #
Instance details Defined in Morley.Client.TezosClient.Types.MorleyClientM Methods ask :: MorleyClientM MorleyClientEnv # local :: (MorleyClientEnv -> MorleyClientEnv) -> MorleyClientM a -> MorleyClientM a # reader :: (MorleyClientEnv -> a) -> MorleyClientM a #
HasLog MorleyClientEnv Message MorleyClientM Source #
Instance details Defined in Morley.Client.TezosClient.Types.MorleyClientM 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 Source #

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

mkMorleyClientEnv :: MorleyClientConfig -> IO MorleyClientEnv Source #

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.

mkLogAction :: MonadIO m => Word -> ClientLogAction m Source #

Make appropriate ClientLogAction based on verbosity specified by the user.

Lens

mceTezosClientL :: Lens' MorleyClientEnv TezosClientEnv Source #

mceLogActionL :: Lens' MorleyClientEnv (ClientLogAction MorleyClientM) Source #

mceSecretKeyL :: Lens' MorleyClientEnv (Maybe SecretKey) Source #

mceClientEnvL :: Lens' MorleyClientEnv ClientEnv Source #

mccEndpointUrlL :: Lens' MorleyClientConfig (Maybe BaseUrl) Source #

mccTezosClientPathL :: Lens' MorleyClientConfig FilePath Source #

mccMbTezosClientDataDirL :: Lens' MorleyClientConfig (Maybe FilePath) Source #

mccVerbosityL :: Lens' MorleyClientConfig Word Source #

mccSecretKeyL :: Lens' MorleyClientConfig (Maybe SecretKey) Source #