[SC-213] Feat: Reserve Vault#665
Merged
Zitzak merged 12 commits intofeature/ToposFundingManagerfrom Oct 8, 2024
Merged
Conversation
Zitzak
requested changes
Oct 2, 2024
src/modules/fundingManager/extensions/interfaces/IFM_EXT_TokenVault_v1.sol
Outdated
Show resolved
Hide resolved
test/modules/fundingManager/extensions/FM_EXT_TokenVault_v1.t.sol
Outdated
Show resolved
Hide resolved
| // Errors | ||
| import {OZErrors} from "test/utils/errors/OZErrors.sol"; | ||
|
|
||
| contract FM_EXT_TokenVault_v1Test is ModuleTest { |
Collaborator
There was a problem hiding this comment.
We don't have any Gherkin in the file.
I've just checked if ChatGPT could help with that and it's pretty good, which could safe you some time. Example:
/* Test validAmount() modifier
├── Given the vault contains a specific amount of tokens
│ └── And the amount is equal to 0
│ └── When the withdraw() function is called
│ └── Then the transaction should revert with Module__FM_EXT_TokenVault__InvalidAmount error
└── Given the amount is greater than 0
└── When the withdraw() function is called
└── Then the transaction should succeed
*/
Contributor
Author
There was a problem hiding this comment.
I test both conditions here
The first one in the test itself
The second in the modifier in position / the modifier test itself
Collaborator
There was a problem hiding this comment.
I will be adding some gherkin to your tests. Will prob do that somewhere later today/tomorrow
Collaborator
|
@FHieser Added Gherkin to the test files and changed a few other things based on our dev guidelines. However somehow I don't get 2 tests to work, but no clue why and have already spent to long on it. Could you take a look at it please 🙏 |
FHieser
changed the base branch from
dev
to
sc-98-create-topos-funding-manager
FHieser
changed the base branch from
sc-98-create-topos-funding-manager
to
feature/ToposFundingManager
marvinkruse
force-pushed
the
sc-213-reserve-vault
branch
2 times, most recently
from
9ebcf30 to
1e06f23
Compare
Zitzak
added a commit
that referenced
this pull request
Feb 24, 2025
* [SC-213] Feat: Reserve Vault (#665) * Create Reservepool Contract * Rename and adapt * Create FM_EXT_ReservePool_v1.t.sol * Rename to TokenVault * Adapt to not send native token * Address comments * Add: - Internal function to modifier - Trailing underscore to parameters - Gherkin to test - Cleaned up tests * Update FM_EXT_TokenVault_v1.t.sol --------- Co-authored-by: Zitzak <marvin88gr@gmail.com> Co-authored-by: Marvin <43185740+Zitzak@users.noreply.github.com> * Chore: Clean up TokenVault * Feat: Add FM_BC_BondingSurface_Redeemable_Repayer_Seizable_v1 (#666) * Create Reservepool Contract * Rename and adapt * Create FM_EXT_ReservePool_v1.t.sol * Topos FM * remove liquidity vault controller contracts * Rename to TokenVault * Adapt to not send native token * Rename to Token Vault * Address comments * Outcomment Burn tests for now * Create setTokenVault * Fix most Burn functions * AddSpentAllowance to ERC20Issuance * Add _spendAllowance to BondingCurveBase * Add _spendAllowance to BurnIssuanceFor * Fix Dependency Issue * Rename Redeemable to Redeeming * Create FM_BC_BondingSurface_Redeeming_v1.sol * WIP * Add: - Internal function to modifier - Trailing underscore to parameters - Gherkin to test - Cleaned up tests * restructure contracts * Add tag for testing file split * Setup seperate Tests * Update Base BondingSurface test * Rename Mock * Remove Tests that are included in the base contract * Remove parameters from BondingSurface Struct * Go over comments * Address comments * Address Comments * Adapt Naming of events * Adding Restricted to the name * Update comments * resolve comments in implementations * Fix: Finalize moving of error into funding manager base * Fix: Typos in ERC20Issuance * Chore: Start cleanup of FM_BC's * Fix: Resolve failing test Was mismatched with implementation, didn't cover the address(this) case. --------- Co-authored-by: FHieser <felix_hieser@web.de> Co-authored-by: Felix Hieser <47272854+FHieser@users.noreply.github.com> Co-authored-by: Marvin Kruse <marvinkruse@users.noreply.github.com> * Sc 720 expand unit tests for topos related modules (#676) * Add empty BondingSurface test file * Remove tokenVault from init The tokenvault cant be set during init because is created simultaneously to the BondingCurve contract. It has to be added via Dependency Injection * Remove unnecessary overrides * Add and adapt tests * Adapt inheritance of functions * Update Comments * Update Tests * Update fmt * Add event to projectFeeCollected * Address comments of PR --------- Co-authored-by: Zitzak <marvin88gr@gmail.com> * Sc 828 address omega review comments (#680) * Add empty BondingSurface test file * Remove tokenVault from init The tokenvault cant be set during init because is created simultaneously to the BondingCurve contract. It has to be added via Dependency Injection * Remove unnecessary overrides * Add and adapt tests * Adapt inheritance of functions * Update Comments * Update Tests * Update fmt * Add event to projectFeeCollected * Address comments of PR * Revert if redeemamount reaches Min Reserve * Check for Min Reserve in TransferOrchestrator Token * Add MinReserveCheck to transferRepayment * Rename Modifier * Remove time casting * Enable BuyFee * Use function that can be overriden * Add gap * Make Min_Reserves variable based on Token Decimals * Use SpotPrice to get StaticPrice * adapt based on comments * Update FM_BC_BondingSurface_Redeeming_v1.t.sol --------- Co-authored-by: Zitzak <marvin88gr@gmail.com> * Refactor Update the BondingSurface implementation to represent the code of conduct * Add empty BondingSurface test file * Remove tokenVault from init The tokenvault cant be set during init because is created simultaneously to the BondingCurve contract. It has to be added via Dependency Injection * Remove unnecessary overrides * Add and adapt tests * Adapt inheritance of functions * Update Comments * Update Tests * Update fmt * Add event to projectFeeCollected * Address comments of PR * Revert if redeemamount reaches Min Reserve * Check for Min Reserve in TransferOrchestrator Token * Add MinReserveCheck to transferRepayment * Rename Modifier * Remove time casting * Enable BuyFee * Use function that can be overriden * Add gap * Make Min_Reserves variable based on Token Decimals * Use SpotPrice to get StaticPrice * adapt based on comments * Update FM_BC_BondingSurface_Redeeming_v1.t.sol * WIP push * Rename seizable * Make state internal * Rename Parameters and Return Values * Rename Contracts * Adapt to code of conduct * Adapting Interfaces to have Contract Overview Documentation * Adapt Sectioning * Adapt Mocks and Tests to parameter conventions * Remove Todos/notes * Adapt merge aftermath * Update BondingSurface.sol * Rename to prevent shadow * Adapt remapping * Address comments * Adapt init * Update inverter standard versioning * Delete FM_BC_BondingSurface_RedeemingV1_exposed.sol * Adapt Contract Naming Standards * Fix naming references * Fix test * Update naming reference * Adapt modifier to call internal function * Adapt naming of internal function * update modifier Naming * Adapt tests * Adapt naming internal functions * Adapt Parameters * Adapt naming of function state * Adapt sections * Update Interface Inheritance * Update versioning * Update natspec to be rule compliant * Fix naming * Delete ILiquidityVaultProviderWhitelist_v1.sol * Remove Liquidity Vault Controller Interface * Rename Modifier * Add solmate as lib * Revert "Add solmate as lib" This reverts commit 050b9d2. * Remove comment * Adapt natspec * Apply comment suggestions from code review Co-authored-by: Marvin Kruse <marvinkruse@users.noreply.github.com> * Adapt internal function state * Add . to comments * Adapt spacing in natspec comments * Adapt spacing * Replace @dev with @notice * Adapt comment length * Adapt naming * Address Comments * Adapt Version * Reposition MIN_RESERVE * Adapt sectioning * Update more sectioning * Add title section and increment version --------- Co-authored-by: Zitzak <marvin88gr@gmail.com> Co-authored-by: Marvin Kruse <marvinkruse@users.noreply.github.com> * Add before and afterSell functionalities * Add new contracts to scripts * Rename Files to contain .t * Add BondingSurface E2E * Use ModuleRole * Finish e2e tests * Add Documentation * Adapt the Deployment Parameters * Create Contract Template.md * 4/5 tests passing * Create BondingSurface.md * Fix missing tests * update comment about eror tolerance * refactor: resolve renaming mismatch in contracts * fix: resolve RPC issue on tests --------- Co-authored-by: Felix Hieser <47272854+FHieser@users.noreply.github.com> Co-authored-by: Zitzak <marvin88gr@gmail.com> Co-authored-by: Marvin <43185740+Zitzak@users.noreply.github.com> Co-authored-by: FHieser <felix_hieser@web.de> Co-authored-by: 0xNuggan <82726722+0xNuggan@users.noreply.github.com>
0xNuggan
added a commit
that referenced
this pull request
Apr 8, 2025
* [SC-213] Feat: Reserve Vault (#665) * Create Reservepool Contract * Rename and adapt * Create FM_EXT_ReservePool_v1.t.sol * Rename to TokenVault * Adapt to not send native token * Address comments * Add: - Internal function to modifier - Trailing underscore to parameters - Gherkin to test - Cleaned up tests * Update FM_EXT_TokenVault_v1.t.sol --------- Co-authored-by: Zitzak <marvin88gr@gmail.com> Co-authored-by: Marvin <43185740+Zitzak@users.noreply.github.com> * Chore: Clean up TokenVault * Feat: Add FM_BC_BondingSurface_Redeemable_Repayer_Seizable_v1 (#666) * Create Reservepool Contract * Rename and adapt * Create FM_EXT_ReservePool_v1.t.sol * Topos FM * remove liquidity vault controller contracts * Rename to TokenVault * Adapt to not send native token * Rename to Token Vault * Address comments * Outcomment Burn tests for now * Create setTokenVault * Fix most Burn functions * AddSpentAllowance to ERC20Issuance * Add _spendAllowance to BondingCurveBase * Add _spendAllowance to BurnIssuanceFor * Fix Dependency Issue * Rename Redeemable to Redeeming * Create FM_BC_BondingSurface_Redeeming_v1.sol * WIP * Add: - Internal function to modifier - Trailing underscore to parameters - Gherkin to test - Cleaned up tests * restructure contracts * Add tag for testing file split * Setup seperate Tests * Update Base BondingSurface test * Rename Mock * Remove Tests that are included in the base contract * Remove parameters from BondingSurface Struct * Go over comments * Address comments * Address Comments * Adapt Naming of events * Adding Restricted to the name * Update comments * resolve comments in implementations * Fix: Finalize moving of error into funding manager base * Fix: Typos in ERC20Issuance * Chore: Start cleanup of FM_BC's * Fix: Resolve failing test Was mismatched with implementation, didn't cover the address(this) case. --------- Co-authored-by: FHieser <felix_hieser@web.de> Co-authored-by: Felix Hieser <47272854+FHieser@users.noreply.github.com> Co-authored-by: Marvin Kruse <marvinkruse@users.noreply.github.com> * Sc 720 expand unit tests for topos related modules (#676) * Add empty BondingSurface test file * Remove tokenVault from init The tokenvault cant be set during init because is created simultaneously to the BondingCurve contract. It has to be added via Dependency Injection * Remove unnecessary overrides * Add and adapt tests * Adapt inheritance of functions * Update Comments * Update Tests * Update fmt * Add event to projectFeeCollected * Address comments of PR --------- Co-authored-by: Zitzak <marvin88gr@gmail.com> * Sc 828 address omega review comments (#680) * Add empty BondingSurface test file * Remove tokenVault from init The tokenvault cant be set during init because is created simultaneously to the BondingCurve contract. It has to be added via Dependency Injection * Remove unnecessary overrides * Add and adapt tests * Adapt inheritance of functions * Update Comments * Update Tests * Update fmt * Add event to projectFeeCollected * Address comments of PR * Revert if redeemamount reaches Min Reserve * Check for Min Reserve in TransferOrchestrator Token * Add MinReserveCheck to transferRepayment * Rename Modifier * Remove time casting * Enable BuyFee * Use function that can be overriden * Add gap * Make Min_Reserves variable based on Token Decimals * Use SpotPrice to get StaticPrice * adapt based on comments * Update FM_BC_BondingSurface_Redeeming_v1.t.sol --------- Co-authored-by: Zitzak <marvin88gr@gmail.com> * Refactor Update the BondingSurface implementation to represent the code of conduct * Add empty BondingSurface test file * Remove tokenVault from init The tokenvault cant be set during init because is created simultaneously to the BondingCurve contract. It has to be added via Dependency Injection * Remove unnecessary overrides * Add and adapt tests * Adapt inheritance of functions * Update Comments * Update Tests * Update fmt * Add event to projectFeeCollected * Address comments of PR * Revert if redeemamount reaches Min Reserve * Check for Min Reserve in TransferOrchestrator Token * Add MinReserveCheck to transferRepayment * Rename Modifier * Remove time casting * Enable BuyFee * Use function that can be overriden * Add gap * Make Min_Reserves variable based on Token Decimals * Use SpotPrice to get StaticPrice * adapt based on comments * Update FM_BC_BondingSurface_Redeeming_v1.t.sol * WIP push * Rename seizable * Make state internal * Rename Parameters and Return Values * Rename Contracts * Adapt to code of conduct * Adapting Interfaces to have Contract Overview Documentation * Adapt Sectioning * Adapt Mocks and Tests to parameter conventions * Remove Todos/notes * Adapt merge aftermath * Update BondingSurface.sol * Rename to prevent shadow * Adapt remapping * Address comments * Adapt init * Update inverter standard versioning * Delete FM_BC_BondingSurface_RedeemingV1_exposed.sol * Adapt Contract Naming Standards * Fix naming references * Fix test * Update naming reference * Adapt modifier to call internal function * Adapt naming of internal function * update modifier Naming * Adapt tests * Adapt naming internal functions * Adapt Parameters * Adapt naming of function state * Adapt sections * Update Interface Inheritance * Update versioning * Update natspec to be rule compliant * Fix naming * Delete ILiquidityVaultProviderWhitelist_v1.sol * Remove Liquidity Vault Controller Interface * Rename Modifier * Add solmate as lib * Revert "Add solmate as lib" This reverts commit 050b9d2. * Remove comment * Adapt natspec * Apply comment suggestions from code review Co-authored-by: Marvin Kruse <marvinkruse@users.noreply.github.com> * Adapt internal function state * Add . to comments * Adapt spacing in natspec comments * Adapt spacing * Replace @dev with @notice * Adapt comment length * Adapt naming * Address Comments * Adapt Version * Reposition MIN_RESERVE * Adapt sectioning * Update more sectioning * Add title section and increment version --------- Co-authored-by: Zitzak <marvin88gr@gmail.com> Co-authored-by: Marvin Kruse <marvinkruse@users.noreply.github.com> * Add before and afterSell functionalities * Add new contracts to scripts * Rename Files to contain .t * Add BondingSurface E2E * Use ModuleRole * Finish e2e tests * Add Documentation * Adapt the Deployment Parameters * Create Contract Template.md * 4/5 tests passing * Create BondingSurface.md * Fix missing tests * update comment about eror tolerance * refactor: resolve renaming mismatch in contracts * fix: resolve RPC issue on tests --------- Co-authored-by: Felix Hieser <47272854+FHieser@users.noreply.github.com> Co-authored-by: Zitzak <marvin88gr@gmail.com> Co-authored-by: Marvin <43185740+Zitzak@users.noreply.github.com> Co-authored-by: FHieser <felix_hieser@web.de> Co-authored-by: 0xNuggan <82726722+0xNuggan@users.noreply.github.com>
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Renamed to Token Vault