Safe Haskell	Safe-Inferred
Language	Haskell2010

PlutusLedgerApi.V4.Address

Description

Addresses and account identifiers for Plutus V4.

In Plutus V1-V3 an Address pairs a payment credential with an optional staking credential. In V4 staking credentials no longer exist: the funds locked by an address are staked via an account, identified by an AccountId.

Synopsis

newtype AccountId = AccountId Credential
data Address = Address {
- addressCredential ∷ Credential
- addressStakingAccountId ∷ Maybe AccountId
}
pubKeyHashAddress ∷ PubKeyHash → Address
toPubKeyHash ∷ Address → Maybe PubKeyHash
toScriptHash ∷ Address → Maybe ScriptHash
scriptHashAddress ∷ ScriptHash → Address
stakingAccountId ∷ Address → Maybe AccountId

Documentation

newtype AccountId Source #

Constructors

AccountId Credential

Instances

Instances details

Generic AccountId Source #
Instance details Defined in PlutusLedgerApi.V4.Address Associated Types type Rep AccountId ∷ Type → Type Source # Methods from ∷ AccountId → Rep AccountId x Source # to ∷ Rep AccountId x → AccountId Source #
Show AccountId Source #
Instance details Defined in PlutusLedgerApi.V4.Address Methods showsPrec ∷ Int → AccountId → ShowS Source # show ∷ AccountId → String Source # showList ∷ [AccountId] → ShowS Source #
Eq AccountId Source #
Instance details Defined in PlutusLedgerApi.V4.Address Methods (==) ∷ AccountId → AccountId → Bool Source # (/=) ∷ AccountId → AccountId → Bool Source #
Ord AccountId Source #
Instance details Defined in PlutusLedgerApi.V4.Address Methods compare ∷ AccountId → AccountId → Ordering Source # (<) ∷ AccountId → AccountId → Bool Source # (<=) ∷ AccountId → AccountId → Bool Source # (>) ∷ AccountId → AccountId → Bool Source # (>=) ∷ AccountId → AccountId → Bool Source # max ∷ AccountId → AccountId → AccountId Source # min ∷ AccountId → AccountId → AccountId Source #
HasBlueprintDefinition AccountId Source #
Instance details Defined in PlutusLedgerApi.V4.Address Associated Types type Unroll AccountId ∷ [Type] Source # Methods definitionId ∷ DefinitionId Source #
Eq AccountId Source #
Instance details Defined in PlutusLedgerApi.V4.Address Methods (==) ∷ AccountId → AccountId → Bool Source #
FromData AccountId Source #
Instance details Defined in PlutusLedgerApi.V4.Address Methods fromBuiltinData ∷ BuiltinData → Maybe AccountId Source #
ToData AccountId Source #
Instance details Defined in PlutusLedgerApi.V4.Address Methods toBuiltinData ∷ AccountId → BuiltinData Source #
UnsafeFromData AccountId Source #
Instance details Defined in PlutusLedgerApi.V4.Address Methods unsafeFromBuiltinData ∷ BuiltinData → AccountId Source #
Pretty AccountId Source #
Instance details Defined in PlutusLedgerApi.V4.Address Methods pretty ∷ AccountId → Doc ann Source # prettyList ∷ [AccountId] → Doc ann Source #
(HasSchemaDefinition PubKeyHash referencedTypes, HasSchemaDefinition ScriptHash referencedTypes) ⇒ HasBlueprintSchema AccountId referencedTypes Source #
Instance details Defined in PlutusLedgerApi.V4.Address Methods schema ∷ Schema referencedTypes Source #
Lift DefaultUni AccountId Source #
Instance details Defined in PlutusLedgerApi.V4.Address Methods lift ∷ AccountId → RTCompile DefaultUni fun (Term TyName Name DefaultUni fun ()) Source #
Typeable DefaultUni AccountId Source #
Instance details Defined in PlutusLedgerApi.V4.Address Methods typeRep ∷ Proxy AccountId → RTCompile DefaultUni fun (Type TyName DefaultUni ()) Source #
type Rep AccountId Source #
Instance details Defined in PlutusLedgerApi.V4.Address type Rep AccountId = D1 ('MetaData "AccountId" "PlutusLedgerApi.V4.Address" "plutus-ledger-api-1.67.0.0-inplace" 'True) (C1 ('MetaCons "AccountId" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Credential)))
type Unroll AccountId Source #
Instance details Defined in PlutusLedgerApi.V4.Address type Unroll AccountId = Insert AccountId (GUnroll (IfStuckRep (RepIsStuckError AccountId ∷ Type → Type) (Rep AccountId)))

data Address Source #

An address may contain two things: the payment credential, and optionally the AccountId of the account the funds are staked to.

Constructors

Address
Fields addressCredential ∷ Credential the payment credential addressStakingAccountId ∷ Maybe AccountId the account the funds locked by this address are staked to

Instances

Instances details

Generic Address Source #
Instance details Defined in PlutusLedgerApi.V4.Address Associated Types type Rep Address ∷ Type → Type Source # Methods from ∷ Address → Rep Address x Source # to ∷ Rep Address x → Address Source #
Show Address Source #
Instance details Defined in PlutusLedgerApi.V4.Address Methods showsPrec ∷ Int → Address → ShowS Source # show ∷ Address → String Source # showList ∷ [Address] → ShowS Source #
Eq Address Source #
Instance details Defined in PlutusLedgerApi.V4.Address Methods (==) ∷ Address → Address → Bool Source # (/=) ∷ Address → Address → Bool Source #
Ord Address Source #
Instance details Defined in PlutusLedgerApi.V4.Address Methods compare ∷ Address → Address → Ordering Source # (<) ∷ Address → Address → Bool Source # (<=) ∷ Address → Address → Bool Source # (>) ∷ Address → Address → Bool Source # (>=) ∷ Address → Address → Bool Source # max ∷ Address → Address → Address Source # min ∷ Address → Address → Address Source #
HasBlueprintDefinition Address Source #
Instance details Defined in PlutusLedgerApi.V4.Address Associated Types type Unroll Address ∷ [Type] Source # Methods definitionId ∷ DefinitionId Source #
Eq Address Source #
Instance details Defined in PlutusLedgerApi.V4.Address Methods (==) ∷ Address → Address → Bool Source #
FromData Address Source #
Instance details Defined in PlutusLedgerApi.V4.Address Methods fromBuiltinData ∷ BuiltinData → Maybe Address Source #
ToData Address Source #
Instance details Defined in PlutusLedgerApi.V4.Address Methods toBuiltinData ∷ Address → BuiltinData Source #
UnsafeFromData Address Source #
Instance details Defined in PlutusLedgerApi.V4.Address Methods unsafeFromBuiltinData ∷ BuiltinData → Address Source #
Pretty Address Source #
Instance details Defined in PlutusLedgerApi.V4.Address Methods pretty ∷ Address → Doc ann Source # prettyList ∷ [Address] → Doc ann Source #
(HasSchemaDefinition Credential referencedTypes, HasSchemaDefinition (Maybe AccountId) referencedTypes) ⇒ HasBlueprintSchema Address referencedTypes Source #
Instance details Defined in PlutusLedgerApi.V4.Address Methods schema ∷ Schema referencedTypes Source #
Lift DefaultUni Address Source #
Instance details Defined in PlutusLedgerApi.V4.Address Methods lift ∷ Address → RTCompile DefaultUni fun (Term TyName Name DefaultUni fun ()) Source #
Typeable DefaultUni Address Source #
Instance details Defined in PlutusLedgerApi.V4.Address Methods typeRep ∷ Proxy Address → RTCompile DefaultUni fun (Type TyName DefaultUni ()) Source #
type Rep Address Source #
Instance details Defined in PlutusLedgerApi.V4.Address type Rep Address = D1 ('MetaData "Address" "PlutusLedgerApi.V4.Address" "plutus-ledger-api-1.67.0.0-inplace" 'False) (C1 ('MetaCons "Address" 'PrefixI 'True) (S1 ('MetaSel ('Just "addressCredential") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Credential) :*: S1 ('MetaSel ('Just "addressStakingAccountId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe AccountId))))
type Unroll Address Source #
Instance details Defined in PlutusLedgerApi.V4.Address type Unroll Address = Insert Address (GUnroll (IfStuckRep (RepIsStuckError Address ∷ Type → Type) (Rep Address)))

pubKeyHashAddress ∷ PubKeyHash → Address Source #

The address that should be targeted by a transaction output locked by the public key with the given hash.

toPubKeyHash ∷ Address → Maybe PubKeyHash Source #

The PubKeyHash of the address, if any

toScriptHash ∷ Address → Maybe ScriptHash Source #

The validator hash of the address, if any

scriptHashAddress ∷ ScriptHash → Address Source #

The address that should be used by a transaction output locked by the given validator script hash.

stakingAccountId ∷ Address → Maybe AccountId Source #

The account the funds locked by an address are staked to (if any)