Provide a wallet-specific interface for coin selection. #3109
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jonathanknowles
force-pushed
the
jonathanknowles/cardano-wallet-coin-selection
branch
5 times, most recently
from
4859110
to
9c31da8
Compare
This commit provides the module `Cardano.Wallet.CoinSelection`, which provides a wallet-specific interface for coin selection. Wallet features requiring coin selection functionality should import from this module.
This commit: 1. Renames `Primitive.CoinSelection` to `CoinSelection.Internal`, making it more obvious that this module is an "internal" module. 2. Adds a disclaimer to the top of the module advising people to import from the "public" module instead.
jonathanknowles
force-pushed
the
jonathanknowles/cardano-wallet-coin-selection
branch
from
9c31da8
to
72dd574
Compare
jonathanknowles
changed the title
|
bors try |
tryBuild failed: Failure: |
HeinrichApfelmus
approved these changes
Feb 7, 2022
There was a problem hiding this comment.
I like it, looks good to me! Having a single module Cardano.Wallet.CoinSelection that exposes "everything you need to know about coin selection" encourages us to keep the abstraction boundary clean and simple — the "internals that you do not need to know about coin selection" are not exposed.
|
bors r+ |
|
Build succeeded: |
iohk-bors
bot
deleted the
jonathanknowles/cardano-wallet-coin-selection
branch
WilliamKingNoel-Bot
pushed a commit
that referenced
this pull request
Feb 7, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Issue Number
ADP-1407
Summary
This PR reorganizes the coin selection module hierarchy to have the following structure:
Cardano.Wallet.CoinSelectionprovides a stable, wallet-specific interface for coin selection, with wallet-friendly types such as
TxIn,TxOut, andUTxO.Cardano.Wallet.CoinSelection.Internal.*provides internal functions and types, whose definitions are allowed to deviate from those provided in the public module.
This PR also:
Cardano.Wallet.CoinSelection, rather thanCardano.Wallet.CoinSelection.Internal.