Safe Haskell	None
Language	Haskell2010

Plutus.Contract.Wallet

Contents

Exporting transactions

Description

Turn UnbalancedTx values into transactions using the wallet API.

Synopsis

balanceTx :: forall effs. Member WalletEffect effs => UnbalancedTx -> Eff effs (Either WalletAPIError CardanoTx)
handleTx :: (Member WalletEffect effs, Member (Error WalletAPIError) effs) => UnbalancedTx -> Eff effs CardanoTx
yieldUnbalancedTx :: forall effs. Member WalletEffect effs => UnbalancedTx -> Eff effs ()
getUnspentOutput :: AsContractError e => Contract w s e TxOutRef
signTxAndSubmit :: Member WalletEffect effs => CardanoTx -> Eff effs CardanoTx
data ExportTx = ExportTx {
- partialTx :: Tx BabbageEra
- lookups :: [ExportTxInput]
- redeemers :: [ExportTxRedeemer]
}
data ExportTxInput = ExportTxInput {
- etxiId :: TxId
- etxiTxIx :: TxIx
- etxiAddress :: AddressInEra BabbageEra
- etxiLovelaceQuantity :: Lovelace
- etxiDatumHash :: Maybe (Hash ScriptData)
- etxiAssets :: [(PolicyId, AssetName, Quantity)]
}
data ExportTxRedeemer
- = SpendingRedeemer {
  - redeemer :: Redeemer
  - redeemerOutRef :: TxOutRef
  }
- | MintingRedeemer {
  - redeemer :: Redeemer
  - redeemerPolicyId :: MintingPolicyHash
  }
- | RewardingRedeemer {
  - redeemer :: Redeemer
  - redeemerStakingCredential :: StakingCredential
  }
- | CertifyingRedeemer {
  - redeemer :: Redeemer
  - redeemerDCert :: DCert
  }
export :: Params -> UnbalancedTx -> Either CardanoLedgerError ExportTx

Documentation

balanceTx :: forall effs. Member WalletEffect effs => UnbalancedTx -> Eff effs (Either WalletAPIError CardanoTx) Source #

handleTx :: (Member WalletEffect effs, Member (Error WalletAPIError) effs) => UnbalancedTx -> Eff effs CardanoTx Source #

Balance an unabalanced transaction, sign it, and submit it to the chain in the context of a wallet.

yieldUnbalancedTx :: forall effs. Member WalletEffect effs => UnbalancedTx -> Eff effs () Source #

getUnspentOutput :: AsContractError e => Contract w s e TxOutRef Source #

Get an unspent output belonging to the wallet.

signTxAndSubmit :: Member WalletEffect effs => CardanoTx -> Eff effs CardanoTx Source #

Add the wallet's signature to the transaction and submit it. Returns the transaction with the wallet's signature.

Exporting transactions

data ExportTx Source #

Partial transaction that can be balanced by the wallet backend.

Constructors

ExportTx
Fields partialTx :: Tx BabbageEra The transaction itself lookups :: [ExportTxInput] The tx outputs for all inputs spent by the partial tx redeemers :: [ExportTxRedeemer]

Instances

Instances details

Eq ExportTx Source #
Instance details Defined in Plutus.Contract.Wallet Methods (==) :: ExportTx -> ExportTx -> Bool Source # (/=) :: ExportTx -> ExportTx -> Bool Source #
Show ExportTx Source #
Instance details Defined in Plutus.Contract.Wallet Methods showsPrec :: Int -> ExportTx -> ShowS Source # show :: ExportTx -> String Source # showList :: [ExportTx] -> ShowS Source #
Generic ExportTx Source #
Instance details Defined in Plutus.Contract.Wallet Associated Types type Rep ExportTx :: Type -> Type Source # Methods from :: ExportTx -> Rep ExportTx x Source # to :: Rep ExportTx x -> ExportTx Source #
ToJSON ExportTx Source #
Instance details Defined in Plutus.Contract.Wallet Methods toJSON :: ExportTx -> Value Source # toEncoding :: ExportTx -> Encoding Source # toJSONList :: [ExportTx] -> Value Source # toEncodingList :: [ExportTx] -> Encoding Source #
FromJSON ExportTx Source #
Instance details Defined in Plutus.Contract.Wallet Methods parseJSON :: Value -> Parser ExportTx Source # parseJSONList :: Value -> Parser [ExportTx] Source #
ToSchema ExportTx Source #
Instance details Defined in Plutus.Contract.Wallet Methods declareNamedSchema :: Proxy ExportTx -> Declare (Definitions Schema) NamedSchema Source #
type Rep ExportTx Source #
Instance details Defined in Plutus.Contract.Wallet type Rep ExportTx = D1 ('MetaData "ExportTx" "Plutus.Contract.Wallet" "plutus-contract-1.1.0.0-KZTRXOViW1GCXNPMdYqx30" 'False) (C1 ('MetaCons "ExportTx" 'PrefixI 'True) (S1 ('MetaSel ('Just "partialTx") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Tx BabbageEra)) :: (S1 ('MetaSel ('Just "lookups") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [ExportTxInput]) :: S1 ('MetaSel ('Just "redeemers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [ExportTxRedeemer]))))

data ExportTxInput Source #

Constructors

ExportTxInput
Fields etxiId :: TxId etxiTxIx :: TxIx etxiAddress :: AddressInEra BabbageEra etxiLovelaceQuantity :: Lovelace etxiDatumHash :: Maybe (Hash ScriptData) etxiAssets :: [(PolicyId, AssetName, Quantity)]

Instances

Instances details

Eq ExportTxInput Source #
Instance details Defined in Plutus.Contract.Wallet Methods (==) :: ExportTxInput -> ExportTxInput -> Bool Source # (/=) :: ExportTxInput -> ExportTxInput -> Bool Source #
Show ExportTxInput Source #
Instance details Defined in Plutus.Contract.Wallet Methods showsPrec :: Int -> ExportTxInput -> ShowS Source # show :: ExportTxInput -> String Source # showList :: [ExportTxInput] -> ShowS Source #
Generic ExportTxInput Source #
Instance details Defined in Plutus.Contract.Wallet Associated Types type Rep ExportTxInput :: Type -> Type Source # Methods from :: ExportTxInput -> Rep ExportTxInput x Source # to :: Rep ExportTxInput x -> ExportTxInput Source #
ToJSON ExportTxInput Source #
Instance details Defined in Plutus.Contract.Wallet Methods toJSON :: ExportTxInput -> Value Source # toEncoding :: ExportTxInput -> Encoding Source # toJSONList :: [ExportTxInput] -> Value Source # toEncodingList :: [ExportTxInput] -> Encoding Source #
FromJSON ExportTxInput Source #
Instance details Defined in Plutus.Contract.Wallet Methods parseJSON :: Value -> Parser ExportTxInput Source # parseJSONList :: Value -> Parser [ExportTxInput] Source #
ToSchema ExportTxInput Source #
Instance details Defined in Plutus.Contract.Wallet Methods declareNamedSchema :: Proxy ExportTxInput -> Declare (Definitions Schema) NamedSchema Source #
type Rep ExportTxInput Source #
Instance details Defined in Plutus.Contract.Wallet type Rep ExportTxInput = D1 ('MetaData "ExportTxInput" "Plutus.Contract.Wallet" "plutus-contract-1.1.0.0-KZTRXOViW1GCXNPMdYqx30" 'False) (C1 ('MetaCons "ExportTxInput" 'PrefixI 'True) ((S1 ('MetaSel ('Just "etxiId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 TxId) :: (S1 ('MetaSel ('Just "etxiTxIx") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 TxIx) :: S1 ('MetaSel ('Just "etxiAddress") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (AddressInEra BabbageEra)))) :: (S1 ('MetaSel ('Just "etxiLovelaceQuantity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Lovelace) :: (S1 ('MetaSel ('Just "etxiDatumHash") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Hash ScriptData))) :*: S1 ('MetaSel ('Just "etxiAssets") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [(PolicyId, AssetName, Quantity)])))))

data ExportTxRedeemer Source #

Constructors

SpendingRedeemer
Fields redeemer :: Redeemer redeemerOutRef :: TxOutRef
MintingRedeemer
Fields redeemer :: Redeemer redeemerPolicyId :: MintingPolicyHash
RewardingRedeemer
Fields redeemer :: Redeemer redeemerStakingCredential :: StakingCredential
CertifyingRedeemer
Fields redeemer :: Redeemer redeemerDCert :: DCert

Instances

Instances details

Eq ExportTxRedeemer Source #
Instance details Defined in Plutus.Contract.Wallet Methods (==) :: ExportTxRedeemer -> ExportTxRedeemer -> Bool Source # (/=) :: ExportTxRedeemer -> ExportTxRedeemer -> Bool Source #
Show ExportTxRedeemer Source #
Instance details Defined in Plutus.Contract.Wallet Methods showsPrec :: Int -> ExportTxRedeemer -> ShowS Source # show :: ExportTxRedeemer -> String Source # showList :: [ExportTxRedeemer] -> ShowS Source #
Generic ExportTxRedeemer Source #
Instance details Defined in Plutus.Contract.Wallet Associated Types type Rep ExportTxRedeemer :: Type -> Type Source # Methods from :: ExportTxRedeemer -> Rep ExportTxRedeemer x Source # to :: Rep ExportTxRedeemer x -> ExportTxRedeemer Source #
ToJSON ExportTxRedeemer Source #
Instance details Defined in Plutus.Contract.Wallet Methods toJSON :: ExportTxRedeemer -> Value Source # toEncoding :: ExportTxRedeemer -> Encoding Source # toJSONList :: [ExportTxRedeemer] -> Value Source # toEncodingList :: [ExportTxRedeemer] -> Encoding Source #
FromJSON ExportTxRedeemer Source #
Instance details Defined in Plutus.Contract.Wallet Methods parseJSON :: Value -> Parser ExportTxRedeemer Source # parseJSONList :: Value -> Parser [ExportTxRedeemer] Source #
ToSchema ExportTxRedeemer Source #
Instance details Defined in Plutus.Contract.Wallet Methods declareNamedSchema :: Proxy ExportTxRedeemer -> Declare (Definitions Schema) NamedSchema Source #
type Rep ExportTxRedeemer Source #
Instance details Defined in Plutus.Contract.Wallet type Rep ExportTxRedeemer = D1 ('MetaData "ExportTxRedeemer" "Plutus.Contract.Wallet" "plutus-contract-1.1.0.0-KZTRXOViW1GCXNPMdYqx30" 'False) ((C1 ('MetaCons "SpendingRedeemer" 'PrefixI 'True) (S1 ('MetaSel ('Just "redeemer") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Redeemer) :: S1 ('MetaSel ('Just "redeemerOutRef") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 TxOutRef)) :+: C1 ('MetaCons "MintingRedeemer" 'PrefixI 'True) (S1 ('MetaSel ('Just "redeemer") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Redeemer) :: S1 ('MetaSel ('Just "redeemerPolicyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 MintingPolicyHash))) :+: (C1 ('MetaCons "RewardingRedeemer" 'PrefixI 'True) (S1 ('MetaSel ('Just "redeemer") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Redeemer) :: S1 ('MetaSel ('Just "redeemerStakingCredential") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 StakingCredential)) :+: C1 ('MetaCons "CertifyingRedeemer" 'PrefixI 'True) (S1 ('MetaSel ('Just "redeemer") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Redeemer) :: S1 ('MetaSel ('Just "redeemerDCert") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 DCert))))

export :: Params -> UnbalancedTx -> Either CardanoLedgerError ExportTx Source #