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

Cardano.Wallet.Primitive.Migration

Contents

Creating a migration plan

Description

This module provides a public API for planning wallet migrations.

Use createPlan to create a migration plan.

Synopsis

createPlan :: TxConstraints -> UTxO -> RewardWithdrawal -> MigrationPlan
data MigrationPlan = MigrationPlan {
- selections :: ![ Selection ( TxIn , TxOut )]
- unselected :: ! UTxO
- totalFee :: ! Coin
}
newtype RewardWithdrawal = RewardWithdrawal {
- unRewardWithdrawal :: Coin
}
data Selection input = Selection {
- inputIds :: !( NonEmpty input)
- inputBalance :: ! TokenBundle
- outputs :: !( NonEmpty TokenBundle )
- fee :: ! Coin
- feeExcess :: ! Coin
- size :: ! TxSize
- rewardWithdrawal :: ! Coin
}

Creating a migration plan

createPlan :: TxConstraints -> UTxO -> RewardWithdrawal -> MigrationPlan Source #

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

See MigrationPlan .

data MigrationPlan Source #

Represents a plan for migrating a UTxO set.

See createPlan to create a migration plan.

Constructors

MigrationPlan
Fields selections :: ![ Selection ( TxIn , TxOut )] A list of generated selections: each selection is the basis for a single transaction. unselected :: ! UTxO 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 MigrationPlan Source #
Instance details Defined in Cardano.Wallet.Primitive.Migration Methods (==) :: MigrationPlan -> MigrationPlan -> Bool Source # (/=) :: MigrationPlan -> MigrationPlan -> Bool Source #
Show MigrationPlan Source #
Instance details Defined in Cardano.Wallet.Primitive.Migration Methods showsPrec :: Int -> MigrationPlan -> ShowS Source # show :: MigrationPlan -> String Source # showList :: [ MigrationPlan ] -> ShowS Source #
Generic MigrationPlan Source #
Instance details Defined in Cardano.Wallet.Primitive.Migration Associated Types type Rep MigrationPlan :: Type -> Type Source # Methods from :: MigrationPlan -> Rep MigrationPlan x Source # to :: Rep MigrationPlan x -> MigrationPlan Source #
type Rep MigrationPlan Source #
Instance details Defined in Cardano.Wallet.Primitive.Migration type Rep MigrationPlan = D1 (' MetaData "MigrationPlan" "Cardano.Wallet.Primitive.Migration" "cardano-wallet-core-2022.7.1-AGKhlyz9liLKN3QqZD1gj" ' False ) ( C1 (' MetaCons "MigrationPlan" ' PrefixI ' True ) ( S1 (' MetaSel (' Just "selections") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 [ Selection ( TxIn , TxOut )]) :: ( S1 (' MetaSel (' Just "unselected") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 UTxO ) :: S1 (' MetaSel (' Just "totalFee") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 Coin ))))

newtype RewardWithdrawal Source #

Constructors

RewardWithdrawal
Fields unRewardWithdrawal :: Coin

Instances

Instances details

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

data Selection input Source #

A selection is the basis for a single transaction.

Use create to create a selection with one or more inputs. Use extend to extend a selection with an additional input. Use verify to verify the correctness of a selection.

Constructors

Selection

Fields

inputIds :: !( NonEmpty input)

The selected inputs.
inputBalance :: ! TokenBundle

The total balance of value provided by the inputs.
outputs :: !( NonEmpty TokenBundle )

The outputs, adjusted to pay for the fee.
fee :: ! Coin

The actual fee payable for this selection.
feeExcess :: ! Coin

The excess over the minimum permissible fee for this selection.
size :: ! TxSize

The size of this selection.
rewardWithdrawal :: ! Coin

The reward withdrawal amount, if any.

Instances

Instances details

Eq input => Eq ( Selection input) Source #
Instance details Defined in Cardano.Wallet.Primitive.Migration.Selection Methods (==) :: Selection input -> Selection input -> Bool Source # (/=) :: Selection input -> Selection input -> Bool Source #
Show input => Show ( Selection input) Source #
Instance details Defined in Cardano.Wallet.Primitive.Migration.Selection Methods showsPrec :: Int -> Selection input -> ShowS Source # show :: Selection input -> String Source # showList :: [ Selection input] -> ShowS Source #
Generic ( Selection input) Source #
Instance details Defined in Cardano.Wallet.Primitive.Migration.Selection Associated Types type Rep ( Selection input) :: Type -> Type Source # Methods from :: Selection input -> Rep ( Selection input) x Source # to :: Rep ( Selection input) x -> Selection input Source #
type Rep ( Selection input) Source #
Instance details Defined in Cardano.Wallet.Primitive.Migration.Selection type Rep ( Selection input) = D1 (' MetaData "Selection" "Cardano.Wallet.Primitive.Migration.Selection" "cardano-wallet-core-2022.7.1-AGKhlyz9liLKN3QqZD1gj" ' False ) ( C1 (' MetaCons "Selection" ' PrefixI ' True ) (( S1 (' MetaSel (' Just "inputIds") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 ( NonEmpty input)) :: ( S1 (' MetaSel (' Just "inputBalance") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 TokenBundle ) :: S1 (' MetaSel (' Just "outputs") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 ( NonEmpty TokenBundle )))) :: (( S1 (' MetaSel (' Just "fee") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 Coin ) :: S1 (' MetaSel (' Just "feeExcess") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 Coin )) :: ( S1 (' MetaSel (' Just "size") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 TxSize ) :: S1 (' MetaSel (' Just "rewardWithdrawal") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 Coin )))))