Morley.Client.TezosClient.Class

Abstraction layer for tezos-client functionality. We use it to fake tezos-client in tests.

Documentation

class Monad m => HasTezosClient m where

Type class that provides interaction with tezos-client binary

Methods

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

Sign an operation with tezos-client.

genKey :: ImplicitAlias -> m ImplicitAddress

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 ImplicitAddress

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

revealKey :: ImplicitAlias -> Maybe ScrubbedBytes -> m ()

Reveal public key associated with given implicit account.

rememberContract :: Bool -> 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.

resolveAddressMaybe :: AddressOrAlias kind -> m (Maybe (KindedAddress kind))

Retrieve an address from given address or alias. If address or alias does not exist returns Nothing

getAlias :: L1AddressKind kind => AddressOrAlias kind -> m (Alias kind)

Retrieve an alias from given address using tezos-client. The primary (and probably only) reason this function exists is that tezos-client sign command only works with aliases. It was reported upstream: https://gitlab.com/tezos/tezos/-/issues/836.

registerDelegate :: ImplicitAlias -> Maybe ScrubbedBytes -> m ()

Register a given address as delegate TODO [#869] move to HasTezosRpc

getKeyPassword :: ImplicitAddress -> 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.

Instances

HasTezosClient MorleyClientM

Defined in Morley.Client.Full

Methods

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

genKey :: ImplicitAlias -> MorleyClientM ImplicitAddress

genFreshKey :: ImplicitAlias -> MorleyClientM ImplicitAddress

revealKey :: ImplicitAlias -> Maybe ScrubbedBytes -> MorleyClientM ()

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

resolveAddressMaybe :: forall (kind :: AddressKind). AddressOrAlias kind -> MorleyClientM (Maybe (KindedAddress kind))

getAlias :: forall (kind :: AddressKind). L1AddressKind kind => AddressOrAlias kind -> MorleyClientM (Alias kind)

registerDelegate :: ImplicitAlias -> Maybe ScrubbedBytes -> MorleyClientM ()

getKeyPassword :: ImplicitAddress -> MorleyClientM (Maybe ScrubbedBytes)

HasTezosClient MorleyOnlyRpcM

Defined in Morley.Client.OnlyRPC

Methods

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

genKey :: ImplicitAlias -> MorleyOnlyRpcM ImplicitAddress

genFreshKey :: ImplicitAlias -> MorleyOnlyRpcM ImplicitAddress

revealKey :: ImplicitAlias -> Maybe ScrubbedBytes -> MorleyOnlyRpcM ()

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

resolveAddressMaybe :: forall (kind :: AddressKind). AddressOrAlias kind -> MorleyOnlyRpcM (Maybe (KindedAddress kind))

getAlias :: forall (kind :: AddressKind). L1AddressKind kind => AddressOrAlias kind -> MorleyOnlyRpcM (Alias kind)

registerDelegate :: ImplicitAlias -> Maybe ScrubbedBytes -> MorleyOnlyRpcM ()

getKeyPassword :: ImplicitAddress -> MorleyOnlyRpcM (Maybe ScrubbedBytes)