New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Global optimistic auction rebalance extension #154

Merged

ckoopmann merged 20 commits into master from snakepoison/GlobalOptimisticAuctionRebalanceExtension

Nov 23, 2023

Contributor

snake-poison commented Oct 31, 2023 •

edited

Loading

UMA docs: https://docs.uma.xyz/

Interaction Flow closely resembles: https://github.com/UMAprotocol/protocol/blob/master/packages/core/contracts/optimistic-governor/implementation/OptimisticGovernor.sol

snake-poison added 8 commits

October 9, 2023 19:23


          feat: GlobalAuctionRebalanceExtension contract, tests & utils

e9f7523


          test: adds cases that increase coverage to 100%

2e294f8


          feat: prevent intialization when not ready.

936ccf8


          chore(deps): add @uma/core as devDep

91e8e2e


          ref(AuctionRebalance): startRebalance overridable

67266e7


          ref(OptimisticAuction): adds Initial contract.

0669be0


          feat: setProductSettings, proposeRebalance, override startRebalance.

c8fbc6d


          chore(deps): remove @uma/core dev dep.

19544d2

coveralls commented Oct 31, 2023 •

edited

Loading

coverage: 46.877% (-30.4%) from 77.323%
when pulling 0635ef6 on snakepoison/GlobalOptimisticAuctionRebalanceExtension
into ec7ce83 on master.

snake-poison commented

View reviewed changes

Contributor Author

snake-poison left a comment •

edited

Loading

Should add some internal functions that would DRY the contract a bit

Should also add some events.

contracts/global-extensions/GlobalOptimisticAuctionRebalanceExtension.sol Outdated Show resolved Hide resolved

contracts/global-extensions/GlobalOptimisticAuctionRebalanceExtension.sol Outdated Show resolved Hide resolved

contracts/global-extensions/GlobalOptimisticAuctionRebalanceExtension.sol Show resolved Hide resolved

contracts/global-extensions/GlobalOptimisticAuctionRebalanceExtension.sol Outdated

+                      require(assertionId != bytes32(0), "Proposal hash does not exist");
+                      delete assertionIds[proposalHash];
+                      delete proposalHashes[assertionId];

Contributor Author

snake-poison Oct 31, 2023

missed removing the assertedProducts here. probably a good idea to make an internal function that unsets these..

Contributor

pblivin0x Nov 15, 2023

bump to resolve @snake-poison

contracts/global-extensions/GlobalOptimisticAuctionRebalanceExtension.sol Outdated

+                      if (msg.sender == address(settings.optimisticParams.optimisticOracleV3)) {
+                          // Delete the disputed proposal and associated assertionId.
+                          delete assertionIds[proposalHash];
+                          delete proposalHashes[assertionId];

Contributor Author

snake-poison Oct 31, 2023

missed removing the assertedProducts here. probably a good idea to make an internal function that unsets these..

snake-poison added 3 commits

November 8, 2023 14:12


          test: derive unit test template for GlobalOptimisticAuctionRebalanceE…

59c7440

…xtension from GlobalAuctionRebalanceExtension.


          test: update deployment helper and barrel.

6ed60c4


          refactor: remove unused param from constructor.

0fb06d1

pblivin0x reviewed

View reviewed changes

contracts/global-extensions/GlobalOptimisticAuctionRebalanceExtension.sol Show resolved Hide resolved

pblivin0x reviewed

View reviewed changes

contracts/global-extensions/GlobalOptimisticAuctionRebalanceExtension.sol Outdated Show resolved Hide resolved

pblivin0x reviewed

View reviewed changes

contracts/global-extensions/GlobalOptimisticAuctionRebalanceExtension.sol Outdated Show resolved Hide resolved

pblivin0x reviewed

View reviewed changes

contracts/global-extensions/GlobalOptimisticAuctionRebalanceExtension.sol Outdated

+                  /* ============ External Functions ============ */
+                  /**
+                  * @dev OPERATOR ONLY: sets product settings for a given quote asset

Contributor

pblivin0x Nov 8, 2023

Suggested change

      
                * @dev OPERATOR ONLY: sets product settings for a given quote asset
          
                * @dev OPERATOR ONLY: sets product settings for a given set token

pblivin0x reviewed

View reviewed changes

contracts/global-extensions/GlobalOptimisticAuctionRebalanceExtension.sol Show resolved Hide resolved

pblivin0x reviewed

View reviewed changes

contracts/global-extensions/GlobalOptimisticAuctionRebalanceExtension.sol Outdated Show resolved Hide resolved

pblivin0x reviewed

View reviewed changes

contracts/global-extensions/GlobalOptimisticAuctionRebalanceExtension.sol Outdated

Comment on lines 176 to 183

+                      uint256 minimumBond = settings.optimisticParams.optimisticOracleV3.getMinimumBond(address(settings.optimisticParams.collateral));
+                      uint256 totalBond =  minimumBond > settings.optimisticParams.bondAmount ? minimumBond : settings.optimisticParams.bondAmount;
+                      settings.optimisticParams.collateral.safeTransferFrom(msg.sender, address(this), totalBond);
+                      settings.optimisticParams.collateral.safeIncreaseAllowance(address(settings.optimisticParams.optimisticOracleV3), totalBond);

Contributor

pblivin0x Nov 8, 2023

lets clean this up with some internal functions

pblivin0x reviewed

View reviewed changes

contracts/global-extensions/GlobalOptimisticAuctionRebalanceExtension.sol Show resolved Hide resolved

pblivin0x reviewed

View reviewed changes

contracts/global-extensions/GlobalOptimisticAuctionRebalanceExtension.sol Outdated Show resolved Hide resolved

snake-poison added 3 commits

November 9, 2023 09:15


          chore(deps): add base58 encode/decode lib.

563d4e7


          feat: add OOV3 mock.

3a25bb8


          test: extends to cover propose rebalance path.

b00bceb

pblivin0x assigned snake-poison and ckoopmann

ckoopmann reviewed

View reviewed changes

Collaborator

ckoopmann left a comment

Good stuff.
Mostly added questions for my own understanding.
Also might be worth to review all the docstrings at the end to make sure they align with the function implementations.

contracts/global-extensions/GlobalOptimisticAuctionRebalanceExtension.sol Outdated Show resolved Hide resolved

contracts/global-extensions/GlobalOptimisticAuctionRebalanceExtension.sol Show resolved Hide resolved

contracts/global-extensions/GlobalOptimisticAuctionRebalanceExtension.sol Outdated Show resolved Hide resolved

contracts/global-extensions/GlobalOptimisticAuctionRebalanceExtension.sol Show resolved Hide resolved

contracts/global-extensions/GlobalOptimisticAuctionRebalanceExtension.sol Outdated Show resolved Hide resolved

contracts/global-extensions/GlobalOptimisticAuctionRebalanceExtension.sol Outdated Show resolved Hide resolved

contracts/global-extensions/GlobalOptimisticAuctionRebalanceExtension.sol Show resolved Hide resolved

contracts/global-extensions/GlobalOptimisticAuctionRebalanceExtension.sol Show resolved Hide resolved

contracts/global-extensions/GlobalOptimisticAuctionRebalanceExtension.sol Show resolved Hide resolved

snake-poison added 2 commits

November 20, 2023 08:46


          refactor: add events, update docstrings.

937b6b4

 fix assertedProducts update.


          feat: emit events, simplify tracking assertion id relationships, refa…

013ddb4

…ctor out bonds.

snake-poison force-pushed the snakepoison/GlobalOptimisticAuctionRebalanceExtension branch from 07cb344 to c633ed5 Compare

November 22, 2023 00:31

snake-poison added 2 commits

November 21, 2023 19:42


          Merge branch 'master' into snakepoison/GlobalOptimisticAuctionRebalan…

cb0618d

…ceExtension


          docs: update contract natspec description.

snake-poison force-pushed the snakepoison/GlobalOptimisticAuctionRebalanceExtension branch from 08cdb1b to 0472543 Compare

November 22, 2023 00:47

snake-poison added 2 commits

November 21, 2023 20:04


          fix: add virtual keyword back and removed extra imports in utils.

0635ef6


          ref: refactor and doc updates.

1673e73

snake-poison marked this pull request as ready for review

November 22, 2023 03:24

ckoopmann approved these changes

View reviewed changes

Collaborator

ckoopmann left a comment

LGTM! Great Work 🚀

ckoopmann merged commit d5ab030 into master

2 checks passed

ckoopmann deleted the snakepoison/GlobalOptimisticAuctionRebalanceExtension branch

November 23, 2023 03:47

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet