Safe Haskell	Safe-Inferred
Language	Haskell2010

Cardano.Ledger.Api.Tx.Address

Contents

Address
- Strict decoders
- Lenient decoders
Reward Account

Synopsis

data Addr
- = Addr Network PaymentCredential StakeReference
- | AddrBootstrap BootstrapAddress
getNetwork ∷ Addr → Network
newtype BootstrapAddress = BootstrapAddress {
- unBootstrapAddress ∷ Address
}
serialiseAddr ∷ Addr → ByteString
decodeAddr ∷ MonadFail m ⇒ ByteString → m Addr
decodeAddrEither ∷ ByteString → Either String Addr
decodeAddrShort ∷ MonadFail m ⇒ ShortByteString → m Addr
decodeAddrShortEither ∷ ShortByteString → Either String Addr
data DecAddr
- = DecAddr Addr
- | DecAddrBadPtr Addr
- | DecAddrUnconsumed Addr ByteString
decodeAddrLenient ∷ MonadFail m ⇒ ByteString → m Addr
decodeAddrLenientEither ∷ ByteString → Either String DecAddr
data RewardAccount = RewardAccount {
- raNetwork ∷ !Network
- raCredential ∷ !(Credential 'Staking)
}
serialiseRewardAccount ∷ RewardAccount → ByteString
deserialiseRewardAccount ∷ ByteString → Maybe RewardAccount

Address

data Addr Source #

An address for UTxO.

Contents of Addr data type are intentionally left as lazy, otherwise operating on compact form of an address will result in redundant work.

Constructors

Addr Network PaymentCredential StakeReference
AddrBootstrap BootstrapAddress

Instances

Instances details

FromJSON Addr
Instance details Defined in Cardano.Ledger.Address Methods parseJSON ∷ Value → Parser Addr Source # parseJSONList ∷ Value → Parser [Addr] Source # omittedField ∷ Maybe Addr Source #
FromJSONKey Addr
Instance details Defined in Cardano.Ledger.Address Methods fromJSONKey ∷ FromJSONKeyFunction Addr Source # fromJSONKeyList ∷ FromJSONKeyFunction [Addr] Source #
ToJSON Addr
Instance details Defined in Cardano.Ledger.Address Methods toJSON ∷ Addr → Value Source # toEncoding ∷ Addr → Encoding Source # toJSONList ∷ [Addr] → Value Source # toEncodingList ∷ [Addr] → Encoding Source # omitField ∷ Addr → Bool Source #
ToJSONKey Addr
Instance details Defined in Cardano.Ledger.Address Methods toJSONKey ∷ ToJSONKeyFunction Addr Source # toJSONKeyList ∷ ToJSONKeyFunction [Addr] Source #
Generic Addr
Instance details Defined in Cardano.Ledger.Address Associated Types type Rep Addr ∷ Type → Type # Methods from ∷ Addr → Rep Addr x # to ∷ Rep Addr x → Addr #
Show Addr
Instance details Defined in Cardano.Ledger.Address Methods showsPrec ∷ Int → Addr → ShowS # show ∷ Addr → String # showList ∷ [Addr] → ShowS #
DecCBOR Addr
Instance details Defined in Cardano.Ledger.Address Methods decCBOR ∷ Decoder s Addr Source # dropCBOR ∷ Proxy Addr → Decoder s () Source # label ∷ Proxy Addr → Text Source #
EncCBOR Addr
Instance details Defined in Cardano.Ledger.Address Methods encCBOR ∷ Addr → Encoding Source # encodedSizeExpr ∷ (∀ t. EncCBOR t ⇒ Proxy t → Size) → Proxy Addr → Size Source # encodedListSizeExpr ∷ (∀ t. EncCBOR t ⇒ Proxy t → Size) → Proxy [Addr] → Size Source #
NFData Addr
Instance details Defined in Cardano.Ledger.Address Methods rnf ∷ Addr → () #
Eq Addr
Instance details Defined in Cardano.Ledger.Address Methods (==) ∷ Addr → Addr → Bool # (/=) ∷ Addr → Addr → Bool #
Ord Addr
Instance details Defined in Cardano.Ledger.Address Methods compare ∷ Addr → Addr → Ordering # (<) ∷ Addr → Addr → Bool # (<=) ∷ Addr → Addr → Bool # (>) ∷ Addr → Addr → Bool # (>=) ∷ Addr → Addr → Bool # max ∷ Addr → Addr → Addr # min ∷ Addr → Addr → Addr #
NoThunks Addr
Instance details Defined in Cardano.Ledger.Address Methods noThunks ∷ Context → Addr → IO (Maybe ThunkInfo) Source # wNoThunks ∷ Context → Addr → IO (Maybe ThunkInfo) Source # showTypeOf ∷ Proxy Addr → String Source #
type Rep Addr
Instance details Defined in Cardano.Ledger.Address type Rep Addr = D1 ('MetaData "Addr" "Cardano.Ledger.Address" "cardano-ledger-core-1.17.0.0-inplace" 'False) (C1 ('MetaCons "Addr" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Network) :: (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 PaymentCredential) :: S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 StakeReference))) :+: C1 ('MetaCons "AddrBootstrap" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 BootstrapAddress)))

getNetwork ∷ Addr → Network Source #

Lookup a Network Id for an Address

newtype BootstrapAddress Source #

Constructors

BootstrapAddress
Fields unBootstrapAddress ∷ Address

Instances

Instances details

Generic BootstrapAddress
Instance details Defined in Cardano.Ledger.Address Associated Types type Rep BootstrapAddress ∷ Type → Type # Methods from ∷ BootstrapAddress → Rep BootstrapAddress x # to ∷ Rep BootstrapAddress x → BootstrapAddress #
Show BootstrapAddress
Instance details Defined in Cardano.Ledger.Address Methods showsPrec ∷ Int → BootstrapAddress → ShowS # show ∷ BootstrapAddress → String # showList ∷ [BootstrapAddress] → ShowS #
NFData BootstrapAddress
Instance details Defined in Cardano.Ledger.Address Methods rnf ∷ BootstrapAddress → () #
Eq BootstrapAddress
Instance details Defined in Cardano.Ledger.Address Methods (==) ∷ BootstrapAddress → BootstrapAddress → Bool # (/=) ∷ BootstrapAddress → BootstrapAddress → Bool #
Ord BootstrapAddress
Instance details Defined in Cardano.Ledger.Address Methods compare ∷ BootstrapAddress → BootstrapAddress → Ordering # (<) ∷ BootstrapAddress → BootstrapAddress → Bool # (<=) ∷ BootstrapAddress → BootstrapAddress → Bool # (>) ∷ BootstrapAddress → BootstrapAddress → Bool # (>=) ∷ BootstrapAddress → BootstrapAddress → Bool # max ∷ BootstrapAddress → BootstrapAddress → BootstrapAddress # min ∷ BootstrapAddress → BootstrapAddress → BootstrapAddress #
NoThunks BootstrapAddress
Instance details Defined in Cardano.Ledger.Address Methods noThunks ∷ Context → BootstrapAddress → IO (Maybe ThunkInfo) Source # wNoThunks ∷ Context → BootstrapAddress → IO (Maybe ThunkInfo) Source # showTypeOf ∷ Proxy BootstrapAddress → String Source #
type Rep BootstrapAddress
Instance details Defined in Cardano.Ledger.Address type Rep BootstrapAddress = D1 ('MetaData "BootstrapAddress" "Cardano.Ledger.Address" "cardano-ledger-core-1.17.0.0-inplace" 'True) (C1 ('MetaCons "BootstrapAddress" 'PrefixI 'True) (S1 ('MetaSel ('Just "unBootstrapAddress") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Address)))

serialiseAddr ∷ Addr → ByteString Source #

Serialise an address to the external format.

Strict decoders

Decoders below will only decode addresses that are allowed to be placed on chain today. Historically there were a few bugs in the decoder which allowed a few malformed addressed to be placed on chain. If you need backwards compatibility, reach out for decodeAddrLenient.

decodeAddr ∷ MonadFail m ⇒ ByteString → m Addr Source #

Strict decoder for an address from a ByteString. This will not let you decode some of the buggy addresses that have been placed on chain. This decoder is intended for addresses that are to be placed on chian today.

decodeAddrEither ∷ ByteString → Either String Addr Source #

Same as decodeAddr, but produces an Either result

decodeAddrShort ∷ MonadFail m ⇒ ShortByteString → m Addr Source #

Same as decodeAddr, but works on ShortByteString

decodeAddrShortEither ∷ ShortByteString → Either String Addr Source #

Same as decodeAddrShort, but produces an Either result

Lenient decoders

These lenient decoders do not fail for addresses with known bugs

data DecAddr Source #

Decoded Address.

Constructors

DecAddr Addr	Address was decoded with no problems
DecAddrBadPtr Addr	Address was decoded, but it contains an invalid `Ptr`, which means that address will be decoded with Ptr that has all values clamped to zero.
DecAddrUnconsumed	Address was decoded, but not all of input was consumed
Fields Addr ByteString Left over bytes after consuming the input

Instances

Instances details

Show DecAddr Source #
Instance details Defined in Cardano.Ledger.Api.Tx.Address Methods showsPrec ∷ Int → DecAddr → ShowS # show ∷ DecAddr → String # showList ∷ [DecAddr] → ShowS #
Eq DecAddr Source #
Instance details Defined in Cardano.Ledger.Api.Tx.Address Methods (==) ∷ DecAddr → DecAddr → Bool # (/=) ∷ DecAddr → DecAddr → Bool #

decodeAddrLenient ∷ MonadFail m ⇒ ByteString → m Addr Source #

This is a lenient decoder that will disregard known bugs in the address deserialization. This function is intended for clients that need to deal with historical data that has already been placed on chain. If you also require information on what exactly is bad in the address, or you would like to guard only against a specific bug, you should use decodeAddrLenientEither instead.

Since: 1.8.0

decodeAddrLenientEither ∷ ByteString → Either String DecAddr Source #

Decode an address and fail only for addresses that could have never been placed on chain, while decoding addresses with information about potential problems in them. Similar to decodeAddrLenient, this function is not intended for addresses that will be placed into a new transaction.

Since: 1.8.0

Reward Account

data RewardAccount Source #

An account based address for rewards

Constructors

RewardAccount
Fields raNetwork ∷ !Network raCredential ∷ !(Credential 'Staking)

Instances

Instances details

FromJSON RewardAccount
Instance details Defined in Cardano.Ledger.Address Methods parseJSON ∷ Value → Parser RewardAccount Source # parseJSONList ∷ Value → Parser [RewardAccount] Source # omittedField ∷ Maybe RewardAccount Source #
FromJSONKey RewardAccount
Instance details Defined in Cardano.Ledger.Address Methods fromJSONKey ∷ FromJSONKeyFunction RewardAccount Source # fromJSONKeyList ∷ FromJSONKeyFunction [RewardAccount] Source #
ToJSON RewardAccount
Instance details Defined in Cardano.Ledger.Address Methods toJSON ∷ RewardAccount → Value Source # toEncoding ∷ RewardAccount → Encoding Source # toJSONList ∷ [RewardAccount] → Value Source # toEncodingList ∷ [RewardAccount] → Encoding Source # omitField ∷ RewardAccount → Bool Source #
ToJSONKey RewardAccount
Instance details Defined in Cardano.Ledger.Address Methods toJSONKey ∷ ToJSONKeyFunction RewardAccount Source # toJSONKeyList ∷ ToJSONKeyFunction [RewardAccount] Source #
Generic RewardAccount
Instance details Defined in Cardano.Ledger.Address Associated Types type Rep RewardAccount ∷ Type → Type # Methods from ∷ RewardAccount → Rep RewardAccount x # to ∷ Rep RewardAccount x → RewardAccount #
Show RewardAccount
Instance details Defined in Cardano.Ledger.Address Methods showsPrec ∷ Int → RewardAccount → ShowS # show ∷ RewardAccount → String # showList ∷ [RewardAccount] → ShowS #
DecCBOR RewardAccount
Instance details Defined in Cardano.Ledger.Address Methods decCBOR ∷ Decoder s RewardAccount Source # dropCBOR ∷ Proxy RewardAccount → Decoder s () Source # label ∷ Proxy RewardAccount → Text Source #
EncCBOR RewardAccount
Instance details Defined in Cardano.Ledger.Address Methods encCBOR ∷ RewardAccount → Encoding Source # encodedSizeExpr ∷ (∀ t. EncCBOR t ⇒ Proxy t → Size) → Proxy RewardAccount → Size Source # encodedListSizeExpr ∷ (∀ t. EncCBOR t ⇒ Proxy t → Size) → Proxy [RewardAccount] → Size Source #
Default RewardAccount
Instance details Defined in Cardano.Ledger.Address Methods def ∷ RewardAccount Source #
NFData RewardAccount
Instance details Defined in Cardano.Ledger.Address Methods rnf ∷ RewardAccount → () #
Eq RewardAccount
Instance details Defined in Cardano.Ledger.Address Methods (==) ∷ RewardAccount → RewardAccount → Bool # (/=) ∷ RewardAccount → RewardAccount → Bool #
Ord RewardAccount
Instance details Defined in Cardano.Ledger.Address Methods compare ∷ RewardAccount → RewardAccount → Ordering # (<) ∷ RewardAccount → RewardAccount → Bool # (<=) ∷ RewardAccount → RewardAccount → Bool # (>) ∷ RewardAccount → RewardAccount → Bool # (>=) ∷ RewardAccount → RewardAccount → Bool # max ∷ RewardAccount → RewardAccount → RewardAccount # min ∷ RewardAccount → RewardAccount → RewardAccount #
NoThunks RewardAccount
Instance details Defined in Cardano.Ledger.Address Methods noThunks ∷ Context → RewardAccount → IO (Maybe ThunkInfo) Source # wNoThunks ∷ Context → RewardAccount → IO (Maybe ThunkInfo) Source # showTypeOf ∷ Proxy RewardAccount → String Source #
type Rep RewardAccount
Instance details Defined in Cardano.Ledger.Address type Rep RewardAccount = D1 ('MetaData "RewardAccount" "Cardano.Ledger.Address" "cardano-ledger-core-1.17.0.0-inplace" 'False) (C1 ('MetaCons "RewardAccount" 'PrefixI 'True) (S1 ('MetaSel ('Just "raNetwork") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Network) :*: S1 ('MetaSel ('Just "raCredential") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Credential 'Staking))))

serialiseRewardAccount ∷ RewardAccount → ByteString Source #

Serialise a reward account to the external format.

deserialiseRewardAccount ∷ ByteString → Maybe RewardAccount Source #

Deserialise a reward account from the external format. This will fail if the input data is not in the right format (or if there is trailing data).