Safe Haskell	Safe-Inferred
Language	Haskell2010

Morley.Client.TezosClient.Types

Contents

Lens

Description

Types used for interaction with octez-client.

Synopsis

class CmdArg a where
- toCmdArg :: a -> String
data CalcOriginationFeeData cp st = forall kind.CalcOriginationFeeData {
- cofdFrom :: AddressOrAlias kind
- cofdBalance :: TezosMutez
- cofdMbFromPassword :: Maybe ScrubbedBytes
- cofdContract :: Contract cp st
- cofdStorage :: Value st
- cofdBurnCap :: TezosInt64
}
data CalcTransferFeeData = forall t kind.UntypedValScope t => CalcTransferFeeData {
- ctfdTo :: AddressOrAlias kind
- ctfdParam :: Value t
- ctfdEp :: EpName
- ctfdAmount :: TezosMutez
}
data TezosClientEnv = TezosClientEnv {
- tceEndpointUrl :: BaseUrl
- tceTezosClientPath :: FilePath
- tceMbTezosClientDataDir :: Maybe FilePath
- tceAliasMap :: MVar (Maybe AliasesAndAddresses)
}
class HasTezosClientEnv env where
- tezosClientEnvL :: Lens' env TezosClientEnv
data SecretKeyEncryption
- = UnencryptedKey
- | EncryptedKey
- | LedgerKey
data AliasBehavior
tceEndpointUrlL :: Lens' TezosClientEnv BaseUrl
tceTezosClientPathL :: Lens' TezosClientEnv FilePath
tceMbTezosClientDataDirL :: Lens' TezosClientEnv (Maybe FilePath)
tceAliasMapL :: Lens' TezosClientEnv (MVar (Maybe AliasesAndAddresses))

Documentation

class CmdArg a where Source #

An object that can be put as argument to a octez-client command-line call.

Minimal complete definition

Nothing

Methods

toCmdArg :: a -> String Source #

Render an object as a command-line argument.

default toCmdArg :: Buildable a => a -> String Source #

Instances

Instances details

CmdArg Word16 Source #
Instance details Defined in Morley.Client.TezosClient.Types Methods toCmdArg :: Word16 -> String Source #
CmdArg ByteString Source #
Instance details Defined in Morley.Client.TezosClient.Types Methods toCmdArg :: ByteString -> String Source #
CmdArg EpName Source #
Instance details Defined in Morley.Client.TezosClient.Types Methods toCmdArg :: EpName -> String Source #
CmdArg Address Source #
Instance details Defined in Morley.Client.TezosClient.Types Methods toCmdArg :: Address -> String Source #
CmdArg Mutez Source #
Instance details Defined in Morley.Client.TezosClient.Types Methods toCmdArg :: Mutez -> String Source #
CmdArg SecretKey Source #
Instance details Defined in Morley.Client.TezosClient.Types Methods toCmdArg :: SecretKey -> String Source #
CmdArg OperationHash Source #
Instance details Defined in Morley.Client.TezosClient.Types Methods toCmdArg :: OperationHash -> String Source #
CmdArg BaseUrl Source #
Instance details Defined in Morley.Client.TezosClient.Types Methods toCmdArg :: BaseUrl -> String Source #
CmdArg Text Source #
Instance details Defined in Morley.Client.TezosClient.Types Methods toCmdArg :: Text -> String Source #
CmdArg LText Source #
Instance details Defined in Morley.Client.TezosClient.Types Methods toCmdArg :: LText -> String Source #
UntypedValScope t => CmdArg (Value t) Source #
Instance details Defined in Morley.Client.TezosClient.Types Methods toCmdArg :: Value t -> String Source #
CmdArg (KindedAddress kind) Source #
Instance details Defined in Morley.Client.TezosClient.Types Methods toCmdArg :: KindedAddress kind -> String Source #
CmdArg (AddressOrAlias kind) Source #
Instance details Defined in Morley.Client.TezosClient.Types Methods toCmdArg :: AddressOrAlias kind -> String Source #
CmdArg (Alias kind) Source #
Instance details Defined in Morley.Client.TezosClient.Types Methods toCmdArg :: Alias kind -> String Source #
CmdArg (Contract cp st) Source #
Instance details Defined in Morley.Client.TezosClient.Types Methods toCmdArg :: Contract cp st -> String Source #

data CalcOriginationFeeData cp st Source #

Data required for calculating fee for origination operation.

Constructors

forall kind. CalcOriginationFeeData
Fields cofdFrom :: AddressOrAlias kind cofdBalance :: TezosMutez cofdMbFromPassword :: Maybe ScrubbedBytes cofdContract :: Contract cp st cofdStorage :: Value st cofdBurnCap :: TezosInt64

data CalcTransferFeeData Source #

Data required for calculating fee for transfer operation.

Constructors

forall t kind.UntypedValScope t => CalcTransferFeeData
Fields ctfdTo :: AddressOrAlias kind ctfdParam :: Value t ctfdEp :: EpName ctfdAmount :: TezosMutez

Instances

Instances details

ToJSON CalcTransferFeeData Source #
Instance details Defined in Morley.Client.TezosClient.Types Methods toJSON :: CalcTransferFeeData -> Value # toEncoding :: CalcTransferFeeData -> Encoding # toJSONList :: [CalcTransferFeeData] -> Value # toEncodingList :: [CalcTransferFeeData] -> Encoding #

data TezosClientEnv Source #

Runtime environment for octez-client bindings.

Constructors

TezosClientEnv

Fields

tceEndpointUrl :: BaseUrl
URL of tezos node on which operations are performed.
tceTezosClientPath :: FilePath
Path to tezos client binary through which operations are performed.
tceMbTezosClientDataDir :: Maybe FilePath
Path to tezos client data directory.
tceAliasMap :: MVar (Maybe AliasesAndAddresses)
Lazy cache for the mapping between addresses and aliases. The Nothing value signifies the cache is either yet unpopulated or was recently invalidated. The Just value is the cached result of octez-client list known contracts. MVar itself being empty/full is used for thread synchronization, as is usual.

class HasTezosClientEnv env where Source #

Using this type class one can require MonadReader constraint that holds any type with TezosClientEnv inside.

Methods

tezosClientEnvL :: Lens' env TezosClientEnv Source #

Instances

Instances details

HasTezosClientEnv MorleyClientEnv Source #
Instance details Defined in Morley.Client.TezosClient.Types.MorleyClientM Methods tezosClientEnvL :: Lens' MorleyClientEnv TezosClientEnv Source #

data SecretKeyEncryption Source #

Representation of address secret key encryption type

Constructors

UnencryptedKey
EncryptedKey
LedgerKey

Instances

Instances details

Show SecretKeyEncryption Source #
Instance details Defined in Morley.Client.TezosClient.Types Methods showsPrec :: Int -> SecretKeyEncryption -> ShowS # show :: SecretKeyEncryption -> String # showList :: [SecretKeyEncryption] -> ShowS #
Eq SecretKeyEncryption Source #
Instance details Defined in Morley.Client.TezosClient.Types Methods (==) :: SecretKeyEncryption -> SecretKeyEncryption -> Bool # (/=) :: SecretKeyEncryption -> SecretKeyEncryption -> Bool #

data AliasBehavior Source #

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

Instances details

Enum AliasBehavior Source #
Instance details Defined in Morley.Client.TezosClient.Types 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 Source #
Instance details Defined in Morley.Client.TezosClient.Types Methods (==) :: AliasBehavior -> AliasBehavior -> Bool # (/=) :: AliasBehavior -> AliasBehavior -> Bool #
Ord AliasBehavior Source #
Instance details Defined in Morley.Client.TezosClient.Types 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 #

Lens

tceEndpointUrlL :: Lens' TezosClientEnv BaseUrl Source #

tceTezosClientPathL :: Lens' TezosClientEnv FilePath Source #

tceMbTezosClientDataDirL :: Lens' TezosClientEnv (Maybe FilePath) Source #

tceAliasMapL :: Lens' TezosClientEnv (MVar (Maybe AliasesAndAddresses)) Source #