Morley.Client.TezosClient.Resolve

Utilities for resolving addresses and aliases.

Documentation

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.

REAmbiguousAlias

Fields

• :: Text
• -> [L1Address]
• -> ResolveError

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

Instances

Show ResolveError

Defined in Morley.Client.TezosClient.Types.Errors

Methods

showsPrec :: Int -> ResolveError -> ShowS

show :: ResolveError -> String

showList :: [ResolveError] -> ShowS

Buildable ResolveError

Defined in Morley.Client.TezosClient.Types.Errors

Methods

build :: ResolveError -> Doc

buildList :: [ResolveError] -> Doc

class Resolve addressOrAlias where

Associated Types

type ResolvedAddress addressOrAlias :: Type

type ResolvedAlias addressOrAlias :: Type

type ResolvedAddressAndAlias addressOrAlias :: Type

Methods

resolveAddressEither :: HasTezosClient m => addressOrAlias -> m (Either ResolveError (ResolvedAddress addressOrAlias))

Looks up the address associated with the given addressOrAlias.

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

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

getAliasEither :: HasTezosClient m => addressOrAlias -> m (Either ResolveError (ResolvedAlias addressOrAlias))

Looks up the alias associated with the given addressOrAlias.

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

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

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

resolveAddressWithAliasEither :: HasTezosClient m => addressOrAlias -> m (Either ResolveError (ResolvedAddressAndAlias addressOrAlias))

Resolve both address and alias at the same time

Instances

Resolve SomeAddressOrAlias

Defined in Morley.Client.TezosClient.Resolve

Associated Types

type ResolvedAddress SomeAddressOrAlias

type ResolvedAlias SomeAddressOrAlias

type ResolvedAddressAndAlias SomeAddressOrAlias

Methods

resolveAddressEither :: HasTezosClient m => SomeAddressOrAlias -> m (Either ResolveError (ResolvedAddress SomeAddressOrAlias))

getAliasEither :: HasTezosClient m => SomeAddressOrAlias -> m (Either ResolveError (ResolvedAlias SomeAddressOrAlias))

resolveAddressWithAliasEither :: HasTezosClient m => SomeAddressOrAlias -> m (Either ResolveError (ResolvedAddressAndAlias SomeAddressOrAlias))

L1AddressKind kind => Resolve (KindedAddress kind)

Defined in Morley.Client.TezosClient.Resolve

Associated Types

type ResolvedAddress (KindedAddress kind)

type ResolvedAlias (KindedAddress kind)

type ResolvedAddressAndAlias (KindedAddress kind)

Methods

resolveAddressEither :: HasTezosClient m => KindedAddress kind -> m (Either ResolveError (ResolvedAddress (KindedAddress kind)))

getAliasEither :: HasTezosClient m => KindedAddress kind -> m (Either ResolveError (ResolvedAlias (KindedAddress kind)))

resolveAddressWithAliasEither :: HasTezosClient m => KindedAddress kind -> m (Either ResolveError (ResolvedAddressAndAlias (KindedAddress kind)))

Resolve (AddressOrAlias kind)

Defined in Morley.Client.TezosClient.Resolve

Associated Types

type ResolvedAddress (AddressOrAlias kind)

type ResolvedAlias (AddressOrAlias kind)

type ResolvedAddressAndAlias (AddressOrAlias kind)

Methods

resolveAddressEither :: HasTezosClient m => AddressOrAlias kind -> m (Either ResolveError (ResolvedAddress (AddressOrAlias kind)))

getAliasEither :: HasTezosClient m => AddressOrAlias kind -> m (Either ResolveError (ResolvedAlias (AddressOrAlias kind)))

resolveAddressWithAliasEither :: HasTezosClient m => AddressOrAlias kind -> m (Either ResolveError (ResolvedAddressAndAlias (AddressOrAlias kind)))

Resolve (Alias kind)

Defined in Morley.Client.TezosClient.Resolve

Associated Types

type ResolvedAddress (Alias kind)

type ResolvedAlias (Alias kind)

type ResolvedAddressAndAlias (Alias kind)

Methods

resolveAddressEither :: HasTezosClient m => Alias kind -> m (Either ResolveError (ResolvedAddress (Alias kind)))

getAliasEither :: HasTezosClient m => Alias kind -> m (Either ResolveError (ResolvedAlias (Alias kind)))

resolveAddressWithAliasEither :: HasTezosClient m => Alias kind -> m (Either ResolveError (ResolvedAddressAndAlias (Alias kind)))

resolveAddress :: forall addressOrAlias m. (HasTezosClient m, MonadThrow 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. (HasTezosClient m, MonadThrow 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.

getAlias :: forall addressOrAlias m. (HasTezosClient 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. (HasTezosClient 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.

getTezosClientConfig :: FilePath -> Maybe FilePath -> IO TezosClientConfig

Read octez-client configuration.

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

Looks up the address and alias with the given addressOrAlias.

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

Looks up the address and alias with the given addressOrAlias.