Milestones: Add simulation based tests

[manav2401]

Description

This PR adds automated simulation based tests for milestones. More info available here. There are 2 primary tests.

1. The base case which tries to perform a network partition of type 3:1 (as per stake) and rely on proposed milestones to follow the correct fork.
2. Another case which tries to perform an equal network partition of type 1:1 (as per stake) and waits for milestones to get proposed on rejoin.

Note that to reproduce the tests, you'd need a custom branch of milestone on bor (one which fixes the primary validator).

Changes

• Bugfix (non-breaking change that solves an issue)
• New feature (non-breaking change that adds functionality)
• Breaking change (change that is not backwards-compatible and/or changes current functionality)
• New test case for remote devnet

Checklist

• I have added at least 2 reviewer or the whole pos-v1 team
• I have added sufficient documentation in code
• I will be resolving comments - if any - by pushing each fix in a separate commit and linking the commit hash in the comment reply

Cross repository changes

It should never be the case...

• This PR requires changes to bor
  • PR here
• This PR requires changes to heimdall
  • PR here:

Testing

• I have tested this code manually on local environment
• I have tested this code manually on remote devnet using express-cli
• I have tested this code manually on mumbai

[marcello33]

Also, @manav2401 can you include the instructions on how to run such tests in the README? I'll make sure to have them also in the epic description on notion. Thanks.

[manav2401]

Have addressed all the comments, refactored the changes by a great extent and updated all the steps in a readme. Looking for review @marcello33. Thanks!

[marcello33]

Thanks @manav2401, LGTM!
I just fixed the linter and pushed the implementation of the --reorg [index] command here
Can you please double check it does what it is supposed to do?
I tested it remotely, but have some doubts on the validateClusters part, around the log
console.log("Peer length mismatch, got: ${peers}, expected: ${expectedPeers}")
Will this work with any custom index the way I implemented it?
Thanks

[manav2401]

Thanks for the feature changes @marcello33. Yes given the implementation, it should work for any index as the expected peers is calculated based on that only.

Also, few more things.

1. Do you think we should quickly add a joinPeers command so that once the reorg is done, one can directly re-connect all the nodes?
2. I am not fully sure of the wordings used for this command in README. The parameter index does not technically represent the index of the node in list of nodes. It basically represents the number of nodes that one of the clusters will have (with other being total number of nodes - index). Do you think we should change it?

[marcello33]

added the requested changes here @manav2401
Please review.
Thanks!

[manav2401]

Thanks @marcello33
LGTM!