Scroll OO Issue #1 - Improve Circuit Breaker Contract

[valeriofichera]

Description The goal of of this issue is to improve the current Circuit Breaker implementation in regards to

• Documentation,
• Gas estimation / optimization &
• simplification

This will contribute to the success and adoption of Circuit Breakers as a novel security measure for asset-sensitive smart contracts.

Circuit Breaker Contracts follow the ethos of the development under EIP-7265 -> https://ethereum-magicians.org/t/eip-7265-circuit-breaker-standard/14909

Requirements

1. Add natspec in base CircuitBreaker contract https://docs.soliditylang.org/en/latest/natspec-format.html

2. Use the latest Circuit Breaker Implementation here: https://github.com/ikigai-labs-xyz/DeFi-Circuit-Breaker-EIPs/tree/new-architecture/assets/eip-7265

3. Do gas-estimation of how costly it is to update parameter

   • check status if it is in one transaction (for example a swap on a protocol or a deposit on an LP position)

4. Pre-requisites

   • Merge periods
   • all gas-optimize tasks
   • all simplify tasks

   Stack

   • Solidity
   • Understanding of Circuit Breakers: https://github.com/DeFi-Circuit-Breaker/EIPs/blob/core-overhaul/EIPS/eip-7265.md

Pull Request Structure

• Title and description: The pull request title and description should be clear and concise, and should accurately describe the changes that are being proposed.
• Code: The code in the pull request should be well-written and easy to understand
• Tests: The pull request should include any type of testing for all new code.

• Documentation: The pull request should be documented, so that other developers can understand what the changes do and how to use them.

  technical reference: https://github.com/DeFi-Circuit-Breaker/EIPs/blob/core-overhaul/EIPS/eip-7265.md

  estimated time effort: Medium (>6h)