Generalize UTxO identifier type within UTxOIndex.
#3154
Merged
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
changed the title
UTxOIndexUTxOIndex.
jonathanknowles
force-pushed
the
jonathanknowles/use-type-parameter-for-utxo-identifier-in-utxo-index
branch
2 times, most recently
from
de16df5 to
3e8aa22
Compare
Anviking
approved these changes
Feb 23, 2022
| @@ -505,7 +508,7 @@ prop_selectRandom_one_withAdaOnly u = checkCoverage $ monadicIO $ do | |||
| -- This should only succeed if there is at least one element with a non-zero | |||
| -- quantity of the asset. | |||
| -- | |||
| prop_selectRandom_one_withAsset :: UTxOIndex -> AssetId -> Property | |||
| prop_selectRandom_one_withAsset :: UTxOIndex InputId -> AssetId -> Property | |||
There was a problem hiding this comment.
All these properties would work with any Ord i => UTxOIndex i right?
There was a problem hiding this comment.
All these properties would work with any Ord i => UTxOIndex i right?
Yes, precisely!
I haven't converted the test suites yet, but I'm thinking of making a simple TestUTxOKey type with generators and shrinkers for it.
I haven't done this yet, because I predict some effort (though not too much) with be required to maintain the coverage conditions.
| @@ -234,7 +234,7 @@ toList = fold (\ubs u b -> (u, b) : ubs) [] | |||
| -- Consider using 'fold' if your goal is to consume all entries in the output. | |||
| -- | |||
| toUTxO :: UTxOIndex u -> Map u TokenBundle | |||
| toUTxO = utxo | |||
| toUTxO = universe | |||
There was a problem hiding this comment.
utxos? allUTxOs? rawUTxO? Maybe universe is a bit too "dressed up"
There was a problem hiding this comment.
utxos?allUTxOs?rawUTxO? Maybeuniverseis a bit too dressed up
I take your point. 😄
How about everything?
jonathanknowles
force-pushed
the
jonathanknowles/coin-selection-compound-input-id
branch
from
59c9fbe to
a269694
Compare
We use the following convention for identifier names:
- `u` represents a unique identifier for an individual UTxO (unspent
transaction output).
- `b` represents a `TokenBundle` value.
- `i` represents an index of type `UTxOIndex`.
The former field name was confusing because it overloaded the term "UTxO" (used elsewhere in the module to refer to a single UTxO) with the complete set of UTxOs in the index.
These names better reflect the types involved.
jonathanknowles
force-pushed
the
jonathanknowles/use-type-parameter-for-utxo-identifier-in-utxo-index
branch
from
3e8aa22 to
6d8a198
Compare
jonathanknowles
merged commit 82c8e38
into
jonathanknowles/coin-selection-compound-input-id
jonathanknowles
deleted the
jonathanknowles/use-type-parameter-for-utxo-identifier-in-utxo-index
branch
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-1418
Summary
This PR adds the type parameter
uto theUTxOIndextype, to represent unique UTxO identifiers. The parameterucan be instantiated to any type for which there is anOrdinstance.Additional Work
This PR also:
UTxOIndexmodule to reflect theUTxOIndextype's generality.UTxOIndexaccording to the following scheme:-
urepresents a unique identifier for an individual UTxO (unspent transaction output).-
brepresents aTokenBundlevalue.-
irepresents an index of typeUTxOIndex.UTxOIndex.{to,from}UTxOtoUTxOIndex.{to,from}Map, since these functions really do produce and consume values of typeMap.utxoof typeUTxOIndextouniverse, to avoid overloading the termUTxO, which refers to a single unspent transaction output in this module.