├── .editorconfig ├── .env.example ├── .github └── workflows │ ├── cli-tests.yml │ ├── prettier.yml │ └── test.yml ├── .gitignore ├── .gitmodules ├── LICENSE ├── README.md ├── audits └── ChainSecurity_Sky_Protego_audit.pdf ├── cli ├── .gitignore ├── README.md ├── cli.js ├── defaults.js ├── fetchPausePlans.js ├── jest.config.js ├── module.js ├── package-lock.json ├── package.json ├── pause-abi.json └── test │ ├── fetchPausePlans.test.js │ └── fixtures │ └── events.js ├── foundry.toml ├── script ├── ProtegoDeploy.s.sol ├── dependencies │ ├── ProtegoDeploy.sol │ └── ProtegoInstance.sol ├── input │ └── 1 │ │ └── README.md └── output │ └── 1 │ └── README.md └── src ├── EmergencyDropSpell.sol ├── Protego.sol ├── Protego.t.sol └── test ├── ConformingSpell.sol └── NonConformingSpell.sol /.editorconfig: -------------------------------------------------------------------------------- 1 | # EditorConfig for Sky Protocol Projects 2 | 3 | # EditorConfig is awesome: https://EditorConfig.org 4 | 5 | # top-most EditorConfig file 6 | root = true 7 | 8 | [*] 9 | charset = utf-8 10 | end_of_line = lf 11 | insert_final_newline = true 12 | trim_trailing_whitespace = true 13 | 14 | [*.{sol,sh,js,py}] 15 | indent_style = space 16 | indent_size = 4 17 | 18 | [*.{diff,md}] 19 | trim_trailing_whitespace = false 20 | 21 | [{package.json,.travis.yml}] 22 | indent_style = space 23 | indent_size = 2 24 | 25 | [foundry.toml] 26 | indent_style = space 27 | indent_size = 4 28 | -------------------------------------------------------------------------------- /.env.example: -------------------------------------------------------------------------------- 1 | FOUNDRY_ROOT_CHAINID='number: the ID of the chain' 2 | FOUNDRY_EXPORTS_OVERWRITE_LATEST='bool: whether to override the latest deployment or not' 3 | -------------------------------------------------------------------------------- /.github/workflows/cli-tests.yml: -------------------------------------------------------------------------------- 1 | name: CLI Tests 2 | 3 | on: 4 | push: 5 | paths: 6 | - 'cli/**' 7 | pull_request: 8 | paths: 9 | - 'cli/**' 10 | 11 | jobs: 12 | test: 13 | runs-on: ubuntu-latest 14 | 15 | strategy: 16 | matrix: 17 | node-version: [18.x, 20.x] 18 | 19 | steps: 20 | - uses: actions/checkout@v3 21 | 22 | - name: Use Node.js ${{ matrix.node-version }} 23 | uses: actions/setup-node@v3 24 | with: 25 | node-version: ${{ matrix.node-version }} 26 | cache: 'npm' 27 | cache-dependency-path: './cli/package-lock.json' 28 | 29 | - name: Install dependencies 30 | working-directory: ./cli 31 | run: npm install 32 | 33 | - name: Run tests 34 | working-directory: ./cli 35 | run: npm test 36 | -------------------------------------------------------------------------------- /.github/workflows/prettier.yml: -------------------------------------------------------------------------------- 1 | name: prettier.check 2 | on: 3 | pull_request: 4 | push: 5 | jobs: 6 | prettier: 7 | runs-on: ubuntu-latest 8 | steps: 9 | - uses: actions/checkout@v4 10 | - uses: actions/setup-node@v4 11 | - run: | 12 | cd cli 13 | npm install 14 | npx prettier . --check --ignore-unknown -------------------------------------------------------------------------------- /.github/workflows/test.yml: -------------------------------------------------------------------------------- 1 | name: test 2 | 3 | on: 4 | push: 5 | branches: 6 | - master 7 | - main 8 | pull_request: 9 | 10 | env: 11 | FOUNDRY_PROFILE: ci 12 | ETH_RPC_URL: ${{ secrets.ETH_RPC_URL }} 13 | 14 | jobs: 15 | check: 16 | strategy: 17 | fail-fast: true 18 | 19 | name: Foundry project 20 | runs-on: ubuntu-latest 21 | steps: 22 | - uses: actions/checkout@v3 23 | with: 24 | submodules: recursive 25 | 26 | - name: Install Foundry 27 | uses: foundry-rs/foundry-toolchain@v1 28 | with: 29 | version: nightly 30 | 31 | - name: Run Forge build 32 | run: | 33 | forge --version 34 | forge build --sizes 35 | id: build 36 | 37 | - name: Run Forge tests 38 | run: | 39 | forge test -vvv 40 | id: test 41 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Compiler files 2 | cache/ 3 | out/ 4 | 5 | # Ignores broadcast logs 6 | broadcast/ 7 | 8 | # Ignores script config 9 | script/input/**/*.json 10 | !script/input/**/template-*.json 11 | script/output/**/*.json 12 | 13 | # Docs 14 | docs/ 15 | 16 | # Dotenv file 17 | .env 18 | -------------------------------------------------------------------------------- /.gitmodules: -------------------------------------------------------------------------------- 1 | [submodule "lib/dss-test"] 2 | path = lib/dss-test 3 | url = https://github.com/makerdao/dss-test 4 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU AFFERO GENERAL PUBLIC LICENSE 2 | Version 3, 19 November 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU Affero General Public License is a free, copyleft license for 11 | software and other kinds of works, specifically designed to ensure 12 | cooperation with the community in the case of network server software. 13 | 14 | The licenses for most software and other practical works are designed 15 | to take away your freedom to share and change the works. By contrast, 16 | our General Public Licenses are intended to guarantee your freedom to 17 | share and change all versions of a program--to make sure it remains free 18 | software for all its users. 19 | 20 | When we speak of free software, we are referring to freedom, not 21 | price. Our General Public Licenses are designed to make sure that you 22 | have the freedom to distribute copies of free software (and charge for 23 | them if you wish), that you receive source code or can get it if you 24 | want it, that you can change the software or use pieces of it in new 25 | free programs, and that you know you can do these things. 26 | 27 | Developers that use our General Public Licenses protect your rights 28 | with two steps: (1) assert copyright on the software, and (2) offer 29 | you this License which gives you legal permission to copy, distribute 30 | and/or modify the software. 31 | 32 | A secondary benefit of defending all users' freedom is that 33 | improvements made in alternate versions of the program, if they 34 | receive widespread use, become available for other developers to 35 | incorporate. Many developers of free software are heartened and 36 | encouraged by the resulting cooperation. However, in the case of 37 | software used on network servers, this result may fail to come about. 38 | The GNU General Public License permits making a modified version and 39 | letting the public access it on a server without ever releasing its 40 | source code to the public. 41 | 42 | The GNU Affero General Public License is designed specifically to 43 | ensure that, in such cases, the modified source code becomes available 44 | to the community. It requires the operator of a network server to 45 | provide the source code of the modified version running there to the 46 | users of that server. Therefore, public use of a modified version, on 47 | a publicly accessible server, gives the public access to the source 48 | code of the modified version. 49 | 50 | An older license, called the Affero General Public License and 51 | published by Affero, was designed to accomplish similar goals. This is 52 | a different license, not a version of the Affero GPL, but Affero has 53 | released a new version of the Affero GPL which permits relicensing under 54 | this license. 55 | 56 | The precise terms and conditions for copying, distribution and 57 | modification follow. 58 | 59 | TERMS AND CONDITIONS 60 | 61 | 0. Definitions. 62 | 63 | "This License" refers to version 3 of the GNU Affero General Public License. 64 | 65 | "Copyright" also means copyright-like laws that apply to other kinds of 66 | works, such as semiconductor masks. 67 | 68 | "The Program" refers to any copyrightable work licensed under this 69 | License. Each licensee is addressed as "you". "Licensees" and 70 | "recipients" may be individuals or organizations. 71 | 72 | To "modify" a work means to copy from or adapt all or part of the work 73 | in a fashion requiring copyright permission, other than the making of an 74 | exact copy. The resulting work is called a "modified version" of the 75 | earlier work or a work "based on" the earlier work. 76 | 77 | A "covered work" means either the unmodified Program or a work based 78 | on the Program. 79 | 80 | To "propagate" a work means to do anything with it that, without 81 | permission, would make you directly or secondarily liable for 82 | infringement under applicable copyright law, except executing it on a 83 | computer or modifying a private copy. Propagation includes copying, 84 | distribution (with or without modification), making available to the 85 | public, and in some countries other activities as well. 86 | 87 | To "convey" a work means any kind of propagation that enables other 88 | parties to make or receive copies. Mere interaction with a user through 89 | a computer network, with no transfer of a copy, is not conveying. 90 | 91 | An interactive user interface displays "Appropriate Legal Notices" 92 | to the extent that it includes a convenient and prominently visible 93 | feature that (1) displays an appropriate copyright notice, and (2) 94 | tells the user that there is no warranty for the work (except to the 95 | extent that warranties are provided), that licensees may convey the 96 | work under this License, and how to view a copy of this License. If 97 | the interface presents a list of user commands or options, such as a 98 | menu, a prominent item in the list meets this criterion. 99 | 100 | 1. Source Code. 101 | 102 | The "source code" for a work means the preferred form of the work 103 | for making modifications to it. "Object code" means any non-source 104 | form of a work. 105 | 106 | A "Standard Interface" means an interface that either is an official 107 | standard defined by a recognized standards body, or, in the case of 108 | interfaces specified for a particular programming language, one that 109 | is widely used among developers working in that language. 110 | 111 | The "System Libraries" of an executable work include anything, other 112 | than the work as a whole, that (a) is included in the normal form of 113 | packaging a Major Component, but which is not part of that Major 114 | Component, and (b) serves only to enable use of the work with that 115 | Major Component, or to implement a Standard Interface for which an 116 | implementation is available to the public in source code form. A 117 | "Major Component", in this context, means a major essential component 118 | (kernel, window system, and so on) of the specific operating system 119 | (if any) on which the executable work runs, or a compiler used to 120 | produce the work, or an object code interpreter used to run it. 121 | 122 | The "Corresponding Source" for a work in object code form means all 123 | the source code needed to generate, install, and (for an executable 124 | work) run the object code and to modify the work, including scripts to 125 | control those activities. However, it does not include the work's 126 | System Libraries, or general-purpose tools or generally available free 127 | programs which are used unmodified in performing those activities but 128 | which are not part of the work. For example, Corresponding Source 129 | includes interface definition files associated with source files for 130 | the work, and the source code for shared libraries and dynamically 131 | linked subprograms that the work is specifically designed to require, 132 | such as by intimate data communication or control flow between those 133 | subprograms and other parts of the work. 134 | 135 | The Corresponding Source need not include anything that users 136 | can regenerate automatically from other parts of the Corresponding 137 | Source. 138 | 139 | The Corresponding Source for a work in source code form is that 140 | same work. 141 | 142 | 2. Basic Permissions. 143 | 144 | All rights granted under this License are granted for the term of 145 | copyright on the Program, and are irrevocable provided the stated 146 | conditions are met. This License explicitly affirms your unlimited 147 | permission to run the unmodified Program. The output from running a 148 | covered work is covered by this License only if the output, given its 149 | content, constitutes a covered work. This License acknowledges your 150 | rights of fair use or other equivalent, as provided by copyright law. 151 | 152 | You may make, run and propagate covered works that you do not 153 | convey, without conditions so long as your license otherwise remains 154 | in force. You may convey covered works to others for the sole purpose 155 | of having them make modifications exclusively for you, or provide you 156 | with facilities for running those works, provided that you comply with 157 | the terms of this License in conveying all material for which you do 158 | not control copyright. Those thus making or running the covered works 159 | for you must do so exclusively on your behalf, under your direction 160 | and control, on terms that prohibit them from making any copies of 161 | your copyrighted material outside their relationship with you. 162 | 163 | Conveying under any other circumstances is permitted solely under 164 | the conditions stated below. Sublicensing is not allowed; section 10 165 | makes it unnecessary. 166 | 167 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 168 | 169 | No covered work shall be deemed part of an effective technological 170 | measure under any applicable law fulfilling obligations under article 171 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 172 | similar laws prohibiting or restricting circumvention of such 173 | measures. 174 | 175 | When you convey a covered work, you waive any legal power to forbid 176 | circumvention of technological measures to the extent such circumvention 177 | is effected by exercising rights under this License with respect to 178 | the covered work, and you disclaim any intention to limit operation or 179 | modification of the work as a means of enforcing, against the work's 180 | users, your or third parties' legal rights to forbid circumvention of 181 | technological measures. 182 | 183 | 4. Conveying Verbatim Copies. 184 | 185 | You may convey verbatim copies of the Program's source code as you 186 | receive it, in any medium, provided that you conspicuously and 187 | appropriately publish on each copy an appropriate copyright notice; 188 | keep intact all notices stating that this License and any 189 | non-permissive terms added in accord with section 7 apply to the code; 190 | keep intact all notices of the absence of any warranty; and give all 191 | recipients a copy of this License along with the Program. 192 | 193 | You may charge any price or no price for each copy that you convey, 194 | and you may offer support or warranty protection for a fee. 195 | 196 | 5. Conveying Modified Source Versions. 197 | 198 | You may convey a work based on the Program, or the modifications to 199 | produce it from the Program, in the form of source code under the 200 | terms of section 4, provided that you also meet all of these conditions: 201 | 202 | a) The work must carry prominent notices stating that you modified 203 | it, and giving a relevant date. 204 | 205 | b) The work must carry prominent notices stating that it is 206 | released under this License and any conditions added under section 207 | 7. This requirement modifies the requirement in section 4 to 208 | "keep intact all notices". 209 | 210 | c) You must license the entire work, as a whole, under this 211 | License to anyone who comes into possession of a copy. This 212 | License will therefore apply, along with any applicable section 7 213 | additional terms, to the whole of the work, and all its parts, 214 | regardless of how they are packaged. This License gives no 215 | permission to license the work in any other way, but it does not 216 | invalidate such permission if you have separately received it. 217 | 218 | d) If the work has interactive user interfaces, each must display 219 | Appropriate Legal Notices; however, if the Program has interactive 220 | interfaces that do not display Appropriate Legal Notices, your 221 | work need not make them do so. 222 | 223 | A compilation of a covered work with other separate and independent 224 | works, which are not by their nature extensions of the covered work, 225 | and which are not combined with it such as to form a larger program, 226 | in or on a volume of a storage or distribution medium, is called an 227 | "aggregate" if the compilation and its resulting copyright are not 228 | used to limit the access or legal rights of the compilation's users 229 | beyond what the individual works permit. Inclusion of a covered work 230 | in an aggregate does not cause this License to apply to the other 231 | parts of the aggregate. 232 | 233 | 6. Conveying Non-Source Forms. 234 | 235 | You may convey a covered work in object code form under the terms 236 | of sections 4 and 5, provided that you also convey the 237 | machine-readable Corresponding Source under the terms of this License, 238 | in one of these ways: 239 | 240 | a) Convey the object code in, or embodied in, a physical product 241 | (including a physical distribution medium), accompanied by the 242 | Corresponding Source fixed on a durable physical medium 243 | customarily used for software interchange. 244 | 245 | b) Convey the object code in, or embodied in, a physical product 246 | (including a physical distribution medium), accompanied by a 247 | written offer, valid for at least three years and valid for as 248 | long as you offer spare parts or customer support for that product 249 | model, to give anyone who possesses the object code either (1) a 250 | copy of the Corresponding Source for all the software in the 251 | product that is covered by this License, on a durable physical 252 | medium customarily used for software interchange, for a price no 253 | more than your reasonable cost of physically performing this 254 | conveying of source, or (2) access to copy the 255 | Corresponding Source from a network server at no charge. 256 | 257 | c) Convey individual copies of the object code with a copy of the 258 | written offer to provide the Corresponding Source. This 259 | alternative is allowed only occasionally and noncommercially, and 260 | only if you received the object code with such an offer, in accord 261 | with subsection 6b. 262 | 263 | d) Convey the object code by offering access from a designated 264 | place (gratis or for a charge), and offer equivalent access to the 265 | Corresponding Source in the same way through the same place at no 266 | further charge. You need not require recipients to copy the 267 | Corresponding Source along with the object code. If the place to 268 | copy the object code is a network server, the Corresponding Source 269 | may be on a different server (operated by you or a third party) 270 | that supports equivalent copying facilities, provided you maintain 271 | clear directions next to the object code saying where to find the 272 | Corresponding Source. Regardless of what server hosts the 273 | Corresponding Source, you remain obligated to ensure that it is 274 | available for as long as needed to satisfy these requirements. 275 | 276 | e) Convey the object code using peer-to-peer transmission, provided 277 | you inform other peers where the object code and Corresponding 278 | Source of the work are being offered to the general public at no 279 | charge under subsection 6d. 280 | 281 | A separable portion of the object code, whose source code is excluded 282 | from the Corresponding Source as a System Library, need not be 283 | included in conveying the object code work. 284 | 285 | A "User Product" is either (1) a "consumer product", which means any 286 | tangible personal property which is normally used for personal, family, 287 | or household purposes, or (2) anything designed or sold for incorporation 288 | into a dwelling. In determining whether a product is a consumer product, 289 | doubtful cases shall be resolved in favor of coverage. For a particular 290 | product received by a particular user, "normally used" refers to a 291 | typical or common use of that class of product, regardless of the status 292 | of the particular user or of the way in which the particular user 293 | actually uses, or expects or is expected to use, the product. A product 294 | is a consumer product regardless of whether the product has substantial 295 | commercial, industrial or non-consumer uses, unless such uses represent 296 | the only significant mode of use of the product. 297 | 298 | "Installation Information" for a User Product means any methods, 299 | procedures, authorization keys, or other information required to install 300 | and execute modified versions of a covered work in that User Product from 301 | a modified version of its Corresponding Source. The information must 302 | suffice to ensure that the continued functioning of the modified object 303 | code is in no case prevented or interfered with solely because 304 | modification has been made. 305 | 306 | If you convey an object code work under this section in, or with, or 307 | specifically for use in, a User Product, and the conveying occurs as 308 | part of a transaction in which the right of possession and use of the 309 | User Product is transferred to the recipient in perpetuity or for a 310 | fixed term (regardless of how the transaction is characterized), the 311 | Corresponding Source conveyed under this section must be accompanied 312 | by the Installation Information. But this requirement does not apply 313 | if neither you nor any third party retains the ability to install 314 | modified object code on the User Product (for example, the work has 315 | been installed in ROM). 316 | 317 | The requirement to provide Installation Information does not include a 318 | requirement to continue to provide support service, warranty, or updates 319 | for a work that has been modified or installed by the recipient, or for 320 | the User Product in which it has been modified or installed. Access to a 321 | network may be denied when the modification itself materially and 322 | adversely affects the operation of the network or violates the rules and 323 | protocols for communication across the network. 324 | 325 | Corresponding Source conveyed, and Installation Information provided, 326 | in accord with this section must be in a format that is publicly 327 | documented (and with an implementation available to the public in 328 | source code form), and must require no special password or key for 329 | unpacking, reading or copying. 330 | 331 | 7. Additional Terms. 332 | 333 | "Additional permissions" are terms that supplement the terms of this 334 | License by making exceptions from one or more of its conditions. 335 | Additional permissions that are applicable to the entire Program shall 336 | be treated as though they were included in this License, to the extent 337 | that they are valid under applicable law. If additional permissions 338 | apply only to part of the Program, that part may be used separately 339 | under those permissions, but the entire Program remains governed by 340 | this License without regard to the additional permissions. 341 | 342 | When you convey a copy of a covered work, you may at your option 343 | remove any additional permissions from that copy, or from any part of 344 | it. (Additional permissions may be written to require their own 345 | removal in certain cases when you modify the work.) You may place 346 | additional permissions on material, added by you to a covered work, 347 | for which you have or can give appropriate copyright permission. 348 | 349 | Notwithstanding any other provision of this License, for material you 350 | add to a covered work, you may (if authorized by the copyright holders of 351 | that material) supplement the terms of this License with terms: 352 | 353 | a) Disclaiming warranty or limiting liability differently from the 354 | terms of sections 15 and 16 of this License; or 355 | 356 | b) Requiring preservation of specified reasonable legal notices or 357 | author attributions in that material or in the Appropriate Legal 358 | Notices displayed by works containing it; or 359 | 360 | c) Prohibiting misrepresentation of the origin of that material, or 361 | requiring that modified versions of such material be marked in 362 | reasonable ways as different from the original version; or 363 | 364 | d) Limiting the use for publicity purposes of names of licensors or 365 | authors of the material; or 366 | 367 | e) Declining to grant rights under trademark law for use of some 368 | trade names, trademarks, or service marks; or 369 | 370 | f) Requiring indemnification of licensors and authors of that 371 | material by anyone who conveys the material (or modified versions of 372 | it) with contractual assumptions of liability to the recipient, for 373 | any liability that these contractual assumptions directly impose on 374 | those licensors and authors. 375 | 376 | All other non-permissive additional terms are considered "further 377 | restrictions" within the meaning of section 10. If the Program as you 378 | received it, or any part of it, contains a notice stating that it is 379 | governed by this License along with a term that is a further 380 | restriction, you may remove that term. If a license document contains 381 | a further restriction but permits relicensing or conveying under this 382 | License, you may add to a covered work material governed by the terms 383 | of that license document, provided that the further restriction does 384 | not survive such relicensing or conveying. 385 | 386 | If you add terms to a covered work in accord with this section, you 387 | must place, in the relevant source files, a statement of the 388 | additional terms that apply to those files, or a notice indicating 389 | where to find the applicable terms. 390 | 391 | Additional terms, permissive or non-permissive, may be stated in the 392 | form of a separately written license, or stated as exceptions; 393 | the above requirements apply either way. 394 | 395 | 8. Termination. 396 | 397 | You may not propagate or modify a covered work except as expressly 398 | provided under this License. Any attempt otherwise to propagate or 399 | modify it is void, and will automatically terminate your rights under 400 | this License (including any patent licenses granted under the third 401 | paragraph of section 11). 402 | 403 | However, if you cease all violation of this License, then your 404 | license from a particular copyright holder is reinstated (a) 405 | provisionally, unless and until the copyright holder explicitly and 406 | finally terminates your license, and (b) permanently, if the copyright 407 | holder fails to notify you of the violation by some reasonable means 408 | prior to 60 days after the cessation. 409 | 410 | Moreover, your license from a particular copyright holder is 411 | reinstated permanently if the copyright holder notifies you of the 412 | violation by some reasonable means, this is the first time you have 413 | received notice of violation of this License (for any work) from that 414 | copyright holder, and you cure the violation prior to 30 days after 415 | your receipt of the notice. 416 | 417 | Termination of your rights under this section does not terminate the 418 | licenses of parties who have received copies or rights from you under 419 | this License. If your rights have been terminated and not permanently 420 | reinstated, you do not qualify to receive new licenses for the same 421 | material under section 10. 422 | 423 | 9. Acceptance Not Required for Having Copies. 424 | 425 | You are not required to accept this License in order to receive or 426 | run a copy of the Program. Ancillary propagation of a covered work 427 | occurring solely as a consequence of using peer-to-peer transmission 428 | to receive a copy likewise does not require acceptance. However, 429 | nothing other than this License grants you permission to propagate or 430 | modify any covered work. These actions infringe copyright if you do 431 | not accept this License. Therefore, by modifying or propagating a 432 | covered work, you indicate your acceptance of this License to do so. 433 | 434 | 10. Automatic Licensing of Downstream Recipients. 435 | 436 | Each time you convey a covered work, the recipient automatically 437 | receives a license from the original licensors, to run, modify and 438 | propagate that work, subject to this License. You are not responsible 439 | for enforcing compliance by third parties with this License. 440 | 441 | An "entity transaction" is a transaction transferring control of an 442 | organization, or substantially all assets of one, or subdividing an 443 | organization, or merging organizations. If propagation of a covered 444 | work results from an entity transaction, each party to that 445 | transaction who receives a copy of the work also receives whatever 446 | licenses to the work the party's predecessor in interest had or could 447 | give under the previous paragraph, plus a right to possession of the 448 | Corresponding Source of the work from the predecessor in interest, if 449 | the predecessor has it or can get it with reasonable efforts. 450 | 451 | You may not impose any further restrictions on the exercise of the 452 | rights granted or affirmed under this License. For example, you may 453 | not impose a license fee, royalty, or other charge for exercise of 454 | rights granted under this License, and you may not initiate litigation 455 | (including a cross-claim or counterclaim in a lawsuit) alleging that 456 | any patent claim is infringed by making, using, selling, offering for 457 | sale, or importing the Program or any portion of it. 458 | 459 | 11. Patents. 460 | 461 | A "contributor" is a copyright holder who authorizes use under this 462 | License of the Program or a work on which the Program is based. The 463 | work thus licensed is called the contributor's "contributor version". 464 | 465 | A contributor's "essential patent claims" are all patent claims 466 | owned or controlled by the contributor, whether already acquired or 467 | hereafter acquired, that would be infringed by some manner, permitted 468 | by this License, of making, using, or selling its contributor version, 469 | but do not include claims that would be infringed only as a 470 | consequence of further modification of the contributor version. For 471 | purposes of this definition, "control" includes the right to grant 472 | patent sublicenses in a manner consistent with the requirements of 473 | this License. 474 | 475 | Each contributor grants you a non-exclusive, worldwide, royalty-free 476 | patent license under the contributor's essential patent claims, to 477 | make, use, sell, offer for sale, import and otherwise run, modify and 478 | propagate the contents of its contributor version. 479 | 480 | In the following three paragraphs, a "patent license" is any express 481 | agreement or commitment, however denominated, not to enforce a patent 482 | (such as an express permission to practice a patent or covenant not to 483 | sue for patent infringement). To "grant" such a patent license to a 484 | party means to make such an agreement or commitment not to enforce a 485 | patent against the party. 486 | 487 | If you convey a covered work, knowingly relying on a patent license, 488 | and the Corresponding Source of the work is not available for anyone 489 | to copy, free of charge and under the terms of this License, through a 490 | publicly available network server or other readily accessible means, 491 | then you must either (1) cause the Corresponding Source to be so 492 | available, or (2) arrange to deprive yourself of the benefit of the 493 | patent license for this particular work, or (3) arrange, in a manner 494 | consistent with the requirements of this License, to extend the patent 495 | license to downstream recipients. "Knowingly relying" means you have 496 | actual knowledge that, but for the patent license, your conveying the 497 | covered work in a country, or your recipient's use of the covered work 498 | in a country, would infringe one or more identifiable patents in that 499 | country that you have reason to believe are valid. 500 | 501 | If, pursuant to or in connection with a single transaction or 502 | arrangement, you convey, or propagate by procuring conveyance of, a 503 | covered work, and grant a patent license to some of the parties 504 | receiving the covered work authorizing them to use, propagate, modify 505 | or convey a specific copy of the covered work, then the patent license 506 | you grant is automatically extended to all recipients of the covered 507 | work and works based on it. 508 | 509 | A patent license is "discriminatory" if it does not include within 510 | the scope of its coverage, prohibits the exercise of, or is 511 | conditioned on the non-exercise of one or more of the rights that are 512 | specifically granted under this License. You may not convey a covered 513 | work if you are a party to an arrangement with a third party that is 514 | in the business of distributing software, under which you make payment 515 | to the third party based on the extent of your activity of conveying 516 | the work, and under which the third party grants, to any of the 517 | parties who would receive the covered work from you, a discriminatory 518 | patent license (a) in connection with copies of the covered work 519 | conveyed by you (or copies made from those copies), or (b) primarily 520 | for and in connection with specific products or compilations that 521 | contain the covered work, unless you entered into that arrangement, 522 | or that patent license was granted, prior to 28 March 2007. 523 | 524 | Nothing in this License shall be construed as excluding or limiting 525 | any implied license or other defenses to infringement that may 526 | otherwise be available to you under applicable patent law. 527 | 528 | 12. No Surrender of Others' Freedom. 529 | 530 | If conditions are imposed on you (whether by court order, agreement or 531 | otherwise) that contradict the conditions of this License, they do not 532 | excuse you from the conditions of this License. If you cannot convey a 533 | covered work so as to satisfy simultaneously your obligations under this 534 | License and any other pertinent obligations, then as a consequence you may 535 | not convey it at all. For example, if you agree to terms that obligate you 536 | to collect a royalty for further conveying from those to whom you convey 537 | the Program, the only way you could satisfy both those terms and this 538 | License would be to refrain entirely from conveying the Program. 539 | 540 | 13. Remote Network Interaction; Use with the GNU General Public License. 541 | 542 | Notwithstanding any other provision of this License, if you modify the 543 | Program, your modified version must prominently offer all users 544 | interacting with it remotely through a computer network (if your version 545 | supports such interaction) an opportunity to receive the Corresponding 546 | Source of your version by providing access to the Corresponding Source 547 | from a network server at no charge, through some standard or customary 548 | means of facilitating copying of software. This Corresponding Source 549 | shall include the Corresponding Source for any work covered by version 3 550 | of the GNU General Public License that is incorporated pursuant to the 551 | following paragraph. 552 | 553 | Notwithstanding any other provision of this License, you have 554 | permission to link or combine any covered work with a work licensed 555 | under version 3 of the GNU General Public License into a single 556 | combined work, and to convey the resulting work. The terms of this 557 | License will continue to apply to the part which is the covered work, 558 | but the work with which it is combined will remain governed by version 559 | 3 of the GNU General Public License. 560 | 561 | 14. Revised Versions of this License. 562 | 563 | The Free Software Foundation may publish revised and/or new versions of 564 | the GNU Affero General Public License from time to time. Such new versions 565 | will be similar in spirit to the present version, but may differ in detail to 566 | address new problems or concerns. 567 | 568 | Each version is given a distinguishing version number. If the 569 | Program specifies that a certain numbered version of the GNU Affero General 570 | Public License "or any later version" applies to it, you have the 571 | option of following the terms and conditions either of that numbered 572 | version or of any later version published by the Free Software 573 | Foundation. If the Program does not specify a version number of the 574 | GNU Affero General Public License, you may choose any version ever published 575 | by the Free Software Foundation. 576 | 577 | If the Program specifies that a proxy can decide which future 578 | versions of the GNU Affero General Public License can be used, that proxy's 579 | public statement of acceptance of a version permanently authorizes you 580 | to choose that version for the Program. 581 | 582 | Later license versions may give you additional or different 583 | permissions. However, no additional obligations are imposed on any 584 | author or copyright holder as a result of your choosing to follow a 585 | later version. 586 | 587 | 15. Disclaimer of Warranty. 588 | 589 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 590 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 591 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 592 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 593 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 594 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 595 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 596 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 597 | 598 | 16. Limitation of Liability. 599 | 600 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 601 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 602 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 603 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 604 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 605 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 606 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 607 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 608 | SUCH DAMAGES. 609 | 610 | 17. Interpretation of Sections 15 and 16. 611 | 612 | If the disclaimer of warranty and limitation of liability provided 613 | above cannot be given local legal effect according to their terms, 614 | reviewing courts shall apply local law that most closely approximates 615 | an absolute waiver of all civil liability in connection with the 616 | Program, unless a warranty or assumption of liability accompanies a 617 | copy of the Program in return for a fee. 618 | 619 | END OF TERMS AND CONDITIONS 620 | 621 | How to Apply These Terms to Your New Programs 622 | 623 | If you develop a new program, and you want it to be of the greatest 624 | possible use to the public, the best way to achieve this is to make it 625 | free software which everyone can redistribute and change under these terms. 626 | 627 | To do so, attach the following notices to the program. It is safest 628 | to attach them to the start of each source file to most effectively 629 | state the exclusion of warranty; and each file should have at least 630 | the "copyright" line and a pointer to where the full notice is found. 631 | 632 | 633 | Copyright (C) 634 | 635 | This program is free software: you can redistribute it and/or modify 636 | it under the terms of the GNU Affero General Public License as published 637 | by the Free Software Foundation, either version 3 of the License, or 638 | (at your option) any later version. 639 | 640 | This program is distributed in the hope that it will be useful, 641 | but WITHOUT ANY WARRANTY; without even the implied warranty of 642 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 643 | GNU Affero General Public License for more details. 644 | 645 | You should have received a copy of the GNU Affero General Public License 646 | along with this program. If not, see . 647 | 648 | Also add information on how to contact you by electronic and paper mail. 649 | 650 | If your software can interact with users remotely through a computer 651 | network, you should also make sure that it provides a way for users to 652 | get its source. For example, if your program is a web application, its 653 | interface could display a "Source" link that leads users to an archive 654 | of the code. There are many ways you could offer source, and different 655 | solutions will be better for different programs; see section 13 for the 656 | specific requirements. 657 | 658 | You should also get your employer (if you work as a programmer) or school, 659 | if any, to sign a "copyright disclaimer" for the program, if necessary. 660 | For more information on this, and how to apply and follow the GNU AGPL, see 661 | . 662 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Protego 2 | 3 | Protego is a tool to permissionlessly deploy a spell which can be used to drop a particular plan in the `MCD_PAUSE` 4 | contract, or in extreme cases the `Protego` contract can itself be lifted to the hat, allowing any user to 5 | permissionlessly drop any scheduled plan. 6 | 7 | ## Context 8 | 9 | - A `plan` is a scheduled `delegatecall` that exists in [`MCD_PAUSE`](https://github.com/makerdao/ds-pause) and can be 10 | permissionlessly executed. 11 | - Plans in `MCD_PAUSE` are [identified by a unique 32 byte hash](https://github.com/makerdao/ds-pause/blob/master/src/pause.sol#L99). 12 | - A conforming spell here is one where the values returned by `action()`, `tag()`, `sig()` and `eta()` are equal to the 13 | corresponding `plan`, `usr`, `tag`, `fax` and `eta` values respectively. Bad actors could potentially manipulate the 14 | return values of these functions such that they are not equal, which would result in a non-conforming spell. 15 | - Users interacting with `Protego` should **always** assume the spell they want to drop is non-conforming and fetch the 16 | parameters directly from the logs created by [`pause.plot()`](https://etherscan.deth.net/address/0xbe286431454714f511008713973d3b053a2d38f3#L189-L203) 17 | 18 | ## Usage 19 | 20 | ### 1. Create a single drop spell 21 | 22 | ```solidity 23 | deploy(address _usr, bytes32 _tag, bytes memory _fax, uint256 _eta)(address) 24 | ``` 25 | 26 | If there is sufficient ecosystem interest to cancel (`drop`) a particular scheduled set of actions (the target `plan`), 27 | Protego contains a factory to permissionlessly create a spell ("Emergency Drop Spell"), which – upon being given 28 | the hat – is able to drop the targeted plan in `MCD_PAUSE`. 29 | 30 | ### 2. Enable permissionless dropping of a single or multiple plans 31 | 32 | 33 | ```solidity 34 | /// @notice Permissionlessly drop anything that has been planned on the pause. 35 | drop(address _usr, bytes32 _tag, bytes memory _fax, uint256 _eta) 36 | ``` 37 | 38 | ```solidity 39 | /** 40 | * @notice A struct representing a plan. 41 | * @param usr The address of the scheduled spell. 42 | * @param tag The tag identifying the address. 43 | * @param fax The encoded call to be made in `usr`. 44 | * @param eta The expiration time. 45 | */ 46 | struct Plan { 47 | address usr; 48 | bytes32 tag; 49 | bytes fax; 50 | uint256 eta; 51 | } 52 | 53 | /// @notice Drop multiple plans in a single call. 54 | drop(Plan[] calldata plans) 55 | ``` 56 | 57 | In case of a governance attack, numerous spells could be created and planned by an attacker at a rate faster than a 58 | single hat spell can `drop` them. To mitigate this risk, the `Protego` contract itself can be given the hat, which 59 | allows any user to permissionlessly drop any plan. Protego may either cancel one plan per call, or cancel multiple plans in a single call by passing a `Plan[]` to the multi drop function. 60 | 61 | Both functions will **immediately** drop one or many plans in `MCD_PAUSE` using the parameters provided. 62 | 63 | ## Additional functions 64 | 65 | ### `id()` 66 | 67 | ```solidity 68 | id(address _usr, bytes32 _tag, bytes memory _fax, uint256 _eta)(bytes32) 69 | ``` 70 | 71 | Returns the `bytes32` id of a given plan using the same method that `hash` does in `MCD_PAUSE`. 72 | 73 | ### `planned()` 74 | 75 | ```solidity 76 | planned(address _usr, bytes32 _tag, bytes memory _fax, uint256 _eta)(bool) 77 | planned(bytes32 _id)(bool) 78 | ``` 79 | 80 | Returns `true` if a plan has been scheduled for execution. 81 | -------------------------------------------------------------------------------- /audits/ChainSecurity_Sky_Protego_audit.pdf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/makerdao/protego/18863734969a79bad6b379fbcb4a03ebf518c9a2/audits/ChainSecurity_Sky_Protego_audit.pdf -------------------------------------------------------------------------------- /cli/.gitignore: -------------------------------------------------------------------------------- 1 | # project 2 | .env* 3 | 4 | # node 5 | node_modules/ 6 | logs 7 | *.log 8 | npm-debug.log* 9 | yarn-debug.log* 10 | yarn-error.log* 11 | lerna-debug.log* 12 | .pnpm-debug.log* 13 | -------------------------------------------------------------------------------- /cli/README.md: -------------------------------------------------------------------------------- 1 | # Protego Scripts 2 | 3 | ## Usage 4 | 5 | ### CLI 6 | 7 | ``` 8 | npx @dewiz-xyz/protego@latest [-V -h] | --rpc-url [--from-block 19420069] [--status PENDING] [--pause-address ] [--format TABLE] 9 | ``` 10 | 11 | All options: 12 | 13 | ``` 14 | Usage: Protego CLI [options] 15 | 16 | ____ _ 17 | | _ \ _ __ ___ | |_ ___ __ _ ___ 18 | | |_) | | '__| / _ \ | __| / _ \ / _` | / _ \ 19 | | __/ | | | (_) | | |_ | __/ | (_| | | (_) | 20 | |_| |_| \___/ \__| \___| \__, | \___/ 21 | |___/ 22 | 23 | Options: 24 | -V, --version output the version number 25 | -r, --rpc-url Ethereum Node RPC URL (default: "https://mainnet.gateway.tenderly.co", 26 | env: ETH_RPC_URL) 27 | -b, --from-block Display spells from a given block (default: 0) 28 | -s, --status Filter by status (choices: "PENDING", "DROPPED", "EXECUTED", "ALL", default: "ALL") 29 | --pause-address
MCD_PAUSE contract address (default: "0xbE286431454714F511008713973d3B053A2d38f3") 30 | -f, --format Output format (choices: "TABLE", "JSON", default: "TABLE") 31 | -h, --help display help for command 32 | ``` 33 | 34 | #### Output 35 | 36 | ``` 37 | ╔═══════════════════════╤═══════════════════════════════════╤═══════════════════════╤═══════════════════════════════════╤════════════╤════════════╤════════════╗ 38 | ║ SPELL │ HASH │ USR │ TAG │ FAX │ ETA │ STATUS ║ 39 | ╟───────────────────────┼───────────────────────────────────┼───────────────────────┼───────────────────────────────────┼────────────┼────────────┼────────────╢ 40 | ║ 0xc25A71BDF956229a035 │ 0x76167df75647db1661a3a49b83e589e │ 0xb1F78B20B3aAfdF061b │ 0xd5b5512ac3872a37517151f280f9b9f │ 0x61461954 │ 1723728263 │ EXECUTED ║ 41 | ║ e35e8038d3FeE4aBa101C │ 9daaff46af3337552e15eb80ea8acf79f │ 0E85f2D3009c436764294 │ 3f37191196b05620d19af0f3c24f55b2e │ │ │ ║ 42 | ╟───────────────────────┼───────────────────────────────────┼───────────────────────┼───────────────────────────────────┼────────────┼────────────┼────────────╢ 43 | ║ 0x8c7F12C7cE07916f631 │ 0x1e4a20372c4647e9428efabca662d47 │ 0x46DD85e91Eab604ca15 │ 0x54561a83a0e6eb1959742ac526aeaa0 │ 0x61461954 │ 1722371399 │ EXECUTED ║ 44 | ║ B25ce148e419FeFf19d46 │ 59f996f1353d2dcb05d52ed50def420f0 │ 0c26853a947617e7Ab322 │ 2e1d074fbbb8e26294b2a46a508c3ccf3 │ │ │ ║ 45 | ╟───────────────────────┼───────────────────────────────────┼───────────────────────┼───────────────────────────────────┼────────────┼────────────┼────────────╢ 46 | ║ 0x452a39C34f9539E0d50 │ 0x11e3af57c6821e4b4b45559c92f5c9d │ 0xA13D7e21643bD46E2cC │ 0x041f68b86ef5961f3d578a7192a09f1 │ 0x61461954 │ 1721070179 │ EXECUTED ║ 47 | ║ C9e33Ad423a15C6f45df4 │ a681f2b7d2d232f91d7b64aa14d317f6a │ 09E87cFB91c5B951Bd955 │ 980b42bcefa8fecb810816369420c1e0c │ │ │ ║ 48 | ╟───────────────────────┼───────────────────────────────────┼───────────────────────┼───────────────────────────────────┼────────────┼────────────┼────────────╢ 49 | ║ 0x0c0B4DA7e02960F98c2 │ 0xb8f4b59cbfe45ba425eb9c10c8a50bd │ 0x0871e28D09c29C41966 │ 0xc8dec11fc102e8810674c4db724fb12 │ 0x61461954 │ 1720383443 │ EXECUTED ║ 50 | ║ AFf2778F6f3E37321B5Dd │ 1eb919325eefdf095c44369098fd21e59 │ 9D82901d53d60A649B36D │ 9a790f93767cf54b691cbe3d2d33dd3d8 │ │ │ ║ 51 | ╟───────────────────────┼───────────────────────────────────┼───────────────────────┼───────────────────────────────────┼────────────┼────────────┼────────────╢ 52 | ║ 0x7fbC867dE58D6e47E43 │ 0x9ca00512f5e87da33fa1fa1e4834581 │ 0x261da1Cdbd788642034 │ 0x5e8fe783452994a42bbbe3b0edde5b9 │ 0x61461954 │ 1719777527 │ EXECUTED ║ 53 | ║ 0eB257B50481F6E878f65 │ c8684ebd9091c7883355ea0ca959a78f2 │ 288B6574d749198FDf75b │ 901ff6bd7561b680b42af92293206bb32 │ │ │ ║ 54 | ╟───────────────────────┼───────────────────────────────────┼───────────────────────┼───────────────────────────────────┼────────────┼────────────┼────────────╢ 55 | ║ 0x622Ad624491a01a2a6b │ 0xd37c72ea00f67c76b6cda8dc0dda0b1 │ 0x6481e7443D321fFF02A │ 0xf218b00aeb30403e97dbedd8542caf1 │ 0x61461954 │ 1718481719 │ EXECUTED ║ 56 | ║ eAD916C3Ca3B90BcA0854 │ b6f825145079e9acd23bdbcfe00259a3e │ 9A7ae883DCd13FAb64Ef7 │ a879c0e15796a20b5836cfadfe9a69b43 │ │ │ ║ 57 | ╟───────────────────────┼───────────────────────────────────┼───────────────────────┼───────────────────────────────────┼────────────┼────────────┼────────────╢ 58 | ║ 0x7B55617f7F04F7B45eE │ 0x2eb42ca4e054352eaa8ef09705925b3 │ 0x612938f231DFcd7F921 │ 0x25f5bbaef576d0cf62af933ec55a6bd │ 0x61461954 │ 1717623383 │ EXECUTED ║ 59 | ║ 865fF9066469Fbe28a632 │ c12b4c0d1a59a050a20baa2b9d44396a8 │ 81F11C9E0B575E7ed2Ec1 │ 468b65fa9902387040283da6bf88ea4a9 │ │ │ ║ 60 | ╚═══════════════════════╧═══════════════════════════════════╧═══════════════════════╧═══════════════════════════════════╧════════════╧════════════╧════════════╝ 61 | ``` 62 | 63 | The script outputs a table with the plans' details: 64 | 65 | - SPELL: Address of the spell (keep in mind this only works for compliant Spells, this field lists the plan scheduler address, which is the Spell on compliant spells, if non-compliant this field should be ignored) 66 | - HASH: Hash of the plan 67 | - USR: Address of the `DssSpellAction` related to the Spell 68 | - TAG: `extcodehash` from the address of `DssSpellAction` 69 | - FAX: `callcode` to be used when calling the Spell 70 | - ETA: Timestamp of earliest execution time 71 | - STATUS: Status of the plan: 72 | - PENDING: The plan has been plotted (scheduled) on Pause, and is pending execution 73 | - EXECUTED: The plan has already been executed 74 | - DROPPED: The plan was scheduled and subsequently dropped 75 | 76 | ### As a dependency 77 | 78 | ```bash 79 | npm i @dewiz-xyz/protego 80 | ``` 81 | 82 | ```javascript 83 | import { fetchPausePlans } from "@dewiz-xyz/protego"; 84 | 85 | const plans = await fetchPausePlans({ 86 | rpcUrl: "https://eth.llamarpc.com", 87 | fromBlock: 16420000, 88 | status: "PENDING", 89 | // Optional: this is the MCD_PAUSE address 90 | pauseAddress: "0xbE286431454714F511008713973d3B053A2d38f3", 91 | }); 92 | ``` 93 | 94 | Response type: 95 | 96 | ```typescript 97 | type Result = { 98 | hash: string; 99 | guy: string; 100 | usr: string; 101 | tag: string; 102 | fax: string; 103 | eta: number; 104 | status: "PENDING" | "EXECUTED" | "DROPPED" | "ALL"; 105 | }; 106 | 107 | type Status = "ALL" | "PENDING" | "DROPPED" | "EXECUTED"; 108 | 109 | type Cfg = { 110 | status: Status = "ALL", 111 | fromBlock: number = 0, 112 | rpcUrl: string = "mainnet", 113 | pauseAddress: string = "{MCD_PAUSE}", 114 | } 115 | 116 | function fetchPausePlans(cfg: Cfg = {}): Promise{} 117 | ``` 118 | 119 | ## Collaborating 120 | 121 | ### 1. Install dependencies 122 | 123 | ```bash 124 | npm i 125 | ``` 126 | 127 | ### 2. Run scripts 128 | 129 | List plans in `MCD_PAUSE` since block 16420000 130 | 131 | ```bash 132 | npm run cli -- --from-block 16420000 133 | 134 | OR 135 | 136 | node cli --from-block 16420000 137 | ``` 138 | 139 | Filter by status with `--status` flag. 140 | Possible values are: `PENDING`, `EXECUTED`, `DROPPED` and `ALL` (default). 141 | 142 | Get pending plans since block 19420069 143 | 144 | ```bash 145 | npm run cli -- --status PENDING --from-block 19420069 146 | OR 147 | node cli --status PENDING --from-block 19420069 148 | ``` 149 | 150 | Get executed plans since block 19420069 151 | 152 | ```bash 153 | npm run cli -- --status EXECUTED --from-block 19420069 154 | OR 155 | node cli --status EXECUTED --from-block 19420069 156 | ``` 157 | 158 | Get dropped plans since block 19420069 159 | 160 | ```bash 161 | npm run cli -- --status DROPPED --from-block 19420069 162 | OR 163 | node cli --status DROPPED --from-block 19420069 164 | ``` 165 | 166 | ### 3. Help 167 | 168 | ```bash 169 | node cli --help 170 | ``` 171 | -------------------------------------------------------------------------------- /cli/cli.js: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env node 2 | 3 | import { Command, Option } from "commander"; 4 | import chalk from "chalk"; 5 | import yoctoSpinner from "yocto-spinner"; 6 | import figlet from "figlet"; 7 | import { ethers } from "ethers"; 8 | import { table } from "table"; 9 | import { fetchPausePlans } from "./fetchPausePlans.js"; 10 | import defaults from "./defaults.js"; 11 | import p from "./package.json" with { type: "json" }; 12 | 13 | const program = new Command(); 14 | 15 | program 16 | .name("Protego CLI") 17 | .description(figlet.textSync("Protego", { horizontalLayout: "full" })) 18 | .version(p.version) 19 | .addOption( 20 | new Option("-r, --rpc-url ", "Ethereum Node RPC URL") 21 | .env("ETH_RPC_URL") 22 | .default(defaults.RPC_URL), 23 | ) 24 | .addOption( 25 | new Option( 26 | "-b, --from-block ", 27 | "Display spells from a given block", 28 | ) 29 | .argParser(Number.parseInt) 30 | .default(defaults.FROM_BLOCK), 31 | ) 32 | .addOption( 33 | new Option("-s, --status ", "Filter by status") 34 | .choices(["PENDING", "DROPPED", "EXECUTED", "ALL"]) 35 | .default(defaults.STATUS), 36 | ) 37 | .addOption( 38 | new Option( 39 | "--pause-address
", 40 | "MCD_PAUSE contract address", 41 | ).default(defaults.MCD_PAUSE_ADDRESS), 42 | ) 43 | .addOption( 44 | new Option("-f, --format ", "Output format") 45 | .choices(["TABLE", "JSON"]) 46 | .default(defaults.FORMAT), 47 | ) 48 | .showHelpAfterError() 49 | .action(run); 50 | 51 | program.parse(); 52 | 53 | /** 54 | * Runs the CLI 55 | * @param {string} options.rpcUrl Ethereum Node RPC URL 56 | * @param {number} options.fromBlock Display spells from a given block 57 | * @param {"ALL"|"PENDING"|"DROPPED"|"EXECUTED"} options.status Filter by status 58 | * @param {string} options.pauseAddress MCD_PAUSE contract address 59 | * @returns {Promise} 60 | */ 61 | async function run({ rpcUrl, fromBlock, status, pauseAddress, format }) { 62 | if (rpcUrl === defaults.RPC_URL) { 63 | console.warn( 64 | chalk.yellow( 65 | `🟡 WARNING: Falling back to a public provider: ${rpcUrl}. For a better experience, set a custom RPC URL with the --rpc-url option or the ETH_RPC_URL env variable.`, 66 | ), 67 | ); 68 | } 69 | 70 | const spinner = ttyOnlySpinner().start("Fetching pause plans..."); 71 | 72 | try { 73 | const pause = new ethers.Contract( 74 | pauseAddress, 75 | defaults.MCD_PAUSE_ABI, 76 | ethers.getDefaultProvider(rpcUrl), 77 | ); 78 | 79 | const plans = await fetchPausePlans(pause, { fromBlock, status }); 80 | spinner.success("Done!"); 81 | 82 | if (format === "TABLE") { 83 | console.log(createTable(plans)); 84 | } else { 85 | console.log(createJson(plans)); 86 | } 87 | 88 | process.exit(0); 89 | } catch (error) { 90 | spinner.error("Failed!"); 91 | console.error(chalk.red("An error occurred:", error)); 92 | process.exit(1); 93 | } 94 | } 95 | 96 | /** 97 | * Creates a spinner that only shows if stdout is a TTY 98 | * @param {...any} args 99 | * @returns {import("yocto-spinner").Spinner} 100 | */ 101 | function ttyOnlySpinner(...args) { 102 | // Only show a spinner if stdout is a TTY 103 | if (process.stdout.isTTY) { 104 | return yoctoSpinner(...args); 105 | } 106 | 107 | // If not a TTY, return a dummy spinner with empty chainable methods 108 | return { 109 | start() { 110 | return this; 111 | }, 112 | success() { 113 | return this; 114 | }, 115 | error() { 116 | return this; 117 | }, 118 | }; 119 | } 120 | 121 | /** 122 | * Converts a list of pause plans to a formatted table 123 | * @param {import("./fetchPausePlans").PausePlan[]} plans 124 | * @returns {string} 125 | */ 126 | function createTable(plans) { 127 | const data = [...plans] 128 | .sort((a, b) => { 129 | const etaA = BigInt(a.eta); 130 | const etaB = BigInt(b.eta); 131 | return etaB > etaA ? 1 : etaB < etaA ? -1 : 0; 132 | }) 133 | .map((event) => [ 134 | colorize(event.status, event.guy), 135 | colorize(event.status, event.hash), 136 | colorize(event.status, event.usr), 137 | colorize(event.status, event.tag), 138 | colorize(event.status, event.fax), 139 | colorize(event.status, event.eta), 140 | colorize(event.status), 141 | ]); 142 | 143 | if (data.length === 0) { 144 | return "No records to display."; 145 | } 146 | 147 | data.unshift( 148 | ["SPELL", "HASH", "USR", "TAG", "FAX", "ETA", "STATUS"].map((item) => 149 | chalk.bold.cyan(item), 150 | ), 151 | ); 152 | 153 | return table(data, { 154 | columns: { 155 | 0: { width: 21, wrapWord: true }, 156 | 1: { width: 33, wrapWord: true }, 157 | 2: { width: 21, wrapWord: true }, 158 | 3: { width: 33, wrapWord: true }, 159 | 4: { width: 10, wrapWord: true }, 160 | 5: { width: 10, wrapWord: true }, 161 | 6: { width: 10, wrapWord: true }, 162 | }, 163 | }); 164 | } 165 | 166 | /** 167 | * Colorizes a status string 168 | * @param {string} status The status to define the color 169 | * @param {string} [text=status] The text to colorize 170 | * @returns {string} 171 | */ 172 | function colorize(status, text = status) { 173 | switch (status) { 174 | case "PENDING": 175 | return chalk.yellow(String(text)); 176 | case "DROPPED": 177 | return chalk.red(String(text)); 178 | case "EXECUTED": 179 | return chalk.green(String(text)); 180 | default: 181 | return status; 182 | } 183 | } 184 | 185 | /** 186 | * Converts a list of pause plans to a JSON string 187 | * @param {import("./fetchPausePlans").PausePlan[]} plans 188 | * @returns {string} 189 | */ 190 | function createJson(plans) { 191 | return JSON.stringify( 192 | plans, 193 | (_, v) => (typeof v === "bigint" ? v.toString() : v), 194 | 2, 195 | ); 196 | } 197 | -------------------------------------------------------------------------------- /cli/defaults.js: -------------------------------------------------------------------------------- 1 | import pauseABI from "./pause-abi.json" with { type: "json" }; 2 | 3 | export default { 4 | MCD_PAUSE_ADDRESS: "0xbE286431454714F511008713973d3B053A2d38f3", 5 | MCD_PAUSE_ABI: pauseABI, 6 | RPC_URL: "https://mainnet.gateway.tenderly.co", 7 | FROM_BLOCK: 0, 8 | STATUS: "ALL", 9 | FORMAT: "TABLE", 10 | }; 11 | -------------------------------------------------------------------------------- /cli/fetchPausePlans.js: -------------------------------------------------------------------------------- 1 | import { ethers } from "ethers"; 2 | 3 | const PLOT_TOPIC = 4 | "0x46d2fbbb00000000000000000000000000000000000000000000000000000000"; 5 | const EXEC_TOPIC = 6 | "0x168ccd6700000000000000000000000000000000000000000000000000000000"; 7 | const DROP_TOPIC = 8 | "0x162c7de300000000000000000000000000000000000000000000000000000000"; 9 | 10 | /** 11 | * Decodes a LogNote event 12 | * @param {import("ethers/contract").UndecodedEventLog} log 13 | * @param {import("ethers/contract").Contract} contract 14 | * @returns {object} 15 | */ 16 | export function decodeLogNote(log, contract) { 17 | const eventFragment = contract.interface.getEvent("LogNote"); 18 | return contract.interface 19 | .decodeEventLog(eventFragment, log.data, log.topics) 20 | .toObject(); 21 | } 22 | 23 | /** 24 | * Decodes a call 25 | * @param {string} sig 26 | * @param {string} fax 27 | * @param {import("ethers/contract").Contract} contract 28 | * @returns {object} 29 | */ 30 | export function decodeCallParams(sig, fax, contract) { 31 | const functionFragment = contract.interface.getFunction(sig); 32 | return contract.interface 33 | .decodeFunctionData(functionFragment, fax) 34 | .toObject(); 35 | } 36 | 37 | /** 38 | * Hashes a pause plan 39 | * @param {string} params.usr Pause plan user 40 | * @param {string} params.tag Pause plan tag 41 | * @param {string} params.fax Pause plan fax 42 | * @param {string|bigint} params.eta Paule plan ETA 43 | * @returns {string} 44 | */ 45 | export function hash(params) { 46 | const abiCoder = new ethers.AbiCoder(); 47 | const types = ["address", "bytes32", "bytes", "uint256"]; 48 | const encoded = abiCoder.encode(types, [ 49 | params.usr, 50 | params.tag, 51 | params.fax, 52 | params.eta, 53 | ]); 54 | return ethers.keccak256(encoded); 55 | } 56 | 57 | /** 58 | * Fetches events from the Pause contract 59 | * @param {number} fromBlock Fetches events from a given block 60 | * @param {import("ethers/contract").Contract} contract The Pause contract instance 61 | * @returns {Promise} 62 | */ 63 | async function fetchEvents(fromBlock, contract) { 64 | return await contract.queryFilter( 65 | [[PLOT_TOPIC, EXEC_TOPIC, DROP_TOPIC]], 66 | fromBlock, 67 | ); 68 | } 69 | 70 | /** 71 | * Processes an event 72 | * @param {import("ethers/contract").UndecodedEventLog} event 73 | * @param {import("ethers/contract").Contract} contract 74 | * @returns {object} 75 | */ 76 | export function processEvent(event, contract) { 77 | const decoded = decodeLogNote(event, contract); 78 | const decodedCall = decodeCallParams( 79 | event.topics[0].slice(0, 10), 80 | decoded.fax, 81 | contract, 82 | ); 83 | return { 84 | ...event, 85 | decoded, 86 | decodedCall, 87 | planHash: hash(decodedCall), 88 | }; 89 | } 90 | 91 | /** 92 | * @typedef {object} PausePlan 93 | * @property {string} hash 94 | * @property {string} guy 95 | * @property {string} usr 96 | * @property {string} tag 97 | * @property {string} fax 98 | * @property {string|bigint} eta 99 | * @property {"ALL"|"PENDING"|"DROPPED"|"EXECUTED"} status 100 | */ 101 | 102 | /** 103 | * Parses the fetched Pause events 104 | * @param {import("ethers/contract").UndecodedEventLog[]} events 105 | * @param {"ALL"|"PENDING"|"DROPPED"|"EXECUTED"} status 106 | * @param {import("ethers/contract").Contract} contract 107 | * @returns {PausePlan[]} 108 | */ 109 | function parseEvents(events, status, contract) { 110 | const decodedEvents = events.map((event) => processEvent(event, contract)); 111 | const hashMap = new Map(); 112 | 113 | decodedEvents.forEach((event) => { 114 | const planHash = event.planHash; 115 | 116 | if (!hashMap.has(planHash)) { 117 | hashMap.set(planHash, { 118 | hash: planHash, 119 | guy: event.decoded.guy, 120 | usr: event.decodedCall.usr, 121 | tag: event.decodedCall.tag, 122 | fax: event.decodedCall.fax.trim(), 123 | eta: event.decodedCall.eta, 124 | status: "", 125 | }); 126 | } 127 | 128 | if (event.topics[0] === PLOT_TOPIC) { 129 | hashMap.get(planHash).status = "PENDING"; 130 | } else if (event.topics[0] === EXEC_TOPIC) { 131 | hashMap.get(planHash).status = "EXECUTED"; 132 | } else if (event.topics[0] === DROP_TOPIC) { 133 | hashMap.get(planHash).status = "DROPPED"; 134 | } 135 | }); 136 | 137 | const eventsList = []; 138 | for (const item of hashMap.values()) { 139 | if (status === "ALL" || item.status === status) { 140 | eventsList.push(item); 141 | } 142 | } 143 | 144 | return eventsList; 145 | } 146 | 147 | /** 148 | * Fetches pause plans 149 | * @param {import("ethers/contract").Contract} contractInstance The Pause contract instance 150 | * @param {number} [options.fromBlock=0] Display spells from a given block 151 | * @param {"ALL"|"PENDING"|"DROPPED"|"EXECUTED"} [options.status="ALL"] Filter by status 152 | * @return {Promise} 153 | */ 154 | export async function fetchPausePlans( 155 | contractInstance, 156 | { fromBlock = 0, status = "ALL" } = {}, 157 | ) { 158 | const events = await fetchEvents(fromBlock, contractInstance); 159 | return parseEvents(events, status, contractInstance); 160 | } 161 | -------------------------------------------------------------------------------- /cli/jest.config.js: -------------------------------------------------------------------------------- 1 | export default { 2 | testEnvironment: "node", 3 | transform: {}, 4 | }; 5 | -------------------------------------------------------------------------------- /cli/module.js: -------------------------------------------------------------------------------- 1 | import { ethers } from "ethers"; 2 | import defaults from "./defaults.js"; 3 | import { fetchPausePlans as _fetchPausePlansImpl } from "./fetchPausePlans.js"; 4 | 5 | /** 6 | * Fetches pause plans 7 | * @param {string} [options.rpcUrl] Ethereum Node RPC URL 8 | * @param {number} [options.fromBlock=0] Display spells from a given block 9 | * @param {"ALL"|"PENDING"|"DROPPED"|"EXECUTED"} [options.status="ALL"] Filter by status 10 | * @param {string} [options.pauseAddress="0x5c69bee701ef814a2b6a3edd4b1652cb9cc5aa6f"] MCD_PAUSE contract address 11 | * @returns {Promise} 12 | */ 13 | export async function fetchPausePlans({ 14 | rpcUrl = defaults.RPC_URL, 15 | pauseAddress = defaults.MCD_PAUSE_ADDRESS, 16 | fromBlock = defaults.FROM_BLOCK, 17 | status = defaults.STATUS, 18 | } = {}) { 19 | const pause = new ethers.Contract( 20 | pauseAddress, 21 | defaults.MCD_PAUSE_ABI, 22 | ethers.getDefaultProvider(rpcUrl), 23 | ); 24 | return await _fetchPausePlansImpl(pause, { fromBlock, status }); 25 | } 26 | -------------------------------------------------------------------------------- /cli/package.json: -------------------------------------------------------------------------------- 1 | { 2 | "type": "module", 3 | "name": "@dewiz-xyz/protego", 4 | "version": "0.2.1", 5 | "scripts": { 6 | "help": "node --no-warnings list.js --help", 7 | "list": "node --no-warnings list.js", 8 | "test": "node --experimental-vm-modules node_modules/jest/bin/jest.js" 9 | }, 10 | "exports": { 11 | ".": "./module.js" 12 | }, 13 | "bin": { 14 | "protego": "cli.js" 15 | }, 16 | "dependencies": { 17 | "chalk": "^5.4.1", 18 | "commander": "^13.1.0", 19 | "ethers": "^6.13.1", 20 | "figlet": "^1.8.1", 21 | "table": "^6.8.2", 22 | "yocto-spinner": "^0.2.2" 23 | }, 24 | "devDependencies": { 25 | "jest": "^29.7.0", 26 | "prettier": "^3.5.3" 27 | } 28 | } 29 | -------------------------------------------------------------------------------- /cli/pause-abi.json: -------------------------------------------------------------------------------- 1 | [ 2 | { 3 | "inputs": [ 4 | { 5 | "internalType": "uint256", 6 | "name": "delay_", 7 | "type": "uint256" 8 | }, 9 | { 10 | "internalType": "address", 11 | "name": "owner_", 12 | "type": "address" 13 | }, 14 | { 15 | "internalType": "contract DSAuthority", 16 | "name": "authority_", 17 | "type": "address" 18 | } 19 | ], 20 | "payable": false, 21 | "stateMutability": "nonpayable", 22 | "type": "constructor" 23 | }, 24 | { 25 | "anonymous": true, 26 | "inputs": [ 27 | { 28 | "indexed": true, 29 | "internalType": "bytes4", 30 | "name": "sig", 31 | "type": "bytes4" 32 | }, 33 | { 34 | "indexed": true, 35 | "internalType": "address", 36 | "name": "guy", 37 | "type": "address" 38 | }, 39 | { 40 | "indexed": true, 41 | "internalType": "bytes32", 42 | "name": "foo", 43 | "type": "bytes32" 44 | }, 45 | { 46 | "indexed": true, 47 | "internalType": "bytes32", 48 | "name": "bar", 49 | "type": "bytes32" 50 | }, 51 | { 52 | "indexed": false, 53 | "internalType": "uint256", 54 | "name": "wad", 55 | "type": "uint256" 56 | }, 57 | { 58 | "indexed": false, 59 | "internalType": "bytes", 60 | "name": "fax", 61 | "type": "bytes" 62 | } 63 | ], 64 | "name": "LogNote", 65 | "type": "event" 66 | }, 67 | { 68 | "anonymous": false, 69 | "inputs": [ 70 | { 71 | "indexed": true, 72 | "internalType": "address", 73 | "name": "authority", 74 | "type": "address" 75 | } 76 | ], 77 | "name": "LogSetAuthority", 78 | "type": "event" 79 | }, 80 | { 81 | "anonymous": false, 82 | "inputs": [ 83 | { 84 | "indexed": true, 85 | "internalType": "address", 86 | "name": "owner", 87 | "type": "address" 88 | } 89 | ], 90 | "name": "LogSetOwner", 91 | "type": "event" 92 | }, 93 | { 94 | "constant": true, 95 | "inputs": [], 96 | "name": "authority", 97 | "outputs": [ 98 | { 99 | "internalType": "contract DSAuthority", 100 | "name": "", 101 | "type": "address" 102 | } 103 | ], 104 | "payable": false, 105 | "stateMutability": "view", 106 | "type": "function" 107 | }, 108 | { 109 | "constant": true, 110 | "inputs": [], 111 | "name": "delay", 112 | "outputs": [ 113 | { 114 | "internalType": "uint256", 115 | "name": "", 116 | "type": "uint256" 117 | } 118 | ], 119 | "payable": false, 120 | "stateMutability": "view", 121 | "type": "function" 122 | }, 123 | { 124 | "constant": false, 125 | "inputs": [ 126 | { 127 | "internalType": "address", 128 | "name": "usr", 129 | "type": "address" 130 | }, 131 | { 132 | "internalType": "bytes32", 133 | "name": "tag", 134 | "type": "bytes32" 135 | }, 136 | { 137 | "internalType": "bytes", 138 | "name": "fax", 139 | "type": "bytes" 140 | }, 141 | { 142 | "internalType": "uint256", 143 | "name": "eta", 144 | "type": "uint256" 145 | } 146 | ], 147 | "name": "drop", 148 | "outputs": [], 149 | "payable": false, 150 | "stateMutability": "nonpayable", 151 | "type": "function" 152 | }, 153 | { 154 | "constant": false, 155 | "inputs": [ 156 | { 157 | "internalType": "address", 158 | "name": "usr", 159 | "type": "address" 160 | }, 161 | { 162 | "internalType": "bytes32", 163 | "name": "tag", 164 | "type": "bytes32" 165 | }, 166 | { 167 | "internalType": "bytes", 168 | "name": "fax", 169 | "type": "bytes" 170 | }, 171 | { 172 | "internalType": "uint256", 173 | "name": "eta", 174 | "type": "uint256" 175 | } 176 | ], 177 | "name": "exec", 178 | "outputs": [ 179 | { 180 | "internalType": "bytes", 181 | "name": "out", 182 | "type": "bytes" 183 | } 184 | ], 185 | "payable": false, 186 | "stateMutability": "nonpayable", 187 | "type": "function" 188 | }, 189 | { 190 | "constant": true, 191 | "inputs": [], 192 | "name": "owner", 193 | "outputs": [ 194 | { 195 | "internalType": "address", 196 | "name": "", 197 | "type": "address" 198 | } 199 | ], 200 | "payable": false, 201 | "stateMutability": "view", 202 | "type": "function" 203 | }, 204 | { 205 | "constant": true, 206 | "inputs": [ 207 | { 208 | "internalType": "bytes32", 209 | "name": "", 210 | "type": "bytes32" 211 | } 212 | ], 213 | "name": "plans", 214 | "outputs": [ 215 | { 216 | "internalType": "bool", 217 | "name": "", 218 | "type": "bool" 219 | } 220 | ], 221 | "payable": false, 222 | "stateMutability": "view", 223 | "type": "function" 224 | }, 225 | { 226 | "constant": false, 227 | "inputs": [ 228 | { 229 | "internalType": "address", 230 | "name": "usr", 231 | "type": "address" 232 | }, 233 | { 234 | "internalType": "bytes32", 235 | "name": "tag", 236 | "type": "bytes32" 237 | }, 238 | { 239 | "internalType": "bytes", 240 | "name": "fax", 241 | "type": "bytes" 242 | }, 243 | { 244 | "internalType": "uint256", 245 | "name": "eta", 246 | "type": "uint256" 247 | } 248 | ], 249 | "name": "plot", 250 | "outputs": [], 251 | "payable": false, 252 | "stateMutability": "nonpayable", 253 | "type": "function" 254 | }, 255 | { 256 | "constant": true, 257 | "inputs": [], 258 | "name": "proxy", 259 | "outputs": [ 260 | { 261 | "internalType": "contract DSPauseProxy", 262 | "name": "", 263 | "type": "address" 264 | } 265 | ], 266 | "payable": false, 267 | "stateMutability": "view", 268 | "type": "function" 269 | }, 270 | { 271 | "constant": false, 272 | "inputs": [ 273 | { 274 | "internalType": "contract DSAuthority", 275 | "name": "authority_", 276 | "type": "address" 277 | } 278 | ], 279 | "name": "setAuthority", 280 | "outputs": [], 281 | "payable": false, 282 | "stateMutability": "nonpayable", 283 | "type": "function" 284 | }, 285 | { 286 | "constant": false, 287 | "inputs": [ 288 | { 289 | "internalType": "uint256", 290 | "name": "delay_", 291 | "type": "uint256" 292 | } 293 | ], 294 | "name": "setDelay", 295 | "outputs": [], 296 | "payable": false, 297 | "stateMutability": "nonpayable", 298 | "type": "function" 299 | }, 300 | { 301 | "constant": false, 302 | "inputs": [ 303 | { 304 | "internalType": "address", 305 | "name": "owner_", 306 | "type": "address" 307 | } 308 | ], 309 | "name": "setOwner", 310 | "outputs": [], 311 | "payable": false, 312 | "stateMutability": "nonpayable", 313 | "type": "function" 314 | } 315 | ] 316 | -------------------------------------------------------------------------------- /cli/test/fetchPausePlans.test.js: -------------------------------------------------------------------------------- 1 | import { jest, describe, it, expect, beforeAll } from "@jest/globals"; 2 | import { ethers } from "ethers"; 3 | import { 4 | fetchPausePlans, 5 | decodeLogNote, 6 | decodeCallParams, 7 | hash, 8 | processEvent, 9 | } from "../fetchPausePlans.js"; 10 | import defaults from "../defaults.js"; 11 | import { mockEvents } from "./fixtures/events.js"; 12 | 13 | const PLOT_TOPIC = 14 | "0x46d2fbbb00000000000000000000000000000000000000000000000000000000"; 15 | const EXEC_TOPIC = 16 | "0x168ccd6700000000000000000000000000000000000000000000000000000000"; 17 | const DROP_TOPIC = 18 | "0x162c7de300000000000000000000000000000000000000000000000000000000"; 19 | 20 | let eventStats; 21 | let processedEvents; 22 | 23 | function analyzeEvents(events) { 24 | const plotEvents = events.filter((e) => e.topics[0] === PLOT_TOPIC); 25 | const execEvents = events.filter((e) => e.topics[0] === EXEC_TOPIC); 26 | const dropEvents = events.filter((e) => e.topics[0] === DROP_TOPIC); 27 | 28 | return { 29 | total: events.length, 30 | plotCount: plotEvents.length, 31 | execCount: execEvents.length, 32 | dropCount: dropEvents.length, 33 | pendingCount: 34 | plotEvents.length - (execEvents.length + dropEvents.length), 35 | events: { 36 | plot: plotEvents, 37 | exec: execEvents, 38 | drop: dropEvents, 39 | }, 40 | }; 41 | } 42 | 43 | describe("fetchPausePlans", () => { 44 | beforeAll(() => { 45 | processedEvents = mockEvents.map((event) => 46 | processEvent(event, { 47 | interface: new ethers.Interface(defaults.MCD_PAUSE_ABI), 48 | }), 49 | ); 50 | 51 | eventStats = analyzeEvents(mockEvents); 52 | }); 53 | 54 | let mockContractInstance; 55 | 56 | beforeEach(() => { 57 | mockContractInstance = { 58 | queryFilter: jest.fn().mockImplementation((topics, fromBlock) => { 59 | // Filter events based on fromBlock and topics 60 | const filteredEvents = mockEvents.filter((event) => { 61 | const matchesBlock = event.blockNumber >= fromBlock; 62 | const matchesTopic = topics[0].includes(event.topics[0]); 63 | return matchesBlock && matchesTopic; 64 | }); 65 | return Promise.resolve(filteredEvents); 66 | }), 67 | interface: new ethers.Interface(defaults.MCD_PAUSE_ABI), 68 | }; 69 | }); 70 | 71 | it("should fetch all spells correctly", async () => { 72 | const result = await fetchPausePlans(mockContractInstance); 73 | expect(result).toHaveLength(eventStats.plotCount); 74 | 75 | result.forEach((spell) => { 76 | const plotEvent = processedEvents.find( 77 | (e) => e.planHash === spell.hash && e.topics[0] === PLOT_TOPIC, 78 | ); 79 | expect(plotEvent).toBeTruthy(); 80 | 81 | expect(spell).toMatchObject({ 82 | hash: plotEvent.planHash, 83 | guy: plotEvent.decoded.guy, 84 | usr: plotEvent.decodedCall.usr, 85 | tag: plotEvent.decodedCall.tag, 86 | fax: plotEvent.decodedCall.fax.trim(), 87 | eta: plotEvent.decodedCall.eta, 88 | }); 89 | }); 90 | 91 | expect(mockContractInstance.queryFilter).toHaveBeenCalled(); 92 | }); 93 | 94 | it("should fetch pending spells correctly", async () => { 95 | const result = await fetchPausePlans(mockContractInstance, { 96 | status: "PENDING", 97 | }); 98 | expect(result).toHaveLength(eventStats.pendingCount); 99 | 100 | result.forEach((spell) => { 101 | const plotEvent = processedEvents.find( 102 | (e) => e.planHash === spell.hash && e.topics[0] === PLOT_TOPIC, 103 | ); 104 | expect(plotEvent).toBeTruthy(); 105 | 106 | const execEvent = processedEvents.find( 107 | (e) => e.planHash === spell.hash && e.topics[0] === EXEC_TOPIC, 108 | ); 109 | const dropEvent = processedEvents.find( 110 | (e) => e.planHash === spell.hash && e.topics[0] === DROP_TOPIC, 111 | ); 112 | expect(execEvent).toBeUndefined(); 113 | expect(dropEvent).toBeUndefined(); 114 | 115 | expect(spell).toMatchObject({ 116 | hash: plotEvent.planHash, 117 | guy: plotEvent.decoded.guy, 118 | usr: plotEvent.decodedCall.usr, 119 | tag: plotEvent.decodedCall.tag, 120 | fax: plotEvent.decodedCall.fax.trim(), 121 | eta: plotEvent.decodedCall.eta, 122 | status: "PENDING", 123 | }); 124 | }); 125 | }); 126 | 127 | it("should fetch executed spells correctly", async () => { 128 | const result = await fetchPausePlans(mockContractInstance, { 129 | status: "EXECUTED", 130 | }); 131 | expect(result).toHaveLength(eventStats.execCount); 132 | 133 | result.forEach((spell) => { 134 | const plotEvent = processedEvents.find( 135 | (e) => e.planHash === spell.hash && e.topics[0] === PLOT_TOPIC, 136 | ); 137 | const execEvent = processedEvents.find( 138 | (e) => e.planHash === spell.hash && e.topics[0] === EXEC_TOPIC, 139 | ); 140 | 141 | expect(plotEvent).toBeTruthy(); 142 | expect(execEvent).toBeTruthy(); 143 | 144 | const dropEvent = processedEvents.find( 145 | (e) => e.planHash === spell.hash && e.topics[0] === DROP_TOPIC, 146 | ); 147 | expect(dropEvent).toBeUndefined(); 148 | 149 | expect(spell).toMatchObject({ 150 | hash: plotEvent.planHash, 151 | guy: plotEvent.decoded.guy, 152 | usr: plotEvent.decodedCall.usr, 153 | tag: plotEvent.decodedCall.tag, 154 | fax: plotEvent.decodedCall.fax.trim(), 155 | eta: plotEvent.decodedCall.eta, 156 | status: "EXECUTED", 157 | }); 158 | }); 159 | }); 160 | 161 | it("should fetch dropped spells correctly", async () => { 162 | const result = await fetchPausePlans(mockContractInstance, { 163 | status: "DROPPED", 164 | }); 165 | expect(result).toHaveLength(eventStats.dropCount); 166 | 167 | result.forEach((spell) => { 168 | const plotEvent = processedEvents.find( 169 | (e) => e.planHash === spell.hash && e.topics[0] === PLOT_TOPIC, 170 | ); 171 | const dropEvent = processedEvents.find( 172 | (e) => e.planHash === spell.hash && e.topics[0] === DROP_TOPIC, 173 | ); 174 | 175 | expect(plotEvent).toBeTruthy(); 176 | expect(dropEvent).toBeTruthy(); 177 | 178 | const execEvent = processedEvents.find( 179 | (e) => e.planHash === spell.hash && e.topics[0] === EXEC_TOPIC, 180 | ); 181 | expect(execEvent).toBeUndefined(); 182 | 183 | expect(spell).toMatchObject({ 184 | hash: plotEvent.planHash, 185 | guy: plotEvent.decoded.guy, 186 | usr: plotEvent.decodedCall.usr, 187 | tag: plotEvent.decodedCall.tag, 188 | fax: plotEvent.decodedCall.fax.trim(), 189 | eta: plotEvent.decodedCall.eta, 190 | status: "DROPPED", 191 | }); 192 | }); 193 | }); 194 | 195 | it("should fetch spells from specified block number", async () => { 196 | const fromBlock = 16700000; // intentionally broke down one of the events (plot before this block, exec after) 197 | const result = await fetchPausePlans(mockContractInstance, { 198 | fromBlock, 199 | }); 200 | 201 | expect(mockContractInstance.queryFilter).toHaveBeenCalledWith( 202 | [[PLOT_TOPIC, EXEC_TOPIC, DROP_TOPIC]], 203 | fromBlock, 204 | ); 205 | 206 | const expectedEvents = mockEvents.filter((e) => { 207 | const matchesBlock = e.blockNumber >= fromBlock; 208 | const matchesTopic = [PLOT_TOPIC, EXEC_TOPIC, DROP_TOPIC].includes( 209 | e.topics[0], 210 | ); 211 | return matchesBlock && matchesTopic; 212 | }); 213 | 214 | const allEventsByHash = new Map(); 215 | processedEvents.forEach((event) => { 216 | if (!allEventsByHash.has(event.planHash)) { 217 | allEventsByHash.set(event.planHash, []); 218 | } 219 | allEventsByHash.get(event.planHash).push(event); 220 | }); 221 | 222 | const expectedSpells = new Set(); 223 | expectedEvents.forEach((event) => { 224 | const decodedCall = decodeCallParams( 225 | event.topics[0].slice(0, 10), 226 | decodeLogNote(event, mockContractInstance).fax, 227 | mockContractInstance, 228 | ); 229 | const planHash = hash(decodedCall); 230 | const spellEvents = allEventsByHash.get(planHash) || []; 231 | 232 | // A spell should be included if: 233 | // 1. Its PLOT event is after fromBlock, or 234 | // 2. Its EXEC/DROP event is after fromBlock and determines its final status 235 | const plotEvent = spellEvents.find( 236 | (e) => e.topics[0] === PLOT_TOPIC, 237 | ); 238 | const execEvent = spellEvents.find( 239 | (e) => e.topics[0] === EXEC_TOPIC, 240 | ); 241 | const dropEvent = spellEvents.find( 242 | (e) => e.topics[0] === DROP_TOPIC, 243 | ); 244 | 245 | if (plotEvent && plotEvent.blockNumber >= fromBlock) { 246 | expectedSpells.add(planHash); 247 | } else if (execEvent && execEvent.blockNumber >= fromBlock) { 248 | expectedSpells.add(planHash); 249 | } else if (dropEvent && dropEvent.blockNumber >= fromBlock) { 250 | expectedSpells.add(planHash); 251 | } 252 | }); 253 | 254 | expect(result).toHaveLength(expectedSpells.size); 255 | 256 | result.forEach((spell) => { 257 | const spellEvents = allEventsByHash.get(spell.hash) || []; 258 | const plotEvent = spellEvents.find( 259 | (e) => e.topics[0] === PLOT_TOPIC, 260 | ); 261 | const execEvent = spellEvents.find( 262 | (e) => e.topics[0] === EXEC_TOPIC, 263 | ); 264 | const dropEvent = spellEvents.find( 265 | (e) => e.topics[0] === DROP_TOPIC, 266 | ); 267 | 268 | expect(plotEvent).toBeTruthy(); 269 | 270 | if ( 271 | spell.status === "EXECUTED" && 272 | execEvent && 273 | execEvent.blockNumber >= fromBlock 274 | ) { 275 | expect(execEvent.blockNumber).toBeGreaterThanOrEqual(fromBlock); 276 | } 277 | if ( 278 | spell.status === "DROPPED" && 279 | dropEvent && 280 | dropEvent.blockNumber >= fromBlock 281 | ) { 282 | expect(dropEvent.blockNumber).toBeGreaterThanOrEqual(fromBlock); 283 | } 284 | }); 285 | }); 286 | }); 287 | -------------------------------------------------------------------------------- /foundry.toml: -------------------------------------------------------------------------------- 1 | [profile.default] 2 | src = "src" 3 | out = "out" 4 | script = 'script' 5 | libs = ["lib"] 6 | solc = '0.8.16' 7 | optimizer = true 8 | 9 | fs_permissions = [ 10 | { access = "read", path = "./out/" }, 11 | { access = "read", path = "./script/input/" }, 12 | { access = "read-write", path = "./script/output/" } 13 | ] 14 | 15 | [fuzz] 16 | runs = 1_000 17 | 18 | [rpc_endpoints] 19 | mainnet = "${ETH_RPC_URL}" 20 | -------------------------------------------------------------------------------- /script/ProtegoDeploy.s.sol: -------------------------------------------------------------------------------- 1 | // SPDX-FileCopyrightText: © 2023 Dai Foundation 2 | // SPDX-License-Identifier: AGPL-3.0-or-later 3 | // 4 | // This program is free software: you can redistribute it and/or modify 5 | // it under the terms of the GNU Affero General Public License as published by 6 | // the Free Software Foundation, either version 3 of the License, or 7 | // (at your option) any later version. 8 | // 9 | // This program is distributed in the hope that it will be useful, 10 | // but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | // GNU Affero General Public License for more details. 13 | // 14 | // You should have received a copy of the GNU Affero General Public License 15 | // along with this program. If not, see . 16 | pragma solidity ^0.8.16; 17 | 18 | import {Script} from "forge-std/Script.sol"; 19 | import {MCD, DssInstance} from "dss-test/MCD.sol"; 20 | import {ScriptTools} from "dss-test/ScriptTools.sol"; 21 | import {ProtegoDeploy, ProtegoDeployParams} from "./dependencies/ProtegoDeploy.sol"; 22 | import {ProtegoInstance} from "./dependencies/ProtegoInstance.sol"; 23 | 24 | contract ProtegoDeployScript is Script { 25 | using ScriptTools for string; 26 | 27 | string constant NAME = "protego"; 28 | 29 | address constant CHAINLOG = 0xdA0Ab1e0017DEbCd72Be8599041a2aa3bA7e740F; 30 | DssInstance dss = MCD.loadFromChainlog(CHAINLOG); 31 | address pause = dss.chainlog.getAddress("MCD_PAUSE"); 32 | ProtegoInstance inst; 33 | 34 | function run() external { 35 | vm.startBroadcast(); 36 | 37 | inst = ProtegoDeploy.deploy(ProtegoDeployParams({pause: pause})); 38 | 39 | vm.stopBroadcast(); 40 | 41 | ScriptTools.exportContract(NAME, "protego", inst.protego); 42 | } 43 | } 44 | -------------------------------------------------------------------------------- /script/dependencies/ProtegoDeploy.sol: -------------------------------------------------------------------------------- 1 | // SPDX-FileCopyrightText: © 2023 Dai Foundation 2 | // SPDX-License-Identifier: AGPL-3.0-or-later 3 | // 4 | // This program is free software: you can redistribute it and/or modify 5 | // it under the terms of the GNU Affero General Public License as published by 6 | // the Free Software Foundation, either version 3 of the License, or 7 | // (at your option) any later version. 8 | // 9 | // This program is distributed in the hope that it will be useful, 10 | // but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | // GNU Affero General Public License for more details. 13 | // 14 | // You should have received a copy of the GNU Affero General Public License 15 | // along with this program. If not, see . 16 | pragma solidity ^0.8.16; 17 | 18 | import {ScriptTools} from "dss-test/ScriptTools.sol"; 19 | import {Protego} from "src/Protego.sol"; 20 | import {ProtegoInstance} from "./ProtegoInstance.sol"; 21 | 22 | struct ProtegoDeployParams { 23 | address pause; 24 | } 25 | 26 | library ProtegoDeploy { 27 | function deploy(ProtegoDeployParams memory p) internal returns (ProtegoInstance memory r) { 28 | r.protego = address(new Protego(p.pause)); 29 | } 30 | } 31 | -------------------------------------------------------------------------------- /script/dependencies/ProtegoInstance.sol: -------------------------------------------------------------------------------- 1 | // SPDX-FileCopyrightText: © 2023 Dai Foundation 2 | // SPDX-License-Identifier: AGPL-3.0-or-later 3 | // 4 | // This program is free software: you can redistribute it and/or modify 5 | // it under the terms of the GNU Affero General Public License as published by 6 | // the Free Software Foundation, either version 3 of the License, or 7 | // (at your option) any later version. 8 | // 9 | // This program is distributed in the hope that it will be useful, 10 | // but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | // GNU Affero General Public License for more details. 13 | // 14 | // You should have received a copy of the GNU Affero General Public License 15 | // along with this program. If not, see . 16 | pragma solidity ^0.8.16; 17 | 18 | struct ProtegoInstance { 19 | address protego; 20 | } 21 | -------------------------------------------------------------------------------- /script/input/1/README.md: -------------------------------------------------------------------------------- 1 | Inputs for Mainnet scripts. 2 | -------------------------------------------------------------------------------- /script/output/1/README.md: -------------------------------------------------------------------------------- 1 | Outputs for Mainnet scripts. 2 | -------------------------------------------------------------------------------- /src/EmergencyDropSpell.sol: -------------------------------------------------------------------------------- 1 | // SPDX-FileCopyrightText: © 2024 Dai Foundation 2 | // SPDX-License-Identifier: AGPL-3.0-or-later 3 | // 4 | // This program is free software: you can redistribute it and/or modify 5 | // it under the terms of the GNU Affero General Public License as published by 6 | // the Free Software Foundation, either version 3 of the License, or 7 | // (at your option) any later version. 8 | // 9 | // This program is distributed in the hope that it will be useful, 10 | // but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | // GNU Affero General Public License for more details. 13 | // 14 | // You should have received a copy of the GNU Affero General Public License 15 | // along with this program. If not, see . 16 | pragma solidity ^0.8.16; 17 | 18 | interface ProtegoLike { 19 | function id(address _usr, bytes32 _tag, bytes memory _fax, uint256 _eta) external view returns (bytes32); 20 | function planned(address _usr, bytes32 _tag, bytes memory _fax, uint256 _eta) external view returns (bool); 21 | function pause() external view returns (address); 22 | } 23 | 24 | interface DsPauseLike { 25 | function plans(bytes32) external view returns (bool); 26 | function drop(address, bytes32, bytes calldata, uint256) external; 27 | } 28 | 29 | interface EmergencySpellLike { 30 | function action() external view returns (address); 31 | function cast() external; 32 | function description() external view returns (string memory); 33 | function done() external view returns (bool); 34 | function eta() external view returns (uint256); 35 | function expiration() external view returns (uint256); 36 | function log() external view returns (address); 37 | function nextCastTime() external view returns (uint256); 38 | function officeHours() external view returns (bool); 39 | function pause() external view returns (DsPauseLike); 40 | function schedule() external; 41 | function sig() external view returns (bytes memory); 42 | function tag() external view returns (bytes32); 43 | } 44 | 45 | /// @title A spell that drops a plan from `MCD_PAUSE` when is cast. 46 | contract EmergencyDropSpell is EmergencySpellLike { 47 | /// @notice The Chainlog contract address. 48 | /// @dev Not used in this contract. Declared to keep compatibility with `DssExec`. 49 | address public constant log = 0xdA0Ab1e0017DEbCd72Be8599041a2aa3bA7e740F; 50 | /// @notice By definition, office hours are not applicable to emergency spells. 51 | bool public constant officeHours = false; 52 | /// @notice Emergency spells should not expire. 53 | uint256 public constant expiration = type(uint256).max; 54 | 55 | /// @notice The Protego factory that deployed the spell. 56 | ProtegoLike public immutable protego; 57 | /// @notice The MCD_PAUSE instance. 58 | DsPauseLike public immutable pause; 59 | /// @notice The original spell action address. 60 | address public immutable action; 61 | /// @notice The original spell action tag (i.e.: `extcodehash`). 62 | bytes32 public immutable tag; 63 | /// @notice The original spell earliest execution time. 64 | uint256 public immutable eta; 65 | /// @notice The original spell encoded call. 66 | bytes public sig; 67 | /** 68 | * @dev An emergency spell does not need to be cast, as all actions happen during the schedule phase. 69 | * Notice that cast is usually not supposed to revert, so it is implemented as a no-op. 70 | */ 71 | uint256 public immutable nextCastTime = type(uint256).max; 72 | 73 | /// @notice Drop have been called. 74 | event Drop(); 75 | 76 | /** 77 | * @param _protego The Protego factory that deployed the spell. 78 | * @param _usr The original spell action address. 79 | * @param _tag The original spell action tag (i.e.: `extcodehash`). 80 | * @param _fax The original spell encoded call. 81 | * @param _eta The original spell earliest execution time. 82 | */ 83 | constructor(address _protego, address _usr, bytes32 _tag, bytes memory _fax, uint256 _eta) { 84 | protego = ProtegoLike(_protego); 85 | pause = DsPauseLike(ProtegoLike(_protego).pause()); 86 | action = _usr; 87 | tag = _tag; 88 | sig = _fax; 89 | eta = _eta; 90 | } 91 | 92 | /** 93 | * @notice Alias for `drop`. 94 | * @dev for compatibility with `DssExec`. 95 | */ 96 | function schedule() external { 97 | drop(); 98 | } 99 | 100 | /// @notice Drops the original spell. 101 | function drop() public { 102 | pause.drop(action, tag, sig, eta); 103 | emit Drop(); 104 | } 105 | 106 | /// @notice No-op. 107 | function cast() external {} 108 | 109 | /// @notice Returns the description of the spell in the format "Sky Protocol Drop Spell: " 110 | function description() external view returns (string memory) { 111 | return string(abi.encodePacked("Sky Protocol Drop Spell: ", protego.id(action, tag, sig, eta))); 112 | } 113 | 114 | /// @notice Returns true if the original spell has been dropped or has never been planned. 115 | function done() external view returns (bool) { 116 | return !planned(); 117 | } 118 | 119 | /// @notice Returns whether the original spell is currently planned or not. 120 | function planned() public view returns (bool) { 121 | return protego.planned(action, tag, sig, eta); 122 | } 123 | } 124 | -------------------------------------------------------------------------------- /src/Protego.sol: -------------------------------------------------------------------------------- 1 | // SPDX-FileCopyrightText: © 2024 Dai Foundation 2 | // SPDX-License-Identifier: AGPL-3.0-or-later 3 | // 4 | // This program is free software: you can redistribute it and/or modify 5 | // it under the terms of the GNU Affero General Public License as published by 6 | // the Free Software Foundation, either version 3 of the License, or 7 | // (at your option) any later version. 8 | // 9 | // This program is distributed in the hope that it will be useful, 10 | // but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | // GNU Affero General Public License for more details. 13 | // 14 | // You should have received a copy of the GNU Affero General Public License 15 | // along with this program. If not, see . 16 | pragma solidity ^0.8.16; 17 | 18 | import {EmergencyDropSpell} from "./EmergencyDropSpell.sol"; 19 | 20 | interface DsPauseLike { 21 | function plans(bytes32) external view returns (bool); 22 | function drop(address, bytes32, bytes calldata, uint256) external; 23 | } 24 | 25 | /// @title Protego: permissionlessly drop any plan in `DsPause`-like contracts. 26 | contract Protego { 27 | /// @notice A reference to the `DsPause` contract. 28 | address public immutable pause; 29 | 30 | /** 31 | * @notice A new `EmergencyDropSpell` instance was deployed. 32 | * @param dropSpell The new `EmergencyDropSpell` address. 33 | */ 34 | event Deploy(address dropSpell); 35 | 36 | /** 37 | * @notice A spell plan was dropped. 38 | * @param id The ID of the dropped plan. 39 | */ 40 | event Drop(bytes32 id); 41 | 42 | /// @param _pause A reference to the `DsPause` contract. 43 | constructor(address _pause) { 44 | pause = _pause; 45 | } 46 | 47 | /** 48 | * @notice Deploys a spell to drop a plan based on attributes. 49 | * @param _usr The address of the scheduled spell. 50 | * @param _tag The tag identifying the address. 51 | * @param _fax The encoded call to be made in `_usr`. 52 | * @param _eta The earliest execution time. 53 | * @return _spell The `EmergencyDropSpell` address. 54 | */ 55 | function deploy(address _usr, bytes32 _tag, bytes memory _fax, uint256 _eta) public returns (address _spell) { 56 | _spell = address(new EmergencyDropSpell(address(this), _usr, _tag, _fax, _eta)); 57 | emit Deploy(_spell); 58 | } 59 | 60 | /** 61 | * @notice Calculates the id for a set of attributes. 62 | * @param _usr The address of the scheduled spell. 63 | * @param _tag The tag identifying the address. 64 | * @param _fax The encoded call to be made in `_usr`. 65 | * @param _eta The earliest execution time. 66 | */ 67 | function id(address _usr, bytes32 _tag, bytes memory _fax, uint256 _eta) public pure returns (bytes32) { 68 | return keccak256(abi.encode(_usr, _tag, _fax, _eta)); 69 | } 70 | 71 | /** 72 | * @notice Returns whether a plan matching the set of attributes is currently planned. 73 | * @param _usr The address of the scheduled spell. 74 | * @param _tag The tag identifying the address. 75 | * @param _fax The encoded call to be made in `_usr`. 76 | * @param _eta The earliest execution time. 77 | */ 78 | function planned(address _usr, bytes32 _tag, bytes memory _fax, uint256 _eta) external view returns (bool) { 79 | return planned(id(_usr, _tag, _fax, _eta)); 80 | } 81 | 82 | /** 83 | * @notice Returns whether an id is planned or not. 84 | * @param _id The id of the plan. 85 | */ 86 | function planned(bytes32 _id) public view returns (bool) { 87 | return DsPauseLike(pause).plans(_id); 88 | } 89 | 90 | /** 91 | * @notice Permissionlessly drop anything that has been planned on the pause. 92 | * @dev In some cases, due to a faulty spell being voted, a governance attack or other unforeseen causes, it may be 93 | * necessary to block any spell that is entered into the pause proxy. 94 | * In this extreme case, the system can be protected during the pause delay by lifting the Protego contract to 95 | * the hat role, which will allow any user to permissionlessly drop any id from the pause. 96 | * This function is expected to revert if it does not have the authority to perform this function. 97 | * @param _usr The address of the scheduled spell. 98 | * @param _tag The tag identifying the address. 99 | * @param _fax The encoded call to be made in `_usr`. 100 | * @param _eta The expiration time. 101 | */ 102 | function drop(address _usr, bytes32 _tag, bytes memory _fax, uint256 _eta) public { 103 | DsPauseLike(pause).drop(_usr, _tag, _fax, _eta); 104 | emit Drop(id(_usr, _tag, _fax, _eta)); 105 | } 106 | 107 | /** 108 | * @notice A struct representing a plan. 109 | * @param usr The address of the scheduled spell. 110 | * @param tag The tag identifying the address. 111 | * @param fax The encoded call to be made in `usr`. 112 | * @param eta The expiration time. 113 | */ 114 | struct Plan { 115 | address usr; 116 | bytes32 tag; 117 | bytes fax; 118 | uint256 eta; 119 | } 120 | 121 | /** 122 | * @notice Drop multiple plans in a single call. 123 | * @dev If an empty array is passed, no spells are dropped and nothing happens as 124 | * `DsPauseLike::drop` is not called. 125 | * @param _plans An array of plans to drop. 126 | */ 127 | function drop(Plan[] calldata _plans) external { 128 | for (uint256 i; i < _plans.length;) { 129 | drop(_plans[i].usr, _plans[i].tag, _plans[i].fax, _plans[i].eta); 130 | 131 | unchecked { 132 | i++; 133 | } 134 | } 135 | } 136 | } 137 | -------------------------------------------------------------------------------- /src/Protego.t.sol: -------------------------------------------------------------------------------- 1 | // SPDX-FileCopyrightText: © 2024 Dai Foundation 2 | // SPDX-License-Identifier: AGPL-3.0-or-later 3 | // 4 | // This program is free software: you can redistribute it and/or modify 5 | // it under the terms of the GNU Affero General Public License as published by 6 | // the Free Software Foundation, either version 3 of the License, or 7 | // (at your option) any later version. 8 | // 9 | // This program is distributed in the hope that it will be useful, 10 | // but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | // GNU Affero General Public License for more details. 13 | // 14 | // You should have received a copy of the GNU Affero General Public License 15 | // along with this program. If not, see . 16 | pragma solidity ^0.8.16; 17 | 18 | import {DssTest} from "dss-test/DssTest.sol"; 19 | import {Protego, EmergencyDropSpell} from "../src/Protego.sol"; 20 | import {ConformingSpell} from "./test/ConformingSpell.sol"; 21 | import {NonConformingSpell} from "./test/NonConformingSpell.sol"; 22 | 23 | interface ChainlogLike { 24 | function getAddress(bytes32) external view returns (address); 25 | } 26 | 27 | interface DsPauseLike { 28 | function plot(address, bytes32, bytes calldata, uint256) external; 29 | function drop(address, bytes32, bytes calldata, uint256) external; 30 | function exec(address, bytes32, bytes calldata, uint256) external returns (bytes memory); 31 | } 32 | 33 | interface DsChiefLike { 34 | function GOV() external view returns (address); 35 | function hat() external view returns (address); 36 | function lock(uint256) external; 37 | function vote(address[] calldata) external returns (bytes32); 38 | function lift(address) external; 39 | } 40 | 41 | interface GemLike { 42 | function balanceOf(address) external view returns (uint256); 43 | function transfer(address, uint256) external returns (bool); 44 | function allowance(address, address) external view returns (uint256); 45 | function approve(address, uint256) external returns (bool); 46 | function approve(address) external returns (bool); 47 | function transferFrom(address, address, uint256) external returns (bool); 48 | } 49 | 50 | struct BadSpell { 51 | address action; 52 | bytes32 tag; 53 | bytes sig; 54 | uint256 eta; 55 | } 56 | 57 | contract ProtegoTest is DssTest { 58 | DsChiefLike chief; 59 | GemLike gov; 60 | Protego protego; 61 | address pause; 62 | address end; 63 | 64 | function setUp() public { 65 | vm.createSelectFork("mainnet"); 66 | 67 | ChainlogLike chainlog = ChainlogLike(0xdA0Ab1e0017DEbCd72Be8599041a2aa3bA7e740F); 68 | chief = DsChiefLike(chainlog.getAddress("MCD_ADM")); 69 | gov = GemLike(chief.GOV()); 70 | pause = chainlog.getAddress("MCD_PAUSE"); 71 | protego = new Protego(pause); 72 | end = chainlog.getAddress("MCD_END"); 73 | } 74 | 75 | function testPause() public view { 76 | assertEq(protego.pause(), pause, "Pause address is incorrect"); 77 | } 78 | 79 | function testDeployDropSpell() public { 80 | ConformingSpell badSpell = new ConformingSpell(pause, end); 81 | 82 | assertFalse( 83 | protego.planned(badSpell.action(), badSpell.tag(), badSpell.sig(), badSpell.eta()), 84 | "Spell already planned for params" 85 | ); 86 | 87 | vm.expectEmit(true, true, true, true); 88 | emit Deploy(vm.computeCreateAddress(address(protego), vm.getNonce(address(protego)))); 89 | protego.deploy(badSpell.action(), badSpell.tag(), badSpell.sig(), badSpell.eta()); 90 | } 91 | 92 | function testPlanned() public { 93 | ConformingSpell badSpell = new ConformingSpell(pause, end); 94 | 95 | assertFalse( 96 | protego.planned(badSpell.action(), badSpell.tag(), badSpell.sig(), badSpell.eta()), 97 | "Spell already planned for params" 98 | ); 99 | 100 | _vote(address(badSpell)); 101 | badSpell.schedule(); 102 | 103 | assertTrue( 104 | protego.planned(badSpell.action(), badSpell.tag(), badSpell.sig(), badSpell.eta()), 105 | "Planned failed for params" 106 | ); 107 | assertTrue( 108 | protego.planned(protego.id(badSpell.action(), badSpell.tag(), badSpell.sig(), badSpell.eta())), 109 | "Planned failed for id" 110 | ); 111 | } 112 | 113 | function testId() public { 114 | ConformingSpell badSpell = new ConformingSpell(pause, end); 115 | address usr = badSpell.action(); 116 | bytes32 tag = badSpell.tag(); 117 | bytes memory sig = badSpell.sig(); 118 | uint256 eta = badSpell.eta(); 119 | 120 | bytes32 id = keccak256(abi.encode(usr, tag, sig, eta)); 121 | 122 | assertEq(id, protego.id(usr, tag, sig, eta), "Invalid id from params"); 123 | } 124 | 125 | // Test drop of spell created with params using a EmergencyDropSpell 126 | function testDropSpellParamsUsingEmergencyDropSpell() public { 127 | address usr = address(0x1337); 128 | bytes32 tag = keccak256("Bad spell"); 129 | bytes memory sig = abi.encodeWithSignature("destroy(bool)", true); 130 | uint256 eta = block.timestamp + 1000 days; 131 | 132 | NonConformingSpell badSpell = new NonConformingSpell(pause); 133 | 134 | assertFalse(protego.planned(usr, tag, sig, eta), "Spell already planned"); 135 | 136 | _vote(address(badSpell)); 137 | badSpell.plot(usr, tag, sig, eta); 138 | 139 | EmergencyDropSpell goodSpell = EmergencyDropSpell(protego.deploy(usr, tag, sig, eta)); 140 | 141 | assertTrue(protego.planned(usr, tag, sig, eta), "Before drop spell: not planned"); 142 | assertFalse(goodSpell.done(), "Before drop spell: already done"); 143 | 144 | _vote(address(goodSpell)); 145 | goodSpell.schedule(); 146 | 147 | assertTrue(goodSpell.done(), "After drop spell: not done"); 148 | assertFalse(protego.planned(usr, tag, sig, eta), "After drop spell: spell still planned"); 149 | } 150 | 151 | // Test dropping a single spell by lifting Protego to hat 152 | function testDropSingleSpellParamsWithHat() public { 153 | ConformingSpell badSpell = new ConformingSpell(pause, end); 154 | _vote(address(badSpell)); 155 | badSpell.schedule(); 156 | 157 | address usr = badSpell.action(); 158 | bytes32 tag = badSpell.tag(); 159 | bytes memory sig = badSpell.sig(); 160 | uint256 eta = badSpell.eta(); 161 | 162 | assertTrue(protego.planned(usr, tag, sig, eta), "Before drop spell: not planned"); 163 | 164 | _vote(address(protego)); 165 | 166 | vm.expectEmit(true, true, true, true); 167 | emit Drop(protego.id(usr, tag, sig, eta)); 168 | protego.drop(usr, tag, sig, eta); 169 | 170 | assertFalse(protego.planned(usr, tag, sig, eta), "After drop spell: still planned"); 171 | 172 | // After Protego loses the hat, it can no longer drop spells 173 | _vote(address(0)); 174 | vm.expectRevert("ds-auth-unauthorized"); 175 | protego.drop(usr, tag, sig, eta); 176 | } 177 | 178 | function testDropEmptyArray() public { 179 | Protego.Plan[] memory plans = new Protego.Plan[](0); 180 | // Start recording logs. 181 | vm.recordLogs(); 182 | // Start recording storage accesses. 183 | vm.record(); 184 | 185 | // If an empty array is passed, the call succeeds but nothing happens as no `DsPauseLike::drop` is called. 186 | protego.drop(plans); 187 | 188 | // Check that no events are emitted. 189 | assertEq(vm.getRecordedLogs().length, 0, "After drop: unexpected logs were emitted"); 190 | 191 | // Get all storage accesses since `vm.record()` was called. 192 | (, bytes32[] memory writeSlots) = vm.accesses(address(pause)); 193 | // Check that DsPause's storage stays unchanged. 194 | assertEq(writeSlots.length, 0, "After drop: unexpected write slot"); 195 | } 196 | 197 | // Fuzz test dropping multiple spells by lifting Protego to hat 198 | function testFuzzDropManySpellsParamsWithHat(uint256 iter) public { 199 | iter = bound(iter, 1, 50); 200 | BadSpell[] memory badSpells = new BadSpell[](iter); 201 | 202 | for (uint256 i; i < iter; i++) { 203 | ConformingSpell badSpell = new ConformingSpell(pause, end); 204 | _vote(address(badSpell)); 205 | badSpell.schedule(); 206 | 207 | badSpells[i].action = badSpell.action(); 208 | badSpells[i].tag = badSpell.tag(); 209 | badSpells[i].sig = badSpell.sig(); 210 | badSpells[i].eta = badSpell.eta(); 211 | 212 | assertTrue( 213 | protego.planned(badSpells[i].action, badSpells[i].tag, badSpells[i].sig, badSpells[i].eta), 214 | "Before drop spell: not planned" 215 | ); 216 | } 217 | 218 | _vote(address(protego)); 219 | 220 | Protego.Plan[] memory plans = new Protego.Plan[](iter); 221 | 222 | for (uint256 i; i < iter; i++) { 223 | plans[i] = Protego.Plan({ 224 | usr: badSpells[i].action, 225 | tag: badSpells[i].tag, 226 | fax: badSpells[i].sig, 227 | eta: badSpells[i].eta 228 | }); 229 | vm.expectEmit(true, true, true, true); 230 | emit Drop(protego.id(badSpells[i].action, badSpells[i].tag, badSpells[i].sig, badSpells[i].eta)); 231 | } 232 | 233 | protego.drop(plans); 234 | 235 | for (uint256 i; i < iter; i++) { 236 | assertFalse( 237 | protego.planned(badSpells[i].action, badSpells[i].tag, badSpells[i].sig, badSpells[i].eta), 238 | "After drop spell: still planned" 239 | ); 240 | } 241 | 242 | // After Protego loses the hat, it can no longer drop spells 243 | _vote(address(0)); 244 | vm.expectRevert("ds-auth-unauthorized"); 245 | protego.drop(plans); 246 | } 247 | 248 | function _vote(address spell_) internal { 249 | if (chief.hat() != spell_) { 250 | deal(address(gov), address(this), 999999999999 ether); 251 | gov.approve(address(chief), type(uint256).max); 252 | chief.lock(999999999999 ether); 253 | 254 | address[] memory slate = new address[](1); 255 | slate[0] = spell_; 256 | 257 | chief.vote(slate); 258 | chief.lift(spell_); 259 | } 260 | assertEq(chief.hat(), spell_, "spell is not the hat"); 261 | } 262 | 263 | event Deploy(address dropSpell); 264 | event Drop(bytes32 id); 265 | } 266 | -------------------------------------------------------------------------------- /src/test/ConformingSpell.sol: -------------------------------------------------------------------------------- 1 | // SPDX-FileCopyrightText: © 2024 Dai Foundation 2 | // SPDX-License-Identifier: AGPL-3.0-or-later 3 | // 4 | // This program is free software: you can redistribute it and/or modify 5 | // it under the terms of the GNU Affero General Public License as published by 6 | // the Free Software Foundation, either version 3 of the License, or 7 | // (at your option) any later version. 8 | // 9 | // This program is distributed in the hope that it will be useful, 10 | // but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | // GNU Affero General Public License for more details. 13 | // 14 | // You should have received a copy of the GNU Affero General Public License 15 | // along with this program. If not, see . 16 | pragma solidity ^0.8.16; 17 | 18 | interface TestEnd { 19 | function cage() external; 20 | } 21 | 22 | interface DsPauseLike { 23 | function delay() external view returns (uint256); 24 | function plot(address, bytes32, bytes calldata, uint256) external; 25 | function exec(address, bytes32, bytes calldata, uint256) external returns (bytes memory); 26 | } 27 | 28 | contract SpellAction { 29 | TestEnd immutable end; 30 | 31 | constructor(address _end) { 32 | end = TestEnd(_end); 33 | } 34 | 35 | function execute() external { 36 | end.cage(); 37 | } 38 | } 39 | 40 | contract ConformingSpell { 41 | DsPauseLike public pause; 42 | address public action; 43 | bytes32 public tag; 44 | bytes public sig; 45 | uint256 public eta; 46 | 47 | string public constant description = "End Cage Test Spell"; 48 | 49 | constructor(address _pause, address _end) { 50 | pause = DsPauseLike(_pause); 51 | sig = abi.encodeWithSignature("execute()"); 52 | action = address(new SpellAction(_end)); 53 | bytes32 _tag; 54 | address _action = action; 55 | assembly { 56 | _tag := extcodehash(_action) 57 | } 58 | tag = _tag; 59 | } 60 | 61 | function schedule() public { 62 | require(eta == 0, "This spell has already been scheduled"); 63 | eta = block.timestamp + pause.delay(); 64 | pause.plot(action, tag, sig, eta); 65 | } 66 | 67 | function cast() public { 68 | pause.exec(action, tag, sig, eta); 69 | } 70 | } 71 | -------------------------------------------------------------------------------- /src/test/NonConformingSpell.sol: -------------------------------------------------------------------------------- 1 | // SPDX-FileCopyrightText: © 2024 Dai Foundation 2 | // SPDX-License-Identifier: AGPL-3.0-or-later 3 | // 4 | // This program is free software: you can redistribute it and/or modify 5 | // it under the terms of the GNU Affero General Public License as published by 6 | // the Free Software Foundation, either version 3 of the License, or 7 | // (at your option) any later version. 8 | // 9 | // This program is distributed in the hope that it will be useful, 10 | // but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | // GNU Affero General Public License for more details. 13 | // 14 | // You should have received a copy of the GNU Affero General Public License 15 | // along with this program. If not, see . 16 | pragma solidity ^0.8.16; 17 | 18 | interface DsPauseLike { 19 | function plot(address, bytes32, bytes calldata, uint256) external; 20 | function drop(address, bytes32, bytes calldata, uint256) external; 21 | function exec(address, bytes32, bytes calldata, uint256) external returns (bytes memory); 22 | } 23 | 24 | contract NonConformingSpell { 25 | DsPauseLike public immutable pause; 26 | 27 | constructor(address pause_) { 28 | pause = DsPauseLike(pause_); 29 | } 30 | 31 | function plot(address usr, bytes32 tag, bytes memory fax, uint256 eta) public { 32 | pause.plot(usr, tag, fax, eta); 33 | } 34 | 35 | function exec(address usr, bytes32 tag, bytes memory fax, uint256 eta) public returns (bytes memory) { 36 | return pause.exec(usr, tag, fax, eta); 37 | } 38 | } 39 | --------------------------------------------------------------------------------