Copyright	(c) 2023 GYELD GMBH
License	Apache 2.0
Maintainer	support@geniusyield.co
Stability	develop
Safe Haskell	Safe-Inferred
Language	GHC2021

GeniusYield.Api.Dex.PartialOrder

Contents

PartialOrderInfo
Redeemer & Datum
Partial order NFT policy
Queries
Tx constructors
Utilities

Description

Synopsis

data PORefs = PORefs {
- porRefNft ∷ !GYAssetClass
- porMintRef ∷ !GYTxOutRef
- porValRef ∷ !GYTxOutRef
}
data PartialOrderInfo = PartialOrderInfo {
- poiRef ∷ !GYTxOutRef
- poiOwnerKey ∷ !GYPubKeyHash
- poiOwnerAddr ∷ !GYAddress
- poiOfferedAsset ∷ !GYAssetClass
- poiOfferedOriginalAmount ∷ !Natural
- poiOfferedAmount ∷ !Natural
- poiAskedAsset ∷ !GYAssetClass
- poiPrice ∷ !GYRational
- poiNFT ∷ !GYTokenName
- poiStart ∷ !(Maybe GYTime)
- poiEnd ∷ !(Maybe GYTime)
- poiPartialFills ∷ !Natural
- poiMakerLovelaceFlatFee ∷ !Natural
- poiTakerLovelaceFlatFee ∷ !Natural
- poiContainedFee ∷ !POIContainedFee
- poiContainedPayment ∷ !Natural
- poiUTxOValue ∷ !GYValue
- poiUTxOAddr ∷ !GYAddress
- poiNFTCS ∷ !GYMintingPolicyId
}
data POIContainedFee = POIContainedFee {
- poifLovelaces ∷ !Natural
- poifOfferedTokens ∷ !Natural
- poifAskedTokens ∷ !Natural
}
partialOrderInfoToIn ∷ HasDexScripts a ⇒ a → PORefs → PartialOrderInfo → PartialOrderAction → GYTxIn 'PlutusV2
partialOrderInfoToPayment ∷ PartialOrderInfo → GYValue → GYTxOut 'PlutusV2
partialOrderInfoToPartialOrderDatum ∷ PartialOrderInfo → PartialOrderDatum
poiGetContainedFeeValue ∷ PartialOrderInfo → GYValue
expectedPaymentWithDeposit ∷ PartialOrderInfo → Bool → GYValue
data PartialOrderAction
- = PartialCancel
- | PartialFill Integer
- | CompleteFill
data PartialOrderDatum = PartialOrderDatum {
- podOwnerKey ∷ PubKeyHash
- podOwnerAddr ∷ Address
- podOfferedAsset ∷ AssetClass
- podOfferedOriginalAmount ∷ Integer
- podOfferedAmount ∷ Integer
- podAskedAsset ∷ AssetClass
- podPrice ∷ Rational
- podNFT ∷ TokenName
- podStart ∷ Maybe POSIXTime
- podEnd ∷ Maybe POSIXTime
- podPartialFills ∷ Integer
- podMakerLovelaceFlatFee ∷ Integer
- podTakerLovelaceFlatFee ∷ Integer
- podContainedFee ∷ PartialOrderContainedFee
- podContainedPayment ∷ Integer
}
partialOrderNftPolicy ∷ GYDexApiQueryMonad m a ⇒ PORefs → m (GYMintingPolicy 'PlutusV2)
partialOrderNftPolicyId ∷ GYDexApiQueryMonad m a ⇒ PORefs → m GYMintingPolicyId
partialOrders ∷ GYDexApiQueryMonad m a ⇒ PORefs → m (Map GYTxOutRef PartialOrderInfo)
getPartialOrderInfo ∷ GYDexApiQueryMonad m a ⇒ PORefs → GYTxOutRef → m PartialOrderInfo
placePartialOrder ∷ GYDexApiMonad m a ⇒ PORefs → GYAddress → (Natural, GYAssetClass) → GYAssetClass → GYRational → Maybe GYTime → Maybe GYTime → Maybe GYStakeCredential → m (GYTxSkeleton 'PlutusV2)
placePartialOrder' ∷ (GYDexApiMonad m a, HasCallStack) ⇒ PORefs → GYAddress → (Natural, GYAssetClass) → GYAssetClass → GYRational → Maybe GYTime → Maybe GYTime → Natural → Natural → Maybe GYStakeCredential → GYTxOutRef → PartialOrderConfigInfoF GYAddress → m (GYTxSkeleton 'PlutusV2)
completelyFillPartialOrder ∷ (HasCallStack, GYDexApiMonad m a) ⇒ PORefs → GYTxOutRef → Maybe (GYTxOutRef, PartialOrderConfigInfoF GYAddress) → Natural → m (GYTxSkeleton 'PlutusV2)
partiallyFillPartialOrder ∷ (HasCallStack, GYDexApiMonad m a) ⇒ PORefs → GYTxOutRef → Natural → Maybe (GYTxOutRef, PartialOrderConfigInfoF GYAddress) → Natural → m (GYTxSkeleton 'PlutusV2)
fillPartialOrder ∷ (HasCallStack, GYDexApiMonad m a) ⇒ PORefs → GYTxOutRef → Natural → Maybe (GYTxOutRef, PartialOrderConfigInfoF GYAddress) → Natural → m (GYTxSkeleton 'PlutusV2)
fillPartialOrder' ∷ (HasCallStack, GYDexApiMonad m a) ⇒ PORefs → PartialOrderInfo → Natural → Maybe (GYTxOutRef, PartialOrderConfigInfoF GYAddress) → Natural → m (GYTxSkeleton 'PlutusV2)
fillMultiplePartialOrders ∷ (HasCallStack, GYDexApiMonad m a) ⇒ PORefs → [(GYTxOutRef, Natural)] → Maybe (GYTxOutRef, PartialOrderConfigInfoF GYAddress) → m (GYTxSkeleton 'PlutusV2)
completelyFillMultiplePartialOrders ∷ (HasCallStack, GYDexApiMonad m a) ⇒ PORefs → [GYTxOutRef] → Maybe (GYTxOutRef, PartialOrderConfigInfoF GYAddress) → m (GYTxSkeleton 'PlutusV2)
fillMultiplePartialOrders' ∷ (HasCallStack, GYDexApiMonad m a) ⇒ PORefs → [(PartialOrderInfo, Natural)] → Maybe (GYTxOutRef, PartialOrderConfigInfoF GYAddress) → m (GYTxSkeleton 'PlutusV2)
cancelPartialOrder ∷ (HasCallStack, GYDexApiMonad m a) ⇒ PORefs → GYTxOutRef → m (GYTxSkeleton 'PlutusV2)
cancelPartialOrder' ∷ (HasCallStack, GYDexApiMonad m a) ⇒ PORefs → PartialOrderInfo → m (GYTxSkeleton 'PlutusV2)
cancelMultiplePartialOrders ∷ (HasCallStack, GYDexApiMonad m a) ⇒ PORefs → [PartialOrderInfo] → m (GYTxSkeleton 'PlutusV2)
partialOrderAddr ∷ GYDexApiQueryMonad m a ⇒ PORefs → m GYAddress
partialOrderPrice ∷ PartialOrderInfo → Natural → GYValue
partialOrderPrice' ∷ PartialOrderInfo → Natural → Natural

Documentation

data PORefs #

Constructors

PORefs
Fields porRefNft ∷ !GYAssetClass The reference NFT. porMintRef ∷ !GYTxOutRef The location of the reference NFT minting policy reference script. porValRef ∷ !GYTxOutRef The location of the validator reference script.

Instances

Instances details

Show PORefs #
Instance details Defined in GeniusYield.Api.Dex.PartialOrder Methods showsPrec ∷ Int → PORefs → ShowS Source # show ∷ PORefs → String Source # showList ∷ [PORefs] → ShowS Source #

PartialOrderInfo

data PartialOrderInfo #

Constructors

PartialOrderInfo

Fields

poiRef ∷ !GYTxOutRef
Reference to the partial order.
poiOwnerKey ∷ !GYPubKeyHash
Public key hash of the owner.
poiOwnerAddr ∷ !GYAddress
Address of the owner.
poiOfferedAsset ∷ !GYAssetClass
The asset being offered.
poiOfferedOriginalAmount ∷ !Natural
The number of units originally offered.
poiOfferedAmount ∷ !Natural
The number of units being offered.
poiAskedAsset ∷ !GYAssetClass
The asset being asked for as payment.
poiPrice ∷ !GYRational
The price for one unit of the offered asset.
poiNFT ∷ !GYTokenName
Token name of the NFT identifying this partial order.
poiStart ∷ !(Maybe GYTime)
The time when the order can earliest be filled (optional).
poiEnd ∷ !(Maybe GYTime)
The time when the order can latest be filled (optional).
poiPartialFills ∷ !Natural
The number of past partial fills.
poiMakerLovelaceFlatFee ∷ !Natural
Flat fee (in lovelace) paid by the taker.
poiTakerLovelaceFlatFee ∷ !Natural
Flat fee (in lovelace) paid by the taker.
poiContainedFee ∷ !POIContainedFee
Fee contained in the order.
poiContainedPayment ∷ !Natural
Payment (in asked asset) contained in the order.
poiUTxOValue ∷ !GYValue
Total value in the UTxO.
poiUTxOAddr ∷ !GYAddress
Address of the order UTxO.
poiNFTCS ∷ !GYMintingPolicyId
Caching the CS to avoid recalculating for it.

Instances

Instances details

Generic PartialOrderInfo #
Instance details Defined in GeniusYield.Api.Dex.PartialOrder Associated Types type Rep PartialOrderInfo ∷ Type → Type Source # Methods from ∷ PartialOrderInfo → Rep PartialOrderInfo x Source # to ∷ Rep PartialOrderInfo x → PartialOrderInfo Source #
Show PartialOrderInfo #
Instance details Defined in GeniusYield.Api.Dex.PartialOrder Methods showsPrec ∷ Int → PartialOrderInfo → ShowS Source # show ∷ PartialOrderInfo → String Source # showList ∷ [PartialOrderInfo] → ShowS Source #
Eq PartialOrderInfo #
Instance details Defined in GeniusYield.Api.Dex.PartialOrder Methods (==) ∷ PartialOrderInfo → PartialOrderInfo → Bool Source # (/=) ∷ PartialOrderInfo → PartialOrderInfo → Bool Source #
ToSchema PartialOrderInfo #
Instance details Defined in GeniusYield.Api.Dex.PartialOrder Methods declareNamedSchema ∷ Proxy PartialOrderInfo → Declare (Definitions Schema) NamedSchema Source #
type Rep PartialOrderInfo #
Instance details Defined in GeniusYield.Api.Dex.PartialOrder type Rep PartialOrderInfo = D1 ('MetaData "PartialOrderInfo" "GeniusYield.Api.Dex.PartialOrder" "geniusyield-dex-api-0.1.0.0-inplace" 'False) (C1 ('MetaCons "PartialOrderInfo" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "poiRef") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 GYTxOutRef) :: S1 ('MetaSel ('Just "poiOwnerKey") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 GYPubKeyHash)) :: (S1 ('MetaSel ('Just "poiOwnerAddr") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 GYAddress) :: S1 ('MetaSel ('Just "poiOfferedAsset") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 GYAssetClass))) :: ((S1 ('MetaSel ('Just "poiOfferedOriginalAmount") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Natural) :: S1 ('MetaSel ('Just "poiOfferedAmount") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Natural)) :: (S1 ('MetaSel ('Just "poiAskedAsset") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 GYAssetClass) :: (S1 ('MetaSel ('Just "poiPrice") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 GYRational) :: S1 ('MetaSel ('Just "poiNFT") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 GYTokenName))))) :: (((S1 ('MetaSel ('Just "poiStart") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe GYTime)) :: S1 ('MetaSel ('Just "poiEnd") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe GYTime))) :: (S1 ('MetaSel ('Just "poiPartialFills") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Natural) :: (S1 ('MetaSel ('Just "poiMakerLovelaceFlatFee") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Natural) :: S1 ('MetaSel ('Just "poiTakerLovelaceFlatFee") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Natural)))) :: ((S1 ('MetaSel ('Just "poiContainedFee") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 POIContainedFee) :: S1 ('MetaSel ('Just "poiContainedPayment") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Natural)) :: (S1 ('MetaSel ('Just "poiUTxOValue") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 GYValue) :: (S1 ('MetaSel ('Just "poiUTxOAddr") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 GYAddress) :: S1 ('MetaSel ('Just "poiNFTCS") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 GYMintingPolicyId)))))))

data POIContainedFee #

Constructors

POIContainedFee
Fields poifLovelaces ∷ !Natural poifOfferedTokens ∷ !Natural poifAskedTokens ∷ !Natural

Instances

Instances details

Monoid POIContainedFee #
Instance details Defined in GeniusYield.Api.Dex.PartialOrder Methods mempty ∷ POIContainedFee Source # mappend ∷ POIContainedFee → POIContainedFee → POIContainedFee Source # mconcat ∷ [POIContainedFee] → POIContainedFee Source #
Semigroup POIContainedFee #
Instance details Defined in GeniusYield.Api.Dex.PartialOrder Methods (<>) ∷ POIContainedFee → POIContainedFee → POIContainedFee Source # sconcat ∷ NonEmpty POIContainedFee → POIContainedFee Source # stimes ∷ Integral b ⇒ b → POIContainedFee → POIContainedFee Source #
Generic POIContainedFee #
Instance details Defined in GeniusYield.Api.Dex.PartialOrder Associated Types type Rep POIContainedFee ∷ Type → Type Source # Methods from ∷ POIContainedFee → Rep POIContainedFee x Source # to ∷ Rep POIContainedFee x → POIContainedFee Source #
Show POIContainedFee #
Instance details Defined in GeniusYield.Api.Dex.PartialOrder Methods showsPrec ∷ Int → POIContainedFee → ShowS Source # show ∷ POIContainedFee → String Source # showList ∷ [POIContainedFee] → ShowS Source #
Eq POIContainedFee #
Instance details Defined in GeniusYield.Api.Dex.PartialOrder Methods (==) ∷ POIContainedFee → POIContainedFee → Bool Source # (/=) ∷ POIContainedFee → POIContainedFee → Bool Source #
ToSchema POIContainedFee #
Instance details Defined in GeniusYield.Api.Dex.PartialOrder Methods declareNamedSchema ∷ Proxy POIContainedFee → Declare (Definitions Schema) NamedSchema Source #
type Rep POIContainedFee #
Instance details Defined in GeniusYield.Api.Dex.PartialOrder type Rep POIContainedFee = D1 ('MetaData "POIContainedFee" "GeniusYield.Api.Dex.PartialOrder" "geniusyield-dex-api-0.1.0.0-inplace" 'False) (C1 ('MetaCons "POIContainedFee" 'PrefixI 'True) (S1 ('MetaSel ('Just "poifLovelaces") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Natural) :: (S1 ('MetaSel ('Just "poifOfferedTokens") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Natural) :: S1 ('MetaSel ('Just "poifAskedTokens") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Natural))))

partialOrderInfoToIn ∷ HasDexScripts a ⇒ a → PORefs → PartialOrderInfo → PartialOrderAction → GYTxIn 'PlutusV2 #

partialOrderInfoToPayment ∷ PartialOrderInfo → GYValue → GYTxOut 'PlutusV2 #

partialOrderInfoToPartialOrderDatum ∷ PartialOrderInfo → PartialOrderDatum #

poiGetContainedFeeValue ∷ PartialOrderInfo → GYValue #

expectedPaymentWithDeposit ∷ PartialOrderInfo → Bool → GYValue #

Note that at any moment, an order UTxO contains:- * An NFT. * Remaining offered tokens. * Payment for tokens consumed. * Initial deposit. * Collected fees.

Redeemer & Datum

data PartialOrderAction #

Constructors

PartialCancel
PartialFill Integer
CompleteFill

Instances

Instances details

Generic PartialOrderAction #
Instance details Defined in GeniusYield.Scripts.Dex.PartialOrder Associated Types type Rep PartialOrderAction ∷ Type → Type Source # Methods from ∷ PartialOrderAction → Rep PartialOrderAction x Source # to ∷ Rep PartialOrderAction x → PartialOrderAction Source #
Show PartialOrderAction #
Instance details Defined in GeniusYield.Scripts.Dex.PartialOrder Methods showsPrec ∷ Int → PartialOrderAction → ShowS Source # show ∷ PartialOrderAction → String Source # showList ∷ [PartialOrderAction] → ShowS Source #
FromData PartialOrderAction #
Instance details Defined in GeniusYield.Scripts.Dex.PartialOrder Methods fromBuiltinData ∷ BuiltinData → Maybe PartialOrderAction Source #
ToData PartialOrderAction #
Instance details Defined in GeniusYield.Scripts.Dex.PartialOrder Methods toBuiltinData ∷ PartialOrderAction → BuiltinData Source #
UnsafeFromData PartialOrderAction #
Instance details Defined in GeniusYield.Scripts.Dex.PartialOrder Methods unsafeFromBuiltinData ∷ BuiltinData → PartialOrderAction Source #
type Rep PartialOrderAction #
Instance details Defined in GeniusYield.Scripts.Dex.PartialOrder type Rep PartialOrderAction = D1 ('MetaData "PartialOrderAction" "GeniusYield.Scripts.Dex.PartialOrder" "geniusyield-dex-api-0.1.0.0-inplace" 'False) (C1 ('MetaCons "PartialCancel" 'PrefixI 'False) (U1 ∷ Type → Type) :+: (C1 ('MetaCons "PartialFill" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Integer)) :+: C1 ('MetaCons "CompleteFill" 'PrefixI 'False) (U1 ∷ Type → Type)))

data PartialOrderDatum #

Datum specifying a partial order.

Constructors

PartialOrderDatum

Fields

podOwnerKey ∷ PubKeyHash
Public key hash of the owner. Order cancellations must be signed by this.
podOwnerAddr ∷ Address
Address of the owner. Payments must be made to this address.
podOfferedAsset ∷ AssetClass
The asset being offered.
podOfferedOriginalAmount ∷ Integer
Original number of units being offered. Initially, this would be same as podOfferedAmount.
podOfferedAmount ∷ Integer
The number of units being offered.
podAskedAsset ∷ AssetClass
The asset being asked for as payment.
podPrice ∷ Rational
The price for one unit of the offered asset.
podNFT ∷ TokenName
Token name of the NFT identifying this order.
podStart ∷ Maybe POSIXTime
The time when the order can earliest be filled (optional).
podEnd ∷ Maybe POSIXTime
The time when the order can latest be filled (optional).
podPartialFills ∷ Integer
Number of partial fills order has undergone, initially would be 0.
podMakerLovelaceFlatFee ∷ Integer
Flat fee (in lovelace) paid by the maker.
podTakerLovelaceFlatFee ∷ Integer
Flat fee (in lovelace) paid by the taker.
podContainedFee ∷ PartialOrderContainedFee
Total fees contained in the order.
podContainedPayment ∷ Integer
Payment (in asked asset) contained in the order.

Instances

Instances details

Generic PartialOrderDatum #
Instance details Defined in GeniusYield.Scripts.Dex.PartialOrder Associated Types type Rep PartialOrderDatum ∷ Type → Type Source # Methods from ∷ PartialOrderDatum → Rep PartialOrderDatum x Source # to ∷ Rep PartialOrderDatum x → PartialOrderDatum Source #
Show PartialOrderDatum #
Instance details Defined in GeniusYield.Scripts.Dex.PartialOrder Methods showsPrec ∷ Int → PartialOrderDatum → ShowS Source # show ∷ PartialOrderDatum → String Source # showList ∷ [PartialOrderDatum] → ShowS Source #
FromData PartialOrderDatum #
Instance details Defined in GeniusYield.Scripts.Dex.PartialOrder Methods fromBuiltinData ∷ BuiltinData → Maybe PartialOrderDatum Source #
ToData PartialOrderDatum #
Instance details Defined in GeniusYield.Scripts.Dex.PartialOrder Methods toBuiltinData ∷ PartialOrderDatum → BuiltinData Source #
UnsafeFromData PartialOrderDatum #
Instance details Defined in GeniusYield.Scripts.Dex.PartialOrder Methods unsafeFromBuiltinData ∷ BuiltinData → PartialOrderDatum Source #
type Rep PartialOrderDatum #
Instance details Defined in GeniusYield.Scripts.Dex.PartialOrder type Rep PartialOrderDatum = D1 ('MetaData "PartialOrderDatum" "GeniusYield.Scripts.Dex.PartialOrder" "geniusyield-dex-api-0.1.0.0-inplace" 'False) (C1 ('MetaCons "PartialOrderDatum" 'PrefixI 'True) (((S1 ('MetaSel ('Just "podOwnerKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 PubKeyHash) :: (S1 ('MetaSel ('Just "podOwnerAddr") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Address) :: S1 ('MetaSel ('Just "podOfferedAsset") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 AssetClass))) :: ((S1 ('MetaSel ('Just "podOfferedOriginalAmount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Integer) :: S1 ('MetaSel ('Just "podOfferedAmount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Integer)) :: (S1 ('MetaSel ('Just "podAskedAsset") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 AssetClass) :: S1 ('MetaSel ('Just "podPrice") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Rational)))) :: (((S1 ('MetaSel ('Just "podNFT") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 TokenName) :: S1 ('MetaSel ('Just "podStart") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe POSIXTime))) :: (S1 ('MetaSel ('Just "podEnd") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe POSIXTime)) :: S1 ('MetaSel ('Just "podPartialFills") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Integer))) :: ((S1 ('MetaSel ('Just "podMakerLovelaceFlatFee") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Integer) :: S1 ('MetaSel ('Just "podTakerLovelaceFlatFee") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Integer)) :: (S1 ('MetaSel ('Just "podContainedFee") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 PartialOrderContainedFee) :: S1 ('MetaSel ('Just "podContainedPayment") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Integer))))))

Partial order NFT policy

partialOrderNftPolicy #

Arguments

∷ GYDexApiQueryMonad m a
⇒ PORefs
→ m (GYMintingPolicy 'PlutusV2)	The minting policy of the partial order NFT.

partialOrderNftPolicyId #

Arguments

∷ GYDexApiQueryMonad m a
⇒ PORefs
→ m GYMintingPolicyId	The minting policy id of the partial order NFT.

Queries

partialOrders ∷ GYDexApiQueryMonad m a ⇒ PORefs → m (Map GYTxOutRef PartialOrderInfo) #

getPartialOrderInfo ∷ GYDexApiQueryMonad m a ⇒ PORefs → GYTxOutRef → m PartialOrderInfo #

Tx constructors

placePartialOrder #

Arguments

∷ GYDexApiMonad m a
⇒ PORefs
→ GYAddress	Order owner
→ (Natural, GYAssetClass)	Amount and asset to offer.
→ GYAssetClass	The asset being asked for as payment.
→ GYRational	The price for one unit of the offered asset.
→ Maybe GYTime	The earliest time when the order can be filled (optional).
→ Maybe GYTime	The latest time when the order can be filled (optional).
→ Maybe GYStakeCredential	Stake credential of user. We do not support pointer reference.
→ m (GYTxSkeleton 'PlutusV2)

placePartialOrder' #

Arguments

∷ (GYDexApiMonad m a, HasCallStack)
⇒ PORefs
→ GYAddress	Order owner
→ (Natural, GYAssetClass)	Amount and asset to offer.
→ GYAssetClass	The asset being asked for as payment.
→ GYRational	The price for one unit of the offered asset.
→ Maybe GYTime	The earliest time when the order can be filled (optional).
→ Maybe GYTime	The latest time when the order can be filled (optional).
→ Natural	Additional lovelace fee.
→ Natural	Additional fee in offered tokens.
→ Maybe GYStakeCredential	Stake credential of user. We do not support pointer reference.
→ GYTxOutRef
→ PartialOrderConfigInfoF GYAddress
→ m (GYTxSkeleton 'PlutusV2)

completelyFillPartialOrder #

Arguments

∷ (HasCallStack, GYDexApiMonad m a)
⇒ PORefs
→ GYTxOutRef	The order reference.
→ Maybe (GYTxOutRef, PartialOrderConfigInfoF GYAddress)
→ Natural	Additional taker fee in payment tokens.
→ m (GYTxSkeleton 'PlutusV2)

Completely fill a partially-fillable order.

partiallyFillPartialOrder #

Arguments

∷ (HasCallStack, GYDexApiMonad m a)
⇒ PORefs
→ GYTxOutRef	The order reference.
→ Natural	The amount of offered tokens to buy.
→ Maybe (GYTxOutRef, PartialOrderConfigInfoF GYAddress)
→ Natural	Additional taker fee in payment tokens.
→ m (GYTxSkeleton 'PlutusV2)

Partially fill a partially-fillable order.

fillPartialOrder #

Arguments

∷ (HasCallStack, GYDexApiMonad m a)
⇒ PORefs
→ GYTxOutRef	The order reference.
→ Natural	The amount of offered tokens to buy.
→ Maybe (GYTxOutRef, PartialOrderConfigInfoF GYAddress)
→ Natural	Additional taker fee in payment tokens.
→ m (GYTxSkeleton 'PlutusV2)

Fills an order. If the provided amount of offered tokens to buy is equal to the offered amount, then we completely fill the order. Otherwise, it gets partially filled.

fillPartialOrder' #

Arguments

∷ (HasCallStack, GYDexApiMonad m a)
⇒ PORefs
→ PartialOrderInfo	The order information.
→ Natural	The amount of offered tokens to buy.
→ Maybe (GYTxOutRef, PartialOrderConfigInfoF GYAddress)
→ Natural	Additional taker fee in payment tokens.
→ m (GYTxSkeleton 'PlutusV2)

Fills an order. If the provided amount of offered tokens to buy is equal to the offered amount, then we completely fill the order. Otherwise, it gets partially filled.

This differs from fillPartialOrder in that it takes fetched order information instead of it's reference.

fillMultiplePartialOrders ∷ (HasCallStack, GYDexApiMonad m a) ⇒ PORefs → [(GYTxOutRef, Natural)] → Maybe (GYTxOutRef, PartialOrderConfigInfoF GYAddress) → m (GYTxSkeleton 'PlutusV2) #

Fills multiple orders. If the provided amount of offered tokens to buy in an order is equal to the offered amount, then we completely fill the order. Otherwise, it gets partially filled.

completelyFillMultiplePartialOrders ∷ (HasCallStack, GYDexApiMonad m a) ⇒ PORefs → [GYTxOutRef] → Maybe (GYTxOutRef, PartialOrderConfigInfoF GYAddress) → m (GYTxSkeleton 'PlutusV2) #

Completely fill multiple orders.

fillMultiplePartialOrders' ∷ (HasCallStack, GYDexApiMonad m a) ⇒ PORefs → [(PartialOrderInfo, Natural)] → Maybe (GYTxOutRef, PartialOrderConfigInfoF GYAddress) → m (GYTxSkeleton 'PlutusV2) #

Fills multiple orders. If the provided amount of offered tokens to buy in an order is equal to the offered amount, then we completely fill the order. Otherwise, it gets partially filled.

cancelPartialOrder #

Arguments

∷ (HasCallStack, GYDexApiMonad m a)
⇒ PORefs
→ GYTxOutRef	The order reference.
→ m (GYTxSkeleton 'PlutusV2)

cancelPartialOrder' #

Arguments

∷ (HasCallStack, GYDexApiMonad m a)
⇒ PORefs
→ PartialOrderInfo	The order information.
→ m (GYTxSkeleton 'PlutusV2)

cancelMultiplePartialOrders ∷ (HasCallStack, GYDexApiMonad m a) ⇒ PORefs → [PartialOrderInfo] → m (GYTxSkeleton 'PlutusV2) #

Cancel multiple partial orders.

Utilities

partialOrderAddr ∷ GYDexApiQueryMonad m a ⇒ PORefs → m GYAddress #

partialOrderPrice ∷ PartialOrderInfo → Natural → GYValue #

partialOrderPrice' ∷ PartialOrderInfo → Natural → Natural #