| Safe Haskell | Safe-Inferred |
|---|---|
| Language | Haskell2010 |
Cardano.Api.Tx
Description
Complete, signed transactions
Synopsis
- data Tx era where
- ByronTx ∷ ATxAux ByteString → Tx ByronEra
- ShelleyTx ∷ ShelleyBasedEra era → Tx (ShelleyLedgerEra era) → Tx era
- pattern Tx ∷ TxBody era → [KeyWitness era] → Tx era
- getTxBody ∷ ∀ era. Tx era → TxBody era
- getTxWitnesses ∷ ∀ era. Tx era → [KeyWitness era]
- data ScriptValidity
- data ShelleySigningKey
- = ShelleyNormalSigningKey (SignKeyDSIGN StandardCrypto)
- | ShelleyExtendedSigningKey XPrv
- toShelleySigningKey ∷ ShelleyWitnessSigningKey → ShelleySigningKey
- signByronTransaction ∷ NetworkId → TxBody ByronEra → [SigningKey ByronKey] → Tx ByronEra
- signShelleyTransaction ∷ IsShelleyBasedEra era ⇒ TxBody era → [ShelleyWitnessSigningKey] → Tx era
- makeSignedTransaction ∷ ∀ era. [KeyWitness era] → TxBody era → Tx era
- data KeyWitness era where
- ByronKeyWitness ∷ TxInWitness → KeyWitness ByronEra
- ShelleyBootstrapWitness ∷ ShelleyBasedEra era → BootstrapWitness StandardCrypto → KeyWitness era
- ShelleyKeyWitness ∷ ShelleyBasedEra era → WitVKey Witness StandardCrypto → KeyWitness era
- makeByronKeyWitness ∷ ∀ key. IsByronKey key ⇒ NetworkId → TxBody ByronEra → SigningKey key → KeyWitness ByronEra
- data ShelleyWitnessSigningKey
- = WitnessPaymentKey (SigningKey PaymentKey)
- | WitnessPaymentExtendedKey (SigningKey PaymentExtendedKey)
- | WitnessStakeKey (SigningKey StakeKey)
- | WitnessStakeExtendedKey (SigningKey StakeExtendedKey)
- | WitnessStakePoolKey (SigningKey StakePoolKey)
- | WitnessGenesisKey (SigningKey GenesisKey)
- | WitnessGenesisExtendedKey (SigningKey GenesisExtendedKey)
- | WitnessGenesisDelegateKey (SigningKey GenesisDelegateKey)
- | WitnessGenesisDelegateExtendedKey (SigningKey GenesisDelegateExtendedKey)
- | WitnessGenesisUTxOKey (SigningKey GenesisUTxOKey)
- makeShelleyKeyWitness ∷ ∀ era. IsShelleyBasedEra era ⇒ TxBody era → ShelleyWitnessSigningKey → KeyWitness era
- data WitnessNetworkIdOrByronAddress
- makeShelleyBootstrapWitness ∷ ∀ era. IsShelleyBasedEra era ⇒ WitnessNetworkIdOrByronAddress → TxBody era → SigningKey ByronKey → KeyWitness era
- makeShelleySignature ∷ SignableRepresentation tosign ⇒ tosign → ShelleySigningKey → SignedDSIGN StandardCrypto tosign
- getShelleyKeyWitnessVerificationKey ∷ ShelleySigningKey → VKey Witness StandardCrypto
- getTxBodyAndWitnesses ∷ Tx era → (TxBody era, [KeyWitness era])
- data family AsType t
Signing transactions
Creating transaction witnesses one by one, or all in one go.
Constructors
| ByronTx ∷ ATxAux ByteString → Tx ByronEra | |
| ShelleyTx ∷ ShelleyBasedEra era → Tx (ShelleyLedgerEra era) → Tx era |
Bundled Patterns
| pattern Tx ∷ TxBody era → [KeyWitness era] → Tx era |
Instances
| Show (InAnyCardanoEra Tx) Source # | |
Defined in Cardano.Api.Tx | |
| Show (Tx era) Source # | |
| HasTypeProxy era ⇒ HasTypeProxy (Tx era) Source # | |
| IsCardanoEra era ⇒ SerialiseAsCBOR (Tx era) Source # | |
Defined in Cardano.Api.Tx Methods serialiseToCBOR ∷ Tx era → ByteString Source # deserialiseFromCBOR ∷ AsType (Tx era) → ByteString → Either DecoderError (Tx era) Source # | |
| IsCardanoEra era ⇒ HasTextEnvelope (Tx era) Source # | |
Defined in Cardano.Api.Tx Methods textEnvelopeType ∷ AsType (Tx era) → TextEnvelopeType Source # textEnvelopeDefaultDescr ∷ Tx era → TextEnvelopeDescr Source # | |
| Eq (InAnyCardanoEra Tx) Source # | |
Defined in Cardano.Api.Tx Methods (==) ∷ InAnyCardanoEra Tx → InAnyCardanoEra Tx → Bool Source # (/=) ∷ InAnyCardanoEra Tx → InAnyCardanoEra Tx → Bool Source # | |
| Eq (Tx era) Source # | |
| data AsType (Tx era) Source # | |
Defined in Cardano.Api.Tx | |
getTxWitnesses ∷ ∀ era. Tx era → [KeyWitness era] Source #
data ScriptValidity Source #
Indicates whether a script is expected to fail or pass validation.
Constructors
| ScriptInvalid | Script is expected to fail validation. Transactions marked as such can include scripts that fail validation. Such transactions may be submitted to the chain, in which case the collateral will be taken upon on chain script validation failure. |
| ScriptValid | Script is expected to pass validation. Transactions marked as such cannot include scripts that fail validation. |
Instances
| Show ScriptValidity Source # | |
Defined in Cardano.Api.TxBody | |
| FromCBOR ScriptValidity Source # | |
Defined in Cardano.Api.TxBody | |
| ToCBOR ScriptValidity Source # | |
Defined in Cardano.Api.TxBody Methods toCBOR ∷ ScriptValidity → Encoding # encodedSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy ScriptValidity → Size # encodedListSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy [ScriptValidity] → Size # | |
| Eq ScriptValidity Source # | |
Defined in Cardano.Api.TxBody Methods (==) ∷ ScriptValidity → ScriptValidity → Bool Source # (/=) ∷ ScriptValidity → ScriptValidity → Bool Source # | |
Signing in one go
data ShelleySigningKey Source #
We support making key witnesses with both normal and extended signing keys.
Constructors
| ShelleyNormalSigningKey (SignKeyDSIGN StandardCrypto) | A normal ed25519 signing key |
| ShelleyExtendedSigningKey XPrv | An extended ed25519 signing key |
signShelleyTransaction ∷ IsShelleyBasedEra era ⇒ TxBody era → [ShelleyWitnessSigningKey] → Tx era Source #
Incremental signing and separate witnesses
makeSignedTransaction ∷ ∀ era. [KeyWitness era] → TxBody era → Tx era Source #
data KeyWitness era where Source #
Constructors
| ByronKeyWitness ∷ TxInWitness → KeyWitness ByronEra | |
| ShelleyBootstrapWitness ∷ ShelleyBasedEra era → BootstrapWitness StandardCrypto → KeyWitness era | |
| ShelleyKeyWitness ∷ ShelleyBasedEra era → WitVKey Witness StandardCrypto → KeyWitness era |
Instances
makeByronKeyWitness ∷ ∀ key. IsByronKey key ⇒ NetworkId → TxBody ByronEra → SigningKey key → KeyWitness ByronEra Source #
data ShelleyWitnessSigningKey Source #
Constructors
makeShelleyKeyWitness ∷ ∀ era. IsShelleyBasedEra era ⇒ TxBody era → ShelleyWitnessSigningKey → KeyWitness era Source #
data WitnessNetworkIdOrByronAddress Source #
Either a network ID or a Byron address to be used in constructing a Shelley bootstrap witness.
Constructors
| WitnessNetworkId !NetworkId | Network ID. If this value is used in the construction of a Shelley bootstrap witness,
the result will not consist of a derivation path. If that is required,
specify a |
| WitnessByronAddress !(Address ByronAddr) | Byron address. If this value is used in the construction of a Shelley bootstrap witness, both the network ID and derivation path will be extracted from the address and used in the construction of the witness. |
makeShelleyBootstrapWitness ∷ ∀ era. IsShelleyBasedEra era ⇒ WitnessNetworkIdOrByronAddress → TxBody era → SigningKey ByronKey → KeyWitness era Source #
makeShelleySignature ∷ SignableRepresentation tosign ⇒ tosign → ShelleySigningKey → SignedDSIGN StandardCrypto tosign Source #
getShelleyKeyWitnessVerificationKey ∷ ShelleySigningKey → VKey Witness StandardCrypto Source #
getTxBodyAndWitnesses ∷ Tx era → (TxBody era, [KeyWitness era]) Source #
Data family instances
A family of singleton types used in this API to indicate which type to use where it would otherwise be ambiguous or merely unclear.
Values of this type are passed to deserialisation functions for example.