Morley.Client.TezosClient.Types

Types used for interaction with tezos-client.

Documentation

class CmdArg a where

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

Minimal complete definition

Nothing

Methods

toCmdArg :: a -> String

Render an object as a command-line argument.

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

Instances

CmdArg Word16

Defined in Morley.Client.TezosClient.Types

Methods

toCmdArg :: Word16 -> String

CmdArg ByteString

Defined in Morley.Client.TezosClient.Types

Methods

toCmdArg :: ByteString -> String

CmdArg Text

Defined in Morley.Client.TezosClient.Types

Methods

toCmdArg :: Text -> String

CmdArg BaseUrl

Defined in Morley.Client.TezosClient.Types

Methods

toCmdArg :: BaseUrl -> String

CmdArg LText

Defined in Morley.Client.TezosClient.Types

Methods

toCmdArg :: LText -> String

CmdArg Address

Defined in Morley.Client.TezosClient.Types

Methods

toCmdArg :: Address -> String

CmdArg Mutez

Defined in Morley.Client.TezosClient.Types

Methods

toCmdArg :: Mutez -> String

CmdArg SecretKey

Defined in Morley.Client.TezosClient.Types

Methods

toCmdArg :: SecretKey -> String

CmdArg EpName

Defined in Morley.Client.TezosClient.Types

Methods

toCmdArg :: EpName -> String

CmdArg OperationHash

Defined in Morley.Client.TezosClient.Types

Methods

toCmdArg :: OperationHash -> String

CmdArg AddressOrAlias

Defined in Morley.Client.TezosClient.Types

Methods

toCmdArg :: AddressOrAlias -> String

CmdArg Alias

Defined in Morley.Client.TezosClient.Types

Methods

toCmdArg :: Alias -> String

ProperUntypedValBetterErrors t => CmdArg (Value t)

Defined in Morley.Client.TezosClient.Types

Methods

toCmdArg :: Value t -> String

CmdArg (Contract cp st)

Defined in Morley.Client.TezosClient.Types

Methods

toCmdArg :: Contract cp st -> String

data Alias

tezos-client can associate addresses with textual aliases. This type denotes such an alias.

Instances

Eq Alias

Defined in Morley.Client.TezosClient.Types

Methods

(==) :: Alias -> Alias -> Bool

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

Ord Alias

Defined in Morley.Client.TezosClient.Types

Methods

compare :: Alias -> Alias -> Ordering

(<) :: Alias -> Alias -> Bool

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

(>) :: Alias -> Alias -> Bool

(>=) :: Alias -> Alias -> Bool

max :: Alias -> Alias -> Alias

min :: Alias -> Alias -> Alias

Show Alias

Defined in Morley.Client.TezosClient.Types

Methods

showsPrec :: Int -> Alias -> ShowS

show :: Alias -> String

showList :: [Alias] -> ShowS

Buildable Alias

Defined in Morley.Client.TezosClient.Types

Methods

build :: Alias -> Builder

CmdArg Alias

Defined in Morley.Client.TezosClient.Types

Methods

toCmdArg :: Alias -> String

data AliasHint

A hint for constructing an alias when generating an address or remembering a contract.

Resulting Alias most likely will differ from this as we tend to prefix aliases, but a user should be able to recognize your alias visually. For instance, passing "alice" as a hint may result into "myTest.alice" alias being created.

Instances

Show AliasHint

Defined in Morley.Client.TezosClient.Types

Methods

showsPrec :: Int -> AliasHint -> ShowS

show :: AliasHint -> String

showList :: [AliasHint] -> ShowS

IsString AliasHint

Defined in Morley.Client.TezosClient.Types

Methods

fromString :: String -> AliasHint

Semigroup AliasHint

Defined in Morley.Client.TezosClient.Types

Methods

(<>) :: AliasHint -> AliasHint -> AliasHint

sconcat :: NonEmpty AliasHint -> AliasHint

stimes :: Integral b => b -> AliasHint -> AliasHint

Monoid AliasHint

Defined in Morley.Client.TezosClient.Types

Methods

mempty :: AliasHint

mappend :: AliasHint -> AliasHint -> AliasHint

mconcat :: [AliasHint] -> AliasHint

Buildable AliasHint

Defined in Morley.Client.TezosClient.Types

Methods

build :: AliasHint -> Builder

data AliasOrAliasHint

Either an Alias, or an AliasHint. The difference is that AliasHint needs to be prefixed (if alias prefix is non-empty), while Alias doesn't.

Constructors

AnAlias Alias

AnAliasHint AliasHint

Instances

Show AliasOrAliasHint

Defined in Morley.Client.TezosClient.Types

Methods

showsPrec :: Int -> AliasOrAliasHint -> ShowS

show :: AliasOrAliasHint -> String

showList :: [AliasOrAliasHint] -> ShowS

data AddressOrAlias

Representation of an address that tezos-client uses. It can be an address itself or a textual alias.

Constructors

AddressResolved Address

Address itself, can be used as is.

AddressAlias Alias

Address alias, should be resolved by tezos-client.

Instances

Eq AddressOrAlias

Defined in Morley.Client.TezosClient.Types

Methods

(==) :: AddressOrAlias -> AddressOrAlias -> Bool

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

Ord AddressOrAlias

Defined in Morley.Client.TezosClient.Types

Methods

compare :: AddressOrAlias -> AddressOrAlias -> Ordering

(<) :: AddressOrAlias -> AddressOrAlias -> Bool

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

(>) :: AddressOrAlias -> AddressOrAlias -> Bool

(>=) :: AddressOrAlias -> AddressOrAlias -> Bool

max :: AddressOrAlias -> AddressOrAlias -> AddressOrAlias

min :: AddressOrAlias -> AddressOrAlias -> AddressOrAlias

Show AddressOrAlias

Defined in Morley.Client.TezosClient.Types

Methods

showsPrec :: Int -> AddressOrAlias -> ShowS

show :: AddressOrAlias -> String

showList :: [AddressOrAlias] -> ShowS

Buildable AddressOrAlias

Defined in Morley.Client.TezosClient.Types

Methods

build :: AddressOrAlias -> Builder

HasCLReader AddressOrAlias

Defined in Morley.Client.TezosClient.Types

Methods

getReader :: ReadM AddressOrAlias

getMetavar :: String

CmdArg AddressOrAlias

Defined in Morley.Client.TezosClient.Types

Methods

toCmdArg :: AddressOrAlias -> String

addressResolved :: ToAddress addr => addr -> AddressOrAlias

Creates an AddressOrAlias with the given address.

data CalcOriginationFeeData cp st

Data required for calculating fee for origination operation.

Constructors

CalcOriginationFeeData

Fields

• cofdFrom :: AddressOrAlias
• cofdBalance :: TezosMutez
• cofdMbFromPassword :: Maybe ScrubbedBytes
• cofdContract :: Contract cp st
• cofdStorage :: Value st
• cofdBurnCap :: TezosInt64

data CalcTransferFeeData

Data required for calculating fee for transfer operation.

Constructors

forall t.UntypedValScope t => CalcTransferFeeData

Fields

• ctfdTo :: AddressOrAlias
• ctfdParam :: Value t
• ctfdEp :: EpName
• ctfdAmount :: TezosMutez

Instances

ToJSON CalcTransferFeeData

Defined in Morley.Client.TezosClient.Types

Methods

toJSON :: CalcTransferFeeData -> Value

toEncoding :: CalcTransferFeeData -> Encoding

toJSONList :: [CalcTransferFeeData] -> Value

toEncodingList :: [CalcTransferFeeData] -> Encoding

newtype TezosClientConfig

Configuration maintained by tezos-client, see its config subcommands (e. g. tezos-client config show). Only the field we are interested in is present here.

Constructors

TezosClientConfig

Fields

• tcEndpointUrl :: BaseUrl

Instances

Show TezosClientConfig

Defined in Morley.Client.TezosClient.Types

Methods

showsPrec :: Int -> TezosClientConfig -> ShowS

show :: TezosClientConfig -> String

showList :: [TezosClientConfig] -> ShowS

FromJSON TezosClientConfig

For reading tezos-client config.

Defined in Morley.Client.TezosClient.Types

Methods

parseJSON :: Value -> Parser TezosClientConfig

parseJSONList :: Value -> Parser [TezosClientConfig]

data TezosClientEnv

Runtime environment for tezos-client bindings.

Constructors

TezosClientEnv

Fields

• tceAliasPrefix :: Maybe Text

  Optional prefix for aliases that will be passed to tezos-client. If you call some function and pass foo Alias to it when the prefix is provided, it will be prepened to foo. So prefix.foo will be passed to tezos-client. Note that the prefix will be only applied in functions such as genKey and rememberContract that work directly with tezos-client contract cache and add addresses to it.

• 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.

class HasTezosClientEnv env where

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

Methods

tezosClientEnvL :: Lens' env TezosClientEnv

Instances

HasTezosClientEnv (MorleyClientEnv' m)

Defined in Morley.Client.Env

Methods

tezosClientEnvL :: Lens' (MorleyClientEnv' m) TezosClientEnv

data SecretKeyEncryption

Representation of address secret key encryption type

Constructors

UnencryptedKey

EncryptedKey

LedgerKey

Instances

Eq SecretKeyEncryption

Defined in Morley.Client.TezosClient.Types

Methods

(==) :: SecretKeyEncryption -> SecretKeyEncryption -> Bool

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

Show SecretKeyEncryption

Defined in Morley.Client.TezosClient.Types

Methods

showsPrec :: Int -> SecretKeyEncryption -> ShowS

show :: SecretKeyEncryption -> String

showList :: [SecretKeyEncryption] -> ShowS

Unsafe coercions

unsafeCoerceAliasHintToAlias :: AliasHint -> Alias

Coerce AliasHint to Alias. Unless you know for a fact that prefix is empty, this is unsafe.

unsafeCoerceAliasToAliasHint :: Alias -> AliasHint

Coerce Alias to AliasHint. Unless you know for a fact that prefix is empty, this is unsafe.

unsafeGetAliasText :: Alias -> Text

Unsafely extract Text from Alias. Do NOT use the result with mkAliasHint.

unsafeGetAliasHintText :: AliasHint -> Text

Unsafely extract Text from AliasHint. Do NOT use the result with mkAlias.

mkAlias :: Text -> Alias

Make Alias from Text

mkAliasHint :: Text -> AliasHint

Make AliasHint from Text

Lens

tceAliasPrefixL :: Lens' TezosClientEnv (Maybe Text)

tceEndpointUrlL :: Lens' TezosClientEnv BaseUrl

tceTezosClientPathL :: Lens' TezosClientEnv FilePath

tceMbTezosClientDataDirL :: Lens' TezosClientEnv (Maybe FilePath)