├── .gitattributes ├── .github └── workflows │ ├── forge-pr.yaml │ ├── forge.yaml │ └── slither.yaml ├── .gitignore ├── .gitmodules ├── LICENSE ├── Makefile ├── README.md ├── configs └── package.yaml ├── contracts ├── MapleProxiedInternals.sol ├── MapleProxyFactory.sol ├── interfaces │ ├── IMapleProxied.sol │ ├── IMapleProxyFactory.sol │ └── Interfaces.sol └── test │ ├── MapleProxyFactory.t.sol │ ├── accounts │ ├── Governor.sol │ └── User.sol │ └── mocks │ └── Mocks.sol ├── foundry.toml └── scripts ├── build.sh └── release.sh /.gitattributes: -------------------------------------------------------------------------------- 1 | *.sol linguist-language=Solidity 2 | -------------------------------------------------------------------------------- /.github/workflows/forge-pr.yaml: -------------------------------------------------------------------------------- 1 | name: Forge Tests (PR) 2 | 3 | on: 4 | pull_request: 5 | 6 | jobs: 7 | test: 8 | runs-on: ubuntu-latest 9 | steps: 10 | - uses: actions/checkout@v2 11 | 12 | - name: Install Foundry 13 | uses: onbjerg/foundry-toolchain@v1 14 | with: 15 | version: nightly 16 | 17 | - name: Install submodules 18 | run: | 19 | git config --global url."https://github.com/".insteadOf "git@github.com:" 20 | git submodule update --init --recursive 21 | 22 | - name: Run Forge tests 23 | run: forge test 24 | -------------------------------------------------------------------------------- /.github/workflows/forge.yaml: -------------------------------------------------------------------------------- 1 | name: Forge Tests 2 | 3 | on: 4 | push: 5 | branches: [main] 6 | 7 | jobs: 8 | test: 9 | runs-on: ubuntu-latest 10 | steps: 11 | - uses: actions/checkout@v2 12 | 13 | - name: Install Foundry 14 | uses: onbjerg/foundry-toolchain@v1 15 | with: 16 | version: nightly 17 | 18 | - name: Install submodules 19 | run: | 20 | git config --global url."https://github.com/".insteadOf "git@github.com:" 21 | git submodule update --init --recursive 22 | 23 | - name: Run Forge tests 24 | run: forge test 25 | -------------------------------------------------------------------------------- /.github/workflows/slither.yaml: -------------------------------------------------------------------------------- 1 | name: Slither Analysis 2 | 3 | on: 4 | push: 5 | branches: [main] 6 | pull_request: 7 | 8 | jobs: 9 | analyze: 10 | runs-on: ubuntu-latest 11 | steps: 12 | - uses: actions/checkout@v2 13 | 14 | - name: Install Foundry 15 | uses: onbjerg/foundry-toolchain@v1 16 | with: 17 | version: nightly 18 | 19 | - uses: crytic/slither-action@v0.1.1 20 | continue-on-error: true 21 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Forge 2 | cache/ 3 | out/ 4 | 5 | # MacOS 6 | .DS_Store 7 | -------------------------------------------------------------------------------- /.gitmodules: -------------------------------------------------------------------------------- 1 | [submodule "modules/proxy-factory"] 2 | path = modules/proxy-factory 3 | url = git@github.com:maple-labs/proxy-factory.git 4 | [submodule "modules/contract-test-utils"] 5 | path = modules/contract-test-utils 6 | url = git@github.com:maple-labs/contract-test-utils.git 7 | -------------------------------------------------------------------------------- /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 | -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | install: 2 | @git submodule update --init --recursive 3 | 4 | update: 5 | @forge update 6 | 7 | build: 8 | @scripts/build.sh 9 | 10 | release: 11 | @scripts/release.sh 12 | 13 | clean: 14 | @forge clean 15 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Maple Proxy Factory 2 | 3 | [![Foundry][foundry-badge]][foundry] 4 | [![Forge CI](https://github.com/maple-labs/maple-proxy-factory/actions/workflows/forge.yaml/badge.svg)](https://circleci.com/gh/maple-labs/maple-proxy-factory/tree/main) [![License: AGPL v3](https://img.shields.io/badge/License-AGPL%20v3-blue.svg)](https://www.gnu.org/licenses/agpl-3.0) 5 | 6 | [foundry]: https://getfoundry.sh/ 7 | [foundry-badge]: https://img.shields.io/badge/Built%20with-Foundry-FFDB1C.svg 8 | 9 | ## Overview 10 | 11 | `MapleProxyFactory` is a Maple protocol specific implementation of ProxyFactory, a set of generic contracts developed by Maple Labs to be able to deploy proxies from a factory and manage multiple implementations in a centrally managed contract. 12 | 13 | This contract has the following capabilities: 14 | 1. Add implementation contracts, tying them to a version. 15 | 2. Enable/disable upgrade paths between specific versions of implementations, preventing any unauthorized upgrade paths from being used. 16 | 3. Specify specialized "migrator" contracts to be used for certain upgrade paths, to perform custom storage manipulation operations during a given upgrade. 17 | 4. Deploy proxy contracts with a given implementation. 18 | 5. Perform upgrades from one implementation to another for a given proxy. 19 | 20 | ## Dependencies/Inheritance 21 | 22 | Contracts in this repo inherit and import code from: 23 | - [`maple-labs/proxy-factory`](https://github.com/maple-labs/proxy-factory) 24 | 25 | Contracts inherit and import code in the following ways: 26 | - `MapleProxyFactory` inherits `ProxyFactory` for proxy factory logic. 27 | 28 | Versions of dependencies can be checked with `git submodule status`. 29 | 30 | ## Setup 31 | 32 | This project was built using [Foundry](https://book.getfoundry.sh/). Refer to installation instructions [here](https://github.com/foundry-rs/foundry#installation). 33 | 34 | ```sh 35 | git clone git@github.com:maple-labs/maple-proxy-factory.git 36 | cd maple-proxy-factory 37 | forge install 38 | ``` 39 | 40 | ## Running Tests 41 | 42 | - To run all tests: `forge test` 43 | - To run specific tests: `forge test --match ` 44 | 45 | ## Audit Reports 46 | 47 | | Auditor | Report Link | 48 | |---|---| 49 | | Trail of Bits - LoanV2 | [`2021-12-28 - Trail of Bits Report`](https://docs.google.com/viewer?url=https://github.com/maple-labs/maple-core/files/7847684/Maple.Finance.-.Final.Report_v3.pdf) | 50 | | Code 4rena - LoanV2 | [`2022-01-05 - C4 Report`](https://code4rena.com/reports/2021-12-maple/) | 51 | | Trail of Bits - LoanV3 | [`2022-04-12 - Trail of Bits Report`](https://docs.google.com/viewer?url=https://github.com/maple-labs/maple-core/files/8507237/Maple.Finance.-.Final.Report.-.Fixes.pdf) | 52 | | Code 4rena - LoanV3 | [`2022-04-20 - C4 Report`](https://code4rena.com/reports/2022-03-maple/) | 53 | | Trail of Bits | [`2022-08-24 - Trail of Bits Report`](https://docs.google.com/viewer?url=https://github.com/maple-labs/maple-v2-audits/files/10246688/Maple.Finance.v2.-.Final.Report.-.Fixed.-.2022.pdf) | 54 | | Spearbit | [`2022-10-17 - Spearbit Report`](https://docs.google.com/viewer?url=https://github.com/maple-labs/maple-v2-audits/files/10223545/Maple.Finance.v2.-.Spearbit.pdf) | 55 | | Three Sigma | [`2022-10-24 - Three Sigma Report`](https://docs.google.com/viewer?url=https://github.com/maple-labs/maple-v2-audits/files/10223541/three-sigma_maple-finance_code-audit_v1.1.1.pdf) | 56 | 57 | ## Bug Bounty 58 | 59 | For all information related to the ongoing bug bounty for these contracts run by [Immunefi](https://immunefi.com/), please visit this [site](https://immunefi.com/bounty/maple/). 60 | 61 | ## About Maple 62 | 63 | [Maple Finance](https://maple.finance/) is a decentralized corporate credit market. Maple provides capital to institutional borrowers through globally accessible fixed-income yield opportunities. 64 | 65 | For all technical documentation related to the Maple V2 protocol, please refer to the GitHub [wiki](https://github.com/maple-labs/maple-core-v2/wiki). 66 | 67 | --- 68 | 69 |

70 | 71 |

72 | -------------------------------------------------------------------------------- /configs/package.yaml: -------------------------------------------------------------------------------- 1 | name: non-transparent-proxy 2 | version: 1.0.0-beta.0 3 | source: contracts 4 | packages: 5 | - path: contracts/NonTransparentProxied.sol 6 | contractName: NonTransparentProxied 7 | - path: contracts/NonTransparentProxy.sol 8 | contractName: NonTransparentProxy 9 | customDescription: NonTransparentProxy Artifacts and ABIs 10 | -------------------------------------------------------------------------------- /contracts/MapleProxiedInternals.sol: -------------------------------------------------------------------------------- 1 | // SPDX-License-Identifier: AGPL-3.0-or-later 2 | pragma solidity ^0.8.7; 3 | 4 | import { ProxiedInternals } from "../modules/proxy-factory/contracts/ProxiedInternals.sol"; 5 | 6 | /// @title A Maple implementation that is to be proxied, will need MapleProxiedInternals. 7 | abstract contract MapleProxiedInternals is ProxiedInternals { } 8 | -------------------------------------------------------------------------------- /contracts/MapleProxyFactory.sol: -------------------------------------------------------------------------------- 1 | // SPDX-License-Identifier: AGPL-3.0-or-later 2 | pragma solidity ^0.8.7; 3 | 4 | import { ProxyFactory } from "../modules/proxy-factory/contracts/ProxyFactory.sol"; 5 | 6 | import { IMapleGlobalsLike } from "./interfaces/Interfaces.sol"; 7 | import { IMapleProxied } from "./interfaces/IMapleProxied.sol"; 8 | import { IMapleProxyFactory } from "./interfaces/IMapleProxyFactory.sol"; 9 | 10 | /// @title A Maple factory for Proxy contracts that proxy MapleProxied implementations. 11 | contract MapleProxyFactory is IMapleProxyFactory, ProxyFactory { 12 | 13 | address public override mapleGlobals; 14 | 15 | uint256 public override defaultVersion; 16 | 17 | mapping(address => bool) public override isInstance; 18 | 19 | mapping(uint256 => mapping(uint256 => bool)) public override upgradeEnabledForPath; 20 | 21 | constructor(address mapleGlobals_) { 22 | require(IMapleGlobalsLike(mapleGlobals = mapleGlobals_).governor() != address(0), "MPF:C:INVALID_GLOBALS"); 23 | } 24 | 25 | modifier onlyGovernor() { 26 | require(msg.sender == IMapleGlobalsLike(mapleGlobals).governor(), "MPF:NOT_GOVERNOR"); 27 | _; 28 | } 29 | 30 | modifier whenProtocolNotPaused() { 31 | require(!IMapleGlobalsLike(mapleGlobals).protocolPaused(), "MPF:PROTOCOL_PAUSED"); 32 | _; 33 | } 34 | 35 | /**************************************************************************************************************************************/ 36 | /*** Admin Functions ***/ 37 | /**************************************************************************************************************************************/ 38 | 39 | function disableUpgradePath(uint256 fromVersion_, uint256 toVersion_) public override virtual onlyGovernor { 40 | require(fromVersion_ != toVersion_, "MPF:DUP:OVERWRITING_INITIALIZER"); 41 | require(_registerMigrator(fromVersion_, toVersion_, address(0)), "MPF:DUP:FAILED"); 42 | 43 | emit UpgradePathDisabled(fromVersion_, toVersion_); 44 | 45 | upgradeEnabledForPath[fromVersion_][toVersion_] = false; 46 | } 47 | 48 | function enableUpgradePath(uint256 fromVersion_, uint256 toVersion_, address migrator_) public override virtual onlyGovernor { 49 | require(fromVersion_ != toVersion_, "MPF:EUP:OVERWRITING_INITIALIZER"); 50 | require(_registerMigrator(fromVersion_, toVersion_, migrator_), "MPF:EUP:FAILED"); 51 | 52 | emit UpgradePathEnabled(fromVersion_, toVersion_, migrator_); 53 | 54 | upgradeEnabledForPath[fromVersion_][toVersion_] = true; 55 | } 56 | 57 | function registerImplementation(uint256 version_, address implementationAddress_, address initializer_) 58 | public override virtual onlyGovernor 59 | { 60 | // Version 0 reserved as "no version" since default `defaultVersion` is 0. 61 | require(version_ != uint256(0), "MPF:RI:INVALID_VERSION"); 62 | 63 | emit ImplementationRegistered(version_, implementationAddress_, initializer_); 64 | 65 | require(_registerImplementation(version_, implementationAddress_), "MPF:RI:FAIL_FOR_IMPLEMENTATION"); 66 | 67 | // Set migrator for initialization, which understood as fromVersion == toVersion. 68 | require(_registerMigrator(version_, version_, initializer_), "MPF:RI:FAIL_FOR_MIGRATOR"); 69 | } 70 | 71 | function setDefaultVersion(uint256 version_) public override virtual onlyGovernor { 72 | // Version must be 0 (to disable creating new instances) or be registered. 73 | require(version_ == 0 || _implementationOf[version_] != address(0), "MPF:SDV:INVALID_VERSION"); 74 | 75 | emit DefaultVersionSet(defaultVersion = version_); 76 | } 77 | 78 | function setGlobals(address mapleGlobals_) public override virtual onlyGovernor { 79 | require(IMapleGlobalsLike(mapleGlobals_).governor() != address(0), "MPF:SG:INVALID_GLOBALS"); 80 | 81 | emit MapleGlobalsSet(mapleGlobals = mapleGlobals_); 82 | } 83 | 84 | /**************************************************************************************************************************************/ 85 | /*** Instance Functions ***/ 86 | /**************************************************************************************************************************************/ 87 | 88 | function createInstance(bytes calldata arguments_, bytes32 salt_) 89 | public override virtual whenProtocolNotPaused returns (address instance_) 90 | { 91 | bool success; 92 | ( success, instance_ ) = _newInstance(arguments_, keccak256(abi.encodePacked(arguments_, salt_))); 93 | require(success, "MPF:CI:FAILED"); 94 | 95 | isInstance[instance_] = true; 96 | 97 | emit InstanceDeployed(defaultVersion, instance_, arguments_); 98 | } 99 | 100 | // NOTE: The implementation proxied by the instance defines the access control logic for its own upgrade. 101 | function upgradeInstance(uint256 toVersion_, bytes calldata arguments_) public override virtual whenProtocolNotPaused { 102 | uint256 fromVersion = _versionOf[IMapleProxied(msg.sender).implementation()]; 103 | 104 | require(upgradeEnabledForPath[fromVersion][toVersion_], "MPF:UI:NOT_ALLOWED"); 105 | 106 | emit InstanceUpgraded(msg.sender, fromVersion, toVersion_, arguments_); 107 | 108 | require(_upgradeInstance(msg.sender, toVersion_, arguments_), "MPF:UI:FAILED"); 109 | } 110 | 111 | /**************************************************************************************************************************************/ 112 | /*** View Functions ***/ 113 | /**************************************************************************************************************************************/ 114 | 115 | function getInstanceAddress(bytes calldata arguments_, bytes32 salt_) public view override virtual returns (address instanceAddress_) { 116 | return _getDeterministicProxyAddress(keccak256(abi.encodePacked(arguments_, salt_))); 117 | } 118 | 119 | function implementationOf(uint256 version_) public view override virtual returns (address implementation_) { 120 | return _implementationOf[version_]; 121 | } 122 | 123 | function defaultImplementation() external view override returns (address defaultImplementation_) { 124 | return _implementationOf[defaultVersion]; 125 | } 126 | 127 | function migratorForPath(uint256 oldVersion_, uint256 newVersion_) public view override virtual returns (address migrator_) { 128 | return _migratorForPath[oldVersion_][newVersion_]; 129 | } 130 | 131 | function versionOf(address implementation_) public view override virtual returns (uint256 version_) { 132 | return _versionOf[implementation_]; 133 | } 134 | 135 | } 136 | -------------------------------------------------------------------------------- /contracts/interfaces/IMapleProxied.sol: -------------------------------------------------------------------------------- 1 | // SPDX-License-Identifier: AGPL-3.0-or-later 2 | pragma solidity ^0.8.7; 3 | 4 | import { IProxied } from "../../modules/proxy-factory/contracts/interfaces/IProxied.sol"; 5 | 6 | /// @title A Maple implementation that is to be proxied, must implement IMapleProxied. 7 | interface IMapleProxied is IProxied { 8 | 9 | /** 10 | * @dev The instance was upgraded. 11 | * @param toVersion_ The new version of the loan. 12 | * @param arguments_ The upgrade arguments, if any. 13 | */ 14 | event Upgraded(uint256 toVersion_, bytes arguments_); 15 | 16 | /** 17 | * @dev Upgrades a contract implementation to a specific version. 18 | * Access control logic critical since caller can force a selfdestruct via a malicious `migrator_` which is delegatecalled. 19 | * @param toVersion_ The version to upgrade to. 20 | * @param arguments_ Some encoded arguments to use for the upgrade. 21 | */ 22 | function upgrade(uint256 toVersion_, bytes calldata arguments_) external; 23 | 24 | } 25 | -------------------------------------------------------------------------------- /contracts/interfaces/IMapleProxyFactory.sol: -------------------------------------------------------------------------------- 1 | // SPDX-License-Identifier: AGPL-3.0-or-later 2 | pragma solidity ^0.8.7; 3 | 4 | import { IDefaultImplementationBeacon } from "../../modules/proxy-factory/contracts/interfaces/IDefaultImplementationBeacon.sol"; 5 | 6 | /// @title A Maple factory for Proxy contracts that proxy MapleProxied implementations. 7 | interface IMapleProxyFactory is IDefaultImplementationBeacon { 8 | 9 | /**************************************************************************************************************************************/ 10 | /*** Events ***/ 11 | /**************************************************************************************************************************************/ 12 | 13 | /** 14 | * @dev A default version was set. 15 | * @param version_ The default version. 16 | */ 17 | event DefaultVersionSet(uint256 indexed version_); 18 | 19 | /** 20 | * @dev A version of an implementation, at some address, was registered, with an optional initializer. 21 | * @param version_ The version registered. 22 | * @param implementationAddress_ The address of the implementation. 23 | * @param initializer_ The address of the initializer, if any. 24 | */ 25 | event ImplementationRegistered(uint256 indexed version_, address indexed implementationAddress_, address indexed initializer_); 26 | 27 | /** 28 | * @dev A proxy contract was deployed with some initialization arguments. 29 | * @param version_ The version of the implementation being proxied by the deployed proxy contract. 30 | * @param instance_ The address of the proxy contract deployed. 31 | * @param initializationArguments_ The arguments used to initialize the proxy contract, if any. 32 | */ 33 | event InstanceDeployed(uint256 indexed version_, address indexed instance_, bytes initializationArguments_); 34 | 35 | /** 36 | * @dev A instance has upgraded by proxying to a new implementation, with some migration arguments. 37 | * @param instance_ The address of the proxy contract. 38 | * @param fromVersion_ The initial implementation version being proxied. 39 | * @param toVersion_ The new implementation version being proxied. 40 | * @param migrationArguments_ The arguments used to migrate, if any. 41 | */ 42 | event InstanceUpgraded(address indexed instance_, uint256 indexed fromVersion_, uint256 indexed toVersion_, bytes migrationArguments_); 43 | 44 | /** 45 | * @dev The MapleGlobals was set. 46 | * @param mapleGlobals_ The address of a Maple Globals contract. 47 | */ 48 | event MapleGlobalsSet(address indexed mapleGlobals_); 49 | 50 | /** 51 | * @dev An upgrade path was disabled, with an optional migrator contract. 52 | * @param fromVersion_ The starting version of the upgrade path. 53 | * @param toVersion_ The destination version of the upgrade path. 54 | */ 55 | event UpgradePathDisabled(uint256 indexed fromVersion_, uint256 indexed toVersion_); 56 | 57 | /** 58 | * @dev An upgrade path was enabled, with an optional migrator contract. 59 | * @param fromVersion_ The starting version of the upgrade path. 60 | * @param toVersion_ The destination version of the upgrade path. 61 | * @param migrator_ The address of the migrator, if any. 62 | */ 63 | event UpgradePathEnabled(uint256 indexed fromVersion_, uint256 indexed toVersion_, address indexed migrator_); 64 | 65 | /**************************************************************************************************************************************/ 66 | /*** State Variables ***/ 67 | /**************************************************************************************************************************************/ 68 | 69 | /** 70 | * @dev The default version. 71 | */ 72 | function defaultVersion() external view returns (uint256 defaultVersion_); 73 | 74 | /** 75 | * @dev The address of the MapleGlobals contract. 76 | */ 77 | function mapleGlobals() external view returns (address mapleGlobals_); 78 | 79 | /** 80 | * @dev Whether the upgrade is enabled for a path from a version to another version. 81 | * @param toVersion_ The initial version. 82 | * @param fromVersion_ The destination version. 83 | * @return allowed_ Whether the upgrade is enabled. 84 | */ 85 | function upgradeEnabledForPath(uint256 toVersion_, uint256 fromVersion_) external view returns (bool allowed_); 86 | 87 | /**************************************************************************************************************************************/ 88 | /*** State Changing Functions ***/ 89 | /**************************************************************************************************************************************/ 90 | 91 | /** 92 | * @dev Deploys a new instance proxying the default implementation version, with some initialization arguments. 93 | * Uses a nonce and `msg.sender` as a salt for the CREATE2 opcode during instantiation to produce deterministic addresses. 94 | * @param arguments_ The initialization arguments to use for the instance deployment, if any. 95 | * @param salt_ The salt to use in the contract creation process. 96 | * @return instance_ The address of the deployed proxy contract. 97 | */ 98 | function createInstance(bytes calldata arguments_, bytes32 salt_) external returns (address instance_); 99 | 100 | /** 101 | * @dev Enables upgrading from a version to a version of an implementation, with an optional migrator. 102 | * Only the Governor can call this function. 103 | * @param fromVersion_ The starting version of the upgrade path. 104 | * @param toVersion_ The destination version of the upgrade path. 105 | * @param migrator_ The address of the migrator, if any. 106 | */ 107 | function enableUpgradePath(uint256 fromVersion_, uint256 toVersion_, address migrator_) external; 108 | 109 | /** 110 | * @dev Disables upgrading from a version to a version of a implementation. 111 | * Only the Governor can call this function. 112 | * @param fromVersion_ The starting version of the upgrade path. 113 | * @param toVersion_ The destination version of the upgrade path. 114 | */ 115 | function disableUpgradePath(uint256 fromVersion_, uint256 toVersion_) external; 116 | 117 | /** 118 | * @dev Registers the address of an implementation contract as a version, with an optional initializer. 119 | * Only the Governor can call this function. 120 | * @param version_ The version to register. 121 | * @param implementationAddress_ The address of the implementation. 122 | * @param initializer_ The address of the initializer, if any. 123 | */ 124 | function registerImplementation(uint256 version_, address implementationAddress_, address initializer_) external; 125 | 126 | /** 127 | * @dev Sets the default version. 128 | * Only the Governor can call this function. 129 | * @param version_ The implementation version to set as the default. 130 | */ 131 | function setDefaultVersion(uint256 version_) external; 132 | 133 | /** 134 | * @dev Sets the Maple Globals contract. 135 | * Only the Governor can call this function. 136 | * @param mapleGlobals_ The address of a Maple Globals contract. 137 | */ 138 | function setGlobals(address mapleGlobals_) external; 139 | 140 | /** 141 | * @dev Upgrades the calling proxy contract's implementation, with some migration arguments. 142 | * @param toVersion_ The implementation version to upgrade the proxy contract to. 143 | * @param arguments_ The migration arguments, if any. 144 | */ 145 | function upgradeInstance(uint256 toVersion_, bytes calldata arguments_) external; 146 | 147 | /**************************************************************************************************************************************/ 148 | /*** View Functions ***/ 149 | /**************************************************************************************************************************************/ 150 | 151 | /** 152 | * @dev Returns the deterministic address of a potential proxy, given some arguments and salt. 153 | * @param arguments_ The initialization arguments to be used when deploying the proxy. 154 | * @param salt_ The salt to be used when deploying the proxy. 155 | * @return instanceAddress_ The deterministic address of a potential proxy. 156 | */ 157 | function getInstanceAddress(bytes calldata arguments_, bytes32 salt_) external view returns (address instanceAddress_); 158 | 159 | /** 160 | * @dev Returns the address of an implementation version. 161 | * @param version_ The implementation version. 162 | * @return implementation_ The address of the implementation. 163 | */ 164 | function implementationOf(uint256 version_) external view returns (address implementation_); 165 | 166 | /** 167 | * @dev Returns if a given address has been deployed by this factory/ 168 | * @param instance_ The address to check. 169 | * @return isInstance_ A boolean indication if the address has been deployed by this factory. 170 | */ 171 | function isInstance(address instance_) external view returns (bool isInstance_); 172 | 173 | /** 174 | * @dev Returns the address of a migrator contract for a migration path (from version, to version). 175 | * If oldVersion_ == newVersion_, the migrator is an initializer. 176 | * @param oldVersion_ The old version. 177 | * @param newVersion_ The new version. 178 | * @return migrator_ The address of a migrator contract. 179 | */ 180 | function migratorForPath(uint256 oldVersion_, uint256 newVersion_) external view returns (address migrator_); 181 | 182 | /** 183 | * @dev Returns the version of an implementation contract. 184 | * @param implementation_ The address of an implementation contract. 185 | * @return version_ The version of the implementation contract. 186 | */ 187 | function versionOf(address implementation_) external view returns (uint256 version_); 188 | 189 | } 190 | -------------------------------------------------------------------------------- /contracts/interfaces/Interfaces.sol: -------------------------------------------------------------------------------- 1 | // SPDX-License-Identifier: AGPL-3.0-or-later 2 | pragma solidity ^0.8.7; 3 | 4 | interface IMapleGlobalsLike { 5 | 6 | /// @dev The address of the Governor responsible for management of global Maple variables. 7 | function governor() external view returns (address governor_); 8 | 9 | function protocolPaused() external view returns (bool protocolPaused_); 10 | 11 | } 12 | -------------------------------------------------------------------------------- /contracts/test/MapleProxyFactory.t.sol: -------------------------------------------------------------------------------- 1 | // SPDX-License-Identifier: AGPL-3.0-or-later 2 | pragma solidity ^0.8.7; 3 | 4 | import { TestUtils } from "../../modules/contract-test-utils/contracts/test.sol"; 5 | import { MockInitializerV1, MockInitializerV2 } from "../../modules/proxy-factory/contracts/test/mocks/Mocks.sol"; 6 | 7 | import { Governor } from "./accounts/Governor.sol"; 8 | import { User } from "./accounts/User.sol"; 9 | 10 | import { EmptyContract, MapleGlobalsMock, MapleInstanceMock } from "./mocks/Mocks.sol"; 11 | 12 | import { MapleProxyFactory } from "../MapleProxyFactory.sol"; 13 | 14 | contract MapleProxyFactoryConstructorTests is TestUtils { 15 | 16 | function test_constructor() external { 17 | try new MapleProxyFactory(address(1)) { assertTrue(false, "Able to instantiate with non-contract"); } catch { } 18 | 19 | EmptyContract fakeContract = new EmptyContract(); 20 | 21 | try new MapleProxyFactory(address(fakeContract)) { assertTrue(false, "Able to instantiate with non-globals"); } catch { } 22 | 23 | MapleGlobalsMock globals = new MapleGlobalsMock(address(this)); 24 | 25 | MapleProxyFactory factory = new MapleProxyFactory(address(globals)); 26 | 27 | assertEq(factory.mapleGlobals(), address(globals)); 28 | } 29 | 30 | } 31 | 32 | contract MapleProxyFactoryTests is TestUtils { 33 | 34 | Governor internal governor; 35 | Governor internal notGovernor; 36 | MapleGlobalsMock internal globals; 37 | MapleInstanceMock internal implementation1; 38 | MapleInstanceMock internal implementation2; 39 | MapleProxyFactory internal factory; 40 | MockInitializerV1 internal initializerV1; 41 | MockInitializerV2 internal initializerV2; 42 | User internal user; 43 | 44 | function setUp() external { 45 | governor = new Governor(); 46 | implementation1 = new MapleInstanceMock(); 47 | implementation2 = new MapleInstanceMock(); 48 | initializerV1 = new MockInitializerV1(); 49 | initializerV2 = new MockInitializerV2(); 50 | notGovernor = new Governor(); 51 | user = new User(); 52 | 53 | globals = new MapleGlobalsMock(address(governor)); 54 | 55 | factory = new MapleProxyFactory(address(globals)); 56 | } 57 | 58 | function test_registerImplementation() external { 59 | assertTrue( 60 | !notGovernor.try_mapleProxyFactory_registerImplementation( 61 | address(factory), 62 | 1, 63 | address(implementation1), 64 | address(initializerV1) 65 | ), 66 | "Should fail: not governor" 67 | ); 68 | 69 | assertTrue( 70 | !governor.try_mapleProxyFactory_registerImplementation( 71 | address(factory), 72 | 0, 73 | address(implementation1), 74 | address(initializerV1) 75 | ), 76 | "Should fail: invalid version" 77 | ); 78 | 79 | assertTrue( 80 | !governor.try_mapleProxyFactory_registerImplementation( 81 | address(factory), 82 | 1, 83 | address(0), 84 | address(initializerV1) 85 | ), 86 | "Should fail: invalid implementation address" 87 | ); 88 | 89 | assertTrue( 90 | governor.try_mapleProxyFactory_registerImplementation( 91 | address(factory), 92 | 1, 93 | address(implementation1), 94 | address(initializerV1) 95 | ), 96 | "Should succeed" 97 | ); 98 | 99 | assertTrue( 100 | !governor.try_mapleProxyFactory_registerImplementation( 101 | address(factory), 102 | 1, 103 | address(implementation1), 104 | address(initializerV1) 105 | ), 106 | "Should fail: already registered version" 107 | ); 108 | 109 | assertEq(factory.implementationOf(1), address(implementation1), "Incorrect state of implementationOf"); 110 | 111 | assertEq(factory.migratorForPath(1, 1), address(initializerV1), "Incorrect state of migratorForPath"); 112 | 113 | assertEq(factory.versionOf(address(implementation1)), 1, "Incorrect state of versionOf"); 114 | } 115 | 116 | function test_setDefaultVersion() external { 117 | governor.mapleProxyFactory_registerImplementation(address(factory), 1, address(implementation1), address(initializerV1)); 118 | 119 | assertTrue(!notGovernor.try_mapleProxyFactory_setDefaultVersion(address(factory), 1), "Should fail: not governor"); 120 | assertTrue( !governor.try_mapleProxyFactory_setDefaultVersion(address(factory), 2), "Should fail: version not registered"); 121 | assertTrue( governor.try_mapleProxyFactory_setDefaultVersion(address(factory), 1), "Should succeed: set"); 122 | 123 | assertEq(factory.defaultVersion(), 1, "Incorrect state of defaultVersion"); 124 | assertEq(factory.defaultImplementation(), address(implementation1), "Incorrect defaultImplementation"); 125 | 126 | assertTrue(!notGovernor.try_mapleProxyFactory_setDefaultVersion(address(factory), 0), "Should fail: not governor"); 127 | assertTrue( governor.try_mapleProxyFactory_setDefaultVersion(address(factory), 0), "Should succeed: unset"); 128 | 129 | assertEq(factory.defaultVersion(), 0, "Incorrect state of defaultVersion"); 130 | assertEq(factory.defaultImplementation(), address(0), "Incorrect defaultImplementation"); 131 | } 132 | 133 | function test_createInstance_protocolPaused() external { 134 | governor.mapleProxyFactory_registerImplementation(address(factory), 1, address(implementation1), address(initializerV1)); 135 | governor.mapleProxyFactory_setDefaultVersion(address(factory), 1); 136 | 137 | globals.setProtocolPaused(true); 138 | 139 | bytes memory arguments = new bytes(0); 140 | bytes32 salt = keccak256(abi.encodePacked("salt")); 141 | 142 | vm.expectRevert("MPF:PROTOCOL_PAUSED"); 143 | factory.createInstance(arguments, salt); 144 | 145 | // Unpause protocol 146 | globals.setProtocolPaused(false); 147 | 148 | MapleInstanceMock instance = MapleInstanceMock(factory.createInstance(arguments, salt)); 149 | 150 | assertEq(factory.getInstanceAddress(arguments, salt), address(instance)); 151 | assertEq(instance.factory(), address(factory)); 152 | assertEq(instance.implementation(), address(implementation1)); 153 | assertEq(factory.versionOf(instance.implementation()), 1); 154 | } 155 | 156 | function test_createInstance() external { 157 | 158 | bytes memory arguments = new bytes(0); 159 | bytes32 salt = keccak256(abi.encodePacked("salt1")); 160 | 161 | assertTrue(!user.try_mapleProxyFactory_createInstance(address(factory), arguments, salt), "Should fail: unregistered version"); 162 | 163 | governor.mapleProxyFactory_registerImplementation(address(factory), 1, address(implementation1), address(initializerV1)); 164 | governor.mapleProxyFactory_setDefaultVersion(address(factory), 1); 165 | 166 | MapleInstanceMock instance1 = MapleInstanceMock(user.mapleProxyFactory_createInstance(address(factory), arguments, salt)); 167 | 168 | assertEq(factory.getInstanceAddress(arguments, salt), address(instance1)); 169 | assertEq(instance1.factory(), address(factory)); 170 | assertEq(instance1.implementation(), address(implementation1)); 171 | assertEq(factory.versionOf(instance1.implementation()), 1); 172 | 173 | assertTrue(!user.try_mapleProxyFactory_createInstance(address(factory), arguments, salt), "Should fail: reused salt"); 174 | 175 | salt = keccak256(abi.encodePacked("salt2")); 176 | 177 | MapleInstanceMock instance2 = MapleInstanceMock(user.mapleProxyFactory_createInstance(address(factory), arguments, salt)); 178 | 179 | assertEq(factory.getInstanceAddress(arguments, salt), address(instance2)); 180 | assertEq(instance2.factory(), address(factory)); 181 | assertEq(instance2.implementation(), address(implementation1)); 182 | assertEq(factory.versionOf(instance2.implementation()), 1); 183 | 184 | assertTrue(address(instance1) != address(instance2), "Instances should have unique addresses"); 185 | } 186 | 187 | function test_enableUpgradePath() external { 188 | governor.mapleProxyFactory_registerImplementation(address(factory), 1, address(implementation1), address(initializerV1)); 189 | governor.mapleProxyFactory_registerImplementation(address(factory), 2, address(implementation2), address(initializerV2)); 190 | 191 | address migrator = address(new EmptyContract()); 192 | 193 | assertTrue(!notGovernor.try_mapleProxyFactory_enableUpgradePath(address(factory), 1, 2, migrator), "Should fail: not governor"); 194 | 195 | assertTrue( 196 | !governor.try_mapleProxyFactory_enableUpgradePath(address(factory), 1, 1, migrator), 197 | "Should fail: overwriting initializer" 198 | ); 199 | 200 | assertTrue(governor.try_mapleProxyFactory_enableUpgradePath(address(factory), 1, 2, migrator), "Should succeed: upgrade"); 201 | 202 | assertEq(factory.migratorForPath(1, 2), migrator, "Incorrect migrator"); 203 | 204 | migrator = address(new EmptyContract()); 205 | 206 | assertTrue(governor.try_mapleProxyFactory_enableUpgradePath(address(factory), 2, 1, migrator), "Should succeed: downgrade"); 207 | 208 | assertEq(factory.migratorForPath(2, 1), migrator, "Incorrect migrator"); 209 | 210 | migrator = address(new EmptyContract()); 211 | 212 | assertTrue(governor.try_mapleProxyFactory_enableUpgradePath(address(factory), 1, 2, migrator), "Should succeed: change migrator"); 213 | 214 | assertEq(factory.migratorForPath(1, 2), migrator, "Incorrect migrator"); 215 | } 216 | 217 | function test_disableUpgradePath() external { 218 | governor.mapleProxyFactory_registerImplementation(address(factory), 1, address(implementation1), address(initializerV1)); 219 | governor.mapleProxyFactory_registerImplementation(address(factory), 2, address(implementation2), address(initializerV2)); 220 | 221 | address migrator = address(new EmptyContract()); 222 | 223 | governor.mapleProxyFactory_enableUpgradePath(address(factory), 1, 2, migrator); 224 | 225 | assertEq(factory.migratorForPath(1, 2), migrator, "Incorrect migrator"); 226 | 227 | assertTrue(!notGovernor.try_mapleProxyFactory_disableUpgradePath(address(factory), 1, 2), "Should fail: not governor"); 228 | assertTrue( !governor.try_mapleProxyFactory_disableUpgradePath(address(factory), 1, 1), "Should fail: overwriting initializer"); 229 | assertTrue( governor.try_mapleProxyFactory_disableUpgradePath(address(factory), 1, 2), "Should succeed"); 230 | 231 | assertEq(factory.migratorForPath(1, 2), address(0), "Incorrect migrator"); 232 | } 233 | 234 | function test_upgradeInstance_protocolPaused() external { 235 | governor.mapleProxyFactory_registerImplementation(address(factory), 1, address(implementation1), address(initializerV1)); 236 | governor.mapleProxyFactory_registerImplementation(address(factory), 2, address(implementation2), address(initializerV2)); 237 | governor.mapleProxyFactory_setDefaultVersion(address(factory), 1); 238 | 239 | bytes memory arguments = new bytes(0); 240 | bytes32 salt = keccak256(abi.encodePacked("salt")); 241 | 242 | MapleInstanceMock instance = MapleInstanceMock(factory.createInstance(arguments, salt)); 243 | 244 | assertEq(factory.getInstanceAddress(arguments, salt), address(instance)); 245 | assertEq(instance.factory(), address(factory)); 246 | assertEq(instance.implementation(), address(implementation1)); 247 | assertEq(factory.versionOf(instance.implementation()), 1); 248 | 249 | governor.mapleProxyFactory_enableUpgradePath(address(factory), 1, 2, address(0)); 250 | 251 | globals.setProtocolPaused(true); 252 | 253 | vm.expectRevert("MPF:PROTOCOL_PAUSED"); 254 | instance.upgrade(2, new bytes(0)); 255 | 256 | globals.setProtocolPaused(false); 257 | instance.upgrade(2, new bytes(0)); 258 | 259 | assertEq(instance.implementation(), address(implementation2)); 260 | 261 | assertEq(factory.versionOf(instance.implementation()), 2); 262 | } 263 | 264 | function test_upgradeInstance() external { 265 | governor.mapleProxyFactory_registerImplementation(address(factory), 1, address(implementation1), address(initializerV1)); 266 | governor.mapleProxyFactory_registerImplementation(address(factory), 2, address(implementation2), address(initializerV2)); 267 | governor.mapleProxyFactory_setDefaultVersion(address(factory), 1); 268 | 269 | bytes memory arguments = new bytes(0); 270 | bytes32 salt = keccak256(abi.encodePacked("salt")); 271 | 272 | MapleInstanceMock instance = MapleInstanceMock(user.mapleProxyFactory_createInstance(address(factory), arguments, salt)); 273 | 274 | assertEq(instance.implementation(), address(implementation1)); 275 | assertEq(factory.versionOf(instance.implementation()), 1); 276 | 277 | assertTrue(!user.try_mapleProxied_upgrade(address(instance), 2, new bytes(0)), "Should fail: upgrade path not enabled"); 278 | 279 | governor.mapleProxyFactory_enableUpgradePath(address(factory), 1, 2, address(0)); 280 | 281 | assertTrue(!user.try_mapleProxied_upgrade(address(instance), 0, new bytes(0)), "Should fail: invalid version"); 282 | assertTrue(!user.try_mapleProxied_upgrade(address(instance), 1, new bytes(0)), "Should fail: same version"); 283 | assertTrue(!user.try_mapleProxied_upgrade(address(instance), 3, new bytes(0)), "Should fail: non-existent version"); 284 | assertTrue( user.try_mapleProxied_upgrade(address(instance), 2, new bytes(0)), "Should succeed"); 285 | 286 | assertEq(instance.implementation(), address(implementation2)); 287 | assertEq(factory.versionOf(instance.implementation()), 2); 288 | } 289 | 290 | function test_setGlobals() external { 291 | MapleGlobalsMock newGlobals = new MapleGlobalsMock(address(governor)); 292 | 293 | assertEq(factory.mapleGlobals(), address(globals)); 294 | 295 | assertTrue(!notGovernor.try_mapleProxyFactory_setGlobals(address(factory), address(newGlobals))); 296 | assertTrue( !governor.try_mapleProxyFactory_setGlobals(address(factory), address(1))); 297 | assertTrue( !governor.try_mapleProxyFactory_setGlobals(address(factory), address(new EmptyContract()))); 298 | assertTrue( governor.try_mapleProxyFactory_setGlobals(address(factory), address(newGlobals))); 299 | 300 | assertEq(factory.mapleGlobals(), address(newGlobals)); 301 | } 302 | 303 | function test_isInstance() external { 304 | bytes memory arguments = new bytes(0); 305 | bytes32 salt = keccak256(abi.encodePacked("salt1")); 306 | 307 | assertTrue(!user.try_mapleProxyFactory_createInstance(address(factory), arguments, salt), "Should fail: unregistered version"); 308 | 309 | governor.mapleProxyFactory_registerImplementation(address(factory), 1, address(implementation1), address(initializerV1)); 310 | governor.mapleProxyFactory_setDefaultVersion(address(factory), 1); 311 | 312 | address instance1 = user.mapleProxyFactory_createInstance(address(factory), arguments, salt); 313 | 314 | assertTrue(factory.isInstance(instance1)); 315 | 316 | // Deploy a new instance and check that it fails 317 | address instance2 = address(new MapleInstanceMock()); 318 | assertTrue(!factory.isInstance(instance2)); 319 | } 320 | 321 | } 322 | -------------------------------------------------------------------------------- /contracts/test/accounts/Governor.sol: -------------------------------------------------------------------------------- 1 | // SPDX-License-Identifier: AGPL-3.0-or-later 2 | pragma solidity ^0.8.7; 3 | 4 | import { IMapleProxyFactory } from "../../interfaces/IMapleProxyFactory.sol"; 5 | 6 | contract Governor { 7 | 8 | /**************************************************************************************************************************************/ 9 | /*** Direct Functions ***/ 10 | /**************************************************************************************************************************************/ 11 | 12 | function mapleProxyFactory_disableUpgradePath(address factory_, uint256 fromVersion_, uint256 toVersion_) external { 13 | IMapleProxyFactory(factory_).disableUpgradePath(fromVersion_, toVersion_); 14 | } 15 | 16 | function mapleProxyFactory_enableUpgradePath(address factory_, uint256 fromVersion_, uint256 toVersion_, address migrator_) external { 17 | IMapleProxyFactory(factory_).enableUpgradePath(fromVersion_, toVersion_, migrator_); 18 | } 19 | 20 | function mapleProxyFactory_registerImplementation( 21 | address factory_, 22 | uint256 version_, 23 | address implementationAddress_, 24 | address initializer_ 25 | ) external { 26 | IMapleProxyFactory(factory_).registerImplementation(version_, implementationAddress_, initializer_); 27 | } 28 | 29 | function mapleProxyFactory_setDefaultVersion(address factory_, uint256 version_) external { 30 | IMapleProxyFactory(factory_).setDefaultVersion(version_); 31 | } 32 | 33 | function mapleProxyFactory_setGlobals(address factory_, address mapleGlobals_) external { 34 | IMapleProxyFactory(factory_).setGlobals(mapleGlobals_); 35 | } 36 | 37 | /**************************************************************************************************************************************/ 38 | /*** Try Functions ***/ 39 | /**************************************************************************************************************************************/ 40 | 41 | function try_mapleProxyFactory_disableUpgradePath(address factory_, uint256 fromVersion_,uint256 toVersion_) 42 | external returns (bool ok_) 43 | { 44 | ( ok_, ) = factory_.call(abi.encodeWithSelector(IMapleProxyFactory.disableUpgradePath.selector, fromVersion_, toVersion_)); 45 | } 46 | 47 | function try_mapleProxyFactory_enableUpgradePath( 48 | address factory_, 49 | uint256 fromVersion_, 50 | uint256 toVersion_, 51 | address migrator_ 52 | ) external returns (bool ok_) { 53 | ( ok_, ) = factory_.call( 54 | abi.encodeWithSelector(IMapleProxyFactory.enableUpgradePath.selector, fromVersion_, toVersion_, migrator_) 55 | ); 56 | } 57 | 58 | function try_mapleProxyFactory_registerImplementation( 59 | address factory_, 60 | uint256 version_, 61 | address implementationAddress_, 62 | address initializer_ 63 | ) external returns (bool ok_) { 64 | ( ok_, ) = factory_.call( 65 | abi.encodeWithSelector(IMapleProxyFactory.registerImplementation.selector, version_, implementationAddress_, initializer_) 66 | ); 67 | } 68 | 69 | function try_mapleProxyFactory_setDefaultVersion(address factory_, uint256 version_) external returns (bool ok_) { 70 | ( ok_, ) = factory_.call(abi.encodeWithSelector(IMapleProxyFactory.setDefaultVersion.selector, version_)); 71 | } 72 | 73 | function try_mapleProxyFactory_setGlobals(address factory_, address mapleGlobals_) external returns (bool ok_) { 74 | ( ok_, ) = factory_.call(abi.encodeWithSelector(IMapleProxyFactory.setGlobals.selector, mapleGlobals_)); 75 | } 76 | 77 | } 78 | -------------------------------------------------------------------------------- /contracts/test/accounts/User.sol: -------------------------------------------------------------------------------- 1 | // SPDX-License-Identifier: AGPL-3.0-or-later 2 | pragma solidity ^0.8.7; 3 | 4 | import { IMapleProxied } from "../../interfaces/IMapleProxied.sol"; 5 | import { IMapleProxyFactory } from "../../interfaces/IMapleProxyFactory.sol"; 6 | 7 | contract User { 8 | 9 | /**************************************************************************************************************************************/ 10 | /*** Direct Functions ***/ 11 | /**************************************************************************************************************************************/ 12 | 13 | function mapleProxied_upgrade(address instance_, uint256 toVersion_, bytes calldata arguments_) external { 14 | IMapleProxied(instance_).upgrade(toVersion_, arguments_); 15 | } 16 | 17 | function mapleProxyFactory_createInstance(address factory_, bytes calldata arguments_, bytes32 salt_) 18 | external returns (address instance_) 19 | { 20 | return IMapleProxyFactory(factory_).createInstance(arguments_, salt_); 21 | } 22 | 23 | /**************************************************************************************************************************************/ 24 | /*** Try Functions ***/ 25 | /**************************************************************************************************************************************/ 26 | 27 | function try_mapleProxied_upgrade(address instance_, uint256 toVersion_, bytes calldata arguments_) external returns (bool ok_) { 28 | ( ok_, ) = instance_.call(abi.encodeWithSelector(IMapleProxied.upgrade.selector, toVersion_, arguments_)); 29 | } 30 | 31 | function try_mapleProxyFactory_createInstance(address factory_, bytes calldata arguments_, bytes32 salt_) external returns (bool ok_) { 32 | ( ok_, ) = factory_.call(abi.encodeWithSelector(IMapleProxyFactory.createInstance.selector, arguments_, salt_)); 33 | } 34 | 35 | } 36 | -------------------------------------------------------------------------------- /contracts/test/mocks/Mocks.sol: -------------------------------------------------------------------------------- 1 | // SPDX-License-Identifier: AGPL-3.0-or-later 2 | pragma solidity ^0.8.7; 3 | 4 | import { IMapleProxied } from "../../interfaces/IMapleProxied.sol"; 5 | import { IMapleProxyFactory } from "../../interfaces/IMapleProxyFactory.sol"; 6 | 7 | import { MapleProxiedInternals } from "../../MapleProxiedInternals.sol"; 8 | 9 | contract MapleGlobalsMock { 10 | 11 | address public governor; 12 | 13 | bool public protocolPaused; 14 | 15 | constructor (address governor_) { 16 | governor = governor_; 17 | } 18 | 19 | function setProtocolPaused(bool protocolPaused_) external { 20 | protocolPaused = protocolPaused_; 21 | } 22 | 23 | } 24 | 25 | contract MapleInstanceMock is IMapleProxied, MapleProxiedInternals { 26 | 27 | function factory() external view override returns (address factory_) { 28 | return _factory(); 29 | } 30 | 31 | function implementation() external view override returns (address implementation_) { 32 | return _implementation(); 33 | } 34 | 35 | function migrate(address migrator_, bytes calldata arguments_) external override { 36 | _migrate(migrator_, arguments_); 37 | } 38 | 39 | function setImplementation(address newImplementation_) external override { 40 | _setImplementation(newImplementation_); 41 | } 42 | 43 | function upgrade(uint256 toVersion_, bytes calldata arguments_) override external { 44 | IMapleProxyFactory(_factory()).upgradeInstance(toVersion_, arguments_); 45 | } 46 | 47 | } 48 | 49 | contract EmptyContract {} 50 | -------------------------------------------------------------------------------- /foundry.toml: -------------------------------------------------------------------------------- 1 | [profile.default] 2 | contracts = 'contracts' # The contract directory 3 | test = 'tests' # The test directory 4 | libs = ['modules'] # A list of library directories 5 | solc_version = '0.8.7' # Override for the solc version (setting this ignores `auto_detect_solc`) 6 | optimizer = true # Enable or disable the solc optimizer 7 | optimizer_runs = 200 # The number of optimizer runs 8 | verbosity = 3 # The verbosity of tests 9 | block_timestamp = 1_622_400_000 # Timestamp for tests (non-zero) 10 | -------------------------------------------------------------------------------- /scripts/build.sh: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | set -e 3 | 4 | while getopts p: flag 5 | do 6 | case "${flag}" in 7 | p) profile=${OPTARG};; 8 | esac 9 | done 10 | 11 | export FOUNDRY_PROFILE=$profile 12 | echo Using profile: $FOUNDRY_PROFILE 13 | 14 | forge build 15 | -------------------------------------------------------------------------------- /scripts/release.sh: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | set -e 3 | 4 | version=$(cat ./configs/package.yaml | grep "version: " | sed -r 's/.{9}//') 5 | name=$(cat ./configs/package.yaml | grep "name: " | sed -r 's/.{6}//') 6 | customDescription=$(cat ./configs/package.yaml | grep "customDescription: " | sed -r 's/.{19}//') 7 | 8 | ./scripts/build.sh 9 | 10 | rm -rf ./package 11 | mkdir -p package 12 | 13 | echo "{ 14 | \"name\": \"@maplelabs/${name}\", 15 | \"version\": \"${version}\", 16 | \"description\": \"${customDescription}\", 17 | \"author\": \"Maple Labs\", 18 | \"license\": \"AGPLv3\", 19 | \"repository\": { 20 | \"type\": \"git\", 21 | \"url\": \"https://github.com/maple-labs/${name}.git\" 22 | }, 23 | \"bugs\": { 24 | \"url\": \"https://github.com/maple-labs/${name}/issues\" 25 | }, 26 | \"homepage\": \"https://github.com/maple-labs/${name}\" 27 | }" > package/package.json 28 | 29 | mkdir -p package/artifacts 30 | mkdir -p package/abis 31 | 32 | paths=($(cat ./configs/package.yaml | grep " - path:" | sed -r 's/.{10}//')) 33 | names=($(cat ./configs/package.yaml | grep " contractName:" | sed -r 's/.{18}//')) 34 | 35 | for i in "${!paths[@]}"; do 36 | cat ./out/${names[i]}.sol/${names[i]}.json | jq "{ abi: .abi, evm: { bytecode: .bytecode, deployedBytecode: .deployedBytecode } }" > package/artifacts/${names[i]}.json 37 | cat ./out/${names[i]}.sol/${names[i]}.json | jq ".abi" > package/abis/${names[i]}.json 38 | done 39 | 40 | npm publish ./package --access public 41 | 42 | rm -rf ./package 43 | --------------------------------------------------------------------------------