Tezos.Address

Address in Tezos.

Documentation

data Address

Data type corresponding to address structure in Tezos.

Constructors

KeyAddress !KeyHash

tz address which is a hash of a public key.

ContractAddress !ByteString

KT address which corresponds to a callable contract. It's a hash of origination command. TODO: we should probably have a Hash type.

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

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]

Buildable Address

Defined in Tezos.Address

Methods

build :: Address -> Builder

FromCVal Address

Defined in Michelson.Typed.CValue

Methods

fromCVal :: CVal (ToCT Address) -> Address

ToCVal Address

Defined in Michelson.Typed.CValue

Methods

toCVal :: Address -> CVal (ToCT Address)

FromVal Address

Defined in Michelson.Typed.Value

Methods

fromVal :: Val instr (ToT Address) -> Address

ToVal Address

Defined in Michelson.Typed.Value

Methods

toVal :: Address -> Val instr (ToT Address)

mkKeyAddress :: PublicKey -> Address

Smart constructor for KeyAddress.

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.

Formatting

formatAddress :: Address -> Text

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.