Copyright	(c) 2023 GYELD GMBH
License	Apache 2.0
Maintainer	[email protected]
Stability	develop
Safe Haskell	Safe-Inferred
Language	GHC2021

GeniusYield.Types.TxCert

Description

Synopsis

data GYTxCert v
data GYTxCertWitness v
- = GYTxCertWitnessKey
- | GYTxCertWitnessScript !(GYStakeValScript v) !GYRedeemer
txCertToApi ∷ GYTxCert' v → (Certificate ApiEra, Maybe (StakeCredential, Witness WitCtxStake ApiEra))
mkStakeAddressRegistrationCertificate ∷ GYStakeCredential → GYTxCertWitness v → GYTxCert v
mkStakeAddressDeregistrationCertificate ∷ GYStakeCredential → GYTxCertWitness v → GYTxCert v
mkStakeAddressDelegationCertificate ∷ GYStakeCredential → GYDelegatee → GYTxCertWitness v → GYTxCert v

Documentation

data GYTxCert v #

A transaction certificate.

The parameter v indicates the minimum version of scripts allowed to witness certificates in the transaction.

Note that witness is not required for registering a stake address and for moving instantaneous rewards. Thus, we provide helper utilities to interact with GYTxCert sanely and thus keep it's representation opaque.

Instances

Instances details

Show (GYTxCert v) #
Instance details Defined in GeniusYield.Types.TxCert.Internal Methods showsPrec ∷ Int → GYTxCert v → ShowS # show ∷ GYTxCert v → String # showList ∷ [GYTxCert v] → ShowS #
Eq (GYTxCert v) #
Instance details Defined in GeniusYield.Types.TxCert.Internal Methods (==) ∷ GYTxCert v → GYTxCert v → Bool # (/=) ∷ GYTxCert v → GYTxCert v → Bool #

data GYTxCertWitness v #

Represents witness type and associated information for a certificate.

Constructors

GYTxCertWitnessKey	Key witness.
GYTxCertWitnessScript !(GYStakeValScript v) !GYRedeemer	Script witness with associated script and redeemer.

Instances

Instances details

Show (GYTxCertWitness v) #
Instance details Defined in GeniusYield.Types.TxCert.Internal Methods showsPrec ∷ Int → GYTxCertWitness v → ShowS # show ∷ GYTxCertWitness v → String # showList ∷ [GYTxCertWitness v] → ShowS #
Eq (GYTxCertWitness v) #
Instance details Defined in GeniusYield.Types.TxCert.Internal Methods (==) ∷ GYTxCertWitness v → GYTxCertWitness v → Bool # (/=) ∷ GYTxCertWitness v → GYTxCertWitness v → Bool #

txCertToApi ∷ GYTxCert' v → (Certificate ApiEra, Maybe (StakeCredential, Witness WitCtxStake ApiEra)) #

mkStakeAddressRegistrationCertificate ∷ GYStakeCredential → GYTxCertWitness v → GYTxCert v #

Post conway, newer stake address registration certificate also require a witness.

mkStakeAddressDeregistrationCertificate ∷ GYStakeCredential → GYTxCertWitness v → GYTxCert v #

Note that deregistration certificate requires following preconditions:

The stake address must be registered.
The corresponding rewards balance is zero.

mkStakeAddressDelegationCertificate ∷ GYStakeCredential → GYDelegatee → GYTxCertWitness v → GYTxCert v #