[Parser] Update parser.MatchOperations to do non-negative and non-positive matching #305
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
KNWR
changed the title
KNWR
commented
Mar 11, 2021
septerr
reviewed
Mar 16, 2021
parser/match_operations.go
Outdated
| PositiveAmountSign = 2 | ||
|
|
||
| // PositiveOrZeroAmountSign is a positive or zero amount. | ||
| PositiveAmountSignOrZero = 3 |
There was a problem hiding this comment.
Comment (PositiveOrZeroAmountSign ) and constant names (PositiveAmountSignOrZero ) don't match.
I would personally prefer PositiveOrZeroAmountSign, for naming consistency, even though zero is not a sign.
parser/match_operations.go
Outdated
| PositiveAmountSignOrZero = 3 | ||
|
|
||
| // NegativeOrZeroAmountSign is a positive or zero amount. | ||
| NegativeAmountSignOrZero = 4 |
| // OppositeZeroAmounts are specified using the operation indices of | ||
| // OperationDescriptions to handle out of order matches. MatchOperations | ||
| // will error if all groups of operations aren't 0 or opposites. | ||
| OppositeOrZeroAmounts [][]int |
There was a problem hiding this comment.
Name in comment (OppositeZeroAmounts ) and constant name (OppositeOrZeroAmounts ) do not match.
parser/match_operations.go
Outdated
| oppositeAmountCheckers := []func(*types.Operation, *types.Operation) error{ | ||
| oppositeOrZeroAmounts, | ||
| oppositeAmounts, | ||
| } |
There was a problem hiding this comment.
The 3d array makes grasping the code kinda difficult (this file is pretty difficult to read as is :( ).
Can we instead utilize a function to which we pass amountPairs, amountChecker and anything else that is needed (matches) and call it twice. Once for OppositeAmounts and once for OppositeOrZeroAmounts ? 🙏
septerr
previously approved these changes
Mar 17, 2021
KNWR
force-pushed
the
add-nonnegative-and-non-positive-matching
branch
2 times, most recently
from
cd25d86 to
fa48c1d
Compare
septerr
previously approved these changes
Mar 17, 2021
…mount operations. Also add corresponding validation function and test
…y change value of a variable just by adding a line in the wrong place.
KNWR
force-pushed
the
add-nonnegative-and-non-positive-matching
branch
from
fa48c1d to
da643b1
Compare
septerr
approved these changes
Mar 17, 2021
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.
Motivation
There are several cases where the matcher may expect opposite amounts but zero amounts are sent. Instead of having clients implement additional fallback logic, we want to update the sdk to be able to handle non-negative or non-positive scenarios when expecting opposite amounts.
Solution
Add a new OppositeOrZeroAmounts matcher and corresponding matching logic instead of replacing the existing OppositeAmounts matcher. This way, this isn't a breaking change for other users of the library.
Add PositiveAmountSignOrZero and NegativeAmountSignOrZero amount signs for amount matching when using
OppositeOrZeroAmounts. We could just use AnyAmountSign, but these additional signs let us get the same order of matches as withOppositeAmounts.Open questions
MatchOperationsmatter?