Ctl.Internal.Testnet.DistributeFunds

data DistrFundsError wallet amount

Constructors

• DistrFunds_MaxUtxosPerTxLowerLimitError { maxUtxosPerTx :: Int }
• DistrFunds_AssignUtxoError { currentSources :: List (SourceState wallet amount), utxoToAssign :: wallet /\ amount }
• DistrFunds_MaxRoundsExceededError { maxRounds :: Int }

Instances

• Generic (DistrFundsError wallet amount) _
• (Eq wallet, Eq amount) => Eq (DistrFundsError wallet amount)
• (Show wallet, Show amount) => Show (DistrFundsError wallet amount)

type DistrFundsParams wallet amount = { feePerTx :: amount, getUtxoMinAdaForWallet :: wallet -> amount, maxRounds :: Int, maxUtxosPerTx :: Int }

type SourceState wallet amount = { currentTx :: Tx wallet amount, leftover :: amount, srcWallet :: wallet }

newtype Tx wallet amount

Constructors

• Tx { numUtxos :: Int, srcWallet :: wallet, utxos :: List { amount :: amount, wallet :: wallet } }

Instances

• Generic (Tx wallet amount) _
• Newtype (Tx wallet amount) _
• (Eq wallet, Eq amount) => Eq (Tx wallet amount)
• (Show wallet, Show amount) => Show (Tx wallet amount)
• Functor (Tx wallet)
• Bifunctor Tx
• Foldable (Tx wallet)
• Traversable (Tx wallet)

explainDistrFundsError :: forall wallet amount. Show wallet => Show amount => DistrFundsError wallet amount -> String

makeDistributionPlan :: forall wallet amount. Ord amount => Ring amount => DistrFundsParams wallet amount -> Array (wallet /\ amount) -> Array (wallet /\ amount) -> Either (DistrFundsError wallet amount) (Array (Array (Tx wallet amount)))

data AssignUtxoResult wallet amount

Constructors

• AssignUtxo_Unassigned
• AssignUtxo_Deferred
• AssignUtxo_AssignedToSource (SourceState wallet amount)

Instances

• Generic (AssignUtxoResult wallet amount) _
• (Eq wallet, Eq amount) => Eq (AssignUtxoResult wallet amount)
• (Show wallet, Show amount) => Show (AssignUtxoResult wallet amount)

assignUtxoToSource :: forall wallet amount. Ord amount => Ring amount => DistrFundsParams wallet amount -> SourceState wallet amount -> wallet /\ amount -> AssignUtxoResult wallet amount

Attempts to assign the specified target utxo to the given source. ADA value of the target utxo is expected to be normalized, i.e. utxo min-ada requirement should be taken into account.

initSourceState :: forall wallet amount. wallet -> amount -> SourceState wallet amount

runDistrFundsRound :: forall wallet amount. Ord amount => Ring amount => DistrFundsParams wallet amount -> List (SourceState wallet amount) -> List (wallet /\ amount) -> Either (DistrFundsError wallet amount) (DistrFundsRoundResult wallet amount)

Executes a single round of funds distribution, assigning the provided target utxos to the sources.

Some utxo may be deferred until the next round if they cannot be immediately covered by the sources due to the algorithm's parameters, even though the sources are sufficient.

If some of the target utxos cannot be covered by any source, a DistrFunds_AssignUtxoError will be returned.