Timelock tests, natspec and scripts

ebtc-protocol / ebtc-multisig

eBTC's EVM multisig operations.

GNU Affero General Public License v3.0

0 stars 0 forks source link

Timelock tests, natspec and scripts #3

Closed sajanrajdev closed 7 months ago

sajanrajdev commented 8 months ago

Added:

Tests for all timelock and fee recipient operations
Natpsec for all current ebtc library methods
Scripts for using all current ebtc library methods with their respective multisigs

Run tests with:

brownie test --network sepolia-fork

Example of running a script:

brownie run scripts/ebtc_treasury.py activePool_claim_fee_recipient_coll_shares 1000 --network sepolia-fork

NOTE: You may need to manually setup the Sepolia network, instructions added to Readme.

Testing results

sajanrajdev commented 8 months ago

@petrovska-petro, thank you very much for your review, all of your comments have been addressed. Added:

Mapping of all governance configuration, roles, signatures, actors, etc.. to the eBTC class so that they can be accessed by scripts, tests or just for reference in a maintained place. There are a few changes expected, we should update this as the changes are applied on testnet. Additionally, we should keep this up to date with any changes that occur in the future.
Added checks before scheduling of any parameter change that is bounded on-chain using the same bounds from the contracts.
Enabled the use of salts for scheduling duplicate txs.
Fixed the comments as suggested.
Wrote new tests for all of the above.

Test suite running properly with new tests and implementations:

petrovska-petro commented 7 months ago

@sajanrajdev everything looks good and comments were tackled ✅

only addition to this pr, which still i believe it has great value while the ui for timelock gets finalised its the side-effect on any timelock tx queue, having in place the tenderly simulation to share to inspect events emitted, storage variable updated, traced etc will be v valuable to share w/ other signers