Address returnsGenerated being incorrect & add tests #119
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
…ty by running yarn upgrade
rareweasel
suggested changes
Nov 29, 2021
There was a problem hiding this comment.
@bsamuels453 Great job!!! Ben! Thank you very much for your contribution. I left some comments/questions.
| @@ -1,4 +1,4 @@ | |||
| #!/bin/sh | |||
| . "$(dirname "$0")/_/husky.sh" | |||
|
|
|||
| yarn lint:fix && git add -A | |||
There was a problem hiding this comment.
yarn lint:fix is still there; I removed git add -A because it kept including files in each commit that I did not want to commit yet. I kept running into issues where I would stage 1 or 2 files for commit, git commit them, then the commit includes every change that was in my working directory.
rareweasel
approved these changes
Nov 29, 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.
This PR fixes the issue reported here, and validates the fix using the new test suite. I can split the fix and tests into multiple PRs if needed.
The commit for the fix can be viewed here
This fix works by adding a balanceTokens field to VaultUpdate. This field reports on the balance of tokens managed by the Vault at the time of the update and is populated by vault.totalAssets();
The returnsGenerated field of VaultUpdate is now populated by comparing the balanceTokens of the previous update to the new balanceTokens. When taking token deposits and withdrawls into account, the difference between the balanceTokens of each update is a reliable proxy for recognized profit the vault has earned.
In addition, the logic for setting vault.latestUpdate, vault.balanceTokens, and vault.balanceTokensIdle has been moved to the createVaultUpdate function (previously this logic was duplicated in two separate spots).