Improve comment regarding settlement check #1739
Merged
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.
Summary
We do not check the transaction data when mapping a swap transfer to ensure it is a
settle
call. The addition of this check was marked with aTODO
.Having looked into the inclusion of this showed that we do not always have access to the transaction
data
, e.g. when getting all incoming transfers, we only have theTransfer
. As such, a detailed comment as been added explaining this, including assurance that the current implementation is sufficient.Changes