Copyright	© 2021 IOHK
License	Apache-2.0
Safe Haskell	None
Language	Haskell2010

Cardano.Wallet.Primitive.Migration.Planning

Contents

Migration planning
UTxO entry categorization

Description

This module contains an algorithm for planning migrations at a high level.

It determines how to partition the UTxO set into entries of different types, and in which order to add entries to selections, in order to maximize the number of entries that can be successfully migrated.

Use createPlan to create a migration plan.

Synopsis

createPlan :: TxConstraints -> CategorizedUTxO input -> RewardWithdrawal -> MigrationPlan input
data MigrationPlan input = MigrationPlan {
- selections :: ![ Selection input]
- unselected :: !( CategorizedUTxO input)
- totalFee :: ! Coin
}
data CategorizedUTxO input = CategorizedUTxO {
- supporters :: ![(input, TokenBundle )]
- freeriders :: ![(input, TokenBundle )]
- ignorables :: ![(input, TokenBundle )]
}
data UTxOEntryCategory
- = Supporter
- | Freerider
- | Ignorable
categorizeUTxO :: TxConstraints -> UTxO -> CategorizedUTxO ( TxIn , TxOut )
categorizeUTxOEntries :: forall input. TxConstraints -> [(input, TokenBundle )] -> CategorizedUTxO input
categorizeUTxOEntry :: TxConstraints -> TokenBundle -> UTxOEntryCategory
uncategorizeUTxO :: CategorizedUTxO ( TxIn , TxOut ) -> UTxO
uncategorizeUTxOEntries :: CategorizedUTxO input -> [(input, TokenBundle )]

Migration planning

createPlan :: TxConstraints -> CategorizedUTxO input -> RewardWithdrawal -> MigrationPlan input Source #

Creates a migration plan for the given categorized UTxO set and reward withdrawal amount.

See MigrationPlan .

data MigrationPlan input Source #

Represents a plan for migrating a set of UTxO entries.

Use createPlan to create a migration plan.

Constructors

MigrationPlan
Fields selections :: ![ Selection input] A list of generated selections: each selection is the basis for a single transaction. unselected :: !( CategorizedUTxO input) The portion of the UTxO that was not selected. totalFee :: ! Coin The total fee payable: equal to the sum of the fees of the individual selections.

Instances

Instances details

Eq input => Eq ( MigrationPlan input) Source #
Instance details Defined in Cardano.Wallet.Primitive.Migration.Planning Methods (==) :: MigrationPlan input -> MigrationPlan input -> Bool Source # (/=) :: MigrationPlan input -> MigrationPlan input -> Bool Source #
Show input => Show ( MigrationPlan input) Source #
Instance details Defined in Cardano.Wallet.Primitive.Migration.Planning Methods showsPrec :: Int -> MigrationPlan input -> ShowS Source # show :: MigrationPlan input -> String Source # showList :: [ MigrationPlan input] -> ShowS Source #
Generic ( MigrationPlan input) Source #
Instance details Defined in Cardano.Wallet.Primitive.Migration.Planning Associated Types type Rep ( MigrationPlan input) :: Type -> Type Source # Methods from :: MigrationPlan input -> Rep ( MigrationPlan input) x Source # to :: Rep ( MigrationPlan input) x -> MigrationPlan input Source #
type Rep ( MigrationPlan input) Source #
Instance details Defined in Cardano.Wallet.Primitive.Migration.Planning type Rep ( MigrationPlan input) = D1 (' MetaData "MigrationPlan" "Cardano.Wallet.Primitive.Migration.Planning" "cardano-wallet-core-2022.7.1-AGKhlyz9liLKN3QqZD1gj" ' False ) ( C1 (' MetaCons "MigrationPlan" ' PrefixI ' True ) ( S1 (' MetaSel (' Just "selections") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 [ Selection input]) :: ( S1 (' MetaSel (' Just "unselected") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 ( CategorizedUTxO input)) :: S1 (' MetaSel (' Just "totalFee") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 Coin ))))

UTxO entry categorization

data CategorizedUTxO input Source #

Constructors

CategorizedUTxO
Fields supporters :: ![(input, TokenBundle )] freeriders :: ![(input, TokenBundle )] ignorables :: ![(input, TokenBundle )]

Instances

Instances details

Eq input => Eq ( CategorizedUTxO input) Source #
Instance details Defined in Cardano.Wallet.Primitive.Migration.Planning Methods (==) :: CategorizedUTxO input -> CategorizedUTxO input -> Bool Source # (/=) :: CategorizedUTxO input -> CategorizedUTxO input -> Bool Source #
Show input => Show ( CategorizedUTxO input) Source #
Instance details Defined in Cardano.Wallet.Primitive.Migration.Planning Methods showsPrec :: Int -> CategorizedUTxO input -> ShowS Source # show :: CategorizedUTxO input -> String Source # showList :: [ CategorizedUTxO input] -> ShowS Source #

data UTxOEntryCategory Source #

Constructors

Supporter	A coin or bundle that is capable of paying for its own marginal fee and the base transaction fee.
Freerider	A coin or bundle that is not capable of paying for itself.
Ignorable	A coin that should not be added to a selection, because its value is lower than the marginal fee for an input.

Instances

Instances details

Eq UTxOEntryCategory Source #
Instance details Defined in Cardano.Wallet.Primitive.Migration.Planning Methods (==) :: UTxOEntryCategory -> UTxOEntryCategory -> Bool Source # (/=) :: UTxOEntryCategory -> UTxOEntryCategory -> Bool Source #
Show UTxOEntryCategory Source #
Instance details Defined in Cardano.Wallet.Primitive.Migration.Planning Methods showsPrec :: Int -> UTxOEntryCategory -> ShowS Source # show :: UTxOEntryCategory -> String Source # showList :: [ UTxOEntryCategory ] -> ShowS Source #

categorizeUTxO :: TxConstraints -> UTxO -> CategorizedUTxO ( TxIn , TxOut ) Source #

categorizeUTxOEntries :: forall input. TxConstraints -> [(input, TokenBundle )] -> CategorizedUTxO input Source #

categorizeUTxOEntry :: TxConstraints -> TokenBundle -> UTxOEntryCategory Source #

uncategorizeUTxO :: CategorizedUTxO ( TxIn , TxOut ) -> UTxO Source #

uncategorizeUTxOEntries :: CategorizedUTxO input -> [(input, TokenBundle )] Source #