Morley.Tezos.Address.Alias

Documentation

data AddressOrAlias kind where

This type is meant to be used to parse CLI options where either an address or an alias of an implicit account or a contract can be accepted.

This can be later converted to an address using Morley.Client.resolveAddress or an alias using Morley.Client.getAlias.

This polymorphic type can be instantiated with AddressKindImplicit or AddressKindContract (see ImplicitAddressOrAlias and ContractAddressOrAlias), but not AddressKindSmartRollup. There is no octez-client command to list smart rollup aliases, unlike octez-client list known addresses/contracts, therefore:

1. It wouldn't be possible to implement Morley.Client.resolveAddress for AddressAlias _ :: AddressOrAlias 'AddressKindTxRollup.
2. It wouldn't be possible to implement Morley.Client.getAlias for AddressResolved _ :: AddressOrAlias 'AddressKindTxRollup.

This should be revisited if/when octez-client adds support for smart rollup aliases.

Constructors

AddressResolved

Fields

• :: L1AddressKind kind
• => KindedAddress kind
• -> AddressOrAlias kind

  Address itself, can be used as is.

AddressAlias

Fields

• :: Alias kind
• -> AddressOrAlias kind

  Address alias, should be resolved by octez-client.

Instances

Show (AddressOrAlias kind)

Defined in Morley.Tezos.Address.Alias

Methods

showsPrec :: Int -> AddressOrAlias kind -> ShowS

show :: AddressOrAlias kind -> String

showList :: [AddressOrAlias kind] -> ShowS

Eq (AddressOrAlias kind)

Defined in Morley.Tezos.Address.Alias

Methods

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

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

Ord (AddressOrAlias kind)

Defined in Morley.Tezos.Address.Alias

Methods

compare :: AddressOrAlias kind -> AddressOrAlias kind -> Ordering

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

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

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

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

max :: AddressOrAlias kind -> AddressOrAlias kind -> AddressOrAlias kind

min :: AddressOrAlias kind -> AddressOrAlias kind -> AddressOrAlias kind

(SingI kind, L1AddressKind kind) => HasCLReader (AddressOrAlias kind)

Defined in Morley.Tezos.Address.Alias

Methods

getReader :: ReadM (AddressOrAlias kind)

getMetavar :: String

Buildable (AddressOrAlias kind)

Defined in Morley.Tezos.Address.Alias

Methods

build :: AddressOrAlias kind -> Doc

buildList :: [AddressOrAlias kind] -> Doc

addressOrAliasKindSanity :: forall kind. AddressOrAlias kind -> Dict (L1AddressKind kind, SingI kind)

Given an AddressOrAlias, prove it's kind is well-defined (i.e. it has a SingI instance and satisfies L1AddressKind constraint)

data Alias (kind :: AddressKind) where

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

Constructors

ImplicitAlias :: Text -> Alias 'AddressKindImplicit

ContractAlias :: Text -> Alias 'AddressKindContract

Instances

GCompare Alias

Defined in Morley.Tezos.Address.Alias

Methods

gcompare :: forall (a :: k) (b :: k). Alias a -> Alias b -> GOrdering a b

GEq Alias

Defined in Morley.Tezos.Address.Alias

Methods

geq :: forall (a :: k) (b :: k). Alias a -> Alias b -> Maybe (a :~: b)

(c 'AddressKindImplicit, c 'AddressKindContract) => Has (c :: AddressKind -> Constraint) Alias

Defined in Morley.Tezos.Address.Alias

Methods

has :: forall (a :: k) r. Alias a -> (c a => r) -> r

argDict :: forall (a :: k). Alias a -> Dict (c a)

(SingI kind, L1AddressKind kind) => FromJSON (Alias kind)

Defined in Morley.Tezos.Address.Alias

Methods

parseJSON :: Value -> Parser (Alias kind)

parseJSONList :: Value -> Parser [Alias kind]

ToJSON (Alias kind)

Defined in Morley.Tezos.Address.Alias

Methods

toJSON :: Alias kind -> Value

toEncoding :: Alias kind -> Encoding

toJSONList :: [Alias kind] -> Value

toEncodingList :: [Alias kind] -> Encoding

Show (Alias kind)

Defined in Morley.Tezos.Address.Alias

Methods

showsPrec :: Int -> Alias kind -> ShowS

show :: Alias kind -> String

showList :: [Alias kind] -> ShowS

NFData (Alias kind)

Defined in Morley.Tezos.Address.Alias

Methods

rnf :: Alias kind -> ()

Eq (Alias kind)

Defined in Morley.Tezos.Address.Alias

Methods

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

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

Ord (Alias kind)

Defined in Morley.Tezos.Address.Alias

Methods

compare :: Alias kind -> Alias kind -> Ordering

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

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

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

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

max :: Alias kind -> Alias kind -> Alias kind

min :: Alias kind -> Alias kind -> Alias kind

Buildable (Alias kind)

Defined in Morley.Tezos.Address.Alias

Methods

build :: Alias kind -> Doc

buildList :: [Alias kind] -> Doc

type SomeAlias = Constrained NullConstraint Alias

Existential wrapper over Alias.

pattern SomeAlias :: Alias a -> SomeAlias

type ImplicitAlias = Alias 'AddressKindImplicit

A type only allowing ImplicitAlias values.

type ContractAlias = Alias 'AddressKindContract

A type only allowing ContractAlias values.

type ImplicitAddressOrAlias = AddressOrAlias 'AddressKindImplicit

type ContractAddressOrAlias = AddressOrAlias 'AddressKindContract

unAlias :: Alias kind -> Text

Get raw alias text from Alias

mkAlias :: forall kind. (SingI kind, L1AddressKind kind) => Text -> Alias kind

Construct an Alias from alias Text.

aliasKindSanity :: Alias kind -> Dict (L1AddressKind kind, SingI kind)

Given an Alias, prove it's kind is well-defined (i.e. it has a SingI instance and satisfies L1AddressKind constraint)

data SomeAddressOrAlias where

Constructors

SAOAKindSpecified :: AddressOrAlias kind -> SomeAddressOrAlias

SAOAKindUnspecified :: Text -> SomeAddressOrAlias

Instances

Show SomeAddressOrAlias

Defined in Morley.Tezos.Address.Alias

Methods

showsPrec :: Int -> SomeAddressOrAlias -> ShowS

show :: SomeAddressOrAlias -> String

showList :: [SomeAddressOrAlias] -> ShowS

HasCLReader SomeAddressOrAlias

Defined in Morley.Tezos.Address.Alias

Methods

getReader :: ReadM SomeAddressOrAlias

getMetavar :: String

Buildable SomeAddressOrAlias

The output of build should be parseable by the HasCLReader instance.

Defined in Morley.Tezos.Address.Alias

Methods

build :: SomeAddressOrAlias -> Doc

buildList :: [SomeAddressOrAlias] -> Doc

aliasPrefix :: forall addressKind. (L1AddressKind addressKind, SingI addressKind) => Doc

The prefix used to specify whether an alias belongs to a contract or an implicit account.

contractPrefix :: Doc

implicitPrefix :: Doc