startNextEpochProcess unit & integration test #11191

soloseng · 2024-08-19T23:51:20Z

Description

Implements unit and integration tests for epochManager contract

Other changes

Describe any minor or "drive-by" changes here.

Tested

An explanation of how the changes were tested or an explanation as to why they don't need to be.

Related issues

Backwards compatibility

Brief explanation of why these changes are/are not backwards compatible.

Documentation

The set of community facing docs that have been added/modified because of this change

gitguardian · 2024-08-19T23:51:58Z

️✅ There are no secrets present in this pull request anymore.

If these secrets were true positive and are still valid, we highly recommend you to revoke them.
Once a secret has been leaked into a git repository, you should consider it compromised, even if it was deleted immediately.
Find here more information about risks.

^{_{🦉 GitGuardian detects secrets in your source code to help developers and security teams secure the modern development process. You are seeing this because you or someone else with access to this repository has authorized GitGuardian to scan your pull request.}}

packages/protocol/test-sol/integration/EpochManagerIntegration.sol

…ss-unit-and-integration-test

Fails when it hits a precompile in `EpochRewards.sol`

Still missing tests

mcortesi · 2024-08-21T17:22:41Z

packages/protocol/contracts/common/interfaces/IEpochManager.sol


-interface IEpochManager is IBlocker {
+interface IEpochManager{


Add timestamp to initialize

add startNextEpoch() and finishNextepcohProcess

uncomment the rest or remove

We are currently using getting block.timestamp within the initializeSystem function and assigning it to the L2 epoch start time.

were you thinking of also storing the timestamp of the last know block on L1 as well?

fix name conflict

…ss-unit-and-integration-test

packages/protocol/contracts-0.8/common/test/MockCeloToken.sol

packages/protocol/contracts-0.8/governance/test/MockElection.sol

packages/protocol/contracts/common/UsingRegistry.sol

martinvol · 2024-09-10T20:02:17Z

packages/protocol/migrations_sol/Migration.s.sol

@@ -930,6 +936,41 @@ contract Migration is Script, UsingRegistry, MigrationsConstants {
    );
  }

+  function migrateEpochManagerEnabler() public {


This should be added to the L2 scripts rather than this one, right?

this contract should be deployed on L1, because it will have to store the epoch state in the contract so that it can initialize the epochManager

wont do then

not sure I understand what you mean.

packages/protocol/test-sol/devchain/migration/Migration.t.sol

…ss-unit-and-integration-test

martinvol · 2024-09-16T15:47:37Z

packages/protocol/test-sol/unit/common/EpochManager.t.sol

    carbonOffsettingPartner = actor("carbonOffsettingPartner");
    communityRewardFund = actor("communityRewardFund");

-    deployCodeTo("Registry.sol", abi.encode(false), REGISTRY_ADDRESS);
-    deployCodeTo("GoldToken.sol", abi.encode(false), celoTokenAddress);
+    deployCodeTo("MockRegistry.sol", abi.encode(false), REGISTRY_ADDRESS);


Do we need MockRegistry? Wouldn't something like that's already on the PR?

function whenL2(Vm vm) public { vm.etch(0x4200000000000000000000000000000000000018, abi.encodePacked(bytes1(0x01))); }

It's fine to use the above code for the L2 check because that gets deployed to the proxyAdmin address. For the case of the registry, we need the actual registry code for the tests to work. So deploying arbitrary code to the registry address will not work.

martinvol · 2024-09-16T15:59:20Z

packages/protocol/contracts-0.8/governance/Validators.sol

+  function mintStableToEpochManager(
+    uint256 amount
+  ) external onlyL2 nonReentrant onlyRegisteredContract(EPOCH_MANAGER_REGISTRY_ID) {
+    require(amount > 0, "mint amount is zero.");


I think it's dangerous to have this call here, transfers with zero value are valid, and if someone hits that edge case then this system will stall.

(which doesn't mean that we shouldn't try to avoid zero calls to this function to save gas)

Could you elaborate more on the danger of this check?

Removed it, as a zero value wont negatively affect any code after the call.

packages/protocol/contracts-0.8/governance/Validators.sol

packages/protocol/test-sol/unit/governance/validators/Validators.t.sol

* first compiling draft no working test. Co-authored-by: Martín Volpe <[email protected]> * Compiler fixes + finishNextEpochProcess * allocateValidatorsRewards compilable * First few tests * test fix * uisng registry instead * updated registry ID var names * typo * ++ mock contracts in 0.8 * ++ passing test using mock * Removal of using precompiles * ScoreManager refactor * Decouple epoch manager initializer from registry * isReadyToStartEpoch fix * startNextEpochProcess fixes * rename score manager to score reader * Rename transfer to release on CeloDistribution schedule * Celo distribution schedule renamed to CeloUnreleasedTreasure * conditions to getFirstBlockAtEpoch and getLastBlockAtEpoch * ScoreManager update * getFirstBlockOfEpoch in EpochManager initializer * extra checks * introduce new getValidatorsGroup * systemAlreadyInitialized update * Removal of IEpochManagerInterface * Made CI run on feature branch * merge fix * Added target for the CI * Fixed quote celo-monorepo.yml * Allow Validator registration in L2 without BLS key (#11181) * Allow validator registration in L2 without BLS key * Reallow ECDSA key change in L2 --------- Co-authored-by: Martín Volpe <[email protected]> * Fix CI * Fixed interfaces and imports * Build fix * lint * prettify * prettify 2 * Attempt to fix truffle build and migrations l2 epoch (#11190) * Added Blocking to LockedGold, Election (#11186) * add EpochManager to abis * force deploy abis * build fix * Move Validators.sol to 0.8 (#11192) * WIP * Validator test WIP, forge doesn't compile yet * buildable * most of the foundry tests working * Validator related tests fixed * truffle build working * cache bump * lint + prettify+ migrations * Enable optimization for Solidity 0.8 * prettify * Ci bump * CI bump 2 * Validators to 0.8 config * CI bump * foundry fix * Truffle migrations are partly fixed * Added import for ValidatorsMock08 in EpochManager.t.sol, I think it was removed by mistake * Added yarn.lock * Changes to mock with full implementation * Attempt to fix linking libraries not working with deployCodeTo foundry-rs/foundry#4049 * truffle migrations fixed * CI bump * lint * forge test fixes * artifacts test fix * lint * update of foundry version * add ProxyFactory import to tests * library linking fix * Foundry migrations fix * migration tests fix * CI bump * Little cleanup + retrigger CI * forgot to commit Validators.sol * Fixed the ABI encoded * lint * Fix contract versions * add Adapter to ignored contracts * revert of ReentrancyGuard change * lint fix * remove adapters from check * storage layout fix --------- Co-authored-by: pahor167 <[email protected]> * force release of canary abi * force new canary version * npm tag revert * Soloseng/update-l2-getepochnumber-logic (#11195) * disable getEpochSize on L2 * update registry * update relevant interfaces * update contracts with L2 `getEpochNumber()` logic * update tests with L2 `getEpochNumber()` logic * ++ TODO * moved constants to constants file * updated allocated supply function to handle L1 & L2 cases * made `epochManager.currenEpochNumber()` private, to avoid returning 0 when not initialized. * PR feedback * Passing validators test using mockEpochManager for L2 tests * clean up * fixed other failing tests * using mockEpochManager instead of interface. Fixed failing tests. * happy linter * revert npm tag ∆ * ++ TODO and comment * add score manager to abis * Split initEpochManager Function (#11199) * ++ contract function * ++ comment * startNextEpochProcess unit & integration test (#11191) * unit test with mocks * ++ integration tests * clean up * -- logging * removed duplicate interface * using `MockCeloToken` to get test to pass. Fails when it hits a precompile in `EpochRewards.sol` * removed endEpochTimestamp * moved IEpochManager to 0.5 folder * added L2 conditions for EpochRewards functions using precompiles Still missing tests * renamed EpochManagerInitializer due to name conflict * ++ more unit test * setup anvil migration fix name conflict * compiles * ++ require fund in unreleased treasury * Updated regex * ++ registry 0.8 for testing only * clean up * ++ unit test * initial integration test using L1 devchain * ++ comment * -- forge based integration test * ++ to const * happy linter * update contract name * ++ PR feedback * ++ checks * updated carbon address * proxy stableToken mint call via Validators contract * -- duplicate imports * removed registry08. replaced with vm call * PR feedback * -- coment * passing unit tests * clean up * ++ mintStable test * -- TODO; compiles test when filtering * PR feedback * updated migration script to add more validators * passing integration test * removed test for zero amount * yarn build fix * clean up comments && TODO * revert change as out of scope * E2E EpochManager test + Epoch truffle migrations & Anvil L2 migration build fix (#11198) * Soloseng/dynamically-fetch-epochmanagerenabler-address (#11207) * dynamically fetch epochManagerEnabler && carbonOffsettingPartner ++ to registry * PR feedback * removed onlyL1 modifier in setter functions * updated unit test to reflect changes * fixing tests * fix test * fixed migration data * fixed migration script error * removed unused modifier * removed duplicate or unused code * Implement sending of allocated validator payments (#11197) * EpochManager fixes (#11208) * truffle build fix * build fix * PR comments * prettify * rename of registerValidator overload * bug fix * extensing epochManager e2e test * yarn lint * Reset pending payment to 0 after sending (#11209) Reset pending payment to 0 when sending * Deleted duplicated import * Make captureEpochAndValidators work in constant time (#11210) * Use more general interface for token transfer (#11216) * Epoch manager enabler tests (#11213) * ++ basic test * -- celoToken balance check * cleanup comments * use celoToken instead of native token for `initializeSystem` balance check * ++ more test * removed additional epochs * Make sendValidatorPayment nonReentrant (#11217) * Martinvol/return account instead of signer (#11215) * EpochManager e2e tests add/remove validators between ecpochs (#11214) * Send validator payment on actions that would modify reward distribution (#11211) * Rename `CeloUnreleasedTreasure` to `CeloUnreleasedTreasury` (#11220) * updated `CeloUnrealeasedTreasure` to `CeloUnreleasedTreasury` * update `CeloUnreleasedTreasury` initial balance to use defined constant * renamed file * prevent CELO transfers to `CeloUnreleasedTreasury` * ++ comment * unused import * using internal accounting for released amount * updated integration test * PR feedback * PR feedback * reverted due to gas consideration * more revert --------- Co-authored-by: Martín Volpe <[email protected]> Co-authored-by: pahor167 <[email protected]> Co-authored-by: Martín Volpe <[email protected]> Co-authored-by: Martín Volpe <[email protected]> Co-authored-by: Martin <[email protected]> Co-authored-by: pahor167 <[email protected]>

unit test with mocks

f9979ce

soloseng changed the base branch from master to feat/l2-epoch-system August 19, 2024 23:52

++ integration tests

75bf938

soloseng commented Aug 20, 2024

View reviewed changes

packages/protocol/test-sol/integration/EpochManagerIntegration.sol Outdated Show resolved Hide resolved

soloseng added 9 commits August 19, 2024 20:08

clean up

cb47ec9

Merge branch 'feat/l2-epoch-system' into soloseng/startNextEpochProce…

fbdc5fd

…ss-unit-and-integration-test

-- logging

b8f5584

removed duplicate interface

282ef91

using MockCeloToken to get test to pass.

40711cb

Fails when it hits a precompile in `EpochRewards.sol`

removed endEpochTimestamp

654b279

moved IEpochManager to 0.5 folder

2072107

added L2 conditions for EpochRewards functions using precompiles

9a6c01f

Still missing tests

renamed EpochManagerInitializer due to name conflict

c48b8e5

mcortesi reviewed Aug 21, 2024

View reviewed changes

soloseng added 2 commits August 21, 2024 17:42

++ more unit test

47f93af

setup anvil migration

d3b1db4

fix name conflict

soloseng mentioned this pull request Aug 22, 2024

Soloseng/update-l2-getepochnumber-logic #11195

Merged

soloseng added 12 commits August 26, 2024 13:16

Merge branch 'feat/l2-epoch-system' into soloseng/startNextEpochProce…

a6e2844

…ss-unit-and-integration-test

compiles

2ba9360

++ require fund in unreleased treasury

35b637a

Updated regex

c02c0a4

++ registry 0.8 for testing only

92ac7cf

clean up

f50ac8b

++ unit test

3aa816c

initial integration test using L1 devchain

180162b

++ comment

22946ff

-- forge based integration test

0ed7e93

Merge branch 'feat/l2-epoch-system' into soloseng/startNextEpochProce…

7fcc9a8

…ss-unit-and-integration-test

++ to const

8f0ea64

martinvol reviewed Sep 10, 2024

View reviewed changes

packages/protocol/contracts-0.8/common/test/MockCeloToken.sol Show resolved Hide resolved

martinvol reviewed Sep 10, 2024

View reviewed changes

packages/protocol/contracts-0.8/governance/test/MockElection.sol Outdated Show resolved Hide resolved

martinvol reviewed Sep 10, 2024

View reviewed changes

packages/protocol/contracts/common/UsingRegistry.sol Outdated Show resolved Hide resolved

martinvol reviewed Sep 10, 2024

View reviewed changes

packages/protocol/test-sol/devchain/migration/Migration.t.sol Outdated Show resolved Hide resolved

soloseng added 10 commits September 11, 2024 11:05

proxy stableToken mint call via Validators contract

48db871

Merge branch 'feat/l2-epoch-system' into soloseng/startNextEpochProce…

8a8f4d9

…ss-unit-and-integration-test

-- duplicate imports

bbb239f

removed registry08. replaced with vm call

2ffeed2

PR feedback

b195ebb

-- coment

3c2ebfc

passing unit tests

83bd5aa

clean up

1d4eaa4

++ mintStable test

43ae993

-- TODO; compiles test when filtering

de06b4e

martinvol reviewed Sep 16, 2024

View reviewed changes

packages/protocol/contracts-0.8/governance/Validators.sol Outdated Show resolved Hide resolved

martinvol reviewed Sep 16, 2024

View reviewed changes

packages/protocol/test-sol/unit/governance/validators/Validators.t.sol Show resolved Hide resolved

soloseng mentioned this pull request Sep 16, 2024

Soloseng/dynamically-fetch-epochmanagerenabler-address #11207

Merged

soloseng added 7 commits September 16, 2024 15:52

PR feedback

0dc7c92

updated migration script to add more validators

4d5360d

passing integration test

729008f

removed test for zero amount

20f8ae4

yarn build fix

6f986bd

clean up comments && TODO

b09a3bb

revert change as out of scope

60e3e70

soloseng merged commit 080b430 into feat/l2-epoch-system Sep 17, 2024
38 checks passed

soloseng deleted the soloseng/startNextEpochProcess-unit-and-integration-test branch September 17, 2024 00:40

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

startNextEpochProcess unit & integration test #11191

startNextEpochProcess unit & integration test #11191

soloseng commented Aug 19, 2024 •

edited by martinvol

Loading

gitguardian bot commented Aug 19, 2024 •

edited

Loading

mcortesi Aug 21, 2024

soloseng Aug 26, 2024

martinvol Sep 10, 2024

soloseng Sep 11, 2024

martinvol Sep 16, 2024

soloseng Sep 16, 2024 •

edited

Loading

martinvol Sep 16, 2024

soloseng Sep 16, 2024

martinvol Sep 16, 2024

soloseng Sep 16, 2024


		interface IEpochManager is IBlocker {
		interface IEpochManager{

startNextEpochProcess unit & integration test #11191

startNextEpochProcess unit & integration test #11191

Conversation

soloseng commented Aug 19, 2024 • edited by martinvol Loading

Description

Other changes

Tested

Related issues

Backwards compatibility

Documentation

gitguardian bot commented Aug 19, 2024 • edited Loading

️✅ There are no secrets present in this pull request anymore.

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

soloseng Sep 16, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

soloseng commented Aug 19, 2024 •

edited by martinvol

Loading

gitguardian bot commented Aug 19, 2024 •

edited

Loading

soloseng Sep 16, 2024 •

edited

Loading