plutus-ledger-1.1.0.0: Wallet API
Safe HaskellNone
LanguageHaskell2010

Ledger.Tx.CardanoAPI

Description

Interface to the transaction types from 'cardano-api'

Synopsis

Documentation

module Ledger.Tx.CardanoAPI.Internal

newtype CardanoBuildTx Source #

Constructors

CardanoBuildTx 

Fields

Instances

Instances details
Eq CardanoBuildTx Source # 
Instance details

Defined in Ledger.Tx.CardanoAPI.Internal

Methods

(==) :: CardanoBuildTx -> CardanoBuildTx -> Bool Source #

(/=) :: CardanoBuildTx -> CardanoBuildTx -> Bool Source #

Show CardanoBuildTx Source # 
Instance details

Defined in Ledger.Tx.CardanoAPI.Internal

Methods

showsPrec :: Int -> CardanoBuildTx -> ShowS Source #

show :: CardanoBuildTx -> String Source #

showList :: [CardanoBuildTx] -> ShowS Source #

ToJSON CardanoBuildTx Source # 
Instance details

Defined in Ledger.Tx.CardanoAPI.Internal

Methods

toJSON :: CardanoBuildTx -> Value Source #

toEncoding :: CardanoBuildTx -> Encoding Source #

toJSONList :: [CardanoBuildTx] -> Value Source #

toEncodingList :: [CardanoBuildTx] -> Encoding Source #

FromJSON CardanoBuildTx Source # 
Instance details

Defined in Ledger.Tx.CardanoAPI.Internal

Methods

parseJSON :: Value -> Parser CardanoBuildTx Source #

parseJSONList :: Value -> Parser [CardanoBuildTx] Source #

ToSchema CardanoBuildTx Source # 
Instance details

Defined in Ledger.Tx.CardanoAPI.Internal

Methods

declareNamedSchema :: Proxy CardanoBuildTx -> Declare (Definitions Schema) NamedSchema Source #

Pretty CardanoBuildTx Source # 
Instance details

Defined in Ledger.Tx

Methods

pretty :: CardanoBuildTx -> Doc ann Source #

prettyList :: [CardanoBuildTx] -> Doc ann Source #

data SomeCardanoApiTx where Source #

Cardano tx from any era.

Constructors

SomeTx :: IsCardanoEra era => Tx era -> EraInMode era CardanoMode -> SomeCardanoApiTx 

Instances

Instances details
Eq SomeCardanoApiTx Source # 
Instance details

Defined in Ledger.Tx.CardanoAPI.Internal

Methods

(==) :: SomeCardanoApiTx -> SomeCardanoApiTx -> Bool Source #

(/=) :: SomeCardanoApiTx -> SomeCardanoApiTx -> Bool Source #

Show SomeCardanoApiTx Source # 
Instance details

Defined in Ledger.Tx.CardanoAPI.Internal

Methods

showsPrec :: Int -> SomeCardanoApiTx -> ShowS Source #

show :: SomeCardanoApiTx -> String Source #

showList :: [SomeCardanoApiTx] -> ShowS Source #

ToJSON SomeCardanoApiTx Source # 
Instance details

Defined in Ledger.Tx.CardanoAPI.Internal

Methods

toJSON :: SomeCardanoApiTx -> Value Source #

toEncoding :: SomeCardanoApiTx -> Encoding Source #

toJSONList :: [SomeCardanoApiTx] -> Value Source #

toEncodingList :: [SomeCardanoApiTx] -> Encoding Source #

FromJSON SomeCardanoApiTx Source #

Converting SomeCardanoApiTx to JSON.

If the "tx" field is from an unknown era, the JSON parser will print an error at runtime while parsing.

Instance details

Defined in Ledger.Tx.CardanoAPI.Internal

Methods

parseJSON :: Value -> Parser SomeCardanoApiTx Source #

parseJSONList :: Value -> Parser [SomeCardanoApiTx] Source #

ToSchema SomeCardanoApiTx Source # 
Instance details

Defined in Ledger.Tx.CardanoAPI.Internal

Methods

declareNamedSchema :: Proxy SomeCardanoApiTx -> Declare (Definitions Schema) NamedSchema Source #

Pretty SomeCardanoApiTx Source # 
Instance details

Defined in Ledger.Tx

Methods

pretty :: SomeCardanoApiTx -> Doc ann Source #

prettyList :: [SomeCardanoApiTx] -> Doc ann Source #

Serialise SomeCardanoApiTx Source # 
Instance details

Defined in Ledger.Tx.CardanoAPI.Internal

Methods

encode :: SomeCardanoApiTx -> Encoding Source #

decode :: Decoder s SomeCardanoApiTx Source #

encodeList :: [SomeCardanoApiTx] -> Encoding Source #

decodeList :: Decoder s [SomeCardanoApiTx] Source #

fromCardanoTxInsCollateral :: TxInsCollateral era -> [TxIn] Source #

fromCardanoTotalCollateral :: TxTotalCollateral BabbageEra -> Maybe Value Source #

fromCardanoReturnCollateral :: TxReturnCollateral CtxTx BabbageEra -> Maybe TxOut Source #

toCardanoTxBody Source #

Arguments

:: NetworkId 
-> PParams (BabbageEra StandardCrypto) 
-> [PaymentPubKeyHash]

Required signers of the transaction

-> Tx 
-> Either ToCardanoError (TxBody BabbageEra) 

toCardanoTxBodyContent Source #

Arguments

:: NetworkId 
-> PParams (BabbageEra StandardCrypto) 
-> [PaymentPubKeyHash]

Required signers of the transaction

-> Tx 
-> Either ToCardanoError CardanoBuildTx 

toCardanoTxInsCollateral :: [TxInput] -> Either ToCardanoError (TxInsCollateral BabbageEra) Source #

toCardanoTotalCollateral :: Maybe Value -> Either ToCardanoError (TxTotalCollateral BabbageEra) Source #

toCardanoReturnCollateral :: Maybe TxOut -> TxReturnCollateral CtxTx BabbageEra Source #

toCardanoTxInWitness :: Tx -> TxInputType -> Either ToCardanoError (Witness WitCtxTxIn BabbageEra) Source #

toCardanoDatumWitness :: Maybe Datum -> ScriptDatum WitCtxTxIn Source #

toCardanoTxInReferenceWitnessHeader :: Versioned TxOutRef -> Either ToCardanoError WitnessHeader Source #

toCardanoTxInScriptWitnessHeader :: Versioned Script -> Either ToCardanoError WitnessHeader Source #

toCardanoMintValue :: Tx -> Either ToCardanoError (TxMintValue BuildTx BabbageEra) Source #

toCardanoMintWitness :: Redeemer -> Maybe (Versioned TxOutRef) -> Maybe (Versioned MintingPolicy) -> Either ToCardanoError (ScriptWitness WitCtxMint BabbageEra) Source #

data ToCardanoError Source #

Constructors

TxBodyError String

A C.TxBodyError converted to String

DeserialisationError 
InvalidValidityRange 
ValueNotPureAda 
OutputHasZeroAda 
StakingPointersNotSupported 
SimpleScriptsNotSupportedToCardano 
MissingInputValidator 
MissingDatum 
MissingMintingPolicy 
ScriptPurposeNotSupported ScriptTag 
MissingMintingPolicyRedeemer 
MissingStakeValidator 
UnsupportedPlutusVersion Language 
Tag String ToCardanoError 

Instances

Instances details
Eq ToCardanoError Source # 
Instance details

Defined in Ledger.Tx.CardanoAPI.Internal

Methods

(==) :: ToCardanoError -> ToCardanoError -> Bool Source #

(/=) :: ToCardanoError -> ToCardanoError -> Bool Source #

Show ToCardanoError Source # 
Instance details

Defined in Ledger.Tx.CardanoAPI.Internal

Methods

showsPrec :: Int -> ToCardanoError -> ShowS Source #

show :: ToCardanoError -> String Source #

showList :: [ToCardanoError] -> ShowS Source #

Generic ToCardanoError Source # 
Instance details

Defined in Ledger.Tx.CardanoAPI.Internal

Associated Types

type Rep ToCardanoError :: Type -> Type Source #

Methods

from :: ToCardanoError -> Rep ToCardanoError x Source #

to :: Rep ToCardanoError x -> ToCardanoError Source #

ToJSON ToCardanoError Source # 
Instance details

Defined in Ledger.Tx.CardanoAPI.Internal

Methods

toJSON :: ToCardanoError -> Value Source #

toEncoding :: ToCardanoError -> Encoding Source #

toJSONList :: [ToCardanoError] -> Value Source #

toEncodingList :: [ToCardanoError] -> Encoding Source #

FromJSON ToCardanoError Source # 
Instance details

Defined in Ledger.Tx.CardanoAPI.Internal

Methods

parseJSON :: Value -> Parser ToCardanoError Source #

parseJSONList :: Value -> Parser [ToCardanoError] Source #

Pretty ToCardanoError Source # 
Instance details

Defined in Ledger.Tx.CardanoAPI.Internal

Methods

pretty :: ToCardanoError -> Doc ann Source #

prettyList :: [ToCardanoError] -> Doc ann Source #

type Rep ToCardanoError Source # 
Instance details

Defined in Ledger.Tx.CardanoAPI.Internal

type Rep ToCardanoError = D1 ('MetaData "ToCardanoError" "Ledger.Tx.CardanoAPI.Internal" "plutus-ledger-1.1.0.0-JskZbcPMCdRJVHaAZ0to82" 'False) (((C1 ('MetaCons "TxBodyError" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 String)) :+: (C1 ('MetaCons "DeserialisationError" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "InvalidValidityRange" 'PrefixI 'False) (U1 :: Type -> Type))) :+: ((C1 ('MetaCons "ValueNotPureAda" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "OutputHasZeroAda" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "StakingPointersNotSupported" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "SimpleScriptsNotSupportedToCardano" 'PrefixI 'False) (U1 :: Type -> Type)))) :+: (((C1 ('MetaCons "MissingInputValidator" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "MissingDatum" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "MissingMintingPolicy" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "ScriptPurposeNotSupported" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ScriptTag)))) :+: ((C1 ('MetaCons "MissingMintingPolicyRedeemer" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "MissingStakeValidator" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "UnsupportedPlutusVersion" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Language)) :+: C1 ('MetaCons "Tag" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 String) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ToCardanoError))))))

data FromCardanoError Source #

Constructors

SimpleScriptsNotSupported 

Instances

Instances details
Eq FromCardanoError Source # 
Instance details

Defined in Ledger.Tx.CardanoAPI.Internal

Methods

(==) :: FromCardanoError -> FromCardanoError -> Bool Source #

(/=) :: FromCardanoError -> FromCardanoError -> Bool Source #

Show FromCardanoError Source # 
Instance details

Defined in Ledger.Tx.CardanoAPI.Internal

Methods

showsPrec :: Int -> FromCardanoError -> ShowS Source #

show :: FromCardanoError -> String Source #

showList :: [FromCardanoError] -> ShowS Source #

Generic FromCardanoError Source # 
Instance details

Defined in Ledger.Tx.CardanoAPI.Internal

Associated Types

type Rep FromCardanoError :: Type -> Type Source #

Methods

from :: FromCardanoError -> Rep FromCardanoError x Source #

to :: Rep FromCardanoError x -> FromCardanoError Source #

ToJSON FromCardanoError Source # 
Instance details

Defined in Ledger.Tx.CardanoAPI.Internal

Methods

toJSON :: FromCardanoError -> Value Source #

toEncoding :: FromCardanoError -> Encoding Source #

toJSONList :: [FromCardanoError] -> Value Source #

toEncodingList :: [FromCardanoError] -> Encoding Source #

FromJSON FromCardanoError Source # 
Instance details

Defined in Ledger.Tx.CardanoAPI.Internal

Methods

parseJSON :: Value -> Parser FromCardanoError Source #

parseJSONList :: Value -> Parser [FromCardanoError] Source #

Pretty FromCardanoError Source # 
Instance details

Defined in Ledger.Tx.CardanoAPI.Internal

Methods

pretty :: FromCardanoError -> Doc ann Source #

prettyList :: [FromCardanoError] -> Doc ann Source #

ToObject FromCardanoError Source # 
Instance details

Defined in Ledger.Tx.CardanoAPI.Internal

Methods

toObject :: TracingVerbosity -> FromCardanoError -> Object

textTransformer :: FromCardanoError -> Object -> Text

type Rep FromCardanoError Source # 
Instance details

Defined in Ledger.Tx.CardanoAPI.Internal

type Rep FromCardanoError = D1 ('MetaData "FromCardanoError" "Ledger.Tx.CardanoAPI.Internal" "plutus-ledger-1.1.0.0-JskZbcPMCdRJVHaAZ0to82" 'False) (C1 ('MetaCons "SimpleScriptsNotSupported" 'PrefixI 'False) (U1 :: Type -> Type))

getRequiredSigners :: Tx BabbageEra -> [PaymentPubKeyHash] Source #

Conversion from Plutus types

fromPlutusIndex :: UtxoIndex -> Either (Either ValidationErrorInPhase ToCardanoError) (UTxO (BabbageEra StandardCrypto)) Source #

fromPlutusTxOut :: TxOut -> TxOut (BabbageEra StandardCrypto) Source #

fromPlutusTxOutRef :: TxOutRef -> Either ToCardanoError (TxIn StandardCrypto) Source #