Tezos.Address

Address in Tezos.

Documentation

newtype ContractHash

Hash of origination command for some contract.

Constructors

ContractHash ByteString

Instances

Eq ContractHash

Defined in Tezos.Address

Methods

(==) :: ContractHash -> ContractHash -> Bool

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

Ord ContractHash

Defined in Tezos.Address

Methods

compare :: ContractHash -> ContractHash -> Ordering

(<) :: ContractHash -> ContractHash -> Bool

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

(>) :: ContractHash -> ContractHash -> Bool

(>=) :: ContractHash -> ContractHash -> Bool

max :: ContractHash -> ContractHash -> ContractHash

min :: ContractHash -> ContractHash -> ContractHash

Show ContractHash

Defined in Tezos.Address

Methods

showsPrec :: Int -> ContractHash -> ShowS

show :: ContractHash -> String

showList :: [ContractHash] -> ShowS

Generic ContractHash

Defined in Tezos.Address

Associated Types

type Rep ContractHash :: Type -> Type

Methods

from :: ContractHash -> Rep ContractHash x

to :: Rep ContractHash x -> ContractHash

ToJSON ContractHash

Defined in Tezos.Address

Methods

toJSON :: ContractHash -> Value

toEncoding :: ContractHash -> Encoding

toJSONList :: [ContractHash] -> Value

toEncodingList :: [ContractHash] -> Encoding

ToJSONKey ContractHash

Defined in Tezos.Address

Methods

toJSONKey :: ToJSONKeyFunction ContractHash

toJSONKeyList :: ToJSONKeyFunction [ContractHash]

FromJSON ContractHash

Defined in Tezos.Address

Methods

parseJSON :: Value -> Parser ContractHash

parseJSONList :: Value -> Parser [ContractHash]

FromJSONKey ContractHash

Defined in Tezos.Address

Methods

fromJSONKey :: FromJSONKeyFunction ContractHash

fromJSONKeyList :: FromJSONKeyFunction [ContractHash]

NFData ContractHash

Defined in Tezos.Address

Methods

rnf :: ContractHash -> ()

type Rep ContractHash

Defined in Tezos.Address

type Rep ContractHash = D1 ('MetaData "ContractHash" "Tezos.Address" "morley-1.2.0-GFTR6HhJxtXGRHqcKAr6TU" 'True) (C1 ('MetaCons "ContractHash" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ByteString)))

data Address

Data type corresponding to address structure in Tezos.

Constructors

KeyAddress KeyHash

tz address which is a hash of a public key.

ContractAddress ContractHash

KT address which corresponds to a callable contract.

Instances

Eq Address

Defined in Tezos.Address

Methods

(==) :: Address -> Address -> Bool

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

Ord Address

Defined in Tezos.Address

Methods

compare :: Address -> Address -> Ordering

(<) :: Address -> Address -> Bool

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

(>) :: Address -> Address -> Bool

(>=) :: Address -> Address -> Bool

max :: Address -> Address -> Address

min :: Address -> Address -> Address

Show Address

Defined in Tezos.Address

Methods

showsPrec :: Int -> Address -> ShowS

show :: Address -> String

showList :: [Address] -> ShowS

Generic Address

Defined in Tezos.Address

Associated Types

type Rep Address :: Type -> Type

Methods

from :: Address -> Rep Address x

to :: Rep Address x -> Address

Arbitrary Address

Defined in Tezos.Address

Methods

arbitrary :: Gen Address

shrink :: Address -> [Address]

ToJSON Address

Defined in Tezos.Address

Methods

toJSON :: Address -> Value

toEncoding :: Address -> Encoding

toJSONList :: [Address] -> Value

toEncodingList :: [Address] -> Encoding

ToJSONKey Address

Defined in Tezos.Address

Methods

toJSONKey :: ToJSONKeyFunction Address

toJSONKeyList :: ToJSONKeyFunction [Address]

FromJSON Address

Defined in Tezos.Address

Methods

parseJSON :: Value -> Parser Address

parseJSONList :: Value -> Parser [Address]

FromJSONKey Address

Defined in Tezos.Address

Methods

fromJSONKey :: FromJSONKeyFunction Address

fromJSONKeyList :: FromJSONKeyFunction [Address]

NFData Address

Defined in Tezos.Address

Methods

rnf :: Address -> ()

Buildable Address

Defined in Tezos.Address

Methods

build :: Address -> Builder

HasCLReader Address

Defined in Tezos.Address

Methods

getReader :: ReadM Address

getMetavar :: String

IsoValue Address

Defined in Michelson.Typed.Haskell.Value

Associated Types

type ToT Address :: T

Methods

toVal :: Address -> Value (ToT Address)

fromVal :: Value (ToT Address) -> Address

TypeHasDoc Address

Defined in Michelson.Typed.Haskell.Doc

Methods

typeDocName :: Proxy Address -> Text

typeDocMdDescription :: Markdown

typeDocMdReference :: Proxy Address -> WithinParens -> Markdown

typeDocDependencies :: Proxy Address -> [SomeTypeWithDoc]

typeDocHaskellRep :: TypeDocHaskellRep Address

typeDocMichelsonRep :: TypeDocMichelsonRep Address

type Rep Address

Defined in Tezos.Address

type Rep Address = D1 ('MetaData "Address" "Tezos.Address" "morley-1.2.0-GFTR6HhJxtXGRHqcKAr6TU" 'False) (C1 ('MetaCons "KeyAddress" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 KeyHash)) :+: C1 ('MetaCons "ContractAddress" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ContractHash)))

type ToT Address

Defined in Michelson.Typed.Haskell.Value

type ToT Address = 'TAddress

mkKeyAddress :: PublicKey -> Address

Smart constructor for KeyAddress.

detGenKeyAddress :: ByteString -> Address

Deterministically generate a random KeyAddress and discard its secret key.

mkContractAddressRaw :: ByteString -> Address

Smart constructor for ContractAddress. Its argument is serialized origination operation.

Note: it's quite unsafe to pass ByteString, because we can pass some garbage which is not a serialized origination operation, but this operation includes contract itself and necessary types are defined in *. So we have to serialize this data outside this module and pass it here as a ByteString. Alternatively we could add some constraint, but it would be almost as unsafe as passing a ByteString. For this reason we add Raw suffix to this function and provide a safer function in Instr. We may reconsider it later.

mkContractHashRaw :: ByteString -> ContractHash

Create a dummy ContractHash value.

Formatting

data ParseAddressError

Errors that can happen during address parsing.

Constructors

ParseAddressWrongBase58Check

Address is not in Base58Check format.

ParseAddressBothFailed CryptoParseError ParseContractAddressError

Both address parsers failed with some error.

Instances

Eq ParseAddressError

Defined in Tezos.Address

Methods

(==) :: ParseAddressError -> ParseAddressError -> Bool

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

Show ParseAddressError

Defined in Tezos.Address

Methods

showsPrec :: Int -> ParseAddressError -> ShowS

show :: ParseAddressError -> String

showList :: [ParseAddressError] -> ShowS

Generic ParseAddressError

Defined in Tezos.Address

Associated Types

type Rep ParseAddressError :: Type -> Type

Methods

from :: ParseAddressError -> Rep ParseAddressError x

to :: Rep ParseAddressError x -> ParseAddressError

NFData ParseAddressError

Defined in Tezos.Address

Methods

rnf :: ParseAddressError -> ()

Buildable ParseAddressError

Defined in Tezos.Address

Methods

build :: ParseAddressError -> Builder

type Rep ParseAddressError

Defined in Tezos.Address

type Rep ParseAddressError = D1 ('MetaData "ParseAddressError" "Tezos.Address" "morley-1.2.0-GFTR6HhJxtXGRHqcKAr6TU" 'False) (C1 ('MetaCons "ParseAddressWrongBase58Check" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "ParseAddressBothFailed" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 CryptoParseError) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ParseContractAddressError)))

data ParseContractAddressError

Instances

Eq ParseContractAddressError

Defined in Tezos.Address

Methods

(==) :: ParseContractAddressError -> ParseContractAddressError -> Bool

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

Show ParseContractAddressError

Defined in Tezos.Address

Methods

showsPrec :: Int -> ParseContractAddressError -> ShowS

show :: ParseContractAddressError -> String

showList :: [ParseContractAddressError] -> ShowS

Generic ParseContractAddressError

Defined in Tezos.Address

Associated Types

type Rep ParseContractAddressError :: Type -> Type

Methods

from :: ParseContractAddressError -> Rep ParseContractAddressError x

to :: Rep ParseContractAddressError x -> ParseContractAddressError

NFData ParseContractAddressError

Defined in Tezos.Address

Methods

rnf :: ParseContractAddressError -> ()

Buildable ParseContractAddressError

Defined in Tezos.Address

Methods

build :: ParseContractAddressError -> Builder

type Rep ParseContractAddressError

Defined in Tezos.Address

type Rep ParseContractAddressError = D1 ('MetaData "ParseContractAddressError" "Tezos.Address" "morley-1.2.0-GFTR6HhJxtXGRHqcKAr6TU" 'False) (C1 ('MetaCons "ParseContractAddressWrongBase58Check" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "ParseContractAddressWrongTag" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ByteString)) :+: C1 ('MetaCons "ParseContractAddressWrongSize" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

formatAddress :: Address -> Text

mformatAddress :: Address -> MText

parseAddress :: Text -> Either ParseAddressError Address

Parse an address from its human-readable textual representation used by Tezos (e. g. "tz1faswCTDciRzE4oJ9jn2Vm2dvjeyA9fUzU"). Or fail if it's invalid.

unsafeParseAddress :: HasCallStack => Text -> Address

Partial version of parseAddress which assumes that the address is correct. Can be used in tests.

unsafeParseContractHash :: HasCallStack => Text -> ContractHash

Parse a TK contract address, fail if address does not match the expected format.